EventNotifier
-
class HPS::EventNotifier : public HPS::Object
The EventNotifier class is a smart pointer that is associated with an event object. It is a special type of control that is used for synchronizing with an event’s completion.
Public Functions
-
virtual void Assign(EventNotifier const &in_that)
Share the underlying smart-pointer of the EventNotifier source.
- Parameters
in_that – The EventNotifier source of the assignment.
-
EventNotifier()
The default constructor creates an EventNotifier object not associated with any event.
-
EventNotifier(EventNotifier &&in_that)
The move constructor creates an EventNotifier by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to an EventNotifier to take the impl from.
-
EventNotifier(EventNotifier const &in_that)
The copy constructor creates a new EventNotifier that is associated with the same event as the source EventNotifier.
- Parameters
in_that – The source EventNotifier to copy.
-
inline virtual HPS::Type ObjectType() const
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
The declared type of the object in question, which may differ from the true, underlying type.
-
EventNotifier &operator=(EventNotifier &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this Control thereby avoiding a copy.
-
EventNotifier &operator=(EventNotifier const &in_that)
Share the underlying smart-pointer of the EventNotifier source.
- Parameters
in_that – The EventNotifier source of the assignment.
- Returns
A reference to this EventNotifier.
-
Event::Status Status() const
Query the status of the event for this notifier.
- Returns
The current state of the event.
-
EventNotifier const &Wait() const
Cause this thread to sleep until the event for this notifier has been handled.
- Returns
A reference to this EventNotifier.
-
virtual ~EventNotifier()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::EventNotifier
-
virtual void Assign(EventNotifier const &in_that)
