OpenLCP/docs/doxygen/html/de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html
2021-08-25 17:21:45 -04:00

236 lines
14 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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: RDMnet::BrokerProtocol::ClientEntry::entry_rpt_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>RDMnet</b></li><li class="navelem"><b>BrokerProtocol</b></li><li class="navelem"><a class="el" href="../../d6/d71/namespace_r_d_mnet_1_1_broker_protocol_1_1_client_entry.html">ClientEntry</a></li><li class="navelem"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html">entry_rpt_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="../../db/d67/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RDMnet::BrokerProtocol::ClientEntry::entry_rpt_data Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The ClientEntry::RptClientEntry_data struct.
<a href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#details">More...</a></p>
<p><code>#include &lt;broker-protocol.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RDMnet::BrokerProtocol::ClientEntry::entry_rpt_data:</div>
<div class="dyncontent">
<div class="center"><img src="../../d6/d24/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data__inherit__graph.png" border="0" usemap="#a_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data_inherit__map" alt="Inheritance graph"/></div>
<map name="a_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data_inherit__map" id="a_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data_inherit__map">
<area shape="rect" title="The ClientEntry::RptClientEntry_data struct." alt="" coords="5,169,192,211"/>
<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="24,95,173,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="17,5,181,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:a15bf7266312cbd12be267e090c4d17f6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a15bf7266312cbd12be267e090c4d17f6">streamSize</a> () const override</td></tr>
<tr class="memdesc:a15bf7266312cbd12be267e090c4d17f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">streamSize <a href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a15bf7266312cbd12be267e090c4d17f6">More...</a><br /></td></tr>
<tr class="separator:a15bf7266312cbd12be267e090c4d17f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a825479e8b9e8c8690083856f41367f66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a825479e8b9e8c8690083856f41367f66">iStream</a> (ACN::PDU::Stream) override</td></tr>
<tr class="memdesc:a825479e8b9e8c8690083856f41367f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">rpt_data::iStream <a href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a825479e8b9e8c8690083856f41367f66">More...</a><br /></td></tr>
<tr class="separator:a825479e8b9e8c8690083856f41367f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9713fce3004ae4f75b428b2aaf181469"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a9713fce3004ae4f75b428b2aaf181469">oStream</a> (ACN::PDU::Stream) const override</td></tr>
<tr class="memdesc:a9713fce3004ae4f75b428b2aaf181469"><td class="mdescLeft">&#160;</td><td class="mdescRight">rpt_data::oStream <a href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a9713fce3004ae4f75b428b2aaf181469">More...</a><br /></td></tr>
<tr class="separator:a9713fce3004ae4f75b428b2aaf181469"><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:acb7bc7a57f70f8e72d14ff1686035ade"><td class="memItemLeft" align="right" valign="top"><a id="acb7bc7a57f70f8e72d14ff1686035ade"></a>
<a class="el" href="../../d6/d1f/struct_r_d_m_1_1_u_i_d.html">RDM::UID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#acb7bc7a57f70f8e72d14ff1686035ade">client_uid</a></td></tr>
<tr class="memdesc:acb7bc7a57f70f8e72d14ff1686035ade"><td class="mdescLeft">&#160;</td><td class="mdescRight">client <a class="el" href="../../de/d93/namespace_r_d_m.html" title="ANSI E1.37-1 2012 (R2017) Additional Message Sets for ANSI E1.20 (RDM) Part 1,...">RDM</a> UID <br /></td></tr>
<tr class="separator:acb7bc7a57f70f8e72d14ff1686035ade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a765f603c3216d1689344f77d92c60558"><td class="memItemLeft" align="right" valign="top"><a id="a765f603c3216d1689344f77d92c60558"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#a765f603c3216d1689344f77d92c60558">client_type</a></td></tr>
<tr class="memdesc:a765f603c3216d1689344f77d92c60558"><td class="mdescLeft">&#160;</td><td class="mdescRight">client type identifier <br /></td></tr>
<tr class="separator:a765f603c3216d1689344f77d92c60558"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac17af7a8e195f52dd855d9ead593cdbb"><td class="memItemLeft" align="right" valign="top"><a id="ac17af7a8e195f52dd855d9ead593cdbb"></a>
<a class="el" href="../../dc/da6/class_u_u_i_d_1_1uuid.html">UUID::uuid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d0a/struct_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1entry__rpt__data.html#ac17af7a8e195f52dd855d9ead593cdbb">binding_cid</a></td></tr>
<tr class="memdesc:ac17af7a8e195f52dd855d9ead593cdbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">UUID to bind. <br /></td></tr>
<tr class="separator:ac17af7a8e195f52dd855d9ead593cdbb"><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>The ClientEntry::RptClientEntry_data struct. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a825479e8b9e8c8690083856f41367f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a825479e8b9e8c8690083856f41367f66">&#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 RDMnet::BrokerProtocol::ClientEntry::entry_rpt_data::iStream </td>
<td>(</td>
<td class="paramtype">ACN::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>rpt_data::iStream </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="a9713fce3004ae4f75b428b2aaf181469"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9713fce3004ae4f75b428b2aaf181469">&#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 RDMnet::BrokerProtocol::ClientEntry::entry_rpt_data::oStream </td>
<td>(</td>
<td class="paramtype">ACN::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>rpt_data::oStream </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="a15bf7266312cbd12be267e090c4d17f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15bf7266312cbd12be267e090c4d17f6">&#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 RDMnet::BrokerProtocol::ClientEntry::entry_rpt_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">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>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/rdmnet/broker-protocol.h</li>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/rdmnet/broker-protocol.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>