IHdrcSession Struct Reference

Inheritance diagram for IHdrcSession:

Public Member Functions
virtual signed int	AskInterface (const BGUID *piid, struct IRoot **ppr)=0
virtual signed int	DecRef ()=0
virtual signed int	Disconnect ()=0
virtual signed int	GetOptions (ENUM_SESSION_RENDER_OPTIONS *)=0
virtual signed int	GetServer (IHdrcServer **)=0
virtual signed int	GetSessionStatus (ENUM_SESSION_STATUS *pe)=0
virtual signed int	GetStream (ENUM_STREAM_CATEGORY Category, ISimpleStream **ppv)=0
virtual signed int	GetTraceOptions (ENUM_TRACE_OPTIONS *)=0
virtual signed int	IncRef ()=0
virtual signed int	SetOptions (ENUM_SESSION_RENDER_OPTIONS e)=0
virtual signed int	SetServer (IHdrcServer *)=0
virtual signed int	SetStream (ENUM_STREAM_CATEGORY Category, ISimpleStream *pv)=0
virtual signed int	SetTraceOptions (ENUM_TRACE_OPTIONS e)=0
virtual signed int	Start ()=0
virtual signed int	Wait (signed int lWait)=0
Public Member Functions inherited from IRoot
template<class T >
signed int	AskInterface (T **pp)

Detailed Description

Object implementing IHdrcSession responsible for maintaining activity. For example rendering session shall perform:

• receiving and sending queue
• a number of receiving, sending and executing threads
• a number of input output streams

Member Function Documentation

virtual signed int IHdrcSession::AskInterface ( const BGUID *  piid, struct IRoot **  ppr  )

pure virtual

ask object for another interface

Implements IRoot.

virtual signed int IHdrcSession::DecRef ( )

pure virtual

decrements the reference count for the object

Implements IRoot.

virtual signed int IHdrcSession::GetSessionStatus ( ENUM_SESSION_STATUS *  pe )

pure virtual

Get session status This function simply returns the session status and tells of it is connected or disconnected

Exmaple:

bool connected = false;
BCOM_THIS_ ENUM_SESSION_STATUS session_status;
piSession->GetSessionStatus(&session_status);   

if(session_status == SS_CONNECTED)
    connected = true;
else
    connected = false;

Parameters

pe	is a pointer to a enumeration type BCOM_THIS_ ENUM_SESSION_STATUS

virtual signed int IHdrcSession::GetStream ( ENUM_STREAM_CATEGORY  Category, ISimpleStream **  ppv  )

pure virtual

Get stream used for logging, error reporting

This function allows to get type of stream set ffor one of the following types.

The allowed types of streams for following

SC_STD_LOG                  Logging         
SC_ERR_LOG                  Error           
SC_IN                       In           
SC_OUT                      Out         
SC_INOUT                    In/Out (Both)   

Example:

BComPtr<ISimpleStream> piStream;
piSession->GetStream(SC_STD_LOG,&piStream); 

Parameters

Category	is enumuration of type BCOM_THIS_ ENUM_STREAM_CATEGORY
ppv	is of type pointer to a pointer of tyep ISimpleStream

virtual signed int IHdrcSession::GetTraceOptions ( ENUM_TRACE_OPTIONS *  )

pure virtual

Get trace options

virtual signed int IHdrcSession::IncRef ( )

pure virtual

increments the reference count for the object

Implements IRoot.

virtual signed int IHdrcSession::SetOptions ( ENUM_SESSION_RENDER_OPTIONS  e )

pure virtual

Set options

virtual signed int IHdrcSession::SetTraceOptions ( ENUM_TRACE_OPTIONS  e )

pure virtual

Set trace options