-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patherpc__arbitrated__client__manager_8hpp_source.html
138 lines (136 loc) · 16.3 KB
/
erpc__arbitrated__client__manager_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
<!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_arbitrated_client_manager.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__arbitrated__client__manager_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_arbitrated_client_manager.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="erpc__arbitrated__client__manager_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) 2016, Freescale Semiconductor, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2016 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__ARBITRATED_CLIENT_MANAGER_H_</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define _EMBEDDED_RPC__ARBITRATED_CLIENT_MANAGER_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 "<a class="code" href="erpc__client__manager_8h.html">erpc_client_manager.h</a>"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// Classes</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceerpc.html">erpc</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>TransportArbitrator;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classerpc_1_1_arbitrated_client_manager.html"> 40</a></span> <span class="keyword">class </span><a class="code" href="classerpc_1_1_arbitrated_client_manager.html">ArbitratedClientManager</a> : <span class="keyword">public</span> <a class="code" href="classerpc_1_1_client_manager.html">ClientManager</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classerpc_1_1_arbitrated_client_manager.html#a4953e4da63ae5a140eeb86caeb539294"> 48</a></span>  <a class="code" href="classerpc_1_1_arbitrated_client_manager.html#a4953e4da63ae5a140eeb86caeb539294">ArbitratedClientManager</a>(<span class="keywordtype">void</span>) : <a class="code" href="classerpc_1_1_client_manager.html">ClientManager</a>(), <a class="code" href="classerpc_1_1_arbitrated_client_manager.html#ab145edac17a94558bf6c47c8a5f63ae8">m_arbitrator</a>(NULL) {}</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> <a class="code" href="classerpc_1_1_arbitrated_client_manager.html#a31a52d8e0bc260875a5d711718eda369">setArbitrator</a>(<a class="code" href="classerpc_1_1_transport_arbitrator.html">TransportArbitrator</a> *arbitrator);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classerpc_1_1_arbitrated_client_manager.html#ab145edac17a94558bf6c47c8a5f63ae8"> 62</a></span>  <a class="code" href="classerpc_1_1_transport_arbitrator.html">TransportArbitrator</a> *<a class="code" href="classerpc_1_1_arbitrated_client_manager.html#aacea5d60c0c62c8ffdfd5eb6e0dba2db">getArbitrator</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> <a class="code" href="classerpc_1_1_arbitrated_client_manager.html#ab145edac17a94558bf6c47c8a5f63ae8">m_arbitrator</a>; };</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classerpc_1_1_transport_arbitrator.html">TransportArbitrator</a> *<a class="code" href="classerpc_1_1_arbitrated_client_manager.html#ab145edac17a94558bf6c47c8a5f63ae8">m_arbitrator</a>; </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classerpc_1_1_arbitrated_client_manager.html#a2daeb518e1342cebba62c1b508dc49c2">performClientRequest</a>(<a class="code" href="classerpc_1_1_request_context.html">RequestContext</a> &request) <span class="keyword">override</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classerpc_1_1_arbitrated_client_manager.html#a91fb14f9fd59a91731d4b450e01e60ce"> 78</a></span>  <span class="keywordtype">void</span> <a class="code" href="classerpc_1_1_arbitrated_client_manager.html#a91fb14f9fd59a91731d4b450e01e60ce">setTransport</a>(<a class="code" href="classerpc_1_1_transport.html">Transport</a> *transport) { (void)transport; }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">// namespace erpc</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif // _EMBEDDED_RPC__ARBITRATED_CLIENT_MANAGER_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="classerpc_1_1_arbitrated_client_manager_html_a2daeb518e1342cebba62c1b508dc49c2"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html#a2daeb518e1342cebba62c1b508dc49c2">erpc::ArbitratedClientManager::performClientRequest</a></div><div class="ttdeci">virtual void performClientRequest(RequestContext &request) override</div><div class="ttdoc">This function performs request. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.cpp:39</div></div>
<div class="ttc" id="classerpc_1_1_arbitrated_client_manager_html_aacea5d60c0c62c8ffdfd5eb6e0dba2db"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html#aacea5d60c0c62c8ffdfd5eb6e0dba2db">erpc::ArbitratedClientManager::getArbitrator</a></div><div class="ttdeci">TransportArbitrator * getArbitrator(void)</div><div class="ttdoc">Gets the transport arbitrator instance. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:62</div></div>
<div class="ttc" id="classerpc_1_1_transport_arbitrator_html"><div class="ttname"><a href="classerpc_1_1_transport_arbitrator.html">erpc::TransportArbitrator</a></div><div class="ttdoc">Interposer to share transport between client and server. </div><div class="ttdef"><b>Definition:</b> erpc_transport_arbitrator.hpp:40</div></div>
<div class="ttc" id="erpc__client__manager_8h_html"><div class="ttname"><a href="erpc__client__manager_8h.html">erpc_client_manager.h</a></div></div>
<div class="ttc" id="classerpc_1_1_client_manager_html"><div class="ttname"><a href="classerpc_1_1_client_manager.html">erpc::ClientManager</a></div><div class="ttdoc">Base client implementation. </div><div class="ttdef"><b>Definition:</b> erpc_client_manager.h:56</div></div>
<div class="ttc" id="classerpc_1_1_arbitrated_client_manager_html_a91fb14f9fd59a91731d4b450e01e60ce"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html#a91fb14f9fd59a91731d4b450e01e60ce">erpc::ArbitratedClientManager::setTransport</a></div><div class="ttdeci">void setTransport(Transport *transport)</div><div class="ttdoc">This method is not used with this class. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:78</div></div>
<div class="ttc" id="classerpc_1_1_arbitrated_client_manager_html_a31a52d8e0bc260875a5d711718eda369"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html#a31a52d8e0bc260875a5d711718eda369">erpc::ArbitratedClientManager::setArbitrator</a></div><div class="ttdeci">void setArbitrator(TransportArbitrator *arbitrator)</div><div class="ttdoc">Sets the transport arbitrator instance. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.cpp:33</div></div>
<div class="ttc" id="classerpc_1_1_arbitrated_client_manager_html_a4953e4da63ae5a140eeb86caeb539294"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html#a4953e4da63ae5a140eeb86caeb539294">erpc::ArbitratedClientManager::ArbitratedClientManager</a></div><div class="ttdeci">ArbitratedClientManager(void)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:48</div></div>
<div class="ttc" id="classerpc_1_1_arbitrated_client_manager_html"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html">erpc::ArbitratedClientManager</a></div><div class="ttdoc">Client that can share a transport with a server. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:40</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_arbitrated_client_manager_html_ab145edac17a94558bf6c47c8a5f63ae8"><div class="ttname"><a href="classerpc_1_1_arbitrated_client_manager.html#ab145edac17a94558bf6c47c8a5f63ae8">erpc::ArbitratedClientManager::m_arbitrator</a></div><div class="ttdeci">TransportArbitrator * m_arbitrator</div><div class="ttdoc">Optional transport arbitrator. May be NULL. </div><div class="ttdef"><b>Definition:</b> erpc_arbitrated_client_manager.hpp:62</div></div>
<div class="ttc" id="classerpc_1_1_request_context_html"><div class="ttname"><a href="classerpc_1_1_request_context.html">erpc::RequestContext</a></div><div class="ttdoc">Encapsulates all information about a request. </div><div class="ttdef"><b>Definition:</b> erpc_client_manager.h:184</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>