-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathclass_r_t_message.html
More file actions
849 lines (770 loc) · 50.5 KB
/
class_r_t_message.html
File metadata and controls
849 lines (770 loc) · 50.5 KB
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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
<!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.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>C++ TargetRTS: RTMessage 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="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">C++ TargetRTS
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="class_r_t_message-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RTMessage Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a message used for communication between capsule instances.
<a href="class_r_t_message.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_r_t_message_8h_source.html">RTMessage.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afeb2f1408668bc168070c098588f037d"><td class="memItemLeft" align="right" valign="top"><a id="afeb2f1408668bc168070c098588f037d" name="afeb2f1408668bc168070c098588f037d"></a>enum  </td><td class="memItemRight" valign="bottom"><b>DeliverResult</b> { <b>Accepted</b>
, <b>Deferred</b>
, <b>Rejected</b>
}</td></tr>
<tr class="separator:afeb2f1408668bc168070c098588f037d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6b7783e818857e3ec7f2af2f9590edfd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a6b7783e818857e3ec7f2af2f9590edfd">clear</a> (void)</td></tr>
<tr class="memdesc:a6b7783e818857e3ec7f2af2f9590edfd"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the data object stored in the message, and reset the message object to make it ready to be used in another communication. <br /></td></tr>
<tr class="separator:a6b7783e818857e3ec7f2af2f9590edfd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75731b195eafb9514a2d30c1da50bf7f"><td class="memItemLeft" align="right" valign="top"><a id="a75731b195eafb9514a2d30c1da50bf7f" name="a75731b195eafb9514a2d30c1da50bf7f"></a>
 </td><td class="memItemRight" valign="bottom"><b>RTMessage</b> (const <a class="el" href="class_r_t_message.html">RTMessage</a> &)</td></tr>
<tr class="separator:a75731b195eafb9514a2d30c1da50bf7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a99d8362a7b06983d07a6adb4162990"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a0a99d8362a7b06983d07a6adb4162990">isRTData</a> (void) const</td></tr>
<tr class="memdesc:a0a99d8362a7b06983d07a6adb4162990"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the message carries a data object which is an <a class="el" href="class_r_t_data_object.html" title="Provides a common interface to certain data type implementations (e.g.">RTDataObject</a>. <br /></td></tr>
<tr class="separator:a0a99d8362a7b06983d07a6adb4162990"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6dc1236845d8b2c1c4a2b1e2449d9e9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a6dc1236845d8b2c1c4a2b1e2449d9e9f">setDeferred</a> (void)</td></tr>
<tr class="memdesc:a6dc1236845d8b2c1c4a2b1e2449d9e9f"><td class="mdescLeft"> </td><td class="mdescRight">Mark this message as deferred. <br /></td></tr>
<tr class="separator:a6dc1236845d8b2c1c4a2b1e2449d9e9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52a115a74f06760220a7eaf6afbb0aad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a52a115a74f06760220a7eaf6afbb0aad">resetDeferred</a> (void)</td></tr>
<tr class="memdesc:a52a115a74f06760220a7eaf6afbb0aad"><td class="mdescLeft"> </td><td class="mdescRight">Mark this message as not deferred. <br /></td></tr>
<tr class="separator:a52a115a74f06760220a7eaf6afbb0aad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab824d1fdd1703af202f938d8eee8b7e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#ab824d1fdd1703af202f938d8eee8b7e7">isDeferred</a> (void) const</td></tr>
<tr class="memdesc:ab824d1fdd1703af202f938d8eee8b7e7"><td class="mdescLeft"> </td><td class="mdescRight">Determines if this message has been deferred, i.e. <br /></td></tr>
<tr class="separator:ab824d1fdd1703af202f938d8eee8b7e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe79e99f2f3bc234fc7a59fc684fd068"><td class="memItemLeft" align="right" valign="top"><a id="afe79e99f2f3bc234fc7a59fc684fd068" name="afe79e99f2f3bc234fc7a59fc684fd068"></a>
void </td><td class="memItemRight" valign="bottom"><b>setInvalid</b> (void)</td></tr>
<tr class="separator:afe79e99f2f3bc234fc7a59fc684fd068"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6227985d9f163c7fc83a8d8a27fbaf2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#af6227985d9f163c7fc83a8d8a27fbaf2">isValid</a> (void) const</td></tr>
<tr class="memdesc:af6227985d9f163c7fc83a8d8a27fbaf2"><td class="mdescLeft"> </td><td class="mdescRight">A message is considered valid as soon as its protocol event (i.e. <br /></td></tr>
<tr class="separator:af6227985d9f163c7fc83a8d8a27fbaf2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05bac589370e4cbd0a733740f3f23419"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a05bac589370e4cbd0a733740f3f23419">setSignal</a> (int id)</td></tr>
<tr class="memdesc:a05bac589370e4cbd0a733740f3f23419"><td class="mdescLeft"> </td><td class="mdescRight">Set the signal id of the message, i.e. <br /></td></tr>
<tr class="separator:a05bac589370e4cbd0a733740f3f23419"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d3e24aece4383bee8e5f63cf6ee40cd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a8d3e24aece4383bee8e5f63cf6ee40cd">getSignal</a> (void) const</td></tr>
<tr class="memdesc:a8d3e24aece4383bee8e5f63cf6ee40cd"><td class="mdescLeft"> </td><td class="mdescRight">Get the signal id of the message, i.e. <br /></td></tr>
<tr class="separator:a8d3e24aece4383bee8e5f63cf6ee40cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a192e10223fc4b9852f4f02710c2ed876"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a192e10223fc4b9852f4f02710c2ed876">getSignalName</a> (void) const</td></tr>
<tr class="memdesc:a192e10223fc4b9852f4f02710c2ed876"><td class="mdescLeft"> </td><td class="mdescRight">Get the signal name of the message, i.e. <br /></td></tr>
<tr class="separator:a192e10223fc4b9852f4f02710c2ed876"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19ead1e39dff7f5a696b774d0c9ebeca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a19ead1e39dff7f5a696b774d0c9ebeca">setPriority</a> (int prio)</td></tr>
<tr class="memdesc:a19ead1e39dff7f5a696b774d0c9ebeca"><td class="mdescLeft"> </td><td class="mdescRight">Set the priority of the message. <br /></td></tr>
<tr class="separator:a19ead1e39dff7f5a696b774d0c9ebeca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac68b15e8d5344677b97c4ed7145687be"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#ac68b15e8d5344677b97c4ed7145687be">getPriority</a> (void) const</td></tr>
<tr class="memdesc:ac68b15e8d5344677b97c4ed7145687be"><td class="mdescLeft"> </td><td class="mdescRight">Get the priority of the message. <br /></td></tr>
<tr class="separator:ac68b15e8d5344677b97c4ed7145687be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa17be8f873a8214a0d213e411985bc97"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#aa17be8f873a8214a0d213e411985bc97">getData</a> (void) const</td></tr>
<tr class="memdesc:aa17be8f873a8214a0d213e411985bc97"><td class="mdescLeft"> </td><td class="mdescRight">Get the data object carried by the message, if any. <br /></td></tr>
<tr class="separator:aa17be8f873a8214a0d213e411985bc97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98d28d4503826c3da83bada234510b28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a98d28d4503826c3da83bada234510b28">setData</a> (const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type)</td></tr>
<tr class="memdesc:a98d28d4503826c3da83bada234510b28"><td class="mdescLeft"> </td><td class="mdescRight">Set the data object of the message. <br /></td></tr>
<tr class="separator:a98d28d4503826c3da83bada234510b28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adabb7b3660ff0fbba86fcb110b342a06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#adabb7b3660ff0fbba86fcb110b342a06">setData</a> (const <a class="el" href="class_r_t_data_object.html">RTDataObject</a> &data)</td></tr>
<tr class="memdesc:adabb7b3660ff0fbba86fcb110b342a06"><td class="mdescLeft"> </td><td class="mdescRight">Set the data object of the message. <br /></td></tr>
<tr class="separator:adabb7b3660ff0fbba86fcb110b342a06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a500cb9080d5e3802ece776de5f00d52b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a500cb9080d5e3802ece776de5f00d52b">internData</a> (bool moveData=false)</td></tr>
<tr class="memdesc:a500cb9080d5e3802ece776de5f00d52b"><td class="mdescLeft"> </td><td class="mdescRight">Intern the data object of the message. <br /></td></tr>
<tr class="separator:a500cb9080d5e3802ece776de5f00d52b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49c7997d3a3b9a62f80f17872004fe44"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a49c7997d3a3b9a62f80f17872004fe44">getType</a> (void) const</td></tr>
<tr class="memdesc:a49c7997d3a3b9a62f80f17872004fe44"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the data object of the message, if any. <br /></td></tr>
<tr class="separator:a49c7997d3a3b9a62f80f17872004fe44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a729636995f4240a398dd8e74e7573947"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_r_t_protocol.html">RTProtocol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a729636995f4240a398dd8e74e7573947">sap</a> (void) const</td></tr>
<tr class="memdesc:a729636995f4240a398dd8e74e7573947"><td class="mdescLeft"> </td><td class="mdescRight">Return the capsule port on which this message was received. <br /></td></tr>
<tr class="separator:a729636995f4240a398dd8e74e7573947"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad55a34d900b25015dc58aec7eee633b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#aad55a34d900b25015dc58aec7eee633b">sapId</a> (void) const</td></tr>
<tr class="memdesc:aad55a34d900b25015dc58aec7eee633b"><td class="mdescLeft"> </td><td class="mdescRight">Return the id of the capsule port on which this message was received. <br /></td></tr>
<tr class="separator:aad55a34d900b25015dc58aec7eee633b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa25e17c072f41607e67b2fb9cd282e9d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#aa25e17c072f41607e67b2fb9cd282e9d">sapIndex0</a> (void) const</td></tr>
<tr class="memdesc:aa25e17c072f41607e67b2fb9cd282e9d"><td class="mdescLeft"> </td><td class="mdescRight">Return the index (0-based) of the replicated port on which this message was received. <br /></td></tr>
<tr class="separator:aa25e17c072f41607e67b2fb9cd282e9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3e9c296b4fe3d9e751718d4e52a8c15"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#ac3e9c296b4fe3d9e751718d4e52a8c15">sapIndex</a> (void) const</td></tr>
<tr class="memdesc:ac3e9c296b4fe3d9e751718d4e52a8c15"><td class="mdescLeft"> </td><td class="mdescRight">Return the index (1-based) of the replicated port on which this message was received. <br /></td></tr>
<tr class="separator:ac3e9c296b4fe3d9e751718d4e52a8c15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d666b205c5c4e681fbb78efc50d9f9b"><td class="memItemLeft" align="right" valign="top">DeliverResult </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a8d666b205c5c4e681fbb78efc50d9f9b">deliver</a> (bool synchronous=false)</td></tr>
<tr class="memdesc:a8d666b205c5c4e681fbb78efc50d9f9b"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to deliver the message to its specified receiver. <br /></td></tr>
<tr class="separator:a8d666b205c5c4e681fbb78efc50d9f9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfe4dd50e262249b4da0caabb226d616"><td class="memItemLeft" align="right" valign="top"><a id="acfe4dd50e262249b4da0caabb226d616" name="acfe4dd50e262249b4da0caabb226d616"></a>
<a class="el" href="class_r_t_message.html">RTMessage</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="class_r_t_message.html">RTMessage</a> &)</td></tr>
<tr class="separator:acfe4dd50e262249b4da0caabb226d616"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69ce639469d11b33482528202c8ab45a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a69ce639469d11b33482528202c8ab45a">defer</a> (void) const</td></tr>
<tr class="memdesc:a69ce639469d11b33482528202c8ab45a"><td class="mdescLeft"> </td><td class="mdescRight">Defer the message by placing it in the defer queue. <br /></td></tr>
<tr class="separator:a69ce639469d11b33482528202c8ab45a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb3c484b68acc16f69da308615ca62c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#afb3c484b68acc16f69da308615ca62c8">setDestination</a> (<a class="el" href="class_r_t_actor.html">RTActor</a> *cap, <a class="el" href="class_r_t_protocol.html">RTProtocol</a> *port, int index)</td></tr>
<tr class="memdesc:afb3c484b68acc16f69da308615ca62c8"><td class="mdescLeft"> </td><td class="mdescRight">Set the destination (i.e. <br /></td></tr>
<tr class="separator:afb3c484b68acc16f69da308615ca62c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6800e7939cb98c8c257fcdd249b9299f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_r_t_actor.html">RTActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a6800e7939cb98c8c257fcdd249b9299f">receiver</a> (void) const</td></tr>
<tr class="memdesc:a6800e7939cb98c8c257fcdd249b9299f"><td class="mdescLeft"> </td><td class="mdescRight">Return the currently set receiver for the message. <br /></td></tr>
<tr class="separator:a6800e7939cb98c8c257fcdd249b9299f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ffead4bdd2457aedf95a6a12276b9f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_r_t_controller.html">RTController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_message.html#a4ffead4bdd2457aedf95a6a12276b9f5">context</a> (void) const</td></tr>
<tr class="memdesc:a4ffead4bdd2457aedf95a6a12276b9f5"><td class="mdescLeft"> </td><td class="mdescRight">Return the controller of the message receiver. <br /></td></tr>
<tr class="separator:a4ffead4bdd2457aedf95a6a12276b9f5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a9b6eb23144e97589e7b1a2ac29dafddb"><td class="memItemLeft" align="right" valign="top"><a id="a9b6eb23144e97589e7b1a2ac29dafddb" name="a9b6eb23144e97589e7b1a2ac29dafddb"></a>
<a class="el" href="class_r_t_message.html">RTMessage</a> * </td><td class="memItemRight" valign="bottom"><b>next</b></td></tr>
<tr class="separator:a9b6eb23144e97589e7b1a2ac29dafddb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8188d75c6ad42a98d63abc78440915e"><td class="memItemLeft" align="right" valign="top"><a id="ad8188d75c6ad42a98d63abc78440915e" name="ad8188d75c6ad42a98d63abc78440915e"></a>
int </td><td class="memItemRight" valign="bottom"><b>_sendPortId</b></td></tr>
<tr class="separator:ad8188d75c6ad42a98d63abc78440915e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9060c96643045e88ae70cecae33434c"><td class="memItemLeft" align="right" valign="top"><a id="aa9060c96643045e88ae70cecae33434c" name="aa9060c96643045e88ae70cecae33434c"></a>
int </td><td class="memItemRight" valign="bottom"><b>_sendPortIndex</b></td></tr>
<tr class="separator:aa9060c96643045e88ae70cecae33434c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89971b2b71c12a02c8c3b76e954602bb"><td class="memItemLeft" align="right" valign="top"><a id="a89971b2b71c12a02c8c3b76e954602bb" name="a89971b2b71c12a02c8c3b76e954602bb"></a>
int </td><td class="memItemRight" valign="bottom"><b>_sendProbeId</b></td></tr>
<tr class="separator:a89971b2b71c12a02c8c3b76e954602bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae67319e1f699b4a7810fc92ca5b5e79"><td class="memItemLeft" align="right" valign="top"><a id="aae67319e1f699b4a7810fc92ca5b5e79" name="aae67319e1f699b4a7810fc92ca5b5e79"></a>
<a class="el" href="struct_r_t_timespec.html">RTTimespec</a> </td><td class="memItemRight" valign="bottom"><b>_sendTime</b></td></tr>
<tr class="separator:aae67319e1f699b4a7810fc92ca5b5e79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c6a40d7f2a0288b542ba1719acef290"><td class="memItemLeft" ><a id="a4c6a40d7f2a0288b542ba1719acef290" name="a4c6a40d7f2a0288b542ba1719acef290"></a>
union {</td></tr>
<tr class="memitem:a62525809dce56869b3f4134f7984da98"><td class="memItemLeft" >
   void *   <b>data</b></td></tr>
<tr class="separator:a62525809dce56869b3f4134f7984da98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af17800d945d820dcc47fa51e711e8660"><td class="memItemLeft" >
   const void *   <b>const_data</b></td></tr>
<tr class="separator:af17800d945d820dcc47fa51e711e8660"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c6a40d7f2a0288b542ba1719acef290"><td class="memItemLeft" valign="top">}; </td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a4c6a40d7f2a0288b542ba1719acef290"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73820370e36c9599828886dbed55cd5e"><td class="memItemLeft" align="right" valign="top"><a id="a73820370e36c9599828886dbed55cd5e" name="a73820370e36c9599828886dbed55cd5e"></a>
short </td><td class="memItemRight" valign="bottom"><b>signal</b></td></tr>
<tr class="separator:a73820370e36c9599828886dbed55cd5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a459f9edffe8d8ddc0820be69489f71"><td class="memItemLeft" align="right" valign="top"><a id="a7a459f9edffe8d8ddc0820be69489f71" name="a7a459f9edffe8d8ddc0820be69489f71"></a>
unsigned char </td><td class="memItemRight" valign="bottom"><b>priority</b></td></tr>
<tr class="separator:a7a459f9edffe8d8ddc0820be69489f71"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:abcaf8a9a543957d67ec3000714b79f9f"><td class="memItemLeft" align="right" valign="top"><a id="abcaf8a9a543957d67ec3000714b79f9f" name="abcaf8a9a543957d67ec3000714b79f9f"></a>enum  </td><td class="memItemRight" valign="bottom">{ <b>MaskDeferred</b> = 1
, <b>MaskDataOwned</b> = 2
}</td></tr>
<tr class="separator:abcaf8a9a543957d67ec3000714b79f9f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a35191fcdd0d6a946f399b2371cd8ca33"><td class="memItemLeft" align="right" valign="top"><a id="a35191fcdd0d6a946f399b2371cd8ca33" name="a35191fcdd0d6a946f399b2371cd8ca33"></a>
void </td><td class="memItemRight" valign="bottom"><b>_internData</b> (bool moveData)</td></tr>
<tr class="separator:a35191fcdd0d6a946f399b2371cd8ca33"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a0febf90ce5741d302879c71a7dd72831"><td class="memItemLeft" align="right" valign="top"><a id="a0febf90ce5741d302879c71a7dd72831" name="a0febf90ce5741d302879c71a7dd72831"></a>
unsigned char </td><td class="memItemRight" valign="bottom"><b>_flags</b></td></tr>
<tr class="separator:a0febf90ce5741d302879c71a7dd72831"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cc9ccdfa77ba9d0b1369f7cba8cd0a8"><td class="memItemLeft" align="right" valign="top"><a id="a2cc9ccdfa77ba9d0b1369f7cba8cd0a8" name="a2cc9ccdfa77ba9d0b1369f7cba8cd0a8"></a>
<a class="el" href="class_r_t_actor.html">RTActor</a> * </td><td class="memItemRight" valign="bottom"><b>_receiver</b></td></tr>
<tr class="separator:a2cc9ccdfa77ba9d0b1369f7cba8cd0a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc0c75bb67e3eac8d1afe3981233004f"><td class="memItemLeft" align="right" valign="top"><a id="acc0c75bb67e3eac8d1afe3981233004f" name="acc0c75bb67e3eac8d1afe3981233004f"></a>
<a class="el" href="class_r_t_protocol.html">RTProtocol</a> * </td><td class="memItemRight" valign="bottom"><b>_port</b></td></tr>
<tr class="separator:acc0c75bb67e3eac8d1afe3981233004f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed7e6031b86512d9d921dbf1f95a07b0"><td class="memItemLeft" align="right" valign="top"><a id="aed7e6031b86512d9d921dbf1f95a07b0" name="aed7e6031b86512d9d921dbf1f95a07b0"></a>
int </td><td class="memItemRight" valign="bottom"><b>_portIndex</b></td></tr>
<tr class="separator:aed7e6031b86512d9d921dbf1f95a07b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6e4b8d94c78a59a8bfbca6754f53297"><td class="memItemLeft" align="right" valign="top"><a id="ae6e4b8d94c78a59a8bfbca6754f53297" name="ae6e4b8d94c78a59a8bfbca6754f53297"></a>
const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> * </td><td class="memItemRight" valign="bottom"><b>_type</b></td></tr>
<tr class="separator:ae6e4b8d94c78a59a8bfbca6754f53297"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a message used for communication between capsule instances. </p>
<p>The message may carry a data object. A message object is usually an instance of a protocol event. However, there are also internal messages used by the TargetRTS itself. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6b7783e818857e3ec7f2af2f9590edfd" name="a6b7783e818857e3ec7f2af2f9590edfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b7783e818857e3ec7f2af2f9590edfd">◆ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::clear </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the data object stored in the message, and reset the message object to make it ready to be used in another communication. </p>
<p>This function is called internally by the TargetRTS and there is usually no need to call it directly. </p>
</div>
</div>
<a id="a4ffead4bdd2457aedf95a6a12276b9f5" name="a4ffead4bdd2457aedf95a6a12276b9f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ffead4bdd2457aedf95a6a12276b9f5">◆ </a></span>context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_controller.html">RTController</a> * RTMessage::context </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the controller of the message receiver. </p>
<dl class="section return"><dt>Returns</dt><dd>The controller of the capsule instance that is set-up as the receiver of the message. </dd></dl>
</div>
</div>
<a id="a69ce639469d11b33482528202c8ab45a" name="a69ce639469d11b33482528202c8ab45a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69ce639469d11b33482528202c8ab45a">◆ </a></span>defer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::defer </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Defer the message by placing it in the defer queue. </p>
<p>You can later recall a deferred message by calling one of the recall functions of <a class="el" href="struct_r_t_in_signal.html" title="Provides the API for working with messages of a certain protocol event received on a certain port.">RTInSignal</a> or <a class="el" href="class_r_t_protocol.html" title="Represents a general capsule port typed by a protocol which determines the set of events that can be ...">RTProtocol</a>. </p><dl class="section return"><dt>Returns</dt><dd>1 if the message was successfully deferred, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a8d666b205c5c4e681fbb78efc50d9f9b" name="a8d666b205c5c4e681fbb78efc50d9f9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d666b205c5c4e681fbb78efc50d9f9b">◆ </a></span>deliver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DeliverResult RTMessage::deliver </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>synchronous</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempt to deliver the message to its specified receiver. </p>
<p>This function is called by the TargetRTS when a message is sent, and it's normally not useful to call it directly. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">synchronous</td><td>False for most messages, but true for messages delivered as part of an invoke </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A delivery status informing about how the receiver handled the message. </dd></dl>
</div>
</div>
<a id="aa17be8f873a8214a0d213e411985bc97" name="aa17be8f873a8214a0d213e411985bc97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa17be8f873a8214a0d213e411985bc97">◆ </a></span>getData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * RTMessage::getData </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the data object carried by the message, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The data object carried by the message, or NULL if none. </dd></dl>
</div>
</div>
<a id="ac68b15e8d5344677b97c4ed7145687be" name="ac68b15e8d5344677b97c4ed7145687be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac68b15e8d5344677b97c4ed7145687be">◆ </a></span>getPriority()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::getPriority </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the priority of the message. </p>
<p>See <a class="el" href="_r_t_priority_8h_source.html">RTPriority.h</a> for a list of valid message priorities. </p><dl class="section return"><dt>Returns</dt><dd>The priority for the message. </dd></dl>
</div>
</div>
<a id="a8d3e24aece4383bee8e5f63cf6ee40cd" name="a8d3e24aece4383bee8e5f63cf6ee40cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d3e24aece4383bee8e5f63cf6ee40cd">◆ </a></span>getSignal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::getSignal </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the signal id of the message, i.e. </p>
<p>the id of its protocol event. </p><dl class="section return"><dt>Returns</dt><dd>Numeric id of the protocol event of the message. </dd></dl>
</div>
</div>
<a id="a192e10223fc4b9852f4f02710c2ed876" name="a192e10223fc4b9852f4f02710c2ed876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a192e10223fc4b9852f4f02710c2ed876">◆ </a></span>getSignalName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTMessage::getSignalName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the signal name of the message, i.e. </p>
<p>the name of its protocol event. </p><dl class="section return"><dt>Returns</dt><dd>Name of the protocol event of the message. </dd></dl>
</div>
</div>
<a id="a49c7997d3a3b9a62f80f17872004fe44" name="a49c7997d3a3b9a62f80f17872004fe44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49c7997d3a3b9a62f80f17872004fe44">◆ </a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> * RTMessage::getType </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of the data object of the message, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>Type descriptor for the data object, or NULL in case the message does not have one. </dd></dl>
</div>
</div>
<a id="a500cb9080d5e3802ece776de5f00d52b" name="a500cb9080d5e3802ece776de5f00d52b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a500cb9080d5e3802ece776de5f00d52b">◆ </a></span>internData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::internData </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>moveData</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intern the data object of the message. </p>
<p>Normally this means the data object will be copied into the message but if moveData is true, the data object will instead be moved into the message. </p>
</div>
</div>
<a id="ab824d1fdd1703af202f938d8eee8b7e7" name="ab824d1fdd1703af202f938d8eee8b7e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab824d1fdd1703af202f938d8eee8b7e7">◆ </a></span>isDeferred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::isDeferred </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if this message has been deferred, i.e. </p>
<p>placed in a defer queue. </p><dl class="section return"><dt>Returns</dt><dd>1 if yes, 0 if no. </dd></dl>
</div>
</div>
<a id="a0a99d8362a7b06983d07a6adb4162990" name="a0a99d8362a7b06983d07a6adb4162990"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a99d8362a7b06983d07a6adb4162990">◆ </a></span>isRTData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::isRTData </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the message carries a data object which is an <a class="el" href="class_r_t_data_object.html" title="Provides a common interface to certain data type implementations (e.g.">RTDataObject</a>. </p>
<p>Mainly provided for backwards compatibility. </p><dl class="section return"><dt>Returns</dt><dd>1 if yes, 0 if no. </dd></dl>
</div>
</div>
<a id="af6227985d9f163c7fc83a8d8a27fbaf2" name="af6227985d9f163c7fc83a8d8a27fbaf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6227985d9f163c7fc83a8d8a27fbaf2">◆ </a></span>isValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::isValid </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>A message is considered valid as soon as its protocol event (i.e. </p>
<p>signal id) has been setup. </p><dl class="section return"><dt>Returns</dt><dd>1 if the message has a protocol event setup, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a6800e7939cb98c8c257fcdd249b9299f" name="a6800e7939cb98c8c257fcdd249b9299f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6800e7939cb98c8c257fcdd249b9299f">◆ </a></span>receiver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_actor.html">RTActor</a> * RTMessage::receiver </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the currently set receiver for the message. </p>
<dl class="section return"><dt>Returns</dt><dd>The capsule instance set-up as the receiver of the message. </dd></dl>
</div>
</div>
<a id="a52a115a74f06760220a7eaf6afbb0aad" name="a52a115a74f06760220a7eaf6afbb0aad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52a115a74f06760220a7eaf6afbb0aad">◆ </a></span>resetDeferred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::resetDeferred </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mark this message as not deferred. </p>
<p>This function is called internally by the TargetRTS and there is usually no need to call it directly. </p>
</div>
</div>
<a id="a729636995f4240a398dd8e74e7573947" name="a729636995f4240a398dd8e74e7573947"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a729636995f4240a398dd8e74e7573947">◆ </a></span>sap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_protocol.html">RTProtocol</a> * RTMessage::sap </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the capsule port on which this message was received. </p>
<dl class="section return"><dt>Returns</dt><dd>The port on which the message was received, or NULL if it was not yet received. </dd></dl>
</div>
</div>
<a id="aad55a34d900b25015dc58aec7eee633b" name="aad55a34d900b25015dc58aec7eee633b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad55a34d900b25015dc58aec7eee633b">◆ </a></span>sapId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::sapId </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the id of the capsule port on which this message was received. </p>
<dl class="section return"><dt>Returns</dt><dd>The id of the port on which the message was received, or NULL if it was not yet received. </dd></dl>
</div>
</div>
<a id="ac3e9c296b4fe3d9e751718d4e52a8c15" name="ac3e9c296b4fe3d9e751718d4e52a8c15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3e9c296b4fe3d9e751718d4e52a8c15">◆ </a></span>sapIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::sapIndex </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the index (1-based) of the replicated port on which this message was received. </p>
<p>It's for example useful to get this index if you want to send a message back to the sender. </p><dl class="section return"><dt>Returns</dt><dd>The 1-based index of the port on which the message was received. </dd></dl>
</div>
</div>
<a id="aa25e17c072f41607e67b2fb9cd282e9d" name="aa25e17c072f41607e67b2fb9cd282e9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa25e17c072f41607e67b2fb9cd282e9d">◆ </a></span>sapIndex0()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTMessage::sapIndex0 </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the index (0-based) of the replicated port on which this message was received. </p>
<p>It's for example useful to get this index if you want to send a message back to the sender. </p><dl class="section return"><dt>Returns</dt><dd>The 0-based index of the port on which the message was received. </dd></dl>
</div>
</div>
<a id="adabb7b3660ff0fbba86fcb110b342a06" name="adabb7b3660ff0fbba86fcb110b342a06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adabb7b3660ff0fbba86fcb110b342a06">◆ </a></span>setData() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::setData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_r_t_data_object.html">RTDataObject</a> & </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the data object of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a98d28d4503826c3da83bada234510b28" name="a98d28d4503826c3da83bada234510b28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98d28d4503826c3da83bada234510b28">◆ </a></span>setData() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::setData </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">const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> * </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the data object of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type descriptor of the data object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6dc1236845d8b2c1c4a2b1e2449d9e9f" name="a6dc1236845d8b2c1c4a2b1e2449d9e9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dc1236845d8b2c1c4a2b1e2449d9e9f">◆ </a></span>setDeferred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::setDeferred </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mark this message as deferred. </p>
<p>This function is called internally by the TargetRTS and there is usually no need to call it directly. </p>
</div>
</div>
<a id="afb3c484b68acc16f69da308615ca62c8" name="afb3c484b68acc16f69da308615ca62c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb3c484b68acc16f69da308615ca62c8">◆ </a></span>setDestination()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::setDestination </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_actor.html">RTActor</a> * </td>
<td class="paramname"><em>cap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_r_t_protocol.html">RTProtocol</a> * </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the destination (i.e. </p>
<p>receiver) of the message. This function is called by the TargetRTS when a message is sent, and it's normally not useful to call it directly. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cap</td><td>Receiver capsule instance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The receiver port on the capsule instance to which the message is sent. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The 0-based index of the receiver port (in case it is replicated). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a19ead1e39dff7f5a696b774d0c9ebeca" name="a19ead1e39dff7f5a696b774d0c9ebeca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19ead1e39dff7f5a696b774d0c9ebeca">◆ </a></span>setPriority()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::setPriority </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>prio</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the priority of the message. </p>
<p>See <a class="el" href="_r_t_priority_8h_source.html">RTPriority.h</a> for a list of valid message priorities. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">prio</td><td>Priority for the message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a05bac589370e4cbd0a733740f3f23419" name="a05bac589370e4cbd0a733740f3f23419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05bac589370e4cbd0a733740f3f23419">◆ </a></span>setSignal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTMessage::setSignal </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the signal id of the message, i.e. </p>
<p>the id of its the protocol event. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Numeric id of the protocol event of the message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_r_t_message_8h_source.html">RTMessage.h</a></li>
<li>RTActor.inl</li>
<li>RTMessage.inl</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>