Photon Server API
Public Member Functions | Properties | List of all members
ExitGames.Net.Sockets.Pgm.PgmSendWindowSize Struct Reference

The RM_SEND_WINDOW structure specifies the Reliable Multicast send window. This structure is used with the RM_RATE_WINDOW_SIZE socket option. More...

Public Member Functions

 PgmSendWindowSize (uint rateKbitsPerSec, uint windowSizeInMSecs, uint windowSizeInBytes)
 Initializes a new instance of the PgmSendWindowSize structure. More...
 
byte[] GetBytes ()
 Returns the RM_SEND_WINDOW structure in raw binary format. More...
 

Properties

uint RateKbitsPerSec [get, set]
 Gets or sets the transmission rate for the send window, in kilobits per second. More...
 
uint WindowSizeInBytes [get, set]
 Gets or sets the window size for the session, in bytes. More...
 
uint WindowSizeInMSecs [get, set]
 Gets or sets the window size for the send window, in milliseconds. More...
 

Detailed Description

The RM_SEND_WINDOW structure specifies the Reliable Multicast send window. This structure is used with the RM_RATE_WINDOW_SIZE socket option.

Any combination of the three available members may be set for a given socket option call. For example, one, any two, or all three members may be specified during a setsockopt function call. Regardless of settings, Windows enforces the following ratio: TransmissionRate == (WindowSizeBytes/WindowSizeMSecs) * 8. As such, setting any two parameters effectively sets the third to ensure optimum performance. The combination of these members can affect the resources used on a PGM sender's computer. For example, a large transmission rate value combined with a large window size results in more required buffer space.

Constructor & Destructor Documentation

ExitGames.Net.Sockets.Pgm.PgmSendWindowSize.PgmSendWindowSize ( uint  rateKbitsPerSec,
uint  windowSizeInMSecs,
uint  windowSizeInBytes 
)
inline

Initializes a new instance of the PgmSendWindowSize structure.

Parameters
rateKbitsPerSecTransmission rate for the send window, in kilobits per second.
windowSizeInMSecsThe window size for the send window, in milliseconds.
windowSizeInBytesThe window size for the session, in bytes.

Member Function Documentation

byte [] ExitGames.Net.Sockets.Pgm.PgmSendWindowSize.GetBytes ( )
inline

Returns the RM_SEND_WINDOW structure in raw binary format.

Returns
Byte array containing RM_SEND_WINDOW structure in raw binary format.

Property Documentation

uint ExitGames.Net.Sockets.Pgm.PgmSendWindowSize.RateKbitsPerSec
getset

Gets or sets the transmission rate for the send window, in kilobits per second.

uint ExitGames.Net.Sockets.Pgm.PgmSendWindowSize.WindowSizeInBytes
getset

Gets or sets the window size for the session, in bytes.

uint ExitGames.Net.Sockets.Pgm.PgmSendWindowSize.WindowSizeInMSecs
getset

Gets or sets the window size for the send window, in milliseconds.