C# / .Net API Library Reference  4.3.2-74-ge1d4cca
Public Functions
ISessionManager Interface Reference

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 OnSessionConnected and OnSessionDisconnected; 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

void AddResponseProvider (Guid sessionId, IResponseProvider responseProvider)
 
bool DestroySession (Guid sessionId)
 
bool RemoveResponseProvider (Guid sessionId, IResponseProvider responseProvider)
 

Events

Events
EventHandler< SessionEventArgsSessionConnected
 
EventHandler< SessionEventArgsSessionDisconnected
 
EventHandler< FlowControlEventArgsFlowControlChanged
 

Usage Description

void AddResponseProvider ( Guid  sessionId,
IResponseProvider  responseProvider 
)

Adds a response provider for a session.

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

Implemented in SessionManager.

bool DestroySession ( Guid  sessionId)

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

Parameters
sessionIdThe unique identifier of the session to destroy.

Implemented in SessionManager.

bool RemoveResponseProvider ( Guid  sessionId,
IResponseProvider  responseProvider 
)

Removes a response provider for a session.

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

Implemented in SessionManager.

Event Documentation

EventHandler<FlowControlEventArgs> FlowControlChanged

This event is triggered when flow control changes for a session.

EventHandler<SessionEventArgs> SessionConnected

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

EventHandler<SessionEventArgs> SessionDisconnected

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