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

The IStateManagerPlugin defines the common interface that all plugins are required to implement.

Public Functions

virtual void Initialize (StateManager *pStateManager)=0
 
virtual void SessionConnected (Guid sessionId, Typeless const &command)=0
 
virtual void SessionDisconnected (Guid sessionId, Typeless const &command)=0
 
virtual void Uninitialize ()=0
 
Constructors and Destructors
virtual ~IStateManagerPlugin ()
 

Usage Description

virtual void Initialize ( StateManager pStateManager)
pure virtual

Initializes the plugin with the specified StateManager.

Parameters
stateManagerThe StateManager.

Implemented in ViewManager.

virtual void SessionConnected ( Guid  sessionId,
Typeless const &  command 
)
pure virtual

Indicates that the specified session is connected.

Parameters
sessionIdThe session's unique identifier.
commandThe command that was received causing the session to connect.
virtual void SessionDisconnected ( Guid  sessionId,
Typeless const &  command 
)
pure virtual

Indicates that the specified session is disconnected.

Parameters
sessionIdThe session's unique identifier.
commandThe command that was received causing the session to disconnect.
virtual void Uninitialize ( )
pure virtual

Uninitializes the plugin.

Implemented in ViewManager.