-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasserpc_1_1_cursor.html
633 lines (599 loc) · 31.1 KB
/
classerpc_1_1_cursor.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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
<!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::Cursor 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_cursor.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="classerpc_1_1_cursor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">erpc::Cursor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classerpc_1_1_cursor.html" title="Cursor within a MessageBuffer. ">Cursor</a> within a <a class="el" href="classerpc_1_1_message_buffer.html" title="Represents a memory buffer containing a message. ">MessageBuffer</a>.
<a href="classerpc_1_1_cursor.html#details">More...</a></p>
<p><code>#include <<a class="el" href="erpc__message__buffer_8hpp_source.html">erpc_message_buffer.hpp</a>></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:ae68701341facf72eaaae1cbfea0403c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#ae68701341facf72eaaae1cbfea0403c8">Cursor</a> (void)</td></tr>
<tr class="memdesc:ae68701341facf72eaaae1cbfea0403c8"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ae68701341facf72eaaae1cbfea0403c8">More...</a><br /></td></tr>
<tr class="separator:ae68701341facf72eaaae1cbfea0403c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ad04cbd346c7fff6ca9aa3faa6404a6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a9ad04cbd346c7fff6ca9aa3faa6404a6">Cursor</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> &buffer)</td></tr>
<tr class="memdesc:a9ad04cbd346c7fff6ca9aa3faa6404a6"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9ad04cbd346c7fff6ca9aa3faa6404a6">More...</a><br /></td></tr>
<tr class="separator:a9ad04cbd346c7fff6ca9aa3faa6404a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b45c168a617dcf61a9e902b68cd32cd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a7b45c168a617dcf61a9e902b68cd32cd">setBuffer</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> &buffer, uint8_t reserved=0)</td></tr>
<tr class="memdesc:a7b45c168a617dcf61a9e902b68cd32cd"><td class="mdescLeft"> </td><td class="mdescRight">Set message buffer. <a href="#a7b45c168a617dcf61a9e902b68cd32cd">More...</a><br /></td></tr>
<tr class="separator:a7b45c168a617dcf61a9e902b68cd32cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72dbf3cb3d25028667686cf5bcde27aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72dbf3cb3d25028667686cf5bcde27aa"></a>
<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a72dbf3cb3d25028667686cf5bcde27aa">getBuffer</a> (void)</td></tr>
<tr class="memdesc:a72dbf3cb3d25028667686cf5bcde27aa"><td class="mdescLeft"> </td><td class="mdescRight">Get message buffer. <br /></td></tr>
<tr class="separator:a72dbf3cb3d25028667686cf5bcde27aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a556d3c4faa20fdbe21d03db0caa51e0e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a556d3c4faa20fdbe21d03db0caa51e0e"></a>
<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a556d3c4faa20fdbe21d03db0caa51e0e">getBufferRef</a> (void)</td></tr>
<tr class="memdesc:a556d3c4faa20fdbe21d03db0caa51e0e"><td class="mdescLeft"> </td><td class="mdescRight">Get message buffer. <br /></td></tr>
<tr class="separator:a556d3c4faa20fdbe21d03db0caa51e0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a601d1a9c96c6d67fbe79e6b319252906"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a601d1a9c96c6d67fbe79e6b319252906">get</a> (void)</td></tr>
<tr class="memdesc:a601d1a9c96c6d67fbe79e6b319252906"><td class="mdescLeft"> </td><td class="mdescRight">Return position in buffer. <a href="#a601d1a9c96c6d67fbe79e6b319252906">More...</a><br /></td></tr>
<tr class="separator:a601d1a9c96c6d67fbe79e6b319252906"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eb0773b52a59f9e5b2e62322fa6c1fb"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a6eb0773b52a59f9e5b2e62322fa6c1fb">get</a> (void) const </td></tr>
<tr class="memdesc:a6eb0773b52a59f9e5b2e62322fa6c1fb"><td class="mdescLeft"> </td><td class="mdescRight">Return position in buffer. <a href="#a6eb0773b52a59f9e5b2e62322fa6c1fb">More...</a><br /></td></tr>
<tr class="separator:a6eb0773b52a59f9e5b2e62322fa6c1fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3e3e733619bc9b1697ef02f5818f6db"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#af3e3e733619bc9b1697ef02f5818f6db">getRemaining</a> (void) const </td></tr>
<tr class="memdesc:af3e3e733619bc9b1697ef02f5818f6db"><td class="mdescLeft"> </td><td class="mdescRight">Return remaining free space in current buffer. <a href="#af3e3e733619bc9b1697ef02f5818f6db">More...</a><br /></td></tr>
<tr class="separator:af3e3e733619bc9b1697ef02f5818f6db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5260899f8e6eabcd43d0ebe8c40a8ace"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a5260899f8e6eabcd43d0ebe8c40a8ace">getRemainingUsed</a> (void) const </td></tr>
<tr class="memdesc:a5260899f8e6eabcd43d0ebe8c40a8ace"><td class="mdescLeft"> </td><td class="mdescRight">Return remaining space from used of current buffer. <a href="#a5260899f8e6eabcd43d0ebe8c40a8ace">More...</a><br /></td></tr>
<tr class="separator:a5260899f8e6eabcd43d0ebe8c40a8ace"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f5dd6199b5c6f06622286c4c63b614a"><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_cursor.html#a2f5dd6199b5c6f06622286c4c63b614a">read</a> (void *data, uint32_t length)</td></tr>
<tr class="memdesc:a2f5dd6199b5c6f06622286c4c63b614a"><td class="mdescLeft"> </td><td class="mdescRight">Read data from current buffer. <a href="#a2f5dd6199b5c6f06622286c4c63b614a">More...</a><br /></td></tr>
<tr class="separator:a2f5dd6199b5c6f06622286c4c63b614a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8139d30e565573af419fbf7090f25c5"><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_cursor.html#af8139d30e565573af419fbf7090f25c5">write</a> (const void *data, uint32_t length)</td></tr>
<tr class="memdesc:af8139d30e565573af419fbf7090f25c5"><td class="mdescLeft"> </td><td class="mdescRight">Read data from current buffer. <a href="#af8139d30e565573af419fbf7090f25c5">More...</a><br /></td></tr>
<tr class="separator:af8139d30e565573af419fbf7090f25c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5cc45449acb5a5ebd7c2f17bf728bae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5cc45449acb5a5ebd7c2f17bf728bae"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#ab5cc45449acb5a5ebd7c2f17bf728bae">operator uint8_t *</a> (void)</td></tr>
<tr class="memdesc:ab5cc45449acb5a5ebd7c2f17bf728bae"><td class="mdescLeft"> </td><td class="mdescRight">Casting operator return local buffer. <br /></td></tr>
<tr class="separator:ab5cc45449acb5a5ebd7c2f17bf728bae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a357f476bb24068dc3c7da199f88ca325"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a357f476bb24068dc3c7da199f88ca325"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a357f476bb24068dc3c7da199f88ca325">operator const uint8_t *</a> (void) const </td></tr>
<tr class="memdesc:a357f476bb24068dc3c7da199f88ca325"><td class="mdescLeft"> </td><td class="mdescRight">Casting operator return local buffer. <br /></td></tr>
<tr class="separator:a357f476bb24068dc3c7da199f88ca325"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98ae1d0282e3f77035a5aca2d1690232"><td class="memItemLeft" align="right" valign="top">uint8_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a98ae1d0282e3f77035a5aca2d1690232">operator[]</a> (int index)</td></tr>
<tr class="memdesc:a98ae1d0282e3f77035a5aca2d1690232"><td class="mdescLeft"> </td><td class="mdescRight">Array operator return value of buffer at given index. <a href="#a98ae1d0282e3f77035a5aca2d1690232">More...</a><br /></td></tr>
<tr class="separator:a98ae1d0282e3f77035a5aca2d1690232"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5615888be7c098f8665d6685bafe8d2"><td class="memItemLeft" align="right" valign="top">const uint8_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#ab5615888be7c098f8665d6685bafe8d2">operator[]</a> (int index) const </td></tr>
<tr class="memdesc:ab5615888be7c098f8665d6685bafe8d2"><td class="mdescLeft"> </td><td class="mdescRight">Array operator return value of buffer at given index. <a href="#ab5615888be7c098f8665d6685bafe8d2">More...</a><br /></td></tr>
<tr class="separator:ab5615888be7c098f8665d6685bafe8d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a45dc3be8833adc7fd11636a79fb1dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a9a45dc3be8833adc7fd11636a79fb1dc">operator+=</a> (uint16_t n)</td></tr>
<tr class="memdesc:a9a45dc3be8833adc7fd11636a79fb1dc"><td class="mdescLeft"> </td><td class="mdescRight">Sum operator return local buffer. <a href="#a9a45dc3be8833adc7fd11636a79fb1dc">More...</a><br /></td></tr>
<tr class="separator:a9a45dc3be8833adc7fd11636a79fb1dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac30485c5f293c17ea5abdf3984d19d29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#ac30485c5f293c17ea5abdf3984d19d29">operator-=</a> (uint16_t n)</td></tr>
<tr class="memdesc:ac30485c5f293c17ea5abdf3984d19d29"><td class="mdescLeft"> </td><td class="mdescRight">Subtract operator return local buffer. <a href="#ac30485c5f293c17ea5abdf3984d19d29">More...</a><br /></td></tr>
<tr class="separator:ac30485c5f293c17ea5abdf3984d19d29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa38a9e36e6c678e23fc282d1558b224f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#aa38a9e36e6c678e23fc282d1558b224f">operator++</a> (void)</td></tr>
<tr class="memdesc:aa38a9e36e6c678e23fc282d1558b224f"><td class="mdescLeft"> </td><td class="mdescRight">Sum +1 operator. <a href="#aa38a9e36e6c678e23fc282d1558b224f">More...</a><br /></td></tr>
<tr class="separator:aa38a9e36e6c678e23fc282d1558b224f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a4bf43d5bf3525500ddad864721d5e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_cursor.html#a7a4bf43d5bf3525500ddad864721d5e7">operator--</a> (void)</td></tr>
<tr class="memdesc:a7a4bf43d5bf3525500ddad864721d5e7"><td class="mdescLeft"> </td><td class="mdescRight">Subtract -1 operator. <a href="#a7a4bf43d5bf3525500ddad864721d5e7">More...</a><br /></td></tr>
<tr class="separator:a7a4bf43d5bf3525500ddad864721d5e7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classerpc_1_1_cursor.html" title="Cursor within a MessageBuffer. ">Cursor</a> within a <a class="el" href="classerpc_1_1_message_buffer.html" title="Represents a memory buffer containing a message. ">MessageBuffer</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae68701341facf72eaaae1cbfea0403c8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">erpc::Cursor::Cursor </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>This function initializes object attributes. </p>
</div>
</div>
<a class="anchor" id="a9ad04cbd346c7fff6ca9aa3faa6404a6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">erpc::Cursor::Cursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> & </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>This function initializes object attributes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td><a class="el" href="classerpc_1_1_message_buffer.html" title="Represents a memory buffer containing a message. ">MessageBuffer</a> for sending/receiving. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7b45c168a617dcf61a9e902b68cd32cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cursor::setBuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> & </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>reserved</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set message buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Message buffer to set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reserved</td><td>Moved cursor position outside of reserved memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a601d1a9c96c6d67fbe79e6b319252906"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t* erpc::Cursor::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return position in buffer. </p>
<p>Return position, where it last write/read.</p>
<dl class="section return"><dt>Returns</dt><dd>Return position in buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a6eb0773b52a59f9e5b2e62322fa6c1fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t* erpc::Cursor::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return position in buffer. </p>
<p>Return position, where it last write/read.</p>
<dl class="section return"><dt>Returns</dt><dd>Return position in buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="af3e3e733619bc9b1697ef02f5818f6db"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t erpc::Cursor::getRemaining </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return remaining free space in current buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>Remaining free space in current buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a5260899f8e6eabcd43d0ebe8c40a8ace"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t erpc::Cursor::getRemainingUsed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return remaining space from used of current buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>Remaining space from used of current buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a2f5dd6199b5c6f06622286c4c63b614a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a> Cursor::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from current buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to value, where copy read data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>How much bytes need be read.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">kErpcStatus_Success</td><td></td></tr>
<tr><td class="paramname">kErpcStatus_BufferOverrun</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af8139d30e565573af419fbf7090f25c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infra.html#gadea8a058796ed8b9a73c5f833445a661">erpc_status_t</a> Cursor::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from current buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Pointer to value to be sent. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>How much bytes need be wrote.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">kErpcStatus_Success</td><td></td></tr>
<tr><td class="paramname">kErpcStatus_BufferOverrun</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a98ae1d0282e3f77035a5aca2d1690232"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t & Cursor::operator[] </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Array operator return value of buffer at given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index in buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab5615888be7c098f8665d6685bafe8d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t & Cursor::operator[] </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array operator return value of buffer at given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index in buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9a45dc3be8833adc7fd11636a79fb1dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & Cursor::operator+= </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sum operator return local buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Summing with n.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current cursor instance. </dd></dl>
</div>
</div>
<a class="anchor" id="ac30485c5f293c17ea5abdf3984d19d29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & Cursor::operator-= </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Subtract operator return local buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Subtracting with n.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current cursor instance. </dd></dl>
</div>
</div>
<a class="anchor" id="aa38a9e36e6c678e23fc282d1558b224f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & Cursor::operator++ </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sum +1 operator. </p>
<dl class="section return"><dt>Returns</dt><dd>Current cursor instance. </dd></dl>
</div>
</div>
<a class="anchor" id="a7a4bf43d5bf3525500ddad864721d5e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classerpc_1_1_cursor.html">Cursor</a> & Cursor::operator-- </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Subtract -1 operator. </p>
<dl class="section return"><dt>Returns</dt><dd>Current cursor instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="erpc__message__buffer_8hpp_source.html">erpc_message_buffer.hpp</a></li>
<li>erpc_message_buffer.cpp</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>