OutputDirector Class Reference

#include "steam/play/output-director.hpp"

Description

Management of external Output connections.

Todo:

write Type comment

Definition at line 60 of file output-director.hpp.

Static Public Attributes
static lib::Depend< OutputDirector >	instance
	storage for the single application wide OutputDirector instance

Public Member Functions
bool	connectUp ()
	connect and bring up the external input/output connections, handlers and interface services and the render/playback service.
void	triggerDisconnect (SigTerm) noexcept
	initiate shutdown of all ongoing render/playback processes and closing of all external input/output interfaces.
bool	isOperational () const

Friends
class	lib::DependencyFactory< OutputDirector >

Private Types
using	SigTerm = lumiera::Subsys::SigTerm
using	PlayServiceHandle = lib::DependInject< lumiera::Play >::ServiceInstance< PlayService >

Private Member Functions
	OutputDirector ()
	bring up the framework for handling input/output connections.
	~OutputDirector ()
void	bringDown (SigTerm completedSignal)
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Private Attributes
PlayServiceHandle	player_
bool	shutdown_initiated_ = false

Additional Inherited Members
Static Public Member Functions inherited from Sync< CONF >
static Monitor &	getMonitor (Sync const *forThis)

Constructor & Destructor Documentation

OutputDirector()

OutputDirector ( )

private

bring up the framework for handling input/output connections.

Creating this object happens on first access and shouldn't be confused with actually booting up / shutting down this subsystem. Rather, the purpose of the OutputDirector is actively to conduct the Lifecycle of booting, connecting, operating, disconnecting.

Definition at line 49 of file output-director.cpp.

~OutputDirector()

~OutputDirector ( )

private

Definition at line 54 of file output-director.cpp.

Member Typedef Documentation

SigTerm

using SigTerm = lumiera::Subsys::SigTerm

private

Definition at line 64 of file output-director.hpp.

PlayServiceHandle

using PlayServiceHandle = lib::DependInject<lumiera::Play>::ServiceInstance<PlayService>

private

Definition at line 65 of file output-director.hpp.

Member Function Documentation

connectUp()

bool connectUp

(

)

connect and bring up the external input/output connections, handlers and interface services and the render/playback service.

Returns

true if the output subsystem can be considered operational

Definition at line 63 of file output-director.cpp.

References DependInject< SRV >::ServiceInstance< IMP >::createInstance(), OutputDirector::isOperational(), OutputDirector::player_, and OutputDirector::shutdown_initiated_.

Here is the call graph for this function:

triggerDisconnect()

void triggerDisconnect ( SigTerm  completedSignal )

noexcept

initiate shutdown of all ongoing render/playback processes and closing of all external input/output interfaces.

Works as an asynchronous operation; the given callback signal will be invoked when the shutdown is complete.

Note

starting a new thread, which might fail. When this happens, the raised exception will cause immediate unconditional termination of the application.

Definition at line 91 of file output-director.cpp.

isOperational()

bool isOperational

(

)

const

Todo:

WIP-WIP-WIP 6/2011

Definition at line 75 of file output-director.cpp.

References OutputDirector::player_.

Referenced by OutputDirector::bringDown(), and OutputDirector::connectUp().

Here is the caller graph for this function:

bringDown()

void bringDown ( SigTerm  completedSignal )

private

actually bring down any calculation processes and finally disconnect any external input/output interfaces. This shutdown and cleanup operation is executed in a separate "Output shutdown supervisor" thread and has the liability to bring down the relevant facilities within a certain timespan. When done, the last operation within this thread will be to invoke the callback signal given as parameter.

Note

locks the OutputDirector

Definition at line 114 of file output-director.cpp.

References OutputDirector::isOperational(), lumiera_error(), OutputDirector::player_, DependInject< SRV >::ServiceInstance< IMP >::shutdown(), and Error::what().

Here is the call graph for this function:

Member Data Documentation

player_

PlayServiceHandle player_

private

Definition at line 67 of file output-director.hpp.

Referenced by OutputDirector::bringDown(), OutputDirector::connectUp(), and OutputDirector::isOperational().

shutdown_initiated_

bool shutdown_initiated_ = false

private

Definition at line 70 of file output-director.hpp.

Referenced by OutputDirector::connectUp().

instance

lib::Depend< OutputDirector > instance

static

storage for the single application wide OutputDirector instance

Definition at line 73 of file output-director.hpp.

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

Friends And Related Symbol Documentation

lib::DependencyFactory< OutputDirector >

friend class lib::DependencyFactory< OutputDirector >

friend

Definition at line 82 of file output-director.hpp.

Inheritance diagram for OutputDirector:

Collaboration diagram for OutputDirector:

---

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

• output-director.hpp
• output-director.cpp