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

288 lines
19 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::params 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/dca/struct_a_c_n_1_1_s_d_t_1_1params.html">params</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="../../d3/d60/struct_a_c_n_1_1_s_d_t_1_1params-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ACN::SDT::params Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>4.4.1.2 <a class="el" href="../../db/df6/class_a_c_n_1_1_s_d_t_1_1_channel.html" title="The Channel class Sequenced channels are unidirectional communication channels (unicast or multicast)...">Channel</a> Parameter Block
<a href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#details">More...</a></p>
<p><code>#include &lt;sdt.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ACN::SDT::params:</div>
<div class="dyncontent">
<div class="center"><img src="../../df/d3a/struct_a_c_n_1_1_s_d_t_1_1params__inherit__graph.png" border="0" usemap="#a_a_c_n_1_1_s_d_t_1_1params_inherit__map" alt="Inheritance graph"/></div>
<map name="a_a_c_n_1_1_s_d_t_1_1params_inherit__map" id="a_a_c_n_1_1_s_d_t_1_1params_inherit__map">
<area shape="rect" title="4.4.1.2 Channel Parameter Block" alt="" coords="20,95,155,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="5,5,169,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:a82d66e2cd01b4ea00d1fa601266a1e7f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a82d66e2cd01b4ea00d1fa601266a1e7f">streamSize</a> () const override</td></tr>
<tr class="memdesc:a82d66e2cd01b4ea00d1fa601266a1e7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">streamSize <a href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a82d66e2cd01b4ea00d1fa601266a1e7f">More...</a><br /></td></tr>
<tr class="separator:a82d66e2cd01b4ea00d1fa601266a1e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a253616177af1263ae0e66eb0b24db636"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a253616177af1263ae0e66eb0b24db636">iStream</a> (PDU::Stream) override</td></tr>
<tr class="memdesc:a253616177af1263ae0e66eb0b24db636"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a253616177af1263ae0e66eb0b24db636" title="params::iStream">params::iStream</a> <a href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a253616177af1263ae0e66eb0b24db636">More...</a><br /></td></tr>
<tr class="separator:a253616177af1263ae0e66eb0b24db636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79838ed1db3f02adeb6a9856dcd4fea1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a79838ed1db3f02adeb6a9856dcd4fea1">oStream</a> (PDU::Stream) const override</td></tr>
<tr class="memdesc:a79838ed1db3f02adeb6a9856dcd4fea1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a79838ed1db3f02adeb6a9856dcd4fea1" title="params::oStream">params::oStream</a> <a href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a79838ed1db3f02adeb6a9856dcd4fea1">More...</a><br /></td></tr>
<tr class="separator:a79838ed1db3f02adeb6a9856dcd4fea1"><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:a57d1c88b6fc411de55481ea0bc4bd304"><td class="memItemLeft" align="right" valign="top"><a id="a57d1c88b6fc411de55481ea0bc4bd304"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a57d1c88b6fc411de55481ea0bc4bd304">Expiry</a></td></tr>
<tr class="memdesc:a57d1c88b6fc411de55481ea0bc4bd304"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of seconds without traffic before leaving <br /></td></tr>
<tr class="separator:a57d1c88b6fc411de55481ea0bc4bd304"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe0a63213b0f10ff027c48e4c4a36c7"><td class="memItemLeft" ><a id="adfe0a63213b0f10ff027c48e4c4a36c7"></a>
union {</td></tr>
<tr class="memitem:ae4110d08cd3959a8f1d9fd919ef793a3"><td class="memItemLeft" >
&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#aad5fdb8ce47d1a663d93958709c486e2">flags</a> = 0</td></tr>
<tr class="memdesc:ae4110d08cd3959a8f1d9fd919ef793a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">packed field of parameter flags <br /></td></tr>
<tr class="separator:ae4110d08cd3959a8f1d9fd919ef793a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20a468a2b27b7eb843d5ea650888777a"><td class="memItemLeft" ><a id="a20a468a2b27b7eb843d5ea650888777a"></a>
&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a534fff9386d4022f4966696e750f46ed"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<b>reserved</b>: 7</td></tr>
<tr class="separator:a534fff9386d4022f4966696e750f46ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef296bda6903673c0dd384383f00571e"><td class="memItemLeft" >
&#160;&#160;&#160;&#160;&#160;&#160;bool&#160;&#160;&#160;<a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a13b74f8ebbd57dd8d793431fe65c0c8b">NAK_Outbound</a>: 1</td></tr>
<tr class="memdesc:aef296bda6903673c0dd384383f00571e"><td class="mdescLeft">&#160;</td><td class="mdescRight">NAK to channel (true) or destination address (false) <br /></td></tr>
<tr class="separator:aef296bda6903673c0dd384383f00571e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20a468a2b27b7eb843d5ea650888777a"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a20a468a2b27b7eb843d5ea650888777a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe0a63213b0f10ff027c48e4c4a36c7"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:adfe0a63213b0f10ff027c48e4c4a36c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfdb4fdf70f37f9af7752b16b84c7213"><td class="memItemLeft" align="right" valign="top"><a id="abfdb4fdf70f37f9af7752b16b84c7213"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#abfdb4fdf70f37f9af7752b16b84c7213">NAKholdoff</a></td></tr>
<tr class="memdesc:abfdb4fdf70f37f9af7752b16b84c7213"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculation of a standoff time for sending NAKs <br /></td></tr>
<tr class="separator:abfdb4fdf70f37f9af7752b16b84c7213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18998983ba6ce551f223c87b73138644"><td class="memItemLeft" align="right" valign="top"><a id="a18998983ba6ce551f223c87b73138644"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a18998983ba6ce551f223c87b73138644">NAKmodulus</a></td></tr>
<tr class="memdesc:a18998983ba6ce551f223c87b73138644"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculation of a standoff time for sending NAKs <br /></td></tr>
<tr class="separator:a18998983ba6ce551f223c87b73138644"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa089e93f7dede59940caf04305935eb6"><td class="memItemLeft" align="right" valign="top"><a id="aa089e93f7dede59940caf04305935eb6"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#aa089e93f7dede59940caf04305935eb6">NAKmaxwait</a></td></tr>
<tr class="memdesc:aa089e93f7dede59940caf04305935eb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">maximum milliseconds to wait before sending a NAK. <br /></td></tr>
<tr class="separator:aa089e93f7dede59940caf04305935eb6"><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.1.2 <a class="el" href="../../db/df6/class_a_c_n_1_1_s_d_t_1_1_channel.html" title="The Channel class Sequenced channels are unidirectional communication channels (unicast or multicast)...">Channel</a> Parameter Block </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a253616177af1263ae0e66eb0b24db636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a253616177af1263ae0e66eb0b24db636">&#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::params::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/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a253616177af1263ae0e66eb0b24db636" title="params::iStream">params::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 class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a253616177af1263ae0e66eb0b24db636_icgraph.png" border="0" usemap="#ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a253616177af1263ae0e66eb0b24db636_icgraph" alt=""/></div>
<map name="ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a253616177af1263ae0e66eb0b24db636_icgraph" id="ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a253616177af1263ae0e66eb0b24db636_icgraph">
<area shape="rect" title="params::iStream" alt="" coords="240,46,428,73"/>
<area shape="rect" href="../../dc/d8e/struct_a_c_n_1_1_s_d_t_1_1join__data.html#ab06f57e3f886ccf1ba46f9180a3cf42d" title="join_data::iStream" alt="" coords="27,5,171,47"/>
<area shape="rect" href="../../db/dc5/struct_a_c_n_1_1_s_d_t_1_1channel__params__data.html#abe688e856dc8990141cff24ce2138ad1" title="channel_params_data::iStream" alt="" coords="5,71,192,112"/>
</map>
</div>
</div>
</div>
<a id="a79838ed1db3f02adeb6a9856dcd4fea1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79838ed1db3f02adeb6a9856dcd4fea1">&#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::params::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/dca/struct_a_c_n_1_1_s_d_t_1_1params.html#a79838ed1db3f02adeb6a9856dcd4fea1" title="params::oStream">params::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 class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a79838ed1db3f02adeb6a9856dcd4fea1_icgraph.png" border="0" usemap="#ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a79838ed1db3f02adeb6a9856dcd4fea1_icgraph" alt=""/></div>
<map name="ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a79838ed1db3f02adeb6a9856dcd4fea1_icgraph" id="ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a79838ed1db3f02adeb6a9856dcd4fea1_icgraph">
<area shape="rect" title="params::oStream" alt="" coords="240,46,432,73"/>
<area shape="rect" href="../../dc/d8e/struct_a_c_n_1_1_s_d_t_1_1join__data.html#ac920fadf056b689a1882a89cc1a6623a" title="join_data::oStream" alt="" coords="27,5,171,47"/>
<area shape="rect" href="../../db/dc5/struct_a_c_n_1_1_s_d_t_1_1channel__params__data.html#a67efa84fad5322641207c55198a7ae53" title="channel_params_data::oStream" alt="" coords="5,71,192,112"/>
</map>
</div>
</div>
</div>
<a id="a82d66e2cd01b4ea00d1fa601266a1e7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82d66e2cd01b4ea00d1fa601266a1e7f">&#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::params::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>streamSize </p>
<dl class="section return"><dt>Returns</dt><dd>length (count of octets) on the wire </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 class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a82d66e2cd01b4ea00d1fa601266a1e7f_icgraph.png" border="0" usemap="#ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a82d66e2cd01b4ea00d1fa601266a1e7f_icgraph" alt=""/></div>
<map name="ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a82d66e2cd01b4ea00d1fa601266a1e7f_icgraph" id="ad8/dca/struct_a_c_n_1_1_s_d_t_1_1params_a82d66e2cd01b4ea00d1fa601266a1e7f_icgraph">
<area shape="rect" title="streamSize" alt="" coords="240,46,449,73"/>
<area shape="rect" href="../../dc/d8e/struct_a_c_n_1_1_s_d_t_1_1join__data.html#a573d04332f5faa305a6f7427f1d4365e" title="join_data::streamSize" alt="" coords="27,5,171,47"/>
<area shape="rect" href="../../db/dc5/struct_a_c_n_1_1_s_d_t_1_1channel__params__data.html#ae0a878a71579bce45e22b94b60309759" title="channel_params_data::streamSize" alt="" coords="5,71,192,112"/>
</map>
</div>
</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