-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patherpc__transport_8hpp_source.html
143 lines (141 loc) · 19.9 KB
/
erpc__transport_8hpp_source.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
<title>eRPC API Reference: erpc_transport.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">eRPC API Reference
 <span id="projectnumber">Rev. 1.13.0</span>
</div>
<div id="projectbrief">NXP Semiconductors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>API Reference</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('erpc__transport_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">erpc_transport.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="erpc__transport_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2014, Freescale Semiconductor, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2016-2017 NXP</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef _EMBEDDED_RPC__TRANSPORT_H_</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define _EMBEDDED_RPC__TRANSPORT_H_</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "erpc_common.h"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="erpc__crc16_8hpp.html">erpc_crc16.hpp</a>"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "<a class="code" href="erpc__message__buffer_8hpp.html">erpc_message_buffer.hpp</a>"</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <cstring></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// Classes</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespaceerpc.html">erpc</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classerpc_1_1_transport.html">Transport</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html#af0b6b9c50d238f99de90ccd8b6050c91"> 42</a></span>  <a class="code" href="classerpc_1_1_transport.html#af0b6b9c50d238f99de90ccd8b6050c91">Transport</a>(<span class="keywordtype">void</span>) {}</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html#a0cb1c4441873bce62f2ef455a6136888"> 47</a></span>  <span class="keyword">virtual</span> <a class="code" href="classerpc_1_1_transport.html#a0cb1c4441873bce62f2ef455a6136888">~Transport</a>(<span class="keywordtype">void</span>) {}</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html#ab3a06be81cec1e1a5e3904d494526449"> 54</a></span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="classerpc_1_1_transport.html#ab3a06be81cec1e1a5e3904d494526449">reserveHeaderSize</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <a class="code" href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a> <a class="code" href="classerpc_1_1_transport.html#a3f886733620e1a2fe00d12f36711dde5">receive</a>(<a class="code" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *message) = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> <a class="code" href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a> <a class="code" href="classerpc_1_1_transport.html#a4ede71b16625cba746818294148f9aba">send</a>(<a class="code" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *message) = 0;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html#aea4a3b77e476397c2f665e7c9449839a"> 87</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classerpc_1_1_transport.html#aea4a3b77e476397c2f665e7c9449839a">hasMessage</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html#a077e72c8afa8caa483220faf45df62c6"> 94</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classerpc_1_1_transport.html#a077e72c8afa8caa483220faf45df62c6">setCrc16</a>(<a class="code" href="classerpc_1_1_crc16.html">Crc16</a> *crcImpl) { (void)crcImpl; }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport.html#a8f3107c5d8d7c89fe074d4433761b924"> 101</a></span>  <span class="keyword">virtual</span> <a class="code" href="classerpc_1_1_crc16.html">Crc16</a> *<a class="code" href="classerpc_1_1_transport.html#a8f3107c5d8d7c89fe074d4433761b924">getCrc16</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> NULL; }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport_factory.html"> 109</a></span> <span class="keyword">class </span><a class="code" href="classerpc_1_1_transport_factory.html">TransportFactory</a></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport_factory.html#a3df8dc7ce4f6c9972fe4a5183c3a894f"> 115</a></span>  <a class="code" href="classerpc_1_1_transport_factory.html#a3df8dc7ce4f6c9972fe4a5183c3a894f">TransportFactory</a>(<span class="keywordtype">void</span>) {}</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classerpc_1_1_transport_factory.html#a6cb6c55c590192643b1da1a4c54b866a"> 120</a></span>  <span class="keyword">virtual</span> <a class="code" href="classerpc_1_1_transport_factory.html#a6cb6c55c590192643b1da1a4c54b866a">~TransportFactory</a>(<span class="keywordtype">void</span>) {}</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">virtual</span> <a class="code" href="classerpc_1_1_transport.html">Transport</a> *create(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> };</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> } <span class="comment">// namespace erpc</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif // _EMBEDDED_RPC__TRANSPORT_H_</span></div><div class="ttc" id="classerpc_1_1_transport_html"><div class="ttname"><a href="classerpc_1_1_transport.html">erpc::Transport</a></div><div class="ttdoc">Abstract interface for transport layer. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:36</div></div>
<div class="ttc" id="erpc__message__buffer_8hpp_html"><div class="ttname"><a href="erpc__message__buffer_8hpp.html">erpc_message_buffer.hpp</a></div></div>
<div class="ttc" id="classerpc_1_1_transport_html_ab3a06be81cec1e1a5e3904d494526449"><div class="ttname"><a href="classerpc_1_1_transport.html#ab3a06be81cec1e1a5e3904d494526449">erpc::Transport::reserveHeaderSize</a></div><div class="ttdeci">virtual uint8_t reserveHeaderSize(void)</div><div class="ttdoc">Size of data placed in MessageBuffer before serializing eRPC data. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:54</div></div>
<div class="ttc" id="classerpc_1_1_transport_factory_html"><div class="ttname"><a href="classerpc_1_1_transport_factory.html">erpc::TransportFactory</a></div><div class="ttdoc">Abstract interface for transport factory. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:109</div></div>
<div class="ttc" id="classerpc_1_1_transport_html_a0cb1c4441873bce62f2ef455a6136888"><div class="ttname"><a href="classerpc_1_1_transport.html#a0cb1c4441873bce62f2ef455a6136888">erpc::Transport::~Transport</a></div><div class="ttdeci">virtual ~Transport(void)</div><div class="ttdoc">Transport destructor. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:47</div></div>
<div class="ttc" id="classerpc_1_1_transport_html_af0b6b9c50d238f99de90ccd8b6050c91"><div class="ttname"><a href="classerpc_1_1_transport.html#af0b6b9c50d238f99de90ccd8b6050c91">erpc::Transport::Transport</a></div><div class="ttdeci">Transport(void)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:42</div></div>
<div class="ttc" id="group__infra_html_gadea8a058796ed8b9a73c5f833445a661"><div class="ttname"><a href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a></div><div class="ttdeci">enum _erpc_status erpc_status_t</div><div class="ttdoc">Type used for all status and error return values. </div><div class="ttdef"><b>Definition:</b> erpc_common.h:85</div></div>
<div class="ttc" id="erpc__crc16_8hpp_html"><div class="ttname"><a href="erpc__crc16_8hpp.html">erpc_crc16.hpp</a></div></div>
<div class="ttc" id="classerpc_1_1_transport_html_aea4a3b77e476397c2f665e7c9449839a"><div class="ttname"><a href="classerpc_1_1_transport.html#aea4a3b77e476397c2f665e7c9449839a">erpc::Transport::hasMessage</a></div><div class="ttdeci">virtual bool hasMessage(void)</div><div class="ttdoc">Poll for an incoming message. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:87</div></div>
<div class="ttc" id="classerpc_1_1_message_buffer_html"><div class="ttname"><a href="classerpc_1_1_message_buffer.html">erpc::MessageBuffer</a></div><div class="ttdoc">Represents a memory buffer containing a message. </div><div class="ttdef"><b>Definition:</b> erpc_message_buffer.hpp:37</div></div>
<div class="ttc" id="namespaceerpc_html"><div class="ttname"><a href="namespaceerpc.html">erpc</a></div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:25</div></div>
<div class="ttc" id="classerpc_1_1_transport_html_a4ede71b16625cba746818294148f9aba"><div class="ttname"><a href="classerpc_1_1_transport.html#a4ede71b16625cba746818294148f9aba">erpc::Transport::send</a></div><div class="ttdeci">virtual erpc_status_t send(MessageBuffer *message)=0</div><div class="ttdoc">Prototype for send message. </div></div>
<div class="ttc" id="classerpc_1_1_transport_factory_html_a3df8dc7ce4f6c9972fe4a5183c3a894f"><div class="ttname"><a href="classerpc_1_1_transport_factory.html#a3df8dc7ce4f6c9972fe4a5183c3a894f">erpc::TransportFactory::TransportFactory</a></div><div class="ttdeci">TransportFactory(void)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:115</div></div>
<div class="ttc" id="classerpc_1_1_crc16_html"><div class="ttname"><a href="classerpc_1_1_crc16.html">erpc::Crc16</a></div><div class="ttdoc">Class for compute crc16. </div><div class="ttdef"><b>Definition:</b> erpc_crc16.hpp:29</div></div>
<div class="ttc" id="classerpc_1_1_transport_html_a8f3107c5d8d7c89fe074d4433761b924"><div class="ttname"><a href="classerpc_1_1_transport.html#a8f3107c5d8d7c89fe074d4433761b924">erpc::Transport::getCrc16</a></div><div class="ttdeci">virtual Crc16 * getCrc16(void)</div><div class="ttdoc">This functions gets the CRC-16 object. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:101</div></div>
<div class="ttc" id="classerpc_1_1_transport_html_a3f886733620e1a2fe00d12f36711dde5"><div class="ttname"><a href="classerpc_1_1_transport.html#a3f886733620e1a2fe00d12f36711dde5">erpc::Transport::receive</a></div><div class="ttdeci">virtual erpc_status_t receive(MessageBuffer *message)=0</div><div class="ttdoc">Prototype for receiving message. </div></div>
<div class="ttc" id="classerpc_1_1_transport_factory_html_a6cb6c55c590192643b1da1a4c54b866a"><div class="ttname"><a href="classerpc_1_1_transport_factory.html#a6cb6c55c590192643b1da1a4c54b866a">erpc::TransportFactory::~TransportFactory</a></div><div class="ttdeci">virtual ~TransportFactory(void)</div><div class="ttdoc">TransportFactory destructor. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:120</div></div>
<div class="ttc" id="classerpc_1_1_transport_html_a077e72c8afa8caa483220faf45df62c6"><div class="ttname"><a href="classerpc_1_1_transport.html#a077e72c8afa8caa483220faf45df62c6">erpc::Transport::setCrc16</a></div><div class="ttdeci">virtual void setCrc16(Crc16 *crcImpl)</div><div class="ttdoc">This functions sets the CRC-16 implementation. </div><div class="ttdef"><b>Definition:</b> erpc_transport.hpp:94</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">Copyright 2016-2020 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>