Public Member Functions

zeus::IModuleSession Class Reference

#include <IModuleSession.hpp>

Inheritance diagram for zeus::IModuleSession:
zeus::IZUnknown zeus::TAbstractModuleSession

List of all members.

Public Member Functions

virtual Retval MQUALIFIER createObjectOfModule (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
virtual void MQUALIFIER initialize (IZeusAPI *pApi)=0
virtual void MQUALIFIER uninitialize ()=0
virtual void MQUALIFIER broadcastMessage (Uint uiMessage, const IString *pstrData)=0

Detailed Description

The module session interface defines a instance of the module ressource. Through this instance various non xobjects can be reached, and created..


Member Function Documentation

virtual void MQUALIFIER zeus::IModuleSession::broadcastMessage ( Uint  uiMessage,
const IString pstrData 
) [pure virtual]

Sends a broadcast message to the modulesession

Parameters:
uiMessage,:Message to send
pstrData,:optional string data

Implemented in zeus::TAbstractModuleSession.

virtual Retval MQUALIFIER zeus::IModuleSession::createObjectOfModule ( const InterfaceID rInterfaceID,
IZUnknown *&  rpIface 
) [pure virtual]

This method creates various objects (inheriting IZUnknown Interface) of a module.

Parameters:
rInterfaceID,:Interface ID of the Object
rpIface,:Return value of the interface
Return values:
RET_NOERROR,:Object created and successfully returned
RET_INVALID_PARAMETER,:Invalid parameter
RET_UNKNOWN_INTERFACE,:Unknown ID

Implemented in zeus::TAbstractModuleSession.

virtual void MQUALIFIER zeus::IModuleSession::initialize ( IZeusAPI pApi ) [pure virtual]

Initializes the Module session

Parameters:
pApi,:Framework communication API

Implemented in zeus::TAbstractModuleSession.

virtual void MQUALIFIER zeus::IModuleSession::uninitialize (  ) [pure virtual]

uninitializes the module session

Implemented in zeus::TAbstractModuleSession.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:27