EventCanceler¶

class EventCanceler

An helper class used to cancel a running Event.

Functions¶

Name	Description
EventCanceler	Creates an uninitialized `EventCanceler`.
EventCanceler	Creates an `EventCanceler` which will abort * the given event once cancelled.
~EventCanceler	Destroys the event canceller and releases * the wrapped event instance.
Valid	Checks whether this `EventCanceler` has been initialized.
Cancel	Cancels and abort the wrapped `Event`.
GetEvent	Returns the `Event` wrapped by this `EventCanceler`.

void Cancel() const

Cancels and abort the wrapped Event.

EventCanceler()

Creates an uninitialized EventCanceler.

An uninitialized EventCanceler cannot be canceled.

explicit EventCanceler(EventInstance* event)

Creates an EventCanceler which will abort * the given event once cancelled.

[[nodiscard]] EventInstance* GetEvent() const

Returns the Event wrapped by this EventCanceler.

[[nodiscard]] bool Valid() const

Checks whether this EventCanceler has been initialized.

Return: true if this EventCanceler has been initialized, false otherwise.

~EventCanceler()

Destroys the event canceller and releases * the wrapped event instance.