C++ TargetRTS
Loading...
Searching...
No Matches
RTOutSignal.h
1/*
2 * Licensed Materials - Property of HCL and/or IBM
3 * Copyright HCL Technologies Ltd. 2016, 2021. All Rights Reserved.
4 * Copyright IBM Corporation 1999, 2016. All Rights Reserved.
5 *
6 * U.S. Government Users Restricted Rights - Use, duplication or
7 * disclosure restricted by GSA ADP Schedule.
8 */
9
10#ifndef __RTOutSignal_h__
11#define __RTOutSignal_h__ included
12
13#ifdef PRAGMA
14#pragma interface
15#endif
16
17#ifndef __RTPriority_h__
18#include <RTPriority.h>
19#endif
20
21class RTMessage;
22struct RTObject_class;
23class RTProtocol;
24
25// It is common to make temporaries of this struct.
26//lint -esym(1901,RTOutSignal)
27
36{
37 // general application use
38
49 RTS_INLINE int invoke ( RTMessage * replyBuffers );
50
63 RTS_INLINE int invokeAt( int index, RTMessage * replyBuffer );
64
71 RTS_INLINE int invoke ();
72
80 RTS_INLINE int invokeAt( int index);
81
87 RTS_INLINE int reply ( void );
88
96 RTS_INLINE int send ( int priority = General );
97
107 RTS_INLINE int sendAt ( int index, int priority = General );
108
109 // for use by run-time services library only
110 RTS_INLINE RTOutSignal( RTProtocol * port,
111 int signal,
112 const void * data,
113 const RTObject_class * type,
114 bool rValueRef = false);
115
118
121
123 const void * _data;
124
127
134
135}; //lint !e1712
136
137#if RTS_INLINES
138#include <RTOutSignal.inl>
139#endif
140
141#endif // __RTOutSignal_h__
Represents a message used for communication between capsule instances.
Definition: RTMessage.h:33
Represents a general capsule port typed by a protocol which determines the set of events that can be ...
Definition: RTProtocol.h:50
A type descriptor providing information about a type.
Definition: RTObject_class.h:64
Provides the API for working with messages of a certain protocol event to be sent on a certain port,...
Definition: RTOutSignal.h:36
bool _rValueRef
The data object for the message to send is by default copied.
Definition: RTOutSignal.h:133
int sendAt(int index, int priority=General)
Send a message of the specified protocol event and on the specified port (optionally passing a specif...
Definition: RTOutSignal.inl:72
const RTObject_class * _type
The type descriptor of the data object, or NULL in case the protocol event has no data.
Definition: RTOutSignal.h:126
int invoke()
Invoke a message of the specified protocol event and on the specified port (optionally passing a spec...
Definition: RTOutSignal.inl:50
int reply(void)
Make a reply to respond to an invoke.
Definition: RTOutSignal.inl:62
int _signal
The signal id of the protocol event for the message to send.
Definition: RTOutSignal.h:120
RTProtocol * _port
The port to which the message should be sent.
Definition: RTOutSignal.h:117
int invokeAt(int index, RTMessage *replyBuffer)
Invoke a message of the specified protocol event and on the specified port (optionally passing a spec...
Definition: RTOutSignal.inl:45
int send(int priority=General)
Send a message of the specified protocol event and on the specified port (optionally passing a specif...
Definition: RTOutSignal.inl:67
const void * _data
The data object to pass with the message, or NULL in case the protocol event has no data.
Definition: RTOutSignal.h:123