-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathstruct_r_t_out_signal.html
More file actions
364 lines (336 loc) · 23.8 KB
/
struct_r_t_out_signal.html
File metadata and controls
364 lines (336 loc) · 23.8 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
<!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: RTOutSignal Struct 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-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="struct_r_t_out_signal-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RTOutSignal Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provides the API for working with messages of a certain protocol event to be sent on a certain port, optionally carrying a data object.
<a href="struct_r_t_out_signal.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_r_t_out_signal_8h_source.html">RTOutSignal.h</a>></code></p>
<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:ab283205cbde008ca72c149f8b5f338f5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#ab283205cbde008ca72c149f8b5f338f5">invoke</a> (<a class="el" href="class_r_t_message.html">RTMessage</a> *replyBuffers)</td></tr>
<tr class="memdesc:ab283205cbde008ca72c149f8b5f338f5"><td class="mdescLeft"> </td><td class="mdescRight">Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). <br /></td></tr>
<tr class="separator:ab283205cbde008ca72c149f8b5f338f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf0e2f6301cccb30529f4bcaef665bdd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#aaf0e2f6301cccb30529f4bcaef665bdd">invokeAt</a> (int index, <a class="el" href="class_r_t_message.html">RTMessage</a> *replyBuffer)</td></tr>
<tr class="memdesc:aaf0e2f6301cccb30529f4bcaef665bdd"><td class="mdescLeft"> </td><td class="mdescRight">Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). <br /></td></tr>
<tr class="separator:aaf0e2f6301cccb30529f4bcaef665bdd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ac9b6b2ffea9ae2b0f8154fb2e6e916"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#a5ac9b6b2ffea9ae2b0f8154fb2e6e916">invoke</a> ()</td></tr>
<tr class="memdesc:a5ac9b6b2ffea9ae2b0f8154fb2e6e916"><td class="mdescLeft"> </td><td class="mdescRight">Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). <br /></td></tr>
<tr class="separator:a5ac9b6b2ffea9ae2b0f8154fb2e6e916"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace8c883519f793bd6ab240c048d89a67"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#ace8c883519f793bd6ab240c048d89a67">invokeAt</a> (int index)</td></tr>
<tr class="memdesc:ace8c883519f793bd6ab240c048d89a67"><td class="mdescLeft"> </td><td class="mdescRight">Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). <br /></td></tr>
<tr class="separator:ace8c883519f793bd6ab240c048d89a67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a4587627631ba4352878f085984cde8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#a8a4587627631ba4352878f085984cde8">reply</a> (void)</td></tr>
<tr class="memdesc:a8a4587627631ba4352878f085984cde8"><td class="mdescLeft"> </td><td class="mdescRight">Make a reply to respond to an invoke. <br /></td></tr>
<tr class="separator:a8a4587627631ba4352878f085984cde8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba74f34e912b50eb355fa4f763bc3260"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#aba74f34e912b50eb355fa4f763bc3260">send</a> (int priority=General)</td></tr>
<tr class="memdesc:aba74f34e912b50eb355fa4f763bc3260"><td class="mdescLeft"> </td><td class="mdescRight">Send a message of the specified protocol event and on the specified port (optionally passing a specified data object with the sent message). <br /></td></tr>
<tr class="separator:aba74f34e912b50eb355fa4f763bc3260"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a138f65ee16a9e8ffb79d5cfa2985b675"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#a138f65ee16a9e8ffb79d5cfa2985b675">sendAt</a> (int index, int priority=General)</td></tr>
<tr class="memdesc:a138f65ee16a9e8ffb79d5cfa2985b675"><td class="mdescLeft"> </td><td class="mdescRight">Send a message of the specified protocol event and on the specified port (optionally passing a specified data object with the sent message). <br /></td></tr>
<tr class="separator:a138f65ee16a9e8ffb79d5cfa2985b675"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4a00687165a72e76c34a23f2a018049"><td class="memItemLeft" align="right" valign="top"><a id="ae4a00687165a72e76c34a23f2a018049" name="ae4a00687165a72e76c34a23f2a018049"></a>
 </td><td class="memItemRight" valign="bottom"><b>RTOutSignal</b> (<a class="el" href="class_r_t_protocol.html">RTProtocol</a> *port, int signal, const void *data, const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> *type, bool rValueRef=false)</td></tr>
<tr class="separator:ae4a00687165a72e76c34a23f2a018049"><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:a992821ad7cf479fd2b3cdf10b2359767"><td class="memItemLeft" align="right" valign="top"><a id="a992821ad7cf479fd2b3cdf10b2359767" name="a992821ad7cf479fd2b3cdf10b2359767"></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="memdesc:a992821ad7cf479fd2b3cdf10b2359767"><td class="mdescLeft"> </td><td class="mdescRight">The port to which the message should be sent. <br /></td></tr>
<tr class="separator:a992821ad7cf479fd2b3cdf10b2359767"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95687c21161ca0d60dbade2bf23bab99"><td class="memItemLeft" align="right" valign="top"><a id="a95687c21161ca0d60dbade2bf23bab99" name="a95687c21161ca0d60dbade2bf23bab99"></a>
int </td><td class="memItemRight" valign="bottom"><b>_signal</b></td></tr>
<tr class="memdesc:a95687c21161ca0d60dbade2bf23bab99"><td class="mdescLeft"> </td><td class="mdescRight">The signal id of the protocol event for the message to send. <br /></td></tr>
<tr class="separator:a95687c21161ca0d60dbade2bf23bab99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac86ce91060d478ea913f3e1ba72cb4ca"><td class="memItemLeft" align="right" valign="top"><a id="ac86ce91060d478ea913f3e1ba72cb4ca" name="ac86ce91060d478ea913f3e1ba72cb4ca"></a>
const void * </td><td class="memItemRight" valign="bottom"><b>_data</b></td></tr>
<tr class="memdesc:ac86ce91060d478ea913f3e1ba72cb4ca"><td class="mdescLeft"> </td><td class="mdescRight">The data object to pass with the message, or NULL in case the protocol event has no data. <br /></td></tr>
<tr class="separator:ac86ce91060d478ea913f3e1ba72cb4ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2015547641ea53fa502ca2e0c500e7f7"><td class="memItemLeft" align="right" valign="top"><a id="a2015547641ea53fa502ca2e0c500e7f7" name="a2015547641ea53fa502ca2e0c500e7f7"></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="memdesc:a2015547641ea53fa502ca2e0c500e7f7"><td class="mdescLeft"> </td><td class="mdescRight">The type descriptor of the data object, or NULL in case the protocol event has no data. <br /></td></tr>
<tr class="separator:a2015547641ea53fa502ca2e0c500e7f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a023066bd6e5fb27b77bad02a7dbaa7af"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_out_signal.html#a023066bd6e5fb27b77bad02a7dbaa7af">_rValueRef</a></td></tr>
<tr class="memdesc:a023066bd6e5fb27b77bad02a7dbaa7af"><td class="mdescLeft"> </td><td class="mdescRight">The data object for the message to send is by default copied. <br /></td></tr>
<tr class="separator:a023066bd6e5fb27b77bad02a7dbaa7af"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides the API for working with messages of a certain protocol event to be sent on a certain port, optionally carrying a data object. </p>
<p>Each protocol event is translated to a function on a class that inherits 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>, and such a function returns an <a class="el" href="struct_r_t_out_signal.html" title="Provides the API for working with messages of a certain protocol event to be sent on a certain port,...">RTOutSignal</a> object that is bound to a specific port and protocol event (and optionally also a data object). This is true if the protocol event is outgoing, or if it is incoming and the port is conjugated. Call functions on that object to send or invoke such messages, or to make a reply to respond to an invoke. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5ac9b6b2ffea9ae2b0f8154fb2e6e916" name="a5ac9b6b2ffea9ae2b0f8154fb2e6e916"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ac9b6b2ffea9ae2b0f8154fb2e6e916">◆ </a></span>invoke() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::invoke </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). </p>
<p>No reply data can be passed back to the caller and the callee does not have to make an explicit reply (it is implicitly made when completing the invoke). </p><dl class="section return"><dt>Returns</dt><dd>1 if the invoke was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="ab283205cbde008ca72c149f8b5f338f5" name="ab283205cbde008ca72c149f8b5f338f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab283205cbde008ca72c149f8b5f338f5">◆ </a></span>invoke() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_message.html">RTMessage</a> * </td>
<td class="paramname"><em>replyBuffers</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">replyBuffers</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. The callee must make an explicit reply call even if no data needs to be passed back to the caller. </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="ace8c883519f793bd6ab240c048d89a67" name="ace8c883519f793bd6ab240c048d89a67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace8c883519f793bd6ab240c048d89a67">◆ </a></span>invokeAt() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::invokeAt </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>Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). </p>
<p>The message is invoked at the specified port index. No reply data can be passed back to the caller and the callee does not have to make an explicit reply (it is implicitly made when completing the invoke). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Port index (0-based). </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="aaf0e2f6301cccb30529f4bcaef665bdd" name="aaf0e2f6301cccb30529f4bcaef665bdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf0e2f6301cccb30529f4bcaef665bdd">◆ </a></span>invokeAt() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke a message of the specified protocol event and on the specified port (optionally passing a specified data object with the invoke message). </p>
<p>The message is invoked at the specified port index. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Port index (0-based). </td></tr>
<tr><td class="paramdir"></td><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. The callee must make an explicit reply call even if no data needs to be passed back to the caller. </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="a8a4587627631ba4352878f085984cde8" name="a8a4587627631ba4352878f085984cde8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a4587627631ba4352878f085984cde8">◆ </a></span>reply()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::reply </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a reply to respond to an invoke. </p>
<p>The reply message is of the specified protocol event and is made on the specified port (optionally passing a specified data object with the reply message). </p><dl class="section return"><dt>Returns</dt><dd>1 if the reply was successful, 0 otherwise. </dd></dl>
</div>
</div>
<a id="aba74f34e912b50eb355fa4f763bc3260" name="aba74f34e912b50eb355fa4f763bc3260"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba74f34e912b50eb355fa4f763bc3260">◆ </a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::send </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>priority</em> = <code>General</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a message of the specified protocol event and on the specified port (optionally passing a specified data object with the sent message). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">priority</td><td>The priority at which the message should be sent. A message priority is interpreted as its relative importance with respect to all other unprocessed messages on a thread. The priority evaluates to one of the defined global priority values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the message was successfully sent, 0 otherwise. </dd></dl>
</div>
</div>
<a id="a138f65ee16a9e8ffb79d5cfa2985b675" name="a138f65ee16a9e8ffb79d5cfa2985b675"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a138f65ee16a9e8ffb79d5cfa2985b675">◆ </a></span>sendAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTOutSignal::sendAt </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>priority</em> = <code>General</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a message of the specified protocol event and on the specified port (optionally passing a specified data object with the sent message). </p>
<p>The message is sent at the specified port index. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Port index (0-based). </td></tr>
<tr><td class="paramdir"></td><td class="paramname">priority</td><td>The priority at which the message should be sent. A message priority is interpreted as its relative importance with respect to all other unprocessed messages on a thread. The priority evaluates to one of the defined global priority values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the message was successfully sent, 0 otherwise. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a023066bd6e5fb27b77bad02a7dbaa7af" name="a023066bd6e5fb27b77bad02a7dbaa7af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a023066bd6e5fb27b77bad02a7dbaa7af">◆ </a></span>_rValueRef</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RTOutSignal::_rValueRef</td>
</tr>
</table>
</div><div class="memdoc">
<p>The data object for the message to send is by default copied. </p>
<p>Sometimes it may be better (for performance reasons) to instead move the data object. This is expressed by using an rvalue of the type when sending the event, for example: myPort.myEvent(std::move(data)).<a class="el" href="struct_r_t_out_signal.html#aba74f34e912b50eb355fa4f763bc3260" title="Send a message of the specified protocol event and on the specified port (optionally passing a specif...">send()</a>; If this is set to false (the default), the data will be copied, otherwise it will be moved. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="_r_t_out_signal_8h_source.html">RTOutSignal.h</a></li>
<li>RTOutSignal.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>