C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | List of all members
ISessionManager Class Referenceabstract

The ISessionManager interface is used to manage the flow of responses back to clients. The methods are mostly for internal use by the SDK.

Of particular interest are the methods addSessionConnectedHandler and addSessionDisconnectedHandler; they allow you to listen for connection and disconnection events and respond accordingly. This can prove especially useful in collaboration scenarios, to determine which users are connected at any point in time.

Public Functions

virtual void AddResponseProvider (Guid sessionId, IResponseProvider *pProvider)=0
 
virtual bool DestroySession (Guid sessionId)=0
 
virtual bool RemoveResponseProvider (Guid sessionId, IResponseProvider *pProvider)=0
 
Constructors and Destructors
virtual ~ISessionManager ()
 
Events
 DEFINE_PURE_VIRTUAL_EVENT (SessionConnected, ISessionManager &, SessionEventArgs const &)
 
 DEFINE_PURE_VIRTUAL_EVENT (SessionDisconnected, ISessionManager &, SessionEventArgs const &)
 

Usage Description

virtual void AddResponseProvider ( Guid  sessionId,
IResponseProvider pProvider 
)
pure virtual

Adds the specified response provider to a session.

Parameters
sessionIdThe unique identifier of the session to which will be added the response provider.
pProviderThe response provider to add.

Implemented in SessionManager.

DEFINE_PURE_VIRTUAL_EVENT ( SessionConnected  ,
ISessionManager ,
SessionEventArgs const &   
)

This event is triggered when a session gets connected to the service.

DEFINE_PURE_VIRTUAL_EVENT ( SessionDisconnected  ,
ISessionManager ,
SessionEventArgs const &   
)

This event is triggered when a session gets disconnected from the service.

virtual bool DestroySession ( Guid  sessionId)
pure virtual

Destroys a connected session. Will return true if the specified session was connected and destroyed, or false if there was no such session.

Parameters
sessionIdThe unique identifier of the session to destroy.

Implemented in SessionManager.

virtual bool RemoveResponseProvider ( Guid  sessionId,
IResponseProvider pProvider 
)
pure virtual

Removes the specified response provider from a session. Will return true if the response provider was successfully removed or false otherwise.

Parameters
sessionIdThe unique identifier of the session from which to remove the response provider.
pProviderThe response provider to remove.

Implemented in SessionManager.