EngineSubsysDescriptor Class Reference

Description

Definition at line 47 of file enginefacade.cpp.

Private Member Functions
bool	checkRunningState () noexcept override
	whether this subsystem is actually operational. More...
	operator string () const
	a human readable name
bool	shouldStart (lumiera::Option &) override
	query application option state to determine if this subsystem should be activated. More...
bool	start (lumiera::Option &, Subsys::SigTerm termination) override
	attempt to bring up this subsystem up. More...
void	triggerShutdown () noexcept override
	initiate termination of this subsystem. More...

Additional Inherited Members
Public Types inherited from Subsys
typedef function< void(string *)>	SigTerm
Public Member Functions inherited from Subsys
Subsys &	depends (Subsys &prereq)
	define a dependency to another Subsys required for running this subsystem
const std::vector< Subsys * >	getPrerequisites ()
bool	isRunning () noexcept

Member Function Documentation

shouldStart()

bool shouldStart ( lumiera::Option &  )

inlineoverrideprivatevirtual

query application option state to determine if this subsystem should be activated.

Note

even if not started explicitly, it could still be started as prerequisite of another one

Implements Subsys.

Definition at line 53 of file enginefacade.cpp.

start()

bool start ( lumiera::Option &  options, Subsys::SigTerm    )

inlineoverrideprivatevirtual

attempt to bring up this subsystem up.

On return, the subsystem must be operational, according to checkRunningState(). Failure to start up usually terminates the whole application. When this subsystem ceases to work, it must ensure to activate the given callback signal.

Parameters

options	may be influencing the operation mode
SigTerm	to be signalled by the subsystem.

Warning

termination must be signalled reliably.

Returns

true if actually started.

Implements Subsys.

Definition at line 60 of file enginefacade.cpp.

triggerShutdown()

void triggerShutdown ( )

inlineoverrideprivatevirtualnoexcept

initiate termination of this subsystem.

This trigger may be called repeatedly any time... When the subsystem actually has terminated, the SigTerm passed to start must be invoked.

Note

called within a locked context (barrier)

Warning

must not block nor throw.

Implements Subsys.

Definition at line 67 of file enginefacade.cpp.

checkRunningState()

bool checkRunningState ( )

inlineoverrideprivatevirtualnoexcept

whether this subsystem is actually operational.

When returning false here, the application may terminate at any point without further notice Note further, that a subsystem must not be in running state when signalling termination.

Implements Subsys.

Definition at line 73 of file enginefacade.cpp.

Inheritance diagram for EngineSubsysDescriptor:

Collaboration diagram for EngineSubsysDescriptor:

---

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

• enginefacade.cpp