PLCnext API Documentation
21.0.0.35466
|
This class implements a ipc event for the bidirectional exchange of realtime events. More...
#include <RtEvent.hpp>
Public Types | |
typedef RtEventManagerSharedData::Ptr< RtEvent > | Ptr |
Shared pointer type of RtEvent. More... | |
Public Member Functions | |
RtEvent (const String &nameArg) | |
Constructs an RtEvent instance. More... | |
RtEvent (const RtEvent &arg)=delete | |
Copy constructor. More... | |
RtEvent & | operator= (const RtEvent &arg)=delete |
Assignment operator. More... | |
~RtEvent (void)=default | |
Destructs this instance and frees all resources. More... | |
String | GetName () |
Returns name identifier of the event. More... | |
void | Set (void) |
Signals the event. More... | |
void | Done (void) |
Signals that the event was processed. More... | |
bool | WaitOne (unsigned long timeoutArg=0, bool setSubscriberReadyArg=true) |
Waits blocking on signal of the event. More... | |
bool | SetAndWaitOne (unsigned long timeoutArg=0) |
Fires the event and waits blocking on that the event has been processed. More... | |
void | SetSubscriberReady (bool isSubscriberReadyArg=true) |
Sets the state of the event subscriber. More... | |
bool | IsSubscriberReady (void) |
Returns state of the event subscriber. More... | |
This class implements a ipc event for the bidirectional exchange of realtime events.
Shared pointer type of RtEvent.
|
delete |
Copy constructor.
|
default |
Destructs this instance and frees all resources.
void Arp::Plc::Commons::Esm::RtEvent::Done | ( | void | ) |
Signals that the event was processed.
|
inline |
Returns name identifier of the event.
|
inline |
Returns state of the event subscriber.
Assignment operator.
void Arp::Plc::Commons::Esm::RtEvent::Set | ( | void | ) |
Signals the event.
bool Arp::Plc::Commons::Esm::RtEvent::SetAndWaitOne | ( | unsigned long | timeoutArg = 0 | ) |
Fires the event and waits blocking on that the event has been processed.
timeoutArg | Timeout in milliseconds to wait for the event to become processed. If the value is set to 0 (default) the calling thread will wait infinitly or until the event is set. |
setSubscriberReadyArg | If the parameter true, the method sets the subscriber ready implicit. Default is this parameter true. |
|
inline |
Sets the state of the event subscriber.
isSubscriberReadyArg | The state of the event subscriber. "true" marks the event subscriber is ready. |
bool Arp::Plc::Commons::Esm::RtEvent::WaitOne | ( | unsigned long | timeoutArg = 0 , |
bool | setSubscriberReadyArg = true |
||
) |
Waits blocking on signal of the event.
timeoutArg | Timeout in milliseconds to wait for the event to become signaled. If the value is set to 0 (default) the calling thread will wait infinitly or until the event is set. |