<!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"/>
<title>GNU Radio 3.3.0 C++ API: gruel::msg_queue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navpath"><b>gruel</b>::<a class="el" href="classgruel_1_1msg__queue.html">msg_queue</a>
</div>
<div class="contents">
<h1>gruel::msg_queue Class Reference</h1><!-- doxytag: class="gruel::msg_queue" -->
<p>thread-safe message queue
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="msg__queue_8h_source.html">msg_queue.h</a>></code></p>
<p><a href="classgruel_1_1msg__queue-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a469a43215ebeec489be4a2713e22ae22">msg_queue</a> (unsigned int limit)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a178ae0e2347c9e982e41cc671a1b351a">~msg_queue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a5e820de615a7c49cca2799a024f3babf">insert_tail</a> (pmt::pmt_t msg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert message at tail of queue. <a href="#a5e820de615a7c49cca2799a024f3babf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">pmt::pmt_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a02eb07e3e0b9e9f4b9e9f6824b0035fa">delete_head</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete message from head of queue and return it. Block if no message is available. <a href="#a02eb07e3e0b9e9f4b9e9f6824b0035fa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">pmt::pmt_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a9481272cbb202559a2bd42e96f00470f">delete_head_nowait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If there's a message in the q, delete it and return it. If no message is available, return pmt_t(). <a href="#a9481272cbb202559a2bd42e96f00470f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a7380917a960d737ae1261dbb8df27da5">flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all messages from the queue. <a href="#a7380917a960d737ae1261dbb8df27da5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a8337be786cb2004953a20e6f241b6dfb">empty_p</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">is the queue empty? <a href="#a8337be786cb2004953a20e6f241b6dfb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#aa76558314459fd6628fffb2162007cff">full_p</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">is the queue full? <a href="#aa76558314459fd6628fffb2162007cff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a4ced37ac20a7a620540a03992bf74ab0">count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return number of messages in queue <a href="#a4ced37ac20a7a620540a03992bf74ab0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgruel_1_1msg__queue.html#a3f8beab2663d3b6b8b01e84b188bc637">limit</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return limit on number of message in queue. 0 -> unbounded <a href="#a3f8beab2663d3b6b8b01e84b188bc637"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>thread-safe message queue </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a469a43215ebeec489be4a2713e22ae22"></a><!-- doxytag: member="gruel::msg_queue::msg_queue" ref="a469a43215ebeec489be4a2713e22ae22" args="(unsigned int limit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gruel::msg_queue::msg_queue </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>limit</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a178ae0e2347c9e982e41cc671a1b351a"></a><!-- doxytag: member="gruel::msg_queue::~msg_queue" ref="a178ae0e2347c9e982e41cc671a1b351a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gruel::msg_queue::~msg_queue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4ced37ac20a7a620540a03992bf74ab0"></a><!-- doxytag: member="gruel::msg_queue::count" ref="a4ced37ac20a7a620540a03992bf74ab0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int gruel::msg_queue::count </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return number of messages in queue </p>
<p>Referenced by <a class="el" href="msg__queue_8h_source.html#l00079">full_p()</a>.</p>
</div>
</div>
<a class="anchor" id="a02eb07e3e0b9e9f4b9e9f6824b0035fa"></a><!-- doxytag: member="gruel::msg_queue::delete_head" ref="a02eb07e3e0b9e9f4b9e9f6824b0035fa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">pmt::pmt_t gruel::msg_queue::delete_head </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete message from head of queue and return it. Block if no message is available. </p>
</div>
</div>
<a class="anchor" id="a9481272cbb202559a2bd42e96f00470f"></a><!-- doxytag: member="gruel::msg_queue::delete_head_nowait" ref="a9481272cbb202559a2bd42e96f00470f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">pmt::pmt_t gruel::msg_queue::delete_head_nowait </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If there's a message in the q, delete it and return it. If no message is available, return pmt_t(). </p>
</div>
</div>
<a class="anchor" id="a8337be786cb2004953a20e6f241b6dfb"></a><!-- doxytag: member="gruel::msg_queue::empty_p" ref="a8337be786cb2004953a20e6f241b6dfb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gruel::msg_queue::empty_p </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>is the queue empty? </p>
</div>
</div>
<a class="anchor" id="a7380917a960d737ae1261dbb8df27da5"></a><!-- doxytag: member="gruel::msg_queue::flush" ref="a7380917a960d737ae1261dbb8df27da5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gruel::msg_queue::flush </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete all messages from the queue. </p>
</div>
</div>
<a class="anchor" id="aa76558314459fd6628fffb2162007cff"></a><!-- doxytag: member="gruel::msg_queue::full_p" ref="aa76558314459fd6628fffb2162007cff" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gruel::msg_queue::full_p </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>is the queue full? </p>
<p>References <a class="el" href="msg__queue_8h_source.html#l00082">count()</a>.</p>
</div>
</div>
<a class="anchor" id="a5e820de615a7c49cca2799a024f3babf"></a><!-- doxytag: member="gruel::msg_queue::insert_tail" ref="a5e820de615a7c49cca2799a024f3babf" args="(pmt::pmt_t msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gruel::msg_queue::insert_tail </td>
<td>(</td>
<td class="paramtype">pmt::pmt_t </td>
<td class="paramname"> <em>msg</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Insert message at tail of queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message</td></tr>
</table>
</dd>
</dl>
<p>Block if queue if full. </p>
</div>
</div>
<a class="anchor" id="a3f8beab2663d3b6b8b01e84b188bc637"></a><!-- doxytag: member="gruel::msg_queue::limit" ref="a3f8beab2663d3b6b8b01e84b188bc637" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int gruel::msg_queue::limit </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return limit on number of message in queue. 0 -> unbounded </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="msg__queue_8h_source.html">msg_queue.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:53:19 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
