<!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.2.2 C++ API: gr_msg_queue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classgr__msg__queue.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>gr_msg_queue Class Reference<div class="ingroups"><a class="el" href="group__misc.html">Miscellaneous</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_msg_queue" --><!-- doxytag: inherits="gr_msg_handler" -->
<p>thread-safe message queue
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__msg__queue_8h_source.html">gr_msg_queue.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_msg_queue:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__msg__queue__inherit__graph.png" border="0" usemap="#gr__msg__queue_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__msg__queue_inherit__map" id="gr__msg__queue_inherit__map">
<area shape="rect" id="node2" href="classgr__msg__handler.html" title="abstract class of message handlers" alt="" coords="5,5,120,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__msg__queue-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#afdb2b45e3fa48b751af1c0efa5b64a6e">gr_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="classgr__msg__queue.html#aa69ef4aea1bdc792d15e6c76bb53a58b">~gr_msg_queue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#a2e2a98602dc08f2999916db33f0dcfaf">handle</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> msg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic msg_handler method: insert the message. <a href="#a2e2a98602dc08f2999916db33f0dcfaf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#ae62e52ad8e7db84d20775b26dd0d7776">insert_tail</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> msg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert message at tail of queue. <a href="#ae62e52ad8e7db84d20775b26dd0d7776"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#a37f3be5d0dc5c6470c552b7cc1c2772d">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="#a37f3be5d0dc5c6470c552b7cc1c2772d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#a4350864fc60a2e49d9027c0826d20a07">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 0. <a href="#a4350864fc60a2e49d9027c0826d20a07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#a06f0bf5384d9b877ac53684dd19e05e3">flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all messages from the queue. <a href="#a06f0bf5384d9b877ac53684dd19e05e3"></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="classgr__msg__queue.html#a0e4773212eb96752d2ada250ed3e2cf9">empty_p</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">is the queue empty? <a href="#a0e4773212eb96752d2ada250ed3e2cf9"></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="classgr__msg__queue.html#a993d45fb88afcc36cae5827b7c6c5b91">full_p</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">is the queue full? <a href="#a993d45fb88afcc36cae5827b7c6c5b91"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#af0e4495b5ef776624ac170bbbb7a6bf7">count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return number of messages in queue <a href="#af0e4495b5ef776624ac170bbbb7a6bf7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html#aa614d591169f4fca48fa28d8caa4da6d">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="#aa614d591169f4fca48fa28d8caa4da6d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>thread-safe message queue </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afdb2b45e3fa48b751af1c0efa5b64a6e"></a><!-- doxytag: member="gr_msg_queue::gr_msg_queue" ref="afdb2b45e3fa48b751af1c0efa5b64a6e" args="(unsigned int limit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_msg_queue::gr_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="aa69ef4aea1bdc792d15e6c76bb53a58b"></a><!-- doxytag: member="gr_msg_queue::~gr_msg_queue" ref="aa69ef4aea1bdc792d15e6c76bb53a58b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_msg_queue::~gr_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="af0e4495b5ef776624ac170bbbb7a6bf7"></a><!-- doxytag: member="gr_msg_queue::count" ref="af0e4495b5ef776624ac170bbbb7a6bf7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int gr_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>
</div>
</div>
<a class="anchor" id="a37f3be5d0dc5c6470c552b7cc1c2772d"></a><!-- doxytag: member="gr_msg_queue::delete_head" ref="a37f3be5d0dc5c6470c552b7cc1c2772d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> gr_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="a4350864fc60a2e49d9027c0826d20a07"></a><!-- doxytag: member="gr_msg_queue::delete_head_nowait" ref="a4350864fc60a2e49d9027c0826d20a07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> gr_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 0. </p>
</div>
</div>
<a class="anchor" id="a0e4773212eb96752d2ada250ed3e2cf9"></a><!-- doxytag: member="gr_msg_queue::empty_p" ref="a0e4773212eb96752d2ada250ed3e2cf9" 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> gr_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="a06f0bf5384d9b877ac53684dd19e05e3"></a><!-- doxytag: member="gr_msg_queue::flush" ref="a06f0bf5384d9b877ac53684dd19e05e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_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="a993d45fb88afcc36cae5827b7c6c5b91"></a><!-- doxytag: member="gr_msg_queue::full_p" ref="a993d45fb88afcc36cae5827b7c6c5b91" 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> gr_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>
</div>
</div>
<a class="anchor" id="a2e2a98602dc08f2999916db33f0dcfaf"></a><!-- doxytag: member="gr_msg_queue::handle" ref="a2e2a98602dc08f2999916db33f0dcfaf" args="(gr_message_sptr msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_msg_queue::handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generic msg_handler method: insert the message. </p>
<p>Implements <a class="el" href="classgr__msg__handler.html#aa0c903a19349849a27b037428e377d0b">gr_msg_handler</a>.</p>
<p>References <a class="el" href="classgr__msg__queue.html#ae62e52ad8e7db84d20775b26dd0d7776">insert_tail()</a>.</p>
</div>
</div>
<a class="anchor" id="ae62e52ad8e7db84d20775b26dd0d7776"></a><!-- doxytag: member="gr_msg_queue::insert_tail" ref="ae62e52ad8e7db84d20775b26dd0d7776" args="(gr_message_sptr msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_msg_queue::insert_tail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> </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 class="params">
<tr><td class="paramname">msg</td><td>message</td></tr>
</table>
</dd>
</dl>
<p>Block if queue if full. </p>
<p>Referenced by <a class="el" href="classgr__msg__queue.html#a2e2a98602dc08f2999916db33f0dcfaf">handle()</a>.</p>
</div>
</div>
<a class="anchor" id="aa614d591169f4fca48fa28d8caa4da6d"></a><!-- doxytag: member="gr_msg_queue::limit" ref="aa614d591169f4fca48fa28d8caa4da6d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int gr_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="gr__msg__queue_8h_source.html">gr_msg_queue.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__msg__queue.html">gr_msg_queue</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
1520
