PlayOutSubsysDescriptor Class Reference

Description

Definition at line 90 of file facade.cpp.

Private Member Functions
	operator string () const
	a human readable name
bool	shouldStart (Option &) override
	determine, if any output system is required to start up explicitly.
bool	start (Option &, Subsys::SigTerm termination) override
	attempt to bring up this subsystem up.
void	triggerShutdown () noexcept override
	initiate termination of this subsystem.
bool	checkRunningState () noexcept override
	whether this subsystem is actually operational.

Private Attributes
SigTerm	completedSignal_

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

Member Function Documentation

operator string()

operator string ( ) const

inlineprivatevirtual

a human readable name

Implements Subsys.

Definition at line 93 of file facade.cpp.

shouldStart()

bool shouldStart ( Option &  )

inlineoverrideprivatevirtual

determine, if any output system is required to start up explicitly.

Moreover, extract configuration variations for specific kinds of output

Returns

true if any output system is required to start stand-alone. otherwise, the player and a default configured output connection is pulled up only when required by another subsystem (e.g. GUI)

Todo:

actually define cmdline options and parse/decide here!

Implements Subsys.

Definition at line 103 of file facade.cpp.

start()

bool start ( 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 110 of file facade.cpp.

References PlayOutSubsysDescriptor::completedSignal_, and OutputDirector::instance.

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 120 of file facade.cpp.

References PlayOutSubsysDescriptor::completedSignal_, and OutputDirector::instance.

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 127 of file facade.cpp.

References OutputDirector::instance.

Member Data Documentation

completedSignal_

SigTerm completedSignal_

private

Definition at line 116 of file facade.cpp.

Referenced by PlayOutSubsysDescriptor::start(), and PlayOutSubsysDescriptor::triggerShutdown().

Inheritance diagram for PlayOutSubsysDescriptor:

Collaboration diagram for PlayOutSubsysDescriptor:

---

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

• facade.cpp