<!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: port.h Source File</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('port_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>port.h</h1> </div>
</div>
<div class="contents">
<a href="port_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 2006,2008 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 along</span>
<a name="l00018"></a>00018 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef INCLUDED_MB_PORT_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_MB_PORT_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <mblock/common.h></span>
<a name="l00025"></a>00025 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">/*!</span>
<a name="l00027"></a>00027 <span class="comment"> * \brief Abstract port characteristics</span>
<a name="l00028"></a>00028 <span class="comment"> */</span>
<a name="l00029"></a><a class="code" href="classmb__port.html">00029</a> <span class="keyword">class </span><a class="code" href="classmb__port.html" title="Abstract port characteristics.">mb_port</a> : boost::noncopyable
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment"> //! port classification</span>
<a name="l00034"></a><a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7">00034</a> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7" title="port classification">port_type_t</a> {
<a name="l00035"></a><a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7afbf7726fc08e0cdad4236ba04e456ac0">00035</a> <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7afbf7726fc08e0cdad4236ba04e456ac0">EXTERNAL</a>, <span class="comment">//< Externally visible</span>
<a name="l00036"></a><a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7a25099810b70e3bd22435edcb3d945971">00036</a> <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7a25099810b70e3bd22435edcb3d945971">RELAY</a>, <span class="comment">//< Externally visible but really connected to a sub-component</span>
<a name="l00037"></a><a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7adbe27e3c2f0de021106128f949ac3d5a">00037</a> <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7adbe27e3c2f0de021106128f949ac3d5a">INTERNAL</a> <span class="comment">//< Visible to self only</span>
<a name="l00038"></a>00038 };
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">private</span>:
<a name="l00041"></a>00041
<a name="l00042"></a>00042 std::string d_port_name;
<a name="l00043"></a>00043 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> d_port_symbol; <span class="comment">// the port_name as a pmt symbol</span>
<a name="l00044"></a>00044 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> d_protocol_class;
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> d_conjugated;
<a name="l00046"></a>00046 <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7" title="port classification">port_type_t</a> d_port_type;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">protected</span>:
<a name="l00049"></a><a class="code" href="classmb__port.html#ab91541cfc8cbae3eab45257ae447e84c">00049</a> <a class="code" href="classmb__mblock.html" title="Parent class for all message passing blocks.">mb_mblock</a> *<a class="code" href="classmb__port.html#ab91541cfc8cbae3eab45257ae447e84c">d_mblock</a>; <span class="comment">// mblock we're defined in</span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">// protected constructor</span>
<a name="l00052"></a>00052 <a class="code" href="classmb__port.html#a4a8bc91c46289022e87b42a9b1962fe5">mb_port</a>(<a class="code" href="classmb__mblock.html" title="Parent class for all message passing blocks.">mb_mblock</a> *<a class="code" href="classmb__port.html#aa6e12c7f0acccd82a9cbe0e54554b620">mblock</a>,
<a name="l00053"></a>00053 <span class="keyword">const</span> std::string &<a class="code" href="classmb__port.html#a6e7d2167a9469bc8fb032273ef89a34e">port_name</a>,
<a name="l00054"></a>00054 <span class="keyword">const</span> std::string &protocol_class_name,
<a name="l00055"></a>00055 <span class="keywordtype">bool</span> <a class="code" href="classmb__port.html#ad18c83bd74aaa1e1f686a37d056a1f74">conjugated</a>,
<a name="l00056"></a>00056 <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7" title="port classification">mb_port::port_type_t</a> <a class="code" href="classmb__port.html#a9f19e3f53b1fb461f48848c9187b177c">port_type</a>);
<a name="l00057"></a>00057
<a name="l00058"></a><a class="code" href="classmb__port.html#aa6e12c7f0acccd82a9cbe0e54554b620">00058</a> <a class="code" href="classmb__mblock.html" title="Parent class for all message passing blocks.">mb_mblock</a> *<a class="code" href="classmb__port.html#aa6e12c7f0acccd82a9cbe0e54554b620">mblock</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmb__port.html#ab91541cfc8cbae3eab45257ae447e84c">d_mblock</a>; }
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">public</span>:
<a name="l00061"></a><a class="code" href="classmb__port.html#a6e7d2167a9469bc8fb032273ef89a34e">00061</a> std::string <a class="code" href="classmb__port.html#a6e7d2167a9469bc8fb032273ef89a34e">port_name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_port_name; }
<a name="l00062"></a><a class="code" href="classmb__port.html#a7f48e9e8cd3c230835ba4d8f008a708c">00062</a> <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__port.html#a7f48e9e8cd3c230835ba4d8f008a708c">port_symbol</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_port_symbol; }
<a name="l00063"></a><a class="code" href="classmb__port.html#a9897e91d06be233669a0e5ee78becd77">00063</a> <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__port.html#a9897e91d06be233669a0e5ee78becd77">protocol_class</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_protocol_class; }
<a name="l00064"></a><a class="code" href="classmb__port.html#ad18c83bd74aaa1e1f686a37d056a1f74">00064</a> <span class="keywordtype">bool</span> <a class="code" href="classmb__port.html#ad18c83bd74aaa1e1f686a37d056a1f74">conjugated</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_conjugated; }
<a name="l00065"></a><a class="code" href="classmb__port.html#a9f19e3f53b1fb461f48848c9187b177c">00065</a> <a class="code" href="classmb__port.html#ab7f3f63c496d0de66461f09320bbaaa7" title="port classification">port_type_t</a> <a class="code" href="classmb__port.html#a9f19e3f53b1fb461f48848c9187b177c">port_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_port_type; }
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__port.html#a065353719c1a2c6ba3defbc98738054c">incoming_message_set</a>() <span class="keyword">const</span>;
<a name="l00068"></a>00068 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> <a class="code" href="classmb__port.html#a92d36c2407c7ee6c85ad27876ba47f19">outgoing_message_set</a>() <span class="keyword">const</span>;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <a class="code" href="classmb__port.html#ad5ed1cc802a4ddaca91f852b810e2b81">~mb_port</a>();
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /*!</span>
<a name="l00073"></a>00073 <span class="comment"> * \brief send a message</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> * \param signal the event name</span>
<a name="l00076"></a>00076 <span class="comment"> * \param data optional data</span>
<a name="l00077"></a>00077 <span class="comment"> * \param metadata optional metadata</span>
<a name="l00078"></a>00078 <span class="comment"> * \param priority the urgency at which the message is sent</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00081"></a>00081 <a class="code" href="classmb__port.html#ad8b9db98bc7588b3f7ba87dcb56fa29d" title="send a message">send</a>(<a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> signal,
<a name="l00082"></a>00082 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> data = PMT_F,
<a name="l00083"></a>00083 <a class="code" href="classboost_1_1shared__ptr.html">pmt_t</a> metadata = PMT_F,
<a name="l00084"></a>00084 <a class="code" href="common_8h.html#aaca6107c0aa97c90bf00d7a0b20c8967">mb_pri_t</a> priority = <a class="code" href="common_8h.html#a612b7e57d4c931cd3565abd0d856d7fc">MB_PRI_DEFAULT</a>) = 0;
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">/*</span>
<a name="l00087"></a>00087 <span class="comment"> * \brief Invalidate any cached peer resolutions</span>
<a name="l00088"></a>00088 <span class="comment"> * \internal</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmb__port.html#aea29fb7a1ec65c2e924a21fd3736fdfa">invalidate_cache</a>() = 0;
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_MB_PORT_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="port_8h.html">port.h</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>
