OpenLCP/docs/doxygen/html/d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html
2021-08-25 17:21:45 -04:00

145 lines
8.8 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: ACN::SDT::SessionId 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/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html">SessionId</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="../../d2/d93/struct_a_c_n_1_1_s_d_t_1_1_session_id-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ACN::SDT::SessionId Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>3.1 <a class="el" href="../../d5/dde/class_a_c_n_1_1_s_d_t_1_1_session.html" title="The Session class A session has a single leader and zero or more session members.">Session</a> <a class="el" href="../../d3/d47/class_a_c_n_1_1_s_d_t_1_1_identity.html" title="The Identity class.">Identity</a>
<a href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#details">More...</a></p>
<p><code>#include &lt;session.h&gt;</code></p>
<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:ad3f336077f5026ba2f4f5026e021d805"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#ad3f336077f5026ba2f4f5026e021d805">operator==</a> (const <a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html">SessionId</a> &amp;) const</td></tr>
<tr class="memdesc:ad3f336077f5026ba2f4f5026e021d805"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#ad3f336077f5026ba2f4f5026e021d805" title="SessionId::operator == sessionID comparitor.">SessionId::operator ==</a> sessionID comparitor. <a href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#ad3f336077f5026ba2f4f5026e021d805">More...</a><br /></td></tr>
<tr class="separator:ad3f336077f5026ba2f4f5026e021d805"><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:adb5bb7af7f014df9650ba8eddccc3528"><td class="memItemLeft" align="right" valign="top"><a id="adb5bb7af7f014df9650ba8eddccc3528"></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="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#adb5bb7af7f014df9650ba8eddccc3528">cid</a></td></tr>
<tr class="memdesc:adb5bb7af7f014df9650ba8eddccc3528"><td class="mdescLeft">&#160;</td><td class="mdescRight">the component ID (CID) of the session leader <br /></td></tr>
<tr class="separator:adb5bb7af7f014df9650ba8eddccc3528"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8681a0cf770c1e75f94032a8487b059"><td class="memItemLeft" align="right" valign="top"><a id="ac8681a0cf770c1e75f94032a8487b059"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#ac8681a0cf770c1e75f94032a8487b059">number</a></td></tr>
<tr class="memdesc:ac8681a0cf770c1e75f94032a8487b059"><td class="mdescLeft">&#160;</td><td class="mdescRight">the session number the leader has assigned <br /></td></tr>
<tr class="separator:ac8681a0cf770c1e75f94032a8487b059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49c6a356cc85336f903fa5ea090afbf6"><td class="memItemLeft" align="right" valign="top"><a id="a49c6a356cc85336f903fa5ea090afbf6"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#a49c6a356cc85336f903fa5ea090afbf6">protocol</a></td></tr>
<tr class="memdesc:a49c6a356cc85336f903fa5ea090afbf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">the ID of the protocol carried by the session <br /></td></tr>
<tr class="separator:a49c6a356cc85336f903fa5ea090afbf6"><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>3.1 <a class="el" href="../../d5/dde/class_a_c_n_1_1_s_d_t_1_1_session.html" title="The Session class A session has a single leader and zero or more session members.">Session</a> <a class="el" href="../../d3/d47/class_a_c_n_1_1_s_d_t_1_1_identity.html" title="The Identity class.">Identity</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad3f336077f5026ba2f4f5026e021d805"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3f336077f5026ba2f4f5026e021d805">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ACN::SDT::SessionId::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html">SessionId</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d8/dac/struct_a_c_n_1_1_s_d_t_1_1_session_id.html#ad3f336077f5026ba2f4f5026e021d805" title="SessionId::operator == sessionID comparitor.">SessionId::operator ==</a> sessionID comparitor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/sdt/session.h</li>
<li>/home/kevin/Code/viewer/lib/OpenLCP/protocols/sdt/session.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>