<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>UHD: uhd::transport::bounded_buffer< elem_type > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">UHD
 <span id="projectnumber">003.007.002-0-unknown</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></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="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="namespaceuhd_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classuhd_1_1transport_1_1bounded__buffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::transport::bounded_buffer< elem_type > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="bounded__buffer_8hpp_source.html">bounded_buffer.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:a0e935871b34ab07cb87cf5dcbb08f488"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#a0e935871b34ab07cb87cf5dcbb08f488">bounded_buffer</a> (size_t capacity)</td></tr>
<tr class="separator:a0e935871b34ab07cb87cf5dcbb08f488"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a045aeb9ec89f62bcc6095768d4529d15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#a045aeb9ec89f62bcc6095768d4529d15">push_with_haste</a> (const elem_type &elem)</td></tr>
<tr class="separator:a045aeb9ec89f62bcc6095768d4529d15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9b64bb94eef6ca95044a9bff5e9a23d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#ae9b64bb94eef6ca95044a9bff5e9a23d">push_with_pop_on_full</a> (const elem_type &elem)</td></tr>
<tr class="separator:ae9b64bb94eef6ca95044a9bff5e9a23d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af57f0f6211514c3090e9518247be83cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#af57f0f6211514c3090e9518247be83cd">push_with_wait</a> (const elem_type &elem)</td></tr>
<tr class="separator:af57f0f6211514c3090e9518247be83cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8718904cf4d928211acf787511fda1c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#a8718904cf4d928211acf787511fda1c2">push_with_timed_wait</a> (const elem_type &elem, double timeout)</td></tr>
<tr class="separator:a8718904cf4d928211acf787511fda1c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab56419b2be3317dfe67999a4b4ac1545"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#ab56419b2be3317dfe67999a4b4ac1545">pop_with_haste</a> (elem_type &elem)</td></tr>
<tr class="separator:ab56419b2be3317dfe67999a4b4ac1545"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa59107520fb0044c677c5b490a873c3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#aa59107520fb0044c677c5b490a873c3e">pop_with_wait</a> (elem_type &elem)</td></tr>
<tr class="separator:aa59107520fb0044c677c5b490a873c3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a924336c1a5b806e2e43beaebbb610935"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html#a924336c1a5b806e2e43beaebbb610935">pop_with_timed_wait</a> (elem_type &elem, double timeout)</td></tr>
<tr class="separator:a924336c1a5b806e2e43beaebbb610935"><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<typename elem_type><br />
class uhd::transport::bounded_buffer< elem_type ></h3>
<p>Implement a templated bounded buffer: Used for passing elements between threads in a producer-consumer model. The bounded buffer implemented waits and timed waits with condition variables. The pop operation blocks on the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> to become non empty. The push operation blocks on the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> to become non full. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0e935871b34ab07cb87cf5dcbb08f488"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::<a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>capacity</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>Create a new bounded buffer object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">capacity</td><td>the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> capacity </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab56419b2be3317dfe67999a4b4ac1545"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::pop_with_haste </td>
<td>(</td>
<td class="paramtype">elem_type & </td>
<td class="paramname"><em>elem</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>Pop an element from the bounded buffer immediately. The element will not be popped when the buffer is empty. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the element reference pop to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false when the buffer is empty </dd></dl>
</div>
</div>
<a class="anchor" id="a924336c1a5b806e2e43beaebbb610935"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::pop_with_timed_wait </td>
<td>(</td>
<td class="paramtype">elem_type & </td>
<td class="paramname"><em>elem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>timeout</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>Pop an element from the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a>. Wait until the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> becomes non-empty or timeout. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the element reference pop to </td></tr>
<tr><td class="paramname">timeout</td><td>the timeout in seconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false when the operation times out </dd></dl>
</div>
</div>
<a class="anchor" id="aa59107520fb0044c677c5b490a873c3e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> void <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::pop_with_wait </td>
<td>(</td>
<td class="paramtype">elem_type & </td>
<td class="paramname"><em>elem</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>Pop an element from the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a>. Wait until the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> becomes non-empty. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the element reference pop to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a045aeb9ec89f62bcc6095768d4529d15"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::push_with_haste </td>
<td>(</td>
<td class="paramtype">const elem_type & </td>
<td class="paramname"><em>elem</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>Push a new element into the bounded buffer immediately. The element will not be pushed when the buffer is full. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the element reference pop to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false when the buffer is full </dd></dl>
</div>
</div>
<a class="anchor" id="ae9b64bb94eef6ca95044a9bff5e9a23d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::push_with_pop_on_full </td>
<td>(</td>
<td class="paramtype">const elem_type & </td>
<td class="paramname"><em>elem</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>Push a new element into the bounded buffer. If the buffer is full prior to the push, make room by poping the oldest element. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the new element to push </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the element fit without popping for space </dd></dl>
</div>
</div>
<a class="anchor" id="a8718904cf4d928211acf787511fda1c2"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> bool <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::push_with_timed_wait </td>
<td>(</td>
<td class="paramtype">const elem_type & </td>
<td class="paramname"><em>elem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>timeout</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>Push a new element into the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a>. Wait until the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> becomes non-full or timeout. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the new element to push </td></tr>
<tr><td class="paramname">timeout</td><td>the timeout in seconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false when the operation times out </dd></dl>
</div>
</div>
<a class="anchor" id="af57f0f6211514c3090e9518247be83cd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename elem_type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> void <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">uhd::transport::bounded_buffer</a>< elem_type >::push_with_wait </td>
<td>(</td>
<td class="paramtype">const elem_type & </td>
<td class="paramname"><em>elem</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>Push a new element into the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a>. Wait until the <a class="el" href="classuhd_1_1transport_1_1bounded__buffer.html">bounded_buffer</a> becomes non-full. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>the new element to push </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/uhd/transport/<a class="el" href="bounded__buffer_8hpp_source.html">bounded_buffer.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
eb4b034508697cc17e7c9cfffe7f772b
>
files
>
81
