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

The FlowControlManager class is an implementation of IFlowControlManager. It provides methods to configure the on/off window size. Changing the default is rare.

Public Functions

virtual void Initialize (StateManager *pStateManager)=0
 
virtual int OffWindowSize () const
 
virtual int OnWindowSize () const
 
virtual void SessionConnected (Guid sessionId, Typeless const &command)=0
 
virtual void SessionDisconnected (Guid sessionId, Typeless const &command)=0
 
virtual void SetWindowSize (int onWindowSize, int offWindowSize)
 
virtual void Uninitialize ()=0
 
Constructors and Destructors
 FlowControlManager ()
 
 ~FlowControlManager ()
 

Usage Description

virtual void Initialize ( StateManager pStateManager)
pure virtualinherited

Initializes the plugin with the specified StateManager.

Parameters
stateManagerThe StateManager.

Implemented in ViewManager.

int OffWindowSize ( ) const
virtual

Returns the minimum window size that will cause flow control to turn SessionFlowControl.TransmitOff.

Implements IFlowControlManager.

int OnWindowSize ( ) const
virtual

Returns the maximum window size that will cause flow control to turn SessionFlowControl.TransmitOn.

Implements IFlowControlManager.

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

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 virtualinherited

Indicates that the specified session is disconnected.

Parameters
sessionIdThe session's unique identifier.
commandThe command that was received causing the session to disconnect.
void SetWindowSize ( int  onWindowSize,
int  offWindowSize 
)
virtual

Sets the client-side flow control window size. onWindowSize is the minimum that will cause flow control to turn SessionFlowControl.TransmitOn, and offWindowSize is the maximum that will cause flow control to turn SessionFlowControl.TransmitOn.

Implements IFlowControlManager.

virtual void Uninitialize ( )
pure virtualinherited

Uninitializes the plugin.

Implemented in ViewManager.