SessManagerImpl Class Reference

#include "steam/mobject/session/sess-manager-impl.hpp"

Description

Session manager implementation class holding the actual smart pointer to the current Session impl.

Definition at line 52 of file sess-manager-impl.hpp.

Public Member Functions
virtual SessionImplAPI *	operator-> () noexcept override
	Access to the "current session", which actually is an SessionImpl instance.
Public Member Functions inherited from SessManager
virtual	~SessManager ()

Friends
class	lib::DependencyFactory< SessManagerImpl >

Private Member Functions
	SessManagerImpl ()
	Starting up the session access and lifecycle management.
	~SessManagerImpl ()
virtual void	clear () override
virtual void	close () override
	Shut down the current session together with all associated services.
virtual void	reset () override
virtual void	load () override
virtual void	save (string) override
virtual bool	isUp () override
	diagnostics: session interface opened?

Private Attributes
unique_ptr< SessionImplAPI >	pSess_
unique_ptr< LifecycleAdvisor >	lifecycle_

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

Constructor & Destructor Documentation

SessManagerImpl()

SessManagerImpl ( )

private

Starting up the session access and lifecycle management.

Initially (at static init time), only the single system-wide Session manger instance is created. It can be used to load an existing session; otherwise an empty default Session, together with the core facilities (PlacementIndex, AssetManager, Query subsystem and the Defaults manager) is created on first access to the session object.

Definition at line 203 of file sess-manager-impl.cpp.

References Session::initFlag.

~SessManagerImpl()

~SessManagerImpl ( )

private

Definition at line 211 of file sess-manager-impl.cpp.

References Session::initFlag.

Member Function Documentation

clear()

void clear ( )

overrideprivatevirtual

Note

no transactional behaviour. may succeed partially.

Todo:

clarify relation to command processing/undo /////////// TICKET #697

Implements SessManager.

Definition at line 230 of file sess-manager-impl.cpp.

References SessManagerImpl::pSess_.

close()

void close ( )

overrideprivatevirtual

Shut down the current session together with all associated services.

Todo:

avoid blocking when aborting render processes ///////////// TICKET #201

well defined transactional behaviour ///////////////////// TICKET #698

Warning

throws error::Fatal or even deadlocks when called from session thread

Implements SessManager.

Definition at line 243 of file sess-manager-impl.cpp.

References SessManagerImpl::isUp(), SessManagerImpl::lifecycle_, and SessManagerImpl::pSess_.

Here is the call graph for this function:

reset()

void reset ( )

overrideprivatevirtual

Todo:

error handling, how to deal with a partially configured session?

for reset() to work, we need to change the implementation of AssetManager so support this kind of transactional switch!

Warning

throws error::Fatal or even deadlocks when called from session thread

Implements SessManager.

Definition at line 258 of file sess-manager-impl.cpp.

References SessManagerImpl::isUp(), and SessManagerImpl::lifecycle_.

Referenced by SessManagerImpl::operator->().

Here is the call graph for this function:

Here is the caller graph for this function:

load()

void load ( )

overrideprivatevirtual

Warning

throws error::Fatal or even deadlocks when called from session thread

Implements SessManager.

Definition at line 270 of file sess-manager-impl.cpp.

References SessManagerImpl::isUp(), and SessManagerImpl::lifecycle_.

Here is the call graph for this function:

save()

void save ( string  snapshotID )

overrideprivatevirtual

Implementation details

We intend to have several switchable object serialisers. One of these serialisers should generate a comprehensible text based representation suitable for checking into SCM systems. Sessions can be saved into one single file or be split to several files (master file and edl files)

Implements SessManager.

Definition at line 289 of file sess-manager-impl.cpp.

isUp()

bool isUp ( )

overrideprivatevirtual

diagnostics: session interface opened?

Implements SessManager.

Definition at line 220 of file sess-manager-impl.cpp.

References SessManagerImpl::pSess_.

Referenced by SessManagerImpl::close(), SessManagerImpl::load(), and SessManagerImpl::reset().

Here is the caller graph for this function:

operator->()

SessionImplAPI * operator-> ( )

overridevirtualnoexcept

Access to the "current session", which actually is an SessionImpl instance.

This session object is created either by loading an existing session, or on demand by this accessor function here (when no session was loaded or created)

Note

any exceptions arising while building the basic session object(s) will halt the system.

Implements SessManager.

Definition at line 63 of file sess-manager-impl.cpp.

References SessManagerImpl::pSess_, and SessManagerImpl::reset().

Here is the call graph for this function:

Member Data Documentation

pSess_

unique_ptr<SessionImplAPI> pSess_

private

Definition at line 56 of file sess-manager-impl.hpp.

Referenced by SessManagerImpl::clear(), SessManagerImpl::close(), SessManagerImpl::isUp(), and SessManagerImpl::operator->().

lifecycle_

unique_ptr<LifecycleAdvisor> lifecycle_

private

Definition at line 57 of file sess-manager-impl.hpp.

Referenced by SessManagerImpl::close(), SessManagerImpl::load(), and SessManagerImpl::reset().

Friends And Related Symbol Documentation

lib::DependencyFactory< SessManagerImpl >

friend class lib::DependencyFactory< SessManagerImpl >

friend

Definition at line 59 of file sess-manager-impl.hpp.

Inheritance diagram for SessManagerImpl:

Collaboration diagram for SessManagerImpl:

---

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

• sess-manager-impl.hpp
• sess-manager-impl.cpp