475 lines
22 KiB
HTML
475 lines
22 KiB
HTML
<!-- HTML header for doxygen 1.8.8-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<!-- For Mobile Devices -->
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta name="generator" content="Doxygen 1.8.12"/>
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<title>Etk: Ewol Tool Kit: etk::Fifo< MY_TYPE > Class Template Reference</title>
|
|
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
|
|
<script type="text/javascript" src="doxy-boot.js"></script>
|
|
</head>
|
|
<body>
|
|
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<a class="navbar-brand">Etk: Ewol Tool Kit 0.10.0</a>
|
|
</div>
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li><a href="index.html">Main Page</a></li>
|
|
<li><a href="pages.html">Related Pages</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
</ul>
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
|
|
Link-libs<span class="caret"></span>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
|
|
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
|
|
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
|
|
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
|
|
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
|
|
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
|
|
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
|
|
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
|
|
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
|
|
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
|
|
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
|
|
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
|
|
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
|
|
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
|
|
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
|
|
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
|
|
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div id="search-box" class="input-group">
|
|
<div class="input-group-btn">
|
|
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
|
|
<span class="glyphicon glyphicon-search"></span>
|
|
<span class="caret"></span>
|
|
</button>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">All</a></li>
|
|
<li><a href="#">Classes</a></li>
|
|
<li><a href="#">Namespaces</a></li>
|
|
<li><a href="#">Files</a></li>
|
|
<li><a href="#">Functions</a></li>
|
|
<li><a href="#">Variables</a></li>
|
|
<li><a href="#">Typedefs</a></li>
|
|
<li><a href="#">Enumerations</a></li>
|
|
<li><a href="#">Enumerator</a></li>
|
|
<li><a href="#">Friends</a></li>
|
|
<li><a href="#">Macros</a></li>
|
|
<li><a href="#">Pages</a></li>
|
|
</ul>
|
|
</div>
|
|
<button id="search-close" type="button" class="close" aria-label="Close">
|
|
<span aria-hidden="true"></span>
|
|
</button>
|
|
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
|
|
</div>
|
|
</div><!--/.nav-collapse -->
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="content" id="content">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
|
|
<div style="margin-bottom: 15px;margin-top: 60px;">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.12 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceetk.html">etk</a></li><li class="navelem"><a class="el" href="classetk_1_1_fifo.html">Fifo</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classetk_1_1_fifo-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">etk::Fifo< MY_TYPE > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_fifo_8hpp_source.html">Fifo.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a37abc79759bdbfe9e28b273e600c59f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#a37abc79759bdbfe9e28b273e600c59f0">Fifo</a> ()</td></tr>
|
|
<tr class="separator:a37abc79759bdbfe9e28b273e600c59f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3aa50d02d2a5099ead2dcd2bda984ec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#ae3aa50d02d2a5099ead2dcd2bda984ec">~Fifo</a> ()</td></tr>
|
|
<tr class="separator:ae3aa50d02d2a5099ead2dcd2bda984ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0693f87b2886e553ccdafdac112ebbd5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#a0693f87b2886e553ccdafdac112ebbd5">wait</a> (MY_TYPE &_data)</td></tr>
|
|
<tr class="separator:a0693f87b2886e553ccdafdac112ebbd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa08e5c57d91bc54ea08f377a6e2653e3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#aa08e5c57d91bc54ea08f377a6e2653e3">wait</a> (MY_TYPE &_data, uint32_t _timeOutInUs)</td></tr>
|
|
<tr class="separator:aa08e5c57d91bc54ea08f377a6e2653e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d43270207b6da91d535a520e18f49c7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#a7d43270207b6da91d535a520e18f49c7">count</a> ()</td></tr>
|
|
<tr class="separator:a7d43270207b6da91d535a520e18f49c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a844b4b22b7e6da8d88e301cb57555043"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#a844b4b22b7e6da8d88e301cb57555043">post</a> (MY_TYPE &_data)</td></tr>
|
|
<tr class="separator:a844b4b22b7e6da8d88e301cb57555043"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee87d87fed54bc307ea3cf3ea12250d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#aee87d87fed54bc307ea3cf3ea12250d9">post</a> (const MY_TYPE &_data)</td></tr>
|
|
<tr class="separator:aee87d87fed54bc307ea3cf3ea12250d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8d5cb46bcba3868e9e858a79d3e22cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classetk_1_1_fifo.html#af8d5cb46bcba3868e9e858a79d3e22cc">clean</a> ()</td></tr>
|
|
<tr class="separator:af8d5cb46bcba3868e9e858a79d3e22cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<class MY_TYPE = int32_t><br />
|
|
class etk::Fifo< MY_TYPE ></h3>
|
|
|
|
<p><a class="el" href="classetk_1_1_fifo.html" title="Fifo tamplate is a simple messaged fifo element to transfer data message from a thead to an other...">Fifo</a> tamplate is a simple messaged fifo element to transfer data message from a thead to an other. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">MY_TYPE</td><td>Type of the fifo message are tranfered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a37abc79759bdbfe9e28b273e600c59f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37abc79759bdbfe9e28b273e600c59f0">§ </a></span>Fifo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::<a class="el" href="classetk_1_1_fifo.html">Fifo</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a fifo with no message. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3aa50d02d2a5099ead2dcd2bda984ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3aa50d02d2a5099ead2dcd2bda984ec">§ </a></span>~Fifo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::~<a class="el" href="classetk_1_1_fifo.html">Fifo</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove the fifo and all message inside. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="af8d5cb46bcba3868e9e858a79d3e22cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8d5cb46bcba3868e9e858a79d3e22cc">§ </a></span>clean()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::clean </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove all the message in the fifo. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d43270207b6da91d535a520e18f49c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d43270207b6da91d535a520e18f49c7">§ </a></span>count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t <a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::count </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of message in the fifo. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of message in the fifo. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a844b4b22b7e6da8d88e301cb57555043"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a844b4b22b7e6da8d88e301cb57555043">§ </a></span>post() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::post </td>
|
|
<td>(</td>
|
|
<td class="paramtype">MY_TYPE & </td>
|
|
<td class="paramname"><em>_data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message at the other thread by setting a new message in the fifo. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>New data to add at the fifo. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee87d87fed54bc307ea3cf3ea12250d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee87d87fed54bc307ea3cf3ea12250d9">§ </a></span>post() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::post </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const MY_TYPE & </td>
|
|
<td class="paramname"><em>_data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message at the other thread by setting a new message in the fifo. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>New data to add at the fifo. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0693f87b2886e553ccdafdac112ebbd5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0693f87b2886e553ccdafdac112ebbd5">§ </a></span>wait() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::wait </td>
|
|
<td>(</td>
|
|
<td class="paramtype">MY_TYPE & </td>
|
|
<td class="paramname"><em>_data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Wait a message from the other thread. (no timeout set) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">_data</td><td>Data find in the fifo. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true A data has been find. </dd>
|
|
<dd>
|
|
false No data found or closed fifo </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa08e5c57d91bc54ea08f377a6e2653e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa08e5c57d91bc54ea08f377a6e2653e3">§ </a></span>wait() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class MY_TYPE = int32_t> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classetk_1_1_fifo.html">etk::Fifo</a>< MY_TYPE >::wait </td>
|
|
<td>(</td>
|
|
<td class="paramtype">MY_TYPE & </td>
|
|
<td class="paramname"><em>_data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>_timeOutInUs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Wait a message from the other thread, with a specified timeout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">_data</td><td>keeped data from the fifo. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_timeOutInUs</td><td>Time-out to wait a message in the fifo. It mightbespecify in micro-second. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true We keep a massage. </dd>
|
|
<dd>
|
|
false No message found while time-out appear. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>framework/atria-soft/etk/etk/os/<a class="el" href="_fifo_8hpp_source.html">Fifo.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.8-->
|
|
<!-- start footer part -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Oct 24 2016 15:35:46 for Etk: Ewol Tool Kit by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.12
|
|
</small></address>
|
|
</body>
|
|
</html>
|