SessManager Class Reference

#include "steam/mobject/session.hpp"

Description

creation, access and Session lifecycle Interface.

An instance is accessible via Session::current

Definition at line 152 of file session.hpp.

Public Member Functions
virtual bool	isUp ()=0
	diagnostics: session interface opened?
virtual void	clear ()=0
	clear current session contents without resetting overall session config.
virtual void	close ()=0
	shut down the current session cleanly.
virtual void	reset ()=0
	reset all session config and start with a pristine default session.
virtual void	load ()=0
	replace the current session by a new session loaded from serialised state.
virtual void	save (string snapshotID)=0
	create a complete, serialised representation of the current session config and contents.
virtual Session *	operator-> () noexcept=0
	access to the current session object instance.
virtual	~SessManager ()

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

~SessManager()

~SessManager ( )

virtual

Definition at line 142 of file session.cpp.

Member Function Documentation

isUp()

virtual bool isUp ( )

pure virtual

diagnostics: session interface opened?

Implemented in SessManagerImpl.

Referenced by SessionServiceFetch::isAccessible().

Here is the caller graph for this function:

clear()

virtual void clear ( )

pure virtual

clear current session contents without resetting overall session config.

Afterwards, the session will contain only one empty Sequence, while all Assets are retained.

Implemented in SessManagerImpl.

Referenced by SessionManager_test::clearSession(), and RebuildFixture_test::run().

Here is the caller graph for this function:

close()

virtual void close ( )

pure virtual

shut down the current session cleanly.

Includes discarding of all assets and unloading any config rules and additional state. Doesn't save anything. Typically invoked on shutdown of the session subsystem.

Note

next access will pull up a empty default session

Implemented in SessManagerImpl.

reset()

virtual void reset ( )

pure virtual

reset all session config and start with a pristine default session.

Implemented in SessManagerImpl.

Referenced by StreamTypeLifecycle_test::check_pristineState(), SessionManager_test::resetSession(), SessionModifyParts_test::run(), SessionStructure_test::run(), TimelineSequenceHandling_test::run(), SessionElementTracker_test::verify_cleanup(), and SessionElementTracker_test::verify_integration().

Here is the caller graph for this function:

load()

virtual void load ( )

pure virtual

replace the current session by a new session loaded from serialised state.

Implemented in SessManagerImpl.

save()

virtual void save ( string  snapshotID )

pure virtual

create a complete, serialised representation of the current session config and contents.

Todo:

2017 how actually to serialise, parameters, return value?

Parameters

snapshotID

marker to tag the snapshot, like e.g. a timestamp

Implemented in SessManagerImpl.

Referenced by steam::cmd::COMMAND_DEFINITION().

Here is the caller graph for this function:

operator->()

virtual Session * operator-> ( )

pure virtualnoexcept

access to the current session object instance.

This is the sole access path available for clients.

Note

there is no operator*

Implemented in SessManagerImpl.

Inheritance diagram for SessManager:

Collaboration diagram for SessManager:

---

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

• session.hpp
• session.cpp