Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Executable Class Referenceabstract

An object that can be scheduled on an executor to run. More...

#include <Executable.hxx>

Inheritance diagram for Executable:
Notifiable QMember Destructable ActiveTimers BlockExecutor CallbackExecutable ExecuteOnMainExecutor ExecutorBase FnExecutable GcHubPort StateFlowBase StateFlowBase::StateFlowTimedSelectHelper SyncExecutable Timer TypedQAsync< T >::BlockingWait openlcb::BroadcastTimeAlarm::Wakeup openlcb::WriteHelper

Public Member Functions

void test_deletion ()
 
virtual void run ()=0
 Entry point.
 
void notify () override
 Crashes the program – everyone who is expecting notify calls must override this function.
 
virtual void alloc_result (QMember *item)
 Return the result of an alloc_async() from a memory Pool.
 
- Public Member Functions inherited from QMember
void init ()
 Initiailize a QMember, in place of a public placement construction.
 

Additional Inherited Members

- Protected Member Functions inherited from QMember
 QMember ()
 Constructor.
 
 ~QMember ()
 Destructor.
 
- Protected Attributes inherited from QMember
QMembernext
 pointer to the next member in the queue
 

Detailed Description

An object that can be scheduled on an executor to run.

Definition at line 42 of file Executable.hxx.

Constructor & Destructor Documentation

◆ ~Executable()

Executable::~Executable ( )
virtual

Definition at line 66 of file Executor.cxx.

Member Function Documentation

◆ alloc_result()

virtual void Executable::alloc_result ( QMember item)
inlinevirtual

Return the result of an alloc_async() from a memory Pool.

Parameters
itemresult of the the allocation

Reimplemented in StateFlowBase, openlcb::WriteHelper, and TypedQAsync< T >::BlockingWait.

Definition at line 63 of file Executable.hxx.

◆ notify()

void Executable::notify ( )
inlineoverridevirtual

Crashes the program – everyone who is expecting notify calls must override this function.

It is not virtual because not all implementation expect Notify calls.

Implements Notifiable.

Reimplemented in StateFlowBase, StateFlowWithQueue, and GcHubPort.

Definition at line 56 of file Executable.hxx.

◆ run()

virtual void Executable::run ( )
pure virtual

◆ test_deletion()

void Executable::test_deletion ( )

Definition at line 64 of file Executor.cxx.


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