FlowControlManager Class Reference

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
void	Initialize (StateManager stateManager)
void	SessionConnected (Guid sessionId, XElement command)
void	SessionDisconnected (Guid sessionId, XElement command)
void	SetWindowSize (int onWindowSize, int offWindowSize)
void	Uninitialize ()

Properties
int	OffWindowSize [get]
int	OnWindowSize [get]

Usage Description

void Initialize ( StateManager  stateManager )

inherited

Initializes the plugin with the specified StateManager.

Parameters

stateManager

The StateManager.

Implemented in ViewManager.

void SessionConnected ( Guid  sessionId, XElement  command  )

inherited

Indicates that the specified session is connected.

Parameters

sessionId	The session's unique identifier.
command	The command that caused the connection.

void SessionDisconnected ( Guid  sessionId, XElement  command  )

inherited

Indicates that the specified session is disconnected.

Parameters

sessionId	The session's unique identifer.
command	The command that caused the disconnection.

void SetWindowSize ( int  onWindowSize, int  offWindowSize  )

inline

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

Parameters

onWindowSize	The new on window size.
offWindowSize	The new off window size.

Implements IFlowControlManager.

void Uninitialize ( )

inherited

Uninitializes the plugin.

Implemented in ViewManager.

Property Documentation

int OffWindowSize

get

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

int OnWindowSize

get

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