<!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: gr_msg_queue.h Source File</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 -->
<h1>gr_msg_queue.h</h1><a href="gr__msg__queue_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2005,2009 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef INCLUDED_GR_MSG_QUEUE_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_MSG_QUEUE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="gr__msg__handler_8h.html">gr_msg_handler.h</a>></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="thread_8h.html">gruel/thread.h</a>></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classgr__msg__queue.html" title="thread-safe message queue">gr_msg_queue</a>;
<a name="l00029"></a>00029 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<gr_msg_queue></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_msg_queue_sptr</a>;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_msg_queue_sptr</a> <a class="code" href="gr__msg__queue_8h.html#abcfdbfcad229e8c43ef0caaba4963fb8">gr_make_msg_queue</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__msg__queue.html#aa614d591169f4fca48fa28d8caa4da6d" title="return limit on number of message in queue. 0 -&gt; unbounded">limit</a>=0);
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/*!</span>
<a name="l00034"></a>00034 <span class="comment"> * \brief thread-safe message queue</span>
<a name="l00035"></a>00035 <span class="comment"> * \ingroup misc</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a><a class="code" href="classgr__msg__queue.html">00037</a> <span class="keyword">class </span><a class="code" href="classgr__msg__queue.html" title="thread-safe message queue">gr_msg_queue</a> : <span class="keyword">public</span> <a class="code" href="classgr__msg__handler.html" title="abstract class of message handlers">gr_msg_handler</a> {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 gruel::mutex d_mutex;
<a name="l00040"></a>00040 gruel::condition_variable d_not_empty;
<a name="l00041"></a>00041 gruel::condition_variable d_not_full;
<a name="l00042"></a>00042 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> d_head;
<a name="l00043"></a>00043 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> d_tail;
<a name="l00044"></a>00044 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_count; <span class="comment">// # of messages in queue.</span>
<a name="l00045"></a>00045 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_limit; <span class="comment">// max # of messages in queue. 0 -> unbounded</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00048"></a>00048 <a class="code" href="classgr__msg__queue.html#afdb2b45e3fa48b751af1c0efa5b64a6e">gr_msg_queue</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__msg__queue.html#aa614d591169f4fca48fa28d8caa4da6d" title="return limit on number of message in queue. 0 -&gt; unbounded">limit</a>);
<a name="l00049"></a>00049 <a class="code" href="classgr__msg__queue.html#aa69ef4aea1bdc792d15e6c76bb53a58b">~gr_msg_queue</a>();
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> //! Generic msg_handler method: insert the message.</span>
<a name="l00052"></a><a class="code" href="classgr__msg__queue.html#a2e2a98602dc08f2999916db33f0dcfaf">00052</a> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classgr__msg__queue.html#a2e2a98602dc08f2999916db33f0dcfaf" title="Generic msg_handler method: insert the message.">handle</a>(<a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> msg) { <a class="code" href="classgr__msg__queue.html#ae62e52ad8e7db84d20775b26dd0d7776" title="Insert message at tail of queue.">insert_tail</a> (msg); }
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /*!</span>
<a name="l00055"></a>00055 <span class="comment"> * \brief Insert message at tail of queue.</span>
<a name="l00056"></a>00056 <span class="comment"> * \param msg message</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * Block if queue if full.</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="classgr__msg__queue.html#ae62e52ad8e7db84d20775b26dd0d7776" title="Insert message at tail of queue.">insert_tail</a>(<a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> msg);
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /*!</span>
<a name="l00063"></a>00063 <span class="comment"> * \brief Delete message from head of queue and return it.</span>
<a name="l00064"></a>00064 <span class="comment"> * Block if no message is available.</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> <a class="code" href="classgr__msg__queue.html#a37f3be5d0dc5c6470c552b7cc1c2772d" title="Delete message from head of queue and return it. Block if no message is available...">delete_head</a>();
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /*!</span>
<a name="l00069"></a>00069 <span class="comment"> * \brief If there's a message in the q, delete it and return it.</span>
<a name="l00070"></a>00070 <span class="comment"> * If no message is available, return 0.</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a>00072 <a class="code" href="classboost_1_1shared__ptr.html">gr_message_sptr</a> <a class="code" href="classgr__msg__queue.html#a4350864fc60a2e49d9027c0826d20a07" title="If there&#39;s a message in the q, delete it and return it. If no message is available...">delete_head_nowait</a>();
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> //! Delete all messages from the queue</span>
<a name="l00075"></a>00075 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classgr__msg__queue.html#a06f0bf5384d9b877ac53684dd19e05e3" title="Delete all messages from the queue.">flush</a>();
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> //! is the queue empty?</span>
<a name="l00078"></a><a class="code" href="classgr__msg__queue.html#a0e4773212eb96752d2ada250ed3e2cf9">00078</a> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classgr__msg__queue.html#a0e4773212eb96752d2ada250ed3e2cf9" title="is the queue empty?">empty_p</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_count == 0; }
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> //! is the queue full?</span>
<a name="l00081"></a><a class="code" href="classgr__msg__queue.html#a993d45fb88afcc36cae5827b7c6c5b91">00081</a> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classgr__msg__queue.html#a993d45fb88afcc36cae5827b7c6c5b91" title="is the queue full?">full_p</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_limit != 0 && d_count >= d_limit; }
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> //! return number of messages in queue</span>
<a name="l00084"></a><a class="code" href="classgr__msg__queue.html#af0e4495b5ef776624ac170bbbb7a6bf7">00084</a> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__msg__queue.html#af0e4495b5ef776624ac170bbbb7a6bf7" title="return number of messages in queue">count</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_count; }
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> //! return limit on number of message in queue. 0 -> unbounded</span>
<a name="l00087"></a><a class="code" href="classgr__msg__queue.html#aa614d591169f4fca48fa28d8caa4da6d">00087</a> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__msg__queue.html#aa614d591169f4fca48fa28d8caa4da6d" title="return limit on number of message in queue. 0 -&gt; unbounded">limit</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_limit; }
<a name="l00088"></a>00088
<a name="l00089"></a>00089 };
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_MSG_QUEUE_H */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:51:00 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>
