-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasserpc_1_1_message_loggers.html
263 lines (254 loc) · 13.8 KB
/
classerpc_1_1_message_loggers.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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!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::MessageLoggers Class 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="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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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('classerpc_1_1_message_loggers.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="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classerpc_1_1_message_loggers-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">erpc::MessageLoggers Class Reference<div class="ingroups"><a class="el" href="group__infra.html">Infrastructure</a> » <a class="el" href="group__infra__utility.html">Utilities</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Logging messages functionality.
<a href="classerpc_1_1_message_loggers.html#details">More...</a></p>
<p><code>#include <<a class="el" href="erpc__message__loggers_8hpp_source.html">erpc_message_loggers.hpp</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for erpc::MessageLoggers:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classerpc_1_1_message_loggers__coll__graph.svg" width="234" height="216"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" 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:ac1fcb4e780a1868303e31422ae2d3d0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1fcb4e780a1868303e31422ae2d3d0c"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_loggers.html#ac1fcb4e780a1868303e31422ae2d3d0c">MessageLoggers</a> (void)</td></tr>
<tr class="memdesc:ac1fcb4e780a1868303e31422ae2d3d0c"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:ac1fcb4e780a1868303e31422ae2d3d0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2eeee6b3bc311fd80db36a687eb80ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2eeee6b3bc311fd80db36a687eb80ae"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_loggers.html#ad2eeee6b3bc311fd80db36a687eb80ae">~MessageLoggers</a> (void)</td></tr>
<tr class="memdesc:ad2eeee6b3bc311fd80db36a687eb80ae"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classerpc_1_1_transport.html" title="Abstract interface for transport layer. ">Transport</a> destructor. <br /></td></tr>
<tr class="separator:ad2eeee6b3bc311fd80db36a687eb80ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00793cb2e5c67bd5a615d225b88c8595"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_loggers.html#a00793cb2e5c67bd5a615d225b88c8595">addMessageLogger</a> (<a class="el" href="classerpc_1_1_transport.html">Transport</a> *transport)</td></tr>
<tr class="memdesc:a00793cb2e5c67bd5a615d225b88c8595"><td class="mdescLeft"> </td><td class="mdescRight">This function add given transport to newly created <a class="el" href="classerpc_1_1_message_logger.html" title="Logging messages objects used for logging sent/received messages. ">MessageLogger</a> object. <a href="#a00793cb2e5c67bd5a615d225b88c8595">More...</a><br /></td></tr>
<tr class="separator:a00793cb2e5c67bd5a615d225b88c8595"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:adb7e3cf37abdbbaab9ab6ed686415302"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_loggers.html#adb7e3cf37abdbbaab9ab6ed686415302">logMessage</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *msg)</td></tr>
<tr class="memdesc:adb7e3cf37abdbbaab9ab6ed686415302"><td class="mdescLeft"> </td><td class="mdescRight">This function add given transport to newly created <a class="el" href="classerpc_1_1_message_logger.html" title="Logging messages objects used for logging sent/received messages. ">MessageLogger</a> object. <a href="#adb7e3cf37abdbbaab9ab6ed686415302">More...</a><br /></td></tr>
<tr class="separator:adb7e3cf37abdbbaab9ab6ed686415302"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:afa59675c94a72e77218291d74c995693"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classerpc_1_1_message_logger.html">MessageLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_loggers.html#afa59675c94a72e77218291d74c995693">m_logger</a></td></tr>
<tr class="separator:afa59675c94a72e77218291d74c995693"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Logging messages functionality. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a00793cb2e5c67bd5a615d225b88c8595"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool erpc::MessageLoggers::addMessageLogger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classerpc_1_1_transport.html">Transport</a> * </td>
<td class="paramname"><em>transport</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function add given transport to newly created <a class="el" href="classerpc_1_1_message_logger.html" title="Logging messages objects used for logging sent/received messages. ">MessageLogger</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td><a class="el" href="classerpc_1_1_transport.html" title="Abstract interface for transport layer. ">Transport</a> used for logging messages</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">True</td><td>When transport was successfully added. </td></tr>
<tr><td class="paramname">False</td><td>When transport wasn't added. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adb7e3cf37abdbbaab9ab6ed686415302"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a> erpc::MessageLoggers::logMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> * </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function add given transport to newly created <a class="el" href="classerpc_1_1_message_logger.html" title="Logging messages objects used for logging sent/received messages. ">MessageLogger</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Buffer which will be logged.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The eRPC status based on transport type. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afa59675c94a72e77218291d74c995693"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classerpc_1_1_message_logger.html">MessageLogger</a>* erpc::MessageLoggers::m_logger</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to first logger. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="erpc__message__loggers_8hpp_source.html">erpc_message_loggers.hpp</a></li>
</ul>
</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>