ISessionManager

Session Manager interface defines a System Core Object. More...

#include <session_intf.h>

Inheritance diagram for ISessionManager:

Public Member Functions
	ADTF_IID (ISessionManager, "sessionmanager.ant.services.adtf.iid")
	definition of interface id
virtual tResult	CreateSession ()=0
	Create a section_session within the Sessionmanager.
virtual tResult	CreateSession (const char *strSessionFileName)=0
	Create a section_session within the Sessionmanager and will load the given strSessionFileName.
virtual tResult	ReleaseSession ()=0
	Release a Session.
virtual tResult	GetSessionFile (base::ant::IString &&strSessionFilePath) const =0
	Returns the current session file if set.
virtual tResult	GetCurrentSession (ucom::ant::iobject_ptr< ant::ISession > &pCurrentSession) const =0
	Gets the current session if created.
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast()

Protected Member Functions
	~ISessionManager ()=default
	not destructable
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Session Manager interface defines a System Core Object.

The Session Manager is a recommended part of the adtf::system::ant::cADTFSystem and able to read
the ADTF Session File to:

• Load Plugins
• Create System Service
• Load and initialize the Streaming Graph
• Load and initialize the Filter Graph

See also

Session

Definition at line 195 of file session_intf.h.

Member Function Documentation

CreateSession() [1/2]

virtual tResult CreateSession ( )

pure virtual

Create a section_session within the Sessionmanager.

Remarks

This function will fail if runlevel is above RL_Shutdown

Returns

Standard Result Code

See also

create_empty_session

CreateSession() [2/2]

virtual tResult CreateSession ( const char * strSessionFileName )

pure virtual

Create a section_session within the Sessionmanager and will load the given strSessionFileName.

Remarks

This function will fail if runlevel is above RL_Shutdown!

Returns

Standard Result Code

GetCurrentSession()

virtual tResult GetCurrentSession ( ucom::ant::iobject_ptr< ant::ISession > & pCurrentSession ) const

pure virtual

Gets the current session if created.

Parameters

[in,out]

pCurrentSession

reference object to return the session to

Returns

Standard Result Code

See also

CreateSession

GetSessionFile()

virtual tResult GetSessionFile ( base::ant::IString && strSessionFilePath ) const

pure virtual

Returns the current session file if set.

Parameters

[in,out]

strSessionFilePath

return value to set the current set path of the ADTF Session File

Returns

Standard Result Code

See also

CreateSession, ADTF Session XML Schema file

ReleaseSession()

virtual tResult ReleaseSession ( )

pure virtual

Release a Session.

Returns

Standard Result Code