C++ TargetRTS
Loading...
Searching...
No Matches
RTInSignal.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 __RTInSignal_h__
11#define __RTInSignal_h__ included
12
13#ifdef PRAGMA
14#pragma interface
15#endif
16
17#ifndef __RTConfig_h__
18#include <RTConfig.h>
19#endif
20
21class RTProtocol;
22
23// It is common to make temporaries of this struct.
24//lint -esym(1901,RTInSignal)
25
34{
35 // general application use
36
42 RTS_INLINE int purge ( void );
43
50 RTS_INLINE int purgeAt ( int index );
51
60 RTS_INLINE int recall ( int front = 0 );
61
71 RTS_INLINE int recallAt ( int index, int front = 0 );
72
81 RTS_INLINE int recallAll ( int front = 0 );
82
92 RTS_INLINE int recallAllAt( int index, int front = 0 );
93
94 // for use by run-time services library only
95 RTS_INLINE RTInSignal( RTProtocol *, int );
96 RTS_INLINE ~RTInSignal( void );
97
100
103}; //lint !e1712
104
105#if RTS_INLINES
106#include <RTInSignal.inl>
107#endif
108
109#endif // __RTInSignal_h__
Represents a general capsule port typed by a protocol which determines the set of events that can be ...
Definition: RTProtocol.h:50
Provides the API for working with messages of a certain protocol event received on a certain port.
Definition: RTInSignal.h:34
int _signal
The signal id of the protocol event for the received message.
Definition: RTInSignal.h:102
RTProtocol * _port
The port on which the message is received.
Definition: RTInSignal.h:99
int recallAt(int index, int front=0)
Recall a message from the defer queue and insert it in the controller's message queue (either before ...
Definition: RTInSignal.inl:53
int recallAllAt(int index, int front=0)
Recall one or many messages from the defer queue and insert them in the controller's message queue (e...
Definition: RTInSignal.inl:63
int recallAll(int front=0)
Recall one or many messages from the defer queue and insert them in the controller's message queue (e...
Definition: RTInSignal.inl:58
int purge(void)
Remove from the defer queue all messages that match the receiver port and the signal id of the protoc...
Definition: RTInSignal.inl:38
int recall(int front=0)
Recall a message from the defer queue and insert it in the controller's message queue (either before ...
Definition: RTInSignal.inl:48
int purgeAt(int index)
Remove from the defer queue all messages that match the receiver port and the signal id of the protoc...
Definition: RTInSignal.inl:43