<!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.3"/>
<title>GNU Radio 3.6.4.1 C++ API: msg_passing.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('msg__passing_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">msg_passing.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="msg__passing_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2009 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License along</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef INCLUDED_GRUEL_MSG_PASSING_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GRUEL_MSG_PASSING_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * \brief Include this header to use the message passing features</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="gruel_2src_2include_2gruel_2api_8h.html">gruel/api.h</a>></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="pmt_8h.html">gruel/pmt.h</a>></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <<a class="code" href="msg__accepter_8h.html">gruel/msg_accepter.h</a>></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>gruel {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * \brief send message to msg_accepter</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * \param accepter is the target of the send.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * \param which_port A pmt symbol describing the port by name.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * \param msg is the message to send. It's usually a pmt tuple.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * Sending a message is an asynchronous operation. The \p send</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * call will not wait for the message either to arrive at the</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * destination or to be received.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * \returns msg</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="namespacegruel.html#a13ea02c0ad4a0d79e85645cc2bcb2c88"> 49</a></span>  <a class="code" href="namespacegruel.html#a13ea02c0ad4a0d79e85645cc2bcb2c88" title="send message to msg_accepter">send</a>(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">msg_accepter_sptr</a> accepter, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &which_port, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &msg)</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  accepter->post(which_port, msg);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> msg;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * \brief send message to msg_accepter</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * \param accepter is the target of the send.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * \param which_port A pmt symbol describing the port by name.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * \param msg is the message to send. It's usually a pmt tuple.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * Sending a message is an asynchronous operation. The \p send</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * call will not wait for the message either to arrive at the</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * destination or to be received.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * \returns msg</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="namespacegruel.html#a57bc482e98cd83cc49a235e6b97cddae"> 69</a></span>  <a class="code" href="namespacegruel.html#a13ea02c0ad4a0d79e85645cc2bcb2c88" title="send message to msg_accepter">send</a>(<a class="code" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages.">msg_accepter</a> *accepter, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &which_port, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &msg)</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  accepter-><a class="code" href="classgruel_1_1msg__accepter.html#a62d8adbf698ebc526653f5dc329442ca" title="send msg to msg_accepter on port which_port ">post</a>(which_port, msg);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> msg;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * \brief send message to msg_accepter</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * \param accepter is the target of the send.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * \param which_port A pmt symbol describing the port by name.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * \param msg is the message to send. It's usually a pmt tuple.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * Sending a message is an asynchronous operation. The \p send</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * call will not wait for the message either to arrive at the</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * destination or to be received.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * \returns msg</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a></div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="namespacegruel.html#ad207c3deb775c43ffc54df77d59fa9c3"> 89</a></span>  <a class="code" href="namespacegruel.html#a13ea02c0ad4a0d79e85645cc2bcb2c88" title="send message to msg_accepter">send</a>(<a class="code" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages.">msg_accepter</a> &accepter, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &which_port, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &msg)</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  accepter.<a class="code" href="classgruel_1_1msg__accepter.html#a62d8adbf698ebc526653f5dc329442ca" title="send msg to msg_accepter on port which_port ">post</a>(which_port, msg);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> msg;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * \brief send message to msg_accepter</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * \param accepter is the target of the send. precond: pmt_is_msg_accepter(accepter)</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * \param which_port A pmt symbol describing the port by name.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * \param msg is the message to send. It's usually a pmt tuple.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * Sending a message is an asynchronous operation. The \p send</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * call will not wait for the message either to arrive at the</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * destination or to be received.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * \returns msg</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a></div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="code" href="namespacegruel.html#ace0465dbdc16bf3330e65bb4d54761a9"> 109</a></span>  <a class="code" href="namespacegruel.html#a13ea02c0ad4a0d79e85645cc2bcb2c88" title="send message to msg_accepter">send</a>(<a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> accepter, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &which_port, <span class="keyword">const</span> <a class="code" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa" title="typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm">pmt::pmt_t</a> &msg)</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> <a class="code" href="namespacegruel.html#a13ea02c0ad4a0d79e85645cc2bcb2c88" title="send message to msg_accepter">send</a>(<a class="code" href="namespacepmt.html#ace122e1b2c1cc95cddf393761772b306" title="Return underlying msg_accepter.">pmt_msg_accepter_ref</a>(accepter), which_port, msg);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> } <span class="comment">/* namespace gruel */</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GRUEL_MSG_PASSING_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e4934a9abf308ec9161c8626411b7338.html">gruel</a></li><li class="navelem"><a class="el" href="dir_49632b44df1cd3222a3be69af1a51055.html">src</a></li><li class="navelem"><a class="el" href="dir_2b71b5f80f21f04232ce1df4a861caba.html">include</a></li><li class="navelem"><a class="el" href="dir_f99cd76972da08c118ef74b0017b7a3e.html">gruel</a></li><li class="navelem"><a class="el" href="msg__passing_8h.html">msg_passing.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
