comms_doc/FrameLayerBase_8h.html at master · commschamp/comms_doc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>COMMS: include/comms/frame/FrameLayerBase.h File 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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">COMMS
   </div>
   <div id="projectbrief">Template library intended to help with implementation of communication protocols.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3b90260015bf389bbf56758f180cfb9.html">comms</a></li><li class="navelem"><a class="el" href="dir_dd8c2c0530cb20291a2dde236c44195f.html">frame</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">FrameLayerBase.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Contains definition of <a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">comms::frame::FrameLayerBase</a>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="Assert_8h_source.html">comms/Assert.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="CompileControl_8h_source.html">comms/CompileControl.h</a>&quot;</code><br />
<code>#include &quot;comms/details/protocol_layers_access.h&quot;</code><br />
<code>#include &quot;comms/details/detect.h&quot;</code><br />
<code>#include &quot;comms/details/tag.h&quot;</code><br />
<code>#include &quot;<a class="el" href="ErrorStatus_8h_source.html">comms/ErrorStatus.h</a>&quot;</code><br />
<code>#include &quot;comms/frame/details/FrameLayerBaseOptionsParser.h&quot;</code><br />
<code>#include &quot;comms/frame/details/FrameLayerDetails.h&quot;</code><br />
<code>#include &quot;<a class="el" href="Message_8h_source.html">comms/Message.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="options_8h_source.html">comms/options.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="Tuple_8h_source.html">comms/util/Tuple.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="type__traits_8h_source.html">comms/util/type_traits.h</a>&quot;</code><br />
<code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;iterator&gt;</code><br />
<code>#include &lt;tuple&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
</div>
<p><a href="FrameLayerBase_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">comms::frame::FrameLayerBase&lt; TField, TNextLayer, TDerived, TOptions &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for all the middle (non <a class="el" href="classcomms_1_1frame_1_1MsgDataLayer.html">MsgDataLayer</a>) protocol transport layers.  <a href="classcomms_1_1frame_1_1FrameLayerBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacecomms" id="r_namespacecomms"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecomms.html">comms</a></td></tr>
<tr class="memdesc:namespacecomms"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main namespace for all classes / functions of COMMS library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacecomms_1_1frame" id="r_namespacecomms_1_1frame"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecomms_1_1frame.html">comms::frame</a></td></tr>
<tr class="memdesc:namespacecomms_1_1frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace that contains definition of layers that can be used to wrap message data with transport data. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3566abf140404b6aeef674168678f23c" id="r_a3566abf140404b6aeef674168678f23c"><td class="memItemLeft" align="right" valign="top">details::MissingSizeRetriever&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecomms_1_1frame.html#a3566abf140404b6aeef674168678f23c">comms::frame::missingSize</a> (std::size_t &amp;val)</td></tr>
<tr class="memdesc:a3566abf140404b6aeef674168678f23c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add "missing size" output parameter to frame's "read" operation.  <br /></td></tr>
<tr class="separator:a3566abf140404b6aeef674168678f23c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad680afe33e9358d91a8d849b7d47ea40" id="r_ad680afe33e9358d91a8d849b7d47ea40"><td class="memTemplParams" colspan="2">template&lt;typename TId &gt; </td></tr>
<tr class="memitem:ad680afe33e9358d91a8d849b7d47ea40"><td class="memTemplItemLeft" align="right" valign="top">details::MsgIdRetriever&lt; TId &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacecomms_1_1frame.html#ad680afe33e9358d91a8d849b7d47ea40">comms::frame::msgId</a> (TId &amp;val)</td></tr>
<tr class="memdesc:ad680afe33e9358d91a8d849b7d47ea40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add "message ID" output parameter to frame's "read" operation.  <br /></td></tr>
<tr class="separator:ad680afe33e9358d91a8d849b7d47ea40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9294d6c9288266eec8f3c3fe51e43269" id="r_a9294d6c9288266eec8f3c3fe51e43269"><td class="memItemLeft" align="right" valign="top">details::MsgIndexRetriever&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecomms_1_1frame.html#a9294d6c9288266eec8f3c3fe51e43269">comms::frame::msgIndex</a> (std::size_t &amp;val)</td></tr>
<tr class="memdesc:a9294d6c9288266eec8f3c3fe51e43269"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add "message index" output parameter to frame's "read" operation.  <br /></td></tr>
<tr class="separator:a9294d6c9288266eec8f3c3fe51e43269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a240f101b35f8499d7b28cc9ee9f297" id="r_a3a240f101b35f8499d7b28cc9ee9f297"><td class="memTemplParams" colspan="2">template&lt;typename TIter &gt; </td></tr>
<tr class="memitem:a3a240f101b35f8499d7b28cc9ee9f297"><td class="memTemplItemLeft" align="right" valign="top">details::MsgPayloadRetriever&lt; TIter &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacecomms_1_1frame.html#a3a240f101b35f8499d7b28cc9ee9f297">comms::frame::msgPayload</a> (TIter &amp;iter, std::size_t &amp;len)</td></tr>
<tr class="memdesc:a3a240f101b35f8499d7b28cc9ee9f297"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add "payload start" and "payload size" output parameters to frame's "read" operation.  <br /></td></tr>
<tr class="separator:a3a240f101b35f8499d7b28cc9ee9f297"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf14d848a5353a579d62e7fef902a085" id="r_aaf14d848a5353a579d62e7fef902a085"><td class="memTemplParams" colspan="2"><a id="aaf14d848a5353a579d62e7fef902a085" name="aaf14d848a5353a579d62e7fef902a085"></a>
template&lt;typename TField , typename TNextLayer , typename TDerived , typename... TOptions&gt; </td></tr>
<tr class="memitem:aaf14d848a5353a579d62e7fef902a085"><td class="memTemplItemLeft" align="right" valign="top">constexpr const <a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">FrameLayerBase</a>&lt; TField, TNextLayer, TDerived, TOptions... &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>comms::frame::toFrameLayerBase</b> (const <a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">FrameLayerBase</a>&lt; TField, TNextLayer, TDerived, TOptions... &gt; &amp;layer)</td></tr>
<tr class="memdesc:aaf14d848a5353a579d62e7fef902a085"><td class="mdescLeft">&#160;</td><td class="mdescRight">Upcast protocol layer in order to have access to its internal types. <br /></td></tr>
<tr class="separator:aaf14d848a5353a579d62e7fef902a085"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafe08121b276abbfa4530c7b1c896053" id="r_aafe08121b276abbfa4530c7b1c896053"><td class="memTemplParams" colspan="2"><a id="aafe08121b276abbfa4530c7b1c896053" name="aafe08121b276abbfa4530c7b1c896053"></a>
template&lt;typename TField , typename TNextLayer , typename TDerived , typename... TOptions&gt; </td></tr>
<tr class="memitem:aafe08121b276abbfa4530c7b1c896053"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">FrameLayerBase</a>&lt; TField, TNextLayer, TDerived, TOptions... &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>comms::frame::toFrameLayerBase</b> (<a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">FrameLayerBase</a>&lt; TField, TNextLayer, TDerived, TOptions... &gt; &amp;layer)</td></tr>
<tr class="memdesc:aafe08121b276abbfa4530c7b1c896053"><td class="mdescLeft">&#160;</td><td class="mdescRight">Upcast protocol layer in order to have access to its internal types. <br /></td></tr>
<tr class="separator:aafe08121b276abbfa4530c7b1c896053"><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>Contains definition of <a class="el" href="classcomms_1_1frame_1_1FrameLayerBase.html">comms::frame::FrameLayerBase</a>. </p>
</div></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.8
</small></address>
</body>
</html>