-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathclass_r_t_protocol.html
More file actions
1479 lines (1355 loc) · 92.4 KB
/
class_r_t_protocol.html
File metadata and controls
1479 lines (1355 loc) · 92.4 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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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: RTProtocol 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="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="class_r_t_protocol-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RTProtocol Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a general capsule port typed by a protocol which determines the set of events that can be sent to and received by the port.
<a href="class_r_t_protocol.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_r_t_protocol_8h_source.html">RTProtocol.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for RTProtocol:</div>
<div class="dyncontent">
<div class="center">
<img src="class_r_t_protocol.png" usemap="#RTProtocol_map" alt=""/>
<map id="RTProtocol_map" name="RTProtocol_map">
<area href="class_exception_1_1_base.html" title="Represents an exception port through which exception events can be raised." alt="Exception::Base" shape="rect" coords="0,56,101,80"/>
<area href="class_external_1_1_base.html" title="Represents a port through which an external thread can safely communicate with its owner capsule." alt="External::Base" shape="rect" coords="111,56,212,80"/>
<area href="class_frame_1_1_base.html" title="Represents a frame port." alt="Frame::Base" shape="rect" coords="222,56,323,80"/>
<area href="class_log_1_1_base.html" title="Represents a log port." alt="Log::Base" shape="rect" coords="333,56,434,80"/>
<area href="class_r_t_root_protocol.html" title="Represents a capsule port which at run-time can be bound to another capsule port." alt="RTRootProtocol" shape="rect" coords="444,56,545,80"/>
<area href="class_timing_1_1_base.html" title="Represents a timer port." alt="Timing::Base" shape="rect" coords="555,56,656,80"/>
</map>
</div></div>
<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:a02358053723895c6423f73ec97d5fe24"><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_protocol.html#a02358053723895c6423f73ec97d5fe24">context</a> (void) const</td></tr>
<tr class="memdesc:a02358053723895c6423f73ec97d5fe24"><td class="mdescLeft"> </td><td class="mdescRight">Get the context of the capsule that owns this port. <br /></td></tr>
<tr class="separator:a02358053723895c6423f73ec97d5fe24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7569d7ad23ba8a40313ebc91aee92cc4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a7569d7ad23ba8a40313ebc91aee92cc4">getId</a> (void) const</td></tr>
<tr class="memdesc:a7569d7ad23ba8a40313ebc91aee92cc4"><td class="mdescLeft"> </td><td class="mdescRight">Get the id of the port. <br /></td></tr>
<tr class="separator:a7569d7ad23ba8a40313ebc91aee92cc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab13996e31840891910920c9880670edf"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_r_t_port_descriptor.html">RTPortDescriptor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#ab13996e31840891910920c9880670edf">getInfo</a> (void) const</td></tr>
<tr class="memdesc:ab13996e31840891910920c9880670edf"><td class="mdescLeft"> </td><td class="mdescRight">Get information about a port. <br /></td></tr>
<tr class="separator:ab13996e31840891910920c9880670edf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee715e514169058cc688ef652ec41f83"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aee715e514169058cc688ef652ec41f83">getName</a> (void) const</td></tr>
<tr class="memdesc:aee715e514169058cc688ef652ec41f83"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the port. <br /></td></tr>
<tr class="separator:aee715e514169058cc688ef652ec41f83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6545f036888aeacaab36096f4e876ff"><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_protocol.html#af6545f036888aeacaab36096f4e876ff">getOwner</a> (void) const</td></tr>
<tr class="memdesc:af6545f036888aeacaab36096f4e876ff"><td class="mdescLeft"> </td><td class="mdescRight">Get the owner capsule to which the port belongs. <br /></td></tr>
<tr class="separator:af6545f036888aeacaab36096f4e876ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bf5a22f8232f12cd60a969523946889"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a1bf5a22f8232f12cd60a969523946889">size</a> (void) const</td></tr>
<tr class="memdesc:a1bf5a22f8232f12cd60a969523946889"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the port. <br /></td></tr>
<tr class="separator:a1bf5a22f8232f12cd60a969523946889"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef50658d6d1246dee65718b70b1a2088"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aef50658d6d1246dee65718b70b1a2088">resize</a> (int new_size)</td></tr>
<tr class="memdesc:aef50658d6d1246dee65718b70b1a2088"><td class="mdescLeft"> </td><td class="mdescRight">Set a new size (i.e. <br /></td></tr>
<tr class="separator:aef50658d6d1246dee65718b70b1a2088"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af35cd8130dde852d13d7953419349a11"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#af35cd8130dde852d13d7953419349a11">registerSAP</a> (const char *service)</td></tr>
<tr class="memdesc:af35cd8130dde852d13d7953419349a11"><td class="mdescLeft"> </td><td class="mdescRight">Register an unwired port (SAP) with the layer service (as a "client"). <br /></td></tr>
<tr class="separator:af35cd8130dde852d13d7953419349a11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e580b53c346f4a623b2864fcc8e344b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a5e580b53c346f4a623b2864fcc8e344b">deregisterSAP</a> (void)</td></tr>
<tr class="memdesc:a5e580b53c346f4a623b2864fcc8e344b"><td class="mdescLeft"> </td><td class="mdescRight">Deregister an unwired port (SAP). <br /></td></tr>
<tr class="separator:a5e580b53c346f4a623b2864fcc8e344b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabb58413ecb8836fe47aa6c0069fb3cf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aabb58413ecb8836fe47aa6c0069fb3cf">registerSPP</a> (const char *service)</td></tr>
<tr class="memdesc:aabb58413ecb8836fe47aa6c0069fb3cf"><td class="mdescLeft"> </td><td class="mdescRight">Register an unwired port (SPP) with the layer service (as the "provider"). <br /></td></tr>
<tr class="separator:aabb58413ecb8836fe47aa6c0069fb3cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa71503e6d0ec280fa95ea813db29f41e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aa71503e6d0ec280fa95ea813db29f41e">deregisterSPP</a> (void)</td></tr>
<tr class="memdesc:aa71503e6d0ec280fa95ea813db29f41e"><td class="mdescLeft"> </td><td class="mdescRight">Deregister an unwired port (SPP). <br /></td></tr>
<tr class="separator:aa71503e6d0ec280fa95ea813db29f41e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d430e4ee11ed7438cb77d60faaba91f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a0d430e4ee11ed7438cb77d60faaba91f">defaultLayerName</a> (void) const</td></tr>
<tr class="memdesc:a0d430e4ee11ed7438cb77d60faaba91f"><td class="mdescLeft"> </td><td class="mdescRight">Get the default registration name for the port. <br /></td></tr>
<tr class="separator:a0d430e4ee11ed7438cb77d60faaba91f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c47b94180b9f30bf3e25bcfa55fe0d0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a2c47b94180b9f30bf3e25bcfa55fe0d0">isRegistered</a> (void) const</td></tr>
<tr class="memdesc:a2c47b94180b9f30bf3e25bcfa55fe0d0"><td class="mdescLeft"> </td><td class="mdescRight">Determine if the port is currently registered with the layer service or not. <br /></td></tr>
<tr class="separator:a2c47b94180b9f30bf3e25bcfa55fe0d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4759bbdb8fcd25545f463a9caf15961d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a4759bbdb8fcd25545f463a9caf15961d">getRegisteredName</a> (void) const</td></tr>
<tr class="memdesc:a4759bbdb8fcd25545f463a9caf15961d"><td class="mdescLeft"> </td><td class="mdescRight">Get the registration name of the port. <br /></td></tr>
<tr class="separator:a4759bbdb8fcd25545f463a9caf15961d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0dafbdb3f5339378036a1f9800ac8b8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#ad0dafbdb3f5339378036a1f9800ac8b8">registerAs</a> (const char *service)</td></tr>
<tr class="memdesc:ad0dafbdb3f5339378036a1f9800ac8b8"><td class="mdescLeft"> </td><td class="mdescRight">Register an unwired port either as an SAP or SPP (depending on the "Publish" property of the port). <br /></td></tr>
<tr class="separator:ad0dafbdb3f5339378036a1f9800ac8b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed18e2ea1cd805cf48df1c4dda1a56df"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aed18e2ea1cd805cf48df1c4dda1a56df">deregister</a> (void)</td></tr>
<tr class="memdesc:aed18e2ea1cd805cf48df1c4dda1a56df"><td class="mdescLeft"> </td><td class="mdescRight">Deregister an unwired port (either an SAP or SPP). <br /></td></tr>
<tr class="separator:aed18e2ea1cd805cf48df1c4dda1a56df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae364dd3d1d73dda4146f77cadd708d53"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#ae364dd3d1d73dda4146f77cadd708d53">isBoundAt</a> (int index) const</td></tr>
<tr class="memdesc:ae364dd3d1d73dda4146f77cadd708d53"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a port instance is currently connected to another port instance. <br /></td></tr>
<tr class="separator:ae364dd3d1d73dda4146f77cadd708d53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2765cfbbe1295b939a47ea0b9be991c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#ab2765cfbbe1295b939a47ea0b9be991c">isIndexTo</a> (int index, <a class="el" href="class_r_t_actor.html">RTActor</a> *capsule) const</td></tr>
<tr class="memdesc:ab2765cfbbe1295b939a47ea0b9be991c"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a port instance is currently connected to a port instance owned by a certain capsule instance. <br /></td></tr>
<tr class="separator:ab2765cfbbe1295b939a47ea0b9be991c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f251e8160558cf5ae295a59cfab1202"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a7f251e8160558cf5ae295a59cfab1202">indexTo</a> (<a class="el" href="class_r_t_actor.html">RTActor</a> *capsule) const</td></tr>
<tr class="memdesc:a7f251e8160558cf5ae295a59cfab1202"><td class="mdescLeft"> </td><td class="mdescRight">Determine if there exists a port instance currently connected to a port instance owned by a certain capsule instance. <br /></td></tr>
<tr class="separator:a7f251e8160558cf5ae295a59cfab1202"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9150bfbf17314443453d429c8f113553"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a9150bfbf17314443453d429c8f113553">purge</a> (void)</td></tr>
<tr class="memdesc:a9150bfbf17314443453d429c8f113553"><td class="mdescLeft"> </td><td class="mdescRight">Empty the defer queue of all port instances without recalling any deferred message. <br /></td></tr>
<tr class="separator:a9150bfbf17314443453d429c8f113553"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2703f40abf6a8df9bbd730215c8c23e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a2703f40abf6a8df9bbd730215c8c23e7">purgeAt</a> (int index)</td></tr>
<tr class="memdesc:a2703f40abf6a8df9bbd730215c8c23e7"><td class="mdescLeft"> </td><td class="mdescRight">Empty the defer queue of a specified port instance without recalling any deferred message. <br /></td></tr>
<tr class="separator:a2703f40abf6a8df9bbd730215c8c23e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a775cee0be2a2cfd90b58b2cc3ec0f86e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a775cee0be2a2cfd90b58b2cc3ec0f86e">recall</a> (void)</td></tr>
<tr class="memdesc:a775cee0be2a2cfd90b58b2cc3ec0f86e"><td class="mdescLeft"> </td><td class="mdescRight">Recall a message from the defer queue and insert it at the back of the controller's message queue (after other queued messages). <br /></td></tr>
<tr class="separator:a775cee0be2a2cfd90b58b2cc3ec0f86e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae611db0412a09055815ac9717394f303"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#ae611db0412a09055815ac9717394f303">recallFront</a> (void)</td></tr>
<tr class="memdesc:ae611db0412a09055815ac9717394f303"><td class="mdescLeft"> </td><td class="mdescRight">Recall a message from the defer queue and insert it at the front of the controller's message queue (before other queued messages). <br /></td></tr>
<tr class="separator:ae611db0412a09055815ac9717394f303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f7cfcb42423fc78b60f48f7220c0779"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a9f7cfcb42423fc78b60f48f7220c0779">recallAt</a> (int index, int front=0)</td></tr>
<tr class="memdesc:a9f7cfcb42423fc78b60f48f7220c0779"><td class="mdescLeft"> </td><td class="mdescRight">Recall a message from the defer queue and insert it in the controller's message queue. <br /></td></tr>
<tr class="separator:a9f7cfcb42423fc78b60f48f7220c0779"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc92df9cafd7c04372916ee4ef6c5c3c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#afc92df9cafd7c04372916ee4ef6c5c3c">recallAll</a> (void)</td></tr>
<tr class="memdesc:afc92df9cafd7c04372916ee4ef6c5c3c"><td class="mdescLeft"> </td><td class="mdescRight">Recall all messages from the defer queue and insert them at the back of the controller's message queue (after other queued messages). <br /></td></tr>
<tr class="separator:afc92df9cafd7c04372916ee4ef6c5c3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70638165fd32d634670c2c2f174a3c3b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a70638165fd32d634670c2c2f174a3c3b">recallAllFront</a> (void)</td></tr>
<tr class="memdesc:a70638165fd32d634670c2c2f174a3c3b"><td class="mdescLeft"> </td><td class="mdescRight">Recall all messages from the defer queue and insert them at the front of the controller's message queue (before other queued messages). <br /></td></tr>
<tr class="separator:a70638165fd32d634670c2c2f174a3c3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a627afae9906e70cea7fc182bfb5f7cb8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a627afae9906e70cea7fc182bfb5f7cb8">recallAllAt</a> (int index, int front=0)</td></tr>
<tr class="memdesc:a627afae9906e70cea7fc182bfb5f7cb8"><td class="mdescLeft"> </td><td class="mdescRight">Recall all messages from the defer queue and insert them in the controller's message queue. <br /></td></tr>
<tr class="separator:a627afae9906e70cea7fc182bfb5f7cb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56b78477128d033d1e1f4c797ef0caf6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a56b78477128d033d1e1f4c797ef0caf6">bindingNotification</a> (int on_off)</td></tr>
<tr class="memdesc:a56b78477128d033d1e1f4c797ef0caf6"><td class="mdescLeft"> </td><td class="mdescRight">Turn on or off binding notifications for this port. <br /></td></tr>
<tr class="separator:a56b78477128d033d1e1f4c797ef0caf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcb72eaea84b5ce02ebf4393d1768c21"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#adcb72eaea84b5ce02ebf4393d1768c21">bindingNotificationRequested</a> (void) const</td></tr>
<tr class="memdesc:adcb72eaea84b5ce02ebf4393d1768c21"><td class="mdescLeft"> </td><td class="mdescRight">Determine if binding notifications are currently enabled for the port. <br /></td></tr>
<tr class="separator:adcb72eaea84b5ce02ebf4393d1768c21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d444f5ca3150bf91f56cf1637623307"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a2d444f5ca3150bf91f56cf1637623307">sendTypeCheckEnable</a> (int on_off)</td></tr>
<tr class="memdesc:a2d444f5ca3150bf91f56cf1637623307"><td class="mdescLeft"> </td><td class="mdescRight">Turn on or off type checking when performing <a class="el" href="class_r_t_protocol.html#a4b38472435fc60256e4a4f2d0234c9de" title="Send an event on the port.">send()</a>, <a class="el" href="class_r_t_protocol.html#a4fba0c4760d48842f11d891b416f3ef9" title="Invoke an event on the port.">invoke()</a> or <a class="el" href="class_r_t_protocol.html#a6458de033f1ecf9f60de9b7745dc376f" title="Make a reply to respond to an invoke.">reply()</a> on the port. <br /></td></tr>
<tr class="separator:a2d444f5ca3150bf91f56cf1637623307"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a880d97d0e3b87ac9ea00bb2f6eaf0d56"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a880d97d0e3b87ac9ea00bb2f6eaf0d56">sendTypeCheckEnabled</a> (void) const</td></tr>
<tr class="memdesc:a880d97d0e3b87ac9ea00bb2f6eaf0d56"><td class="mdescLeft"> </td><td class="mdescRight">Determine if type checking when sending events is enabled. <br /></td></tr>
<tr class="separator:a880d97d0e3b87ac9ea00bb2f6eaf0d56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d2a9a51d2ec8c9f97dd6eb8e8370aaa"><td class="memItemLeft" align="right" valign="top">RTProtocolDescriptor::Status </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a1d2a9a51d2ec8c9f97dd6eb8e8370aaa">sendCheck</a> (int signal, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type) const</td></tr>
<tr class="memdesc:a1d2a9a51d2ec8c9f97dd6eb8e8370aaa"><td class="mdescLeft"> </td><td class="mdescRight">Check if a particular event would be possible to send on this port. <br /></td></tr>
<tr class="separator:a1d2a9a51d2ec8c9f97dd6eb8e8370aaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac415448c9272ba92ead19c6e97c806bd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#ac415448c9272ba92ead19c6e97c806bd">receiveTypeCheckEnable</a> (int on_off)</td></tr>
<tr class="memdesc:ac415448c9272ba92ead19c6e97c806bd"><td class="mdescLeft"> </td><td class="mdescRight">Turn on or off type checking when receiving an event on the port. <br /></td></tr>
<tr class="separator:ac415448c9272ba92ead19c6e97c806bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74e0bd91743d6720c1ea3426074314e7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a74e0bd91743d6720c1ea3426074314e7">receiveTypeCheckEnabled</a> (void) const</td></tr>
<tr class="memdesc:a74e0bd91743d6720c1ea3426074314e7"><td class="mdescLeft"> </td><td class="mdescRight">Determine if type checking when receiving events is enabled. <br /></td></tr>
<tr class="separator:a74e0bd91743d6720c1ea3426074314e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2ad300424f58e0f6325fdee64fe02d8"><td class="memItemLeft" align="right" valign="top">RTProtocolDescriptor::Status </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aa2ad300424f58e0f6325fdee64fe02d8">receiveCheck</a> (int signal, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type) const</td></tr>
<tr class="memdesc:aa2ad300424f58e0f6325fdee64fe02d8"><td class="mdescLeft"> </td><td class="mdescRight">Check if a particular event would be possible to receive on this port. <br /></td></tr>
<tr class="separator:aa2ad300424f58e0f6325fdee64fe02d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fba0c4760d48842f11d891b416f3ef9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a4fba0c4760d48842f11d891b416f3ef9">invoke</a> (<a class="el" href="class_r_t_message.html">RTMessage</a> *replyBuffer, int signal, const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type, bool implicitReply)</td></tr>
<tr class="memdesc:a4fba0c4760d48842f11d891b416f3ef9"><td class="mdescLeft"> </td><td class="mdescRight">Invoke an event on the port. <br /></td></tr>
<tr class="separator:a4fba0c4760d48842f11d891b416f3ef9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3c5eae9cdc5ab117f9332b41964bcf7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#aa3c5eae9cdc5ab117f9332b41964bcf7">invokeAt</a> (int index, <a class="el" href="class_r_t_message.html">RTMessage</a> *replyBuffer, int signal, const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type, bool implicitReply)</td></tr>
<tr class="memdesc:aa3c5eae9cdc5ab117f9332b41964bcf7"><td class="mdescLeft"> </td><td class="mdescRight">Invoke an event on a replicated port at a specified index. <br /></td></tr>
<tr class="separator:aa3c5eae9cdc5ab117f9332b41964bcf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6458de033f1ecf9f60de9b7745dc376f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a6458de033f1ecf9f60de9b7745dc376f">reply</a> (int signal, const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type)</td></tr>
<tr class="memdesc:a6458de033f1ecf9f60de9b7745dc376f"><td class="mdescLeft"> </td><td class="mdescRight">Make a reply to respond to an invoke. <br /></td></tr>
<tr class="separator:a6458de033f1ecf9f60de9b7745dc376f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b38472435fc60256e4a4f2d0234c9de"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a4b38472435fc60256e4a4f2d0234c9de">send</a> (int signal, const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type, int priority, bool moveData=false)</td></tr>
<tr class="memdesc:a4b38472435fc60256e4a4f2d0234c9de"><td class="mdescLeft"> </td><td class="mdescRight">Send an event on the port. <br /></td></tr>
<tr class="separator:a4b38472435fc60256e4a4f2d0234c9de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77d071f7137ca82a8ffd7c8e589c3114"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_protocol.html#a77d071f7137ca82a8ffd7c8e589c3114">sendAt</a> (int index, int signal, const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type, int priority, bool moveData=false)</td></tr>
<tr class="memdesc:a77d071f7137ca82a8ffd7c8e589c3114"><td class="mdescLeft"> </td><td class="mdescRight">Send an event on a replicated port at a specified index. <br /></td></tr>
<tr class="separator:a77d071f7137ca82a8ffd7c8e589c3114"><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:aa9db557a5ebfcf5b8eceedd15dc0e5d5"><td class="memItemLeft" align="right" valign="top"><a id="aa9db557a5ebfcf5b8eceedd15dc0e5d5" name="aa9db557a5ebfcf5b8eceedd15dc0e5d5"></a>enum  </td><td class="memItemRight" valign="bottom">{ <br />
  <b>BindingNotification</b> = 1
, <b>RegisteredAsSAP</b> = 2
, <b>SendTypeCheck</b> = 4
, <b>ReceiveTypeCheck</b> = 8
, <br />
  <b>Resized</b> = 16
<br />
}</td></tr>
<tr class="separator:aa9db557a5ebfcf5b8eceedd15dc0e5d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3bf1044e6f75455f11dd4edce2af616"><td class="memItemLeft" align="right" valign="top"><a id="ae3bf1044e6f75455f11dd4edce2af616" name="ae3bf1044e6f75455f11dd4edce2af616"></a>enum  </td><td class="memItemRight" valign="bottom">{ <b>rtiLast_RTProtocol</b> = 0
}</td></tr>
<tr class="separator:ae3bf1044e6f75455f11dd4edce2af616"><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:ac7a17e8dc831575b8b324c123af2b0da"><td class="memItemLeft" align="right" valign="top"><a id="ac7a17e8dc831575b8b324c123af2b0da" name="ac7a17e8dc831575b8b324c123af2b0da"></a>
void </td><td class="memItemRight" valign="bottom"><b>init</b> (const <a class="el" href="struct_r_t_port_descriptor.html">RTPortDescriptor</a> *)</td></tr>
<tr class="separator:ac7a17e8dc831575b8b324c123af2b0da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab821319dd07a3ef521765d9260783898"><td class="memItemLeft" align="right" valign="top"><a id="ab821319dd07a3ef521765d9260783898" name="ab821319dd07a3ef521765d9260783898"></a>
int </td><td class="memItemRight" valign="bottom"><b>getFlags</b> (void) const</td></tr>
<tr class="separator:ab821319dd07a3ef521765d9260783898"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab13b117f2c7538cb426e361fba7426ef"><td class="memItemLeft" align="right" valign="top"><a id="ab13b117f2c7538cb426e361fba7426ef" name="ab13b117f2c7538cb426e361fba7426ef"></a>
void </td><td class="memItemRight" valign="bottom"><b>setFlag</b> (int)</td></tr>
<tr class="separator:ab13b117f2c7538cb426e361fba7426ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbc08d99d20ab533b5079e3aa074e892"><td class="memItemLeft" align="right" valign="top"><a id="acbc08d99d20ab533b5079e3aa074e892" name="acbc08d99d20ab533b5079e3aa074e892"></a>
void </td><td class="memItemRight" valign="bottom"><b>resetFlag</b> (int)</td></tr>
<tr class="separator:acbc08d99d20ab533b5079e3aa074e892"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b8e009f25cb11e3f94b3e8b1a03e885"><td class="memItemLeft" align="right" valign="top"><a id="a1b8e009f25cb11e3f94b3e8b1a03e885" name="a1b8e009f25cb11e3f94b3e8b1a03e885"></a>
void </td><td class="memItemRight" valign="bottom"><b>bindAt</b> (int, <a class="el" href="struct_r_t_binding_end.html">RTBindingEnd</a> &, <a class="el" href="class_r_t_controller.html">RTController</a> *)</td></tr>
<tr class="separator:a1b8e009f25cb11e3f94b3e8b1a03e885"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab999150c4dc37ce4cbc4390b847f39fb"><td class="memItemLeft" align="right" valign="top"><a id="ab999150c4dc37ce4cbc4390b847f39fb" name="ab999150c4dc37ce4cbc4390b847f39fb"></a>
int </td><td class="memItemRight" valign="bottom"><b>peerAt</b> (int, <a class="el" href="struct_r_t_binding_end.html">RTBindingEnd</a> &)</td></tr>
<tr class="separator:ab999150c4dc37ce4cbc4390b847f39fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae12e8428f1305054a5ddf074f19b595a"><td class="memItemLeft" align="right" valign="top"><a id="ae12e8428f1305054a5ddf074f19b595a" name="ae12e8428f1305054a5ddf074f19b595a"></a>
void </td><td class="memItemRight" valign="bottom"><b>unbindAt</b> (int, <a class="el" href="class_r_t_controller.html">RTController</a> *)</td></tr>
<tr class="separator:ae12e8428f1305054a5ddf074f19b595a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7adb291e96c24590673c557299d052e"><td class="memItemLeft" align="right" valign="top"><a id="aa7adb291e96c24590673c557299d052e" name="aa7adb291e96c24590673c557299d052e"></a>
void </td><td class="memItemRight" valign="bottom"><b>notifyInit</b> (<a class="el" href="class_r_t_controller.html">RTController</a> *)</td></tr>
<tr class="separator:aa7adb291e96c24590673c557299d052e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2536ee9af988c7bebd23c626cb3f4898"><td class="memItemLeft" align="right" valign="top"><a id="a2536ee9af988c7bebd23c626cb3f4898" name="a2536ee9af988c7bebd23c626cb3f4898"></a>
void </td><td class="memItemRight" valign="bottom"><b>notifyBoundAt</b> (int, <a class="el" href="class_r_t_controller.html">RTController</a> *)</td></tr>
<tr class="separator:a2536ee9af988c7bebd23c626cb3f4898"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a6f65fa7d7adfc3c4f62b1c5d2b276cde"><td class="memItemLeft" align="right" valign="top"><a id="a6f65fa7d7adfc3c4f62b1c5d2b276cde" name="a6f65fa7d7adfc3c4f62b1c5d2b276cde"></a>
struct </td><td class="memItemRight" valign="bottom"><b>End</b></td></tr>
<tr class="separator:a6f65fa7d7adfc3c4f62b1c5d2b276cde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa644bc916a7ca31a4149961f3ad64ff6"><td class="memItemLeft" align="right" valign="top"><a id="aa644bc916a7ca31a4149961f3ad64ff6" name="aa644bc916a7ca31a4149961f3ad64ff6"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTActor</b></td></tr>
<tr class="separator:aa644bc916a7ca31a4149961f3ad64ff6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f686b54c837122ffe208c46806481ea"><td class="memItemLeft" align="right" valign="top"><a id="a8f686b54c837122ffe208c46806481ea" name="a8f686b54c837122ffe208c46806481ea"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTActorProbe</b></td></tr>
<tr class="separator:a8f686b54c837122ffe208c46806481ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a632282972b0b5f6cd394a261964435e2"><td class="memItemLeft" align="right" valign="top"><a id="a632282972b0b5f6cd394a261964435e2" name="a632282972b0b5f6cd394a261964435e2"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTDebugger</b></td></tr>
<tr class="separator:a632282972b0b5f6cd394a261964435e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1314ca45caee52459c16d339938aa90b"><td class="memItemLeft" align="right" valign="top"><a id="a1314ca45caee52459c16d339938aa90b" name="a1314ca45caee52459c16d339938aa90b"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTLayerConnector</b></td></tr>
<tr class="separator:a1314ca45caee52459c16d339938aa90b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb07e7cbb1c57e72ceeaf81b915c3dae"><td class="memItemLeft" align="right" valign="top"><a id="adb07e7cbb1c57e72ceeaf81b915c3dae" name="adb07e7cbb1c57e72ceeaf81b915c3dae"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTTracer</b></td></tr>
<tr class="separator:adb07e7cbb1c57e72ceeaf81b915c3dae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7aab5956bf8c8d6ec8620c660113a9f"><td class="memItemLeft" align="right" valign="top"><a id="ad7aab5956bf8c8d6ec8620c660113a9f" name="ad7aab5956bf8c8d6ec8620c660113a9f"></a>
struct </td><td class="memItemRight" valign="bottom"><b>RTExceptionSignal</b></td></tr>
<tr class="separator:ad7aab5956bf8c8d6ec8620c660113a9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac281f18ff703e97842320e4bbc6f1bc3"><td class="memItemLeft" align="right" valign="top"><a id="ac281f18ff703e97842320e4bbc6f1bc3" name="ac281f18ff703e97842320e4bbc6f1bc3"></a>
struct </td><td class="memItemRight" valign="bottom"><b>RTInSignal</b></td></tr>
<tr class="separator:ac281f18ff703e97842320e4bbc6f1bc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dc35f44acec83a764bca88fe399028f"><td class="memItemLeft" align="right" valign="top"><a id="a5dc35f44acec83a764bca88fe399028f" name="a5dc35f44acec83a764bca88fe399028f"></a>
struct </td><td class="memItemRight" valign="bottom"><b>RTOutSignal</b></td></tr>
<tr class="separator:a5dc35f44acec83a764bca88fe399028f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab242a96be7ae97f15d5f21caa79da27d"><td class="memItemLeft" align="right" valign="top"><a id="ab242a96be7ae97f15d5f21caa79da27d" name="ab242a96be7ae97f15d5f21caa79da27d"></a>
struct </td><td class="memItemRight" valign="bottom"><b>RTSymmetricSignal</b></td></tr>
<tr class="separator:ab242a96be7ae97f15d5f21caa79da27d"><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 general capsule port typed by a protocol which determines the set of events that can be sent to and received by the port. </p>
<p>All specific protocols inherit from <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>, which means that the functions of this class can be called on any capsule port regardless of which protocol it is typed by. For all protocols defined in the application two subclasses of <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> are generated; one for each direction of communication using the events defined in the protocol. For a protocol X these subclasses are X::Base and X::Conjugate. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a56b78477128d033d1e1f4c797ef0caf6" name="a56b78477128d033d1e1f4c797ef0caf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56b78477128d033d1e1f4c797ef0caf6">◆ </a></span>bindingNotification()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTProtocol::bindingNotification </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>on_off</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn on or off binding notifications for this port. </p>
<p>When such notifications are turned on the port will receive the 'rtBound' and 'rtUnbound' messages each time a port instance gets connected to (bound) or disconnected from (unbound) a remote port instance. Note that no messages are sent for port instances that are bound prior to the call of this function. Also note that turning off binding notifications will not purge 'rtBound' and 'rtUnbound' messages that have already been queued. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">on_off</td><td>Set to 0 to turn off binding notifications for the port, and 1 (or any non-zero value) to turn them on. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adcb72eaea84b5ce02ebf4393d1768c21" name="adcb72eaea84b5ce02ebf4393d1768c21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcb72eaea84b5ce02ebf4393d1768c21">◆ </a></span>bindingNotificationRequested()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::bindingNotificationRequested </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if binding notifications are currently enabled for the port. </p>
<dl class="section return"><dt>Returns</dt><dd>1 if binding notifications have been turned on for this port, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a02358053723895c6423f73ec97d5fe24" name="a02358053723895c6423f73ec97d5fe24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02358053723895c6423f73ec97d5fe24">◆ </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> * RTProtocol::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>Get the context of the capsule that owns this port. </p>
<dl class="section return"><dt>Returns</dt><dd>The controller that runs the capsule instance to which this port belongs. </dd></dl>
</div>
</div>
<a id="a0d430e4ee11ed7438cb77d60faaba91f" name="a0d430e4ee11ed7438cb77d60faaba91f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d430e4ee11ed7438cb77d60faaba91f">◆ </a></span>defaultLayerName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTProtocol::defaultLayerName </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 default registration name for the port. </p>
<dl class="section return"><dt>Returns</dt><dd>The default registration name specified for the unwired port. This corresponds to the port property "Registration Override". </dd></dl>
</div>
</div>
<a id="aed18e2ea1cd805cf48df1c4dda1a56df" name="aed18e2ea1cd805cf48df1c4dda1a56df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed18e2ea1cd805cf48df1c4dda1a56df">◆ </a></span>deregister()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::deregister </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deregister an unwired port (either an SAP or SPP). </p>
<p>This is equivalent of calling <a class="el" href="class_r_t_protocol.html#a5e580b53c346f4a623b2864fcc8e344b" title="Deregister an unwired port (SAP).">deregisterSAP()</a> or <a class="el" href="class_r_t_protocol.html#aa71503e6d0ec280fa95ea813db29f41e" title="Deregister an unwired port (SPP).">deregisterSPP()</a>. </p><dl class="section return"><dt>Returns</dt><dd>1 if deregistration was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a5e580b53c346f4a623b2864fcc8e344b" name="a5e580b53c346f4a623b2864fcc8e344b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e580b53c346f4a623b2864fcc8e344b">◆ </a></span>deregisterSAP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::deregisterSAP </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deregister an unwired port (SAP). </p>
<p>If the port is currently connected to an SPP, the connection will be terminated. </p><dl class="section return"><dt>Returns</dt><dd>1 if deregistration was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="aa71503e6d0ec280fa95ea813db29f41e" name="aa71503e6d0ec280fa95ea813db29f41e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa71503e6d0ec280fa95ea813db29f41e">◆ </a></span>deregisterSPP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::deregisterSPP </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deregister an unwired port (SPP). </p>
<p>If the port is currently connected to SPPs, all those connections will be terminated. </p><dl class="section return"><dt>Returns</dt><dd>1 if deregistration was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a7569d7ad23ba8a40313ebc91aee92cc4" name="a7569d7ad23ba8a40313ebc91aee92cc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7569d7ad23ba8a40313ebc91aee92cc4">◆ </a></span>getId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::getId </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 id of the port. </p>
<dl class="section return"><dt>Returns</dt><dd>An id that is unique among all the ports of the owner capsule. </dd></dl>
</div>
</div>
<a id="ab13996e31840891910920c9880670edf" name="ab13996e31840891910920c9880670edf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab13996e31840891910920c9880670edf">◆ </a></span>getInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_r_t_port_descriptor.html">RTPortDescriptor</a> * RTProtocol::getInfo </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 information about a port. </p>
<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="struct_r_t_port_descriptor.html">RTPortDescriptor</a> object that contains information about the port. This information is static and is constituted by properties of the port definition, such as the name of the port. </dd></dl>
</div>
</div>
<a id="aee715e514169058cc688ef652ec41f83" name="aee715e514169058cc688ef652ec41f83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee715e514169058cc688ef652ec41f83">◆ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTProtocol::getName </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 name of the port. </p>
<dl class="section return"><dt>Returns</dt><dd>The name of the port. </dd></dl>
</div>
</div>
<a id="af6545f036888aeacaab36096f4e876ff" name="af6545f036888aeacaab36096f4e876ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6545f036888aeacaab36096f4e876ff">◆ </a></span>getOwner()</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> * RTProtocol::getOwner </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 owner capsule to which the port belongs. </p>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_r_t_actor.html" title="An instance of this class represents a capsule instance.">RTActor</a> representing the capsule to which this port belongs. </dd></dl>
</div>
</div>
<a id="a4759bbdb8fcd25545f463a9caf15961d" name="a4759bbdb8fcd25545f463a9caf15961d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4759bbdb8fcd25545f463a9caf15961d">◆ </a></span>getRegisteredName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * RTProtocol::getRegisteredName </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 registration name of the port. </p>
<dl class="section return"><dt>Returns</dt><dd>The name under which the unwired port is currently registered with the layer service. </dd></dl>
</div>
</div>
<a id="a7f251e8160558cf5ae295a59cfab1202" name="a7f251e8160558cf5ae295a59cfab1202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f251e8160558cf5ae295a59cfab1202">◆ </a></span>indexTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::indexTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_actor.html">RTActor</a> * </td>
<td class="paramname"><em>capsule</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if there exists a port instance currently connected to a port instance owned by a certain capsule instance. </p>
<p>If so, the index of the first found matching port instance is returned. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">capsule</td><td>Capsule instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The smallest index found for a port instance connected to another port instance that is owned by the specified capsule instance. -1 if no such port instance exists. </dd></dl>
</div>
</div>
<a id="a4fba0c4760d48842f11d891b416f3ef9" name="a4fba0c4760d48842f11d891b416f3ef9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fba0c4760d48842f11d891b416f3ef9">◆ </a></span>invoke()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_message.html">RTMessage</a> * </td>
<td class="paramname"><em>replyBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>implicitReply</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke an event on the port. </p>
<p>Normally you should not call this function directly, but instead call RTOutsignal::invoke() because it will provide most of the needed parameters for you. However, if you need to programatically invoke on a general port based on descriptor info this function can be used. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">replyBuffer</td><td>A caller-supplied message object that stores the reply message(s) resulting from the invoke. The caller is responsible for allocating and deleting the message(s) when they are no longer required. To verify that a returned message is valid call <a class="el" href="class_r_t_message.html#af6227985d9f163c7fc83a8d8a27fbaf2" title="A message is considered valid as soon as its protocol event (i.e.">RTMessage::isValid()</a> once the invoke returns. </td></tr>
<tr><td class="paramname">signal</td><td>The id of the event to invoke </td></tr>
<tr><td class="paramname">data</td><td>Data object to pass with the invoke </td></tr>
<tr><td class="paramname">type</td><td>Type descriptor describing the data object </td></tr>
<tr><td class="paramname">implicitReply</td><td>Whether it should be allowed for the receiver to not make a reply call if no data needs to be passed back to the sender. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the invoke was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="aa3c5eae9cdc5ab117f9332b41964bcf7" name="aa3c5eae9cdc5ab117f9332b41964bcf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3c5eae9cdc5ab117f9332b41964bcf7">◆ </a></span>invokeAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::invokeAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_r_t_message.html">RTMessage</a> * </td>
<td class="paramname"><em>replyBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>implicitReply</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke an event on a replicated port at a specified index. </p>
<p>Normally you should not call this function directly, but instead call RTOutsignal::invokeAt() because it will provide most of the needed parameters for you. However, if you need to programatically invoke on a general port based on descriptor info this function can be used. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The 0-based index of the port instance within the port on which to perform the invoke (0 <= index < <a class="el" href="class_r_t_protocol.html#a1bf5a22f8232f12cd60a969523946889" title="Get the size of the port.">size()</a>) </td></tr>
<tr><td class="paramname">replyBuffer</td><td>A caller-supplied message object that stores the reply message(s) resulting from the invoke. The caller is responsible for allocating and deleting the message(s) when they are no longer required. To verify that a returned message is valid call <a class="el" href="class_r_t_message.html#af6227985d9f163c7fc83a8d8a27fbaf2" title="A message is considered valid as soon as its protocol event (i.e.">RTMessage::isValid()</a> once the invoke returns. </td></tr>
<tr><td class="paramname">signal</td><td>The id of the event to invoke </td></tr>
<tr><td class="paramname">data</td><td>Data object to pass with the invoke </td></tr>
<tr><td class="paramname">type</td><td>Type descriptor describing the data object </td></tr>
<tr><td class="paramname">implicitReply</td><td>Whether it should be allowed for the receiver to not make a reply call if no data needs to be passed back to the sender. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the invoke was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="ae364dd3d1d73dda4146f77cadd708d53" name="ae364dd3d1d73dda4146f77cadd708d53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae364dd3d1d73dda4146f77cadd708d53">◆ </a></span>isBoundAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::isBoundAt </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>Determine if a port instance is currently connected to another port instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>0-based index of the port instance within the port (0 <= index < <a class="el" href="class_r_t_protocol.html#a1bf5a22f8232f12cd60a969523946889" title="Get the size of the port.">size()</a>) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the port instance at the specified index is connected to another port instance. 0 if it is not connected. </dd></dl>
</div>
</div>
<a id="ab2765cfbbe1295b939a47ea0b9be991c" name="ab2765cfbbe1295b939a47ea0b9be991c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2765cfbbe1295b939a47ea0b9be991c">◆ </a></span>isIndexTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::isIndexTo </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_r_t_actor.html">RTActor</a> * </td>
<td class="paramname"><em>capsule</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if a port instance is currently connected to a port instance owned by a certain capsule instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>0-based index of the port instance within the port (0 <= index < <a class="el" href="class_r_t_protocol.html#a1bf5a22f8232f12cd60a969523946889" title="Get the size of the port.">size()</a>) </td></tr>
<tr><td class="paramname">capsule</td><td>Capsule instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the port instance at the specified index is connected to another port instance that is owned by the specified capsule instance. 0 if not. </dd></dl>
</div>
</div>
<a id="a2c47b94180b9f30bf3e25bcfa55fe0d0" name="a2c47b94180b9f30bf3e25bcfa55fe0d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c47b94180b9f30bf3e25bcfa55fe0d0">◆ </a></span>isRegistered()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::isRegistered </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if the port is currently registered with the layer service or not. </p>
<dl class="section return"><dt>Returns</dt><dd>1 if the unwired port is currently registered with the layer service, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a9150bfbf17314443453d429c8f113553" name="a9150bfbf17314443453d429c8f113553"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9150bfbf17314443453d429c8f113553">◆ </a></span>purge()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::purge </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Empty the defer queue of all port instances without recalling any deferred message. </p>
<p>To delete deferred messages for one port instance only, use <a class="el" href="class_r_t_protocol.html#a2703f40abf6a8df9bbd730215c8c23e7" title="Empty the defer queue of a specified port instance without recalling any deferred message.">purgeAt()</a>. </p><dl class="section return"><dt>Returns</dt><dd>The number of messages deleted from the defer queue. </dd></dl>
</div>
</div>
<a id="a2703f40abf6a8df9bbd730215c8c23e7" name="a2703f40abf6a8df9bbd730215c8c23e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2703f40abf6a8df9bbd730215c8c23e7">◆ </a></span>purgeAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::purgeAt </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>Empty the defer queue of a specified port instance without recalling any deferred message. </p>
<p>To delete deferred messages for all port instances, use <a class="el" href="class_r_t_protocol.html#a9150bfbf17314443453d429c8f113553" title="Empty the defer queue of all port instances without recalling any deferred message.">purge()</a>. </p><dl class="section return"><dt>Returns</dt><dd>The number of messages deleted from the defer queue. </dd></dl>
</div>
</div>
<a id="a775cee0be2a2cfd90b58b2cc3ec0f86e" name="a775cee0be2a2cfd90b58b2cc3ec0f86e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a775cee0be2a2cfd90b58b2cc3ec0f86e">◆ </a></span>recall()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::recall </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall a message from the defer queue and insert it at the back of the controller's message queue (after other queued messages). </p>
<p>The recalled message can be for any port instance. </p><dl class="section return"><dt>Returns</dt><dd>The number of messages recalled from the defer queue (i.e. either 1 or 0). </dd></dl>
</div>
</div>
<a id="afc92df9cafd7c04372916ee4ef6c5c3c" name="afc92df9cafd7c04372916ee4ef6c5c3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc92df9cafd7c04372916ee4ef6c5c3c">◆ </a></span>recallAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::recallAll </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall all messages from the defer queue and insert them at the back of the controller's message queue (after other queued messages). </p>
<p>The recalled messages can be for any port instance. </p><dl class="section return"><dt>Returns</dt><dd>The number of messages recalled from the defer queue. </dd></dl>
</div>
</div>
<a id="a627afae9906e70cea7fc182bfb5f7cb8" name="a627afae9906e70cea7fc182bfb5f7cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a627afae9906e70cea7fc182bfb5f7cb8">◆ </a></span>recallAllAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::recallAllAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>front</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall all messages from the defer queue and insert them in the controller's message queue. </p>
<p>By default the recalled messages are inserted at the back of the message queue. The recalled messages must be for the port instance at the specified index. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Index of the port instance for which to recall the messages. </td></tr>
<tr><td class="paramname">front</td><td>Set this parameter to 1 to insert the recalled messages at the front of the message queue instead of at the back which is the default behavior. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of messages recalled from the defer queue. </dd></dl>
</div>
</div>
<a id="a70638165fd32d634670c2c2f174a3c3b" name="a70638165fd32d634670c2c2f174a3c3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70638165fd32d634670c2c2f174a3c3b">◆ </a></span>recallAllFront()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::recallAllFront </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall all messages from the defer queue and insert them at the front of the controller's message queue (before other queued messages). </p>
<p>The recalled messages can be for any port instance. </p><dl class="section return"><dt>Returns</dt><dd>The number of messages recalled from the defer queue. </dd></dl>
</div>
</div>
<a id="a9f7cfcb42423fc78b60f48f7220c0779" name="a9f7cfcb42423fc78b60f48f7220c0779"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f7cfcb42423fc78b60f48f7220c0779">◆ </a></span>recallAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::recallAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>front</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall a message from the defer queue and insert it in the controller's message queue. </p>
<p>By default the recalled message is inserted at the back of the message queue. The recalled message must be for the port instance at the specified index. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Index of the port instance for which to recall a message. </td></tr>
<tr><td class="paramname">front</td><td>Set this parameter to 1 to insert the recalled message at the front of the message queue instead of at the back which is the default behavior. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of messages recalled from the defer queue (i.e. either 1 or 0). </dd></dl>
</div>
</div>
<a id="ae611db0412a09055815ac9717394f303" name="ae611db0412a09055815ac9717394f303"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae611db0412a09055815ac9717394f303">◆ </a></span>recallFront()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTProtocol::recallFront </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recall a message from the defer queue and insert it at the front of the controller's message queue (before other queued messages). </p>