official/OpenLCP
1
0
Fork 0
Code Releases 1 Activity
ce74d93cad
OpenLCP/docs/doxygen/html/d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html
Kevin Matz ce74d93cad doxygen built files
2021-08-25 17:21:45 -04:00

256 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenLCP: ACN::SDT::wrapper_data Struct Reference</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="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenLCP
&#160;<span id="projectnumber">0.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ACN</b></li><li class="navelem"><b>SDT</b></li><li class="navelem"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html">wrapper_data</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d5/d55/struct_a_c_n_1_1_s_d_t_1_1wrapper__data-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ACN::SDT::wrapper_data Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>4.4.6 Reliable Wrapper and Unreliable Wrapper
<a href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#details">More...</a></p>
<p><code>#include &lt;sdt.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ACN::SDT::wrapper_data:</div>
<div class="dyncontent">
<div class="center"><img src="../../d9/d3a/struct_a_c_n_1_1_s_d_t_1_1wrapper__data__inherit__graph.png" border="0" usemap="#a_a_c_n_1_1_s_d_t_1_1wrapper__data_inherit__map" alt="Inheritance graph"/></div>
<map name="a_a_c_n_1_1_s_d_t_1_1wrapper__data_inherit__map" id="a_a_c_n_1_1_s_d_t_1_1wrapper__data_inherit__map">
<area shape="rect" title="4.4.6 Reliable Wrapper and Unreliable Wrapper" alt="" coords="5,169,176,196"/>
<area shape="rect" href="../../d6/d25/struct_a_c_n_1_1_p_d_u_1_1pdu__data.html" title="The pdu_data struct." alt="" coords="16,95,165,121"/>
<area shape="rect" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html" title="The pdu_stream_object struct." alt="" coords="9,5,173,47"/>
</map>
<center><span class="legend">[<a href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6aa46b439485872205208a65656f1a4a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a6aa46b439485872205208a65656f1a4a">streamSize</a> () const override</td></tr>
<tr class="memdesc:a6aa46b439485872205208a65656f1a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a6aa46b439485872205208a65656f1a4a" title="wrapper_data::streamSize">wrapper_data::streamSize</a> <a href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a6aa46b439485872205208a65656f1a4a">More...</a><br /></td></tr>
<tr class="separator:a6aa46b439485872205208a65656f1a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa969da99bde89743eb971c5b95b87c1d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#aa969da99bde89743eb971c5b95b87c1d">iStream</a> (PDU::Stream) override</td></tr>
<tr class="memdesc:aa969da99bde89743eb971c5b95b87c1d"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#aa969da99bde89743eb971c5b95b87c1d" title="wrapper_data::iStream">wrapper_data::iStream</a> <a href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#aa969da99bde89743eb971c5b95b87c1d">More...</a><br /></td></tr>
<tr class="separator:aa969da99bde89743eb971c5b95b87c1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10d54743da01e101da55f204ecf49d2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a10d54743da01e101da55f204ecf49d2f">oStream</a> (PDU::Stream) const override</td></tr>
<tr class="memdesc:a10d54743da01e101da55f204ecf49d2f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a10d54743da01e101da55f204ecf49d2f" title="wrapper_data::oStream">wrapper_data::oStream</a> <a href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a10d54743da01e101da55f204ecf49d2f">More...</a><br /></td></tr>
<tr class="separator:a10d54743da01e101da55f204ecf49d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6d5adb86275c711cf3faa410da6b801a"><td class="memItemLeft" align="right" valign="top"><a id="a6d5adb86275c711cf3faa410da6b801a"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a6d5adb86275c711cf3faa410da6b801a">channel</a></td></tr>
<tr class="memdesc:a6d5adb86275c711cf3faa410da6b801a"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel number <br /></td></tr>
<tr class="separator:a6d5adb86275c711cf3faa410da6b801a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac90756a9e1a8b314bf03f22cd439bf76"><td class="memItemLeft" align="right" valign="top"><a id="ac90756a9e1a8b314bf03f22cd439bf76"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#ac90756a9e1a8b314bf03f22cd439bf76">sequence</a></td></tr>
<tr class="memdesc:ac90756a9e1a8b314bf03f22cd439bf76"><td class="mdescLeft">&#160;</td><td class="mdescRight">sequence number <br /></td></tr>
<tr class="separator:ac90756a9e1a8b314bf03f22cd439bf76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8759b4e1237f9e3b06057fb59fe152d9"><td class="memItemLeft" align="right" valign="top"><a id="a8759b4e1237f9e3b06057fb59fe152d9"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a8759b4e1237f9e3b06057fb59fe152d9">reliable</a></td></tr>
<tr class="memdesc:a8759b4e1237f9e3b06057fb59fe152d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">reliable number <br /></td></tr>
<tr class="separator:a8759b4e1237f9e3b06057fb59fe152d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c552ff4115211ecf02b5fd11ef20db6"><td class="memItemLeft" align="right" valign="top"><a id="a8c552ff4115211ecf02b5fd11ef20db6"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a8c552ff4115211ecf02b5fd11ef20db6">oldest</a></td></tr>
<tr class="memdesc:a8c552ff4115211ecf02b5fd11ef20db6"><td class="mdescLeft">&#160;</td><td class="mdescRight">oldest sequence number <br /></td></tr>
<tr class="separator:a8c552ff4115211ecf02b5fd11ef20db6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc8ce094962b3b89cc4c43da4645da5e"><td class="memItemLeft" align="right" valign="top"><a id="abc8ce094962b3b89cc4c43da4645da5e"></a>
MID&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#abc8ce094962b3b89cc4c43da4645da5e">ack_range_begin</a></td></tr>
<tr class="memdesc:abc8ce094962b3b89cc4c43da4645da5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">first MID to acknowledge <br /></td></tr>
<tr class="separator:abc8ce094962b3b89cc4c43da4645da5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd247e26b3927321bcb911c61fbdb713"><td class="memItemLeft" align="right" valign="top"><a id="acd247e26b3927321bcb911c61fbdb713"></a>
MID&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#acd247e26b3927321bcb911c61fbdb713">ack_range_end</a></td></tr>
<tr class="memdesc:acd247e26b3927321bcb911c61fbdb713"><td class="mdescLeft">&#160;</td><td class="mdescRight">last MID to acknowledge <br /></td></tr>
<tr class="separator:acd247e26b3927321bcb911c61fbdb713"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4779b209a873268f63576e90cdddda1f"><td class="memItemLeft" align="right" valign="top"><a id="a4779b209a873268f63576e90cdddda1f"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a4779b209a873268f63576e90cdddda1f">MAK_threshold</a></td></tr>
<tr class="memdesc:a4779b209a873268f63576e90cdddda1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">MAK Threshold. <br /></td></tr>
<tr class="separator:a4779b209a873268f63576e90cdddda1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a149b2c3663161b2cb320d234172e44c8"><td class="memItemLeft" align="right" valign="top"><a id="a149b2c3663161b2cb320d234172e44c8"></a>
<a class="el" href="../../d6/d85/struct_a_c_n_1_1_p_d_u_1_1_block.html">PDU::Block</a>&lt; <a class="el" href="../../db/d6c/class_a_c_n_1_1_s_d_t_1_1_c_l_i_e_n_t_1_1_pdu.html">CLIENT::Pdu</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a149b2c3663161b2cb320d234172e44c8">block</a></td></tr>
<tr class="memdesc:a149b2c3663161b2cb320d234172e44c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">client PDU block <br /></td></tr>
<tr class="separator:a149b2c3663161b2cb320d234172e44c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>4.4.6 Reliable Wrapper and Unreliable Wrapper </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa969da99bde89743eb971c5b95b87c1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa969da99bde89743eb971c5b95b87c1d">&#9670;&nbsp;</a></span>iStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ACN::SDT::wrapper_data::iStream </td>
<td>(</td>
<td class="paramtype">PDU::Stream&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#aa969da99bde89743eb971c5b95b87c1d" title="wrapper_data::iStream">wrapper_data::iStream</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#acaa5e9ee7ddce7c11749b231369fb454">ACN::PDU::pdu_stream_object</a>.</p>
</div>
</div>
<a id="a10d54743da01e101da55f204ecf49d2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10d54743da01e101da55f204ecf49d2f">&#9670;&nbsp;</a></span>oStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ACN::SDT::wrapper_data::oStream </td>
<td>(</td>
<td class="paramtype">PDU::Stream&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a10d54743da01e101da55f204ecf49d2f" title="wrapper_data::oStream">wrapper_data::oStream</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#a78127230fabad6aa07d507eb7540822a">ACN::PDU::pdu_stream_object</a>.</p>
</div>
</div>
<a id="a6aa46b439485872205208a65656f1a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aa46b439485872205208a65656f1a4a">&#9670;&nbsp;</a></span>streamSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t ACN::SDT::wrapper_data::streamSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/d30/struct_a_c_n_1_1_s_d_t_1_1wrapper__data.html#a6aa46b439485872205208a65656f1a4a" title="wrapper_data::streamSize">wrapper_data::streamSize</a> </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Implements <a class="el" href="../../da/d12/struct_a_c_n_1_1_p_d_u_1_1pdu__stream__object.html#a511b8fe623f70d9220f315451e896b34">ACN::PDU::pdu_stream_object</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/sdt/sdt.h</li>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/sdt/sdt.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
View Git Blame Copy Permalink