Lumiera  0.pre.03
»edityourfreedom«
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
EngineSubsysDescriptor Class Reference

Description

Definition at line 46 of file enginefacade.cpp.

Private Member Functions

bool checkRunningState () noexceptoverride
 whether this subsystem is actually operational. More...
 
 operator string () const
 a human readable name More...
 
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 () noexceptoverride
 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
virtual ~Subsys ()
 
Subsysdepends (Subsys &prereq)
 define a dependency to another Subsys required for running this subsystem More...
 
const std::vector< Subsys * > getPrerequisites ()
 
bool isRunning () noexcept
 

Member Function Documentation

operator string ( ) const
inlineprivatevirtual

a human readable name

Implements Subsys.

Definition at line 49 of file enginefacade.cpp.

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 52 of file enginefacade.cpp.

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
optionsmay be influencing the operation mode
SigTermto be signalled by the subsystem.
Warning
termination must be signalled reliably.
Returns
true if actually started.

Implements Subsys.

Definition at line 59 of file enginefacade.cpp.

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 66 of file enginefacade.cpp.

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 72 of file enginefacade.cpp.

+ Inheritance diagram for EngineSubsysDescriptor:
+ Collaboration diagram for EngineSubsysDescriptor:

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