OpenLCP/docs/doxygen/html/dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html
2021-08-25 17:21:45 -04:00

232 lines
13 KiB
HTML

<!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::client_entry_update_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="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html">client_entry_update_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="../../d6/daf/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RDMnet::BrokerProtocol::client_entry_update_data Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>6.3.1.4 Client Entry Update
<a href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#details">More...</a></p>
<p><code>#include &lt;broker-protocol.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RDMnet::BrokerProtocol::client_entry_update_data:</div>
<div class="dyncontent">
<div class="center"><img src="../../de/dda/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data__inherit__graph.png" border="0" usemap="#a_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data_inherit__map" alt="Inheritance graph"/></div>
<map name="a_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data_inherit__map" id="a_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data_inherit__map">
<area shape="rect" title="6.3.1.4 Client Entry Update" alt="" coords="5,169,180,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="18,95,167,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="11,5,175,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:ac85c642adc2637265142ab1bf40bc632"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#ac85c642adc2637265142ab1bf40bc632">streamSize</a> () const override</td></tr>
<tr class="memdesc:ac85c642adc2637265142ab1bf40bc632"><td class="mdescLeft">&#160;</td><td class="mdescRight">streamSize <a href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#ac85c642adc2637265142ab1bf40bc632">More...</a><br /></td></tr>
<tr class="separator:ac85c642adc2637265142ab1bf40bc632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fa9a5bb5fbf8579f838532e05837769"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#a4fa9a5bb5fbf8579f838532e05837769">iStream</a> (ACN::PDU::Stream) override</td></tr>
<tr class="memdesc:a4fa9a5bb5fbf8579f838532e05837769"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#a4fa9a5bb5fbf8579f838532e05837769" title="client_entry_update_data::iStream">client_entry_update_data::iStream</a> <a href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#a4fa9a5bb5fbf8579f838532e05837769">More...</a><br /></td></tr>
<tr class="separator:a4fa9a5bb5fbf8579f838532e05837769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeedfc1385971faf5a92bbee488301e4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#aeedfc1385971faf5a92bbee488301e4f">oStream</a> (ACN::PDU::Stream) const override</td></tr>
<tr class="memdesc:aeedfc1385971faf5a92bbee488301e4f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#aeedfc1385971faf5a92bbee488301e4f" title="client_entry_update_data::oStream">client_entry_update_data::oStream</a> <a href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#aeedfc1385971faf5a92bbee488301e4f">More...</a><br /></td></tr>
<tr class="separator:aeedfc1385971faf5a92bbee488301e4f"><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:a9b0192232649c5ed83aeec101fe5aa32"><td class="memItemLeft" align="right" valign="top"><a id="a9b0192232649c5ed83aeec101fe5aa32"></a>
<a class="el" href="../../db/d8c/union_r_d_mnet_1_1_broker_protocol_1_1connection__flags.html">connection_flags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#a9b0192232649c5ed83aeec101fe5aa32">flags</a></td></tr>
<tr class="memdesc:a9b0192232649c5ed83aeec101fe5aa32"><td class="mdescLeft">&#160;</td><td class="mdescRight">connection flags <br /></td></tr>
<tr class="separator:a9b0192232649c5ed83aeec101fe5aa32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9da19c908c8e0d235fe899c0790fdd86"><td class="memItemLeft" align="right" valign="top"><a id="a9da19c908c8e0d235fe899c0790fdd86"></a>
ACN::PDU::Message&lt; <a class="el" href="../../dc/daf/class_r_d_mnet_1_1_broker_protocol_1_1_client_entry_1_1_pdu.html">ClientEntry::Pdu</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#a9da19c908c8e0d235fe899c0790fdd86">pdu</a></td></tr>
<tr class="memdesc:a9da19c908c8e0d235fe899c0790fdd86"><td class="mdescLeft">&#160;</td><td class="mdescRight">client entry PDU <br /></td></tr>
<tr class="separator:a9da19c908c8e0d235fe899c0790fdd86"><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>6.3.1.4 Client Entry Update </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4fa9a5bb5fbf8579f838532e05837769"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fa9a5bb5fbf8579f838532e05837769">&#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::client_entry_update_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><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#a4fa9a5bb5fbf8579f838532e05837769" title="client_entry_update_data::iStream">client_entry_update_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="aeedfc1385971faf5a92bbee488301e4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeedfc1385971faf5a92bbee488301e4f">&#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::client_entry_update_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><a class="el" href="../../dc/dc0/struct_r_d_mnet_1_1_broker_protocol_1_1client__entry__update__data.html#aeedfc1385971faf5a92bbee488301e4f" title="client_entry_update_data::oStream">client_entry_update_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="ac85c642adc2637265142ab1bf40bc632"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac85c642adc2637265142ab1bf40bc632">&#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::client_entry_update_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>