Inheritance diagram for CancellableEvent:

Collaboration diagram for CancellableEvent:

Public Member Functions
	CancellableEvent (const Time &t, const string &n)

void	EventFct () override
	Event handler function to be overridden.

const string &	get_name () const

Public Member Functions inherited from TimeoutQueue::Event
	~Event () noexcept override

Execution_Status	get_execution_status () const

Time	getAbsoluteTime () const

void	set_for_deletion ()

EventId	get_id () const
	Get the unique event ID (auto-generated on construction)

const std::string &	get_name () const
	Get the event name (for debugging)

void	set_name (const std::string &name)
	Set the event name.

void	set_completion_callback (CompletionCallback cb)
	Set the completion callback (called after EventFct completes or the event is canceled)

Additional Inherited Members
Public Types inherited from TimeoutQueue::Event
enum	Execution_Status { Out_Queue , In_Queue , Canceled , Executing , Executed , To_Delete , Deleted }
	Possible states of an event in its lifecycle. More...

using	CompletionCallback = std::function< void(Event *, Execution_Status)>
	Optional callback invoked after an event completes, is canceled, or is deleted.

using	EventId = uint64_t
	Type for unique event identifiers.

Static Public Attributes inherited from TimeoutQueue::Event
static constexpr EventId	InvalidId = 0
	Invalid/null event ID.

Protected Member Functions inherited from TimeoutQueue::Event
	Event (const Time &t, std::string name="")

	Event (const long sec, const long nsec, std::string name="")

Detailed Description

Definition at line 164 of file timeoutQueue_example.C.

Constructor & Destructor Documentation

CancellableEvent::CancellableEvent	(	const Time &	t,
		const string &	n
	)

inline

Definition at line 169 of file timeoutQueue_example.C.

void CancellableEvent::EventFct ( )

inlineoverridevirtual

Event handler function to be overridden.

This pure virtual function is called when the event's trigger time arrives. Override this in derived classes to implement custom event behavior. *

Definition at line 172 of file timeoutQueue_example.C.

const string & CancellableEvent::get_name ( ) const

inline

Definition at line 177 of file timeoutQueue_example.C.

References name.

string CancellableEvent::name

private

Definition at line 166 of file timeoutQueue_example.C.

Referenced by EventFct(), and get_name().

The documentation for this class was generated from the following file: