📄 a00742.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>OpenDDS: OpenDDS::DCPS::TransportControlElement Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a01301.html">OpenDDS</a>::<a class="el" href="a01275.html">DCPS</a>::<a class="el" href="a00742.html">TransportControlElement</a></div>
<h1>OpenDDS::DCPS::TransportControlElement Class Reference</h1><!-- doxytag: class="OpenDDS::DCPS::TransportControlElement" --><!-- doxytag: inherits="OpenDDS::DCPS::TransportQueueElement" --><code>#include <TransportControlElement.h></code>
<p>
Inheritance diagram for OpenDDS::DCPS::TransportControlElement:<p><center><img src="a02851.png" border="0" usemap="#a02852" alt="Inheritance graph"></center>
<map name="a02852">
<area href="a00751.html" shape="rect" coords="8,7,304,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for OpenDDS::DCPS::TransportControlElement:<p><center><img src="a02853.png" border="0" usemap="#a02854" alt="Collaboration graph"></center>
<map name="a02854">
<area href="a00751.html" shape="rect" coords="8,7,304,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="a00096.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#f9ae1bf336a3fea70c9091cb8352e30a">TransportControlElement</a> (ACE_Message_Block *msg_block)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#b0a798641efc191a81b511df12f7d25b">~TransportControlElement</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#3384e04b27a06d112afabfbb63875b35">requires_exclusive_packet</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does the sample require an exclusive transport packet? <a href="#3384e04b27a06d112afabfbb63875b35"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00552.html">RepoId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#61a17531ffe6105b88a1e78b2967fa27">publication_id</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the publisher id that sent the sample. <a href="#61a17531ffe6105b88a1e78b2967fa27"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const ACE_Message_Block * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#6c4df3c576195b36f22730e9c8ae4287">msg</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The marshalled sample (sample header + sample data). <a href="#6c4df3c576195b36f22730e9c8ae4287"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#2bbccb45c47d3d44b889152c63b432bd">release_element</a> (bool dropped_by_transport)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoked when the counter reaches 0. <a href="#2bbccb45c47d3d44b889152c63b432bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#16e20b2ce17e3f48083e20f233fab519">data_delivered</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoked when the sample has been sent by a <a class="el" href="a00493.html">DataLink</a>. <a href="#16e20b2ce17e3f48083e20f233fab519"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ACE_Message_Block * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00742.html#e558da7b5ca5823b6b89349d2b440dd9">msg_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The control message. <a href="#e558da7b5ca5823b6b89349d2b440dd9"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f9ae1bf336a3fea70c9091cb8352e30a"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::TransportControlElement" ref="f9ae1bf336a3fea70c9091cb8352e30a" args="(ACE_Message_Block *msg_block)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenDDS::DCPS::TransportControlElement::TransportControlElement </td>
<td>(</td>
<td class="paramtype">ACE_Message_Block * </td>
<td class="paramname"> <em>msg_block</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b0a798641efc191a81b511df12f7d25b"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::~TransportControlElement" ref="b0a798641efc191a81b511df12f7d25b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenDDS::DCPS::TransportControlElement::~TransportControlElement </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="16e20b2ce17e3f48083e20f233fab519"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::data_delivered" ref="16e20b2ce17e3f48083e20f233fab519" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenDDS::DCPS::TransportControlElement::data_delivered </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Invoked when the sample has been sent by a <a class="el" href="a00493.html">DataLink</a>.
<p>
<p>
Reimplemented from <a class="el" href="a00751.html#dad1cb8a077ecef4ca3283fb53fbee06">OpenDDS::DCPS::TransportQueueElement</a>.
</div>
</div><p>
<a class="anchor" name="6c4df3c576195b36f22730e9c8ae4287"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::msg" ref="6c4df3c576195b36f22730e9c8ae4287" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const ACE_Message_Block * OpenDDS::DCPS::TransportControlElement::msg </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The marshalled sample (sample header + sample data).
<p>
<p>
Implements <a class="el" href="a00751.html#95e4e477b6968f9596f830c95ce6b8e8">OpenDDS::DCPS::TransportQueueElement</a>.
</div>
</div><p>
<a class="anchor" name="61a17531ffe6105b88a1e78b2967fa27"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::publication_id" ref="61a17531ffe6105b88a1e78b2967fa27" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00552.html">OpenDDS::DCPS::RepoId</a> OpenDDS::DCPS::TransportControlElement::publication_id </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessor for the publisher id that sent the sample.
<p>
<p>
Implements <a class="el" href="a00751.html#5f7f7e4edad463a11bf1f2b52dc9eae5">OpenDDS::DCPS::TransportQueueElement</a>.
</div>
</div><p>
<a class="anchor" name="2bbccb45c47d3d44b889152c63b432bd"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::release_element" ref="2bbccb45c47d3d44b889152c63b432bd" args="(bool dropped_by_transport)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenDDS::DCPS::TransportControlElement::release_element </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>dropped_by_transport</em> </td>
<td> ) </td>
<td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Invoked when the counter reaches 0.
<p>
<p>
Implements <a class="el" href="a00751.html#0e67ec23019b89c476890ec643c87f86">OpenDDS::DCPS::TransportQueueElement</a>.
</div>
</div><p>
<a class="anchor" name="3384e04b27a06d112afabfbb63875b35"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::requires_exclusive_packet" ref="3384e04b27a06d112afabfbb63875b35" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool OpenDDS::DCPS::TransportControlElement::requires_exclusive_packet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Does the sample require an exclusive transport packet?
<p>
<p>
Reimplemented from <a class="el" href="a00751.html#7db0e82260f47ac5f166de21cb731e3d">OpenDDS::DCPS::TransportQueueElement</a>.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="e558da7b5ca5823b6b89349d2b440dd9"></a><!-- doxytag: member="OpenDDS::DCPS::TransportControlElement::msg_" ref="e558da7b5ca5823b6b89349d2b440dd9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ACE_Message_Block* <a class="el" href="a00742.html#e558da7b5ca5823b6b89349d2b440dd9">OpenDDS::DCPS::TransportControlElement::msg_</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The control message.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a01196.html">TransportControlElement.h</a><li><a class="el" href="a01195.html">TransportControlElement.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Nov 7 09:37:44 2008 for OpenDDS by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -