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

A socket for PGM. More...

Inheritance diagram for ExitGames.Net.Sockets.Pgm.PgmSocket:

Public Member Functions

 PgmSocket ()
 Initializes a new instance of the PgmSocket class. More...
 
void AddReceiveInterface (IPAddress interfaceIpAddress)
 Receiver only. Adds an interface on which to listen (the default is the first local interface enumerated). The value specified replaces the default interface on the first call for a given socket, and adds other interfaces on subsequent calls. To obtain IPAddress.Any behavior, each network interface must be added separately. More...
 
void AddReceiveInterfaces (IEnumerable< IPAddress > interfaceIpAddresses)
 Receiver only. Adds an list of interfaces on which to listen. More...
 
void SetHighSpeedIntranetOption (bool value)
 Receiver only. Specifies whether a high bandwidth LAN (100Mbps+) connection is used. More...
 
void SetReuseAddress (bool value)
 Specifies if the socket is allowed to be bound to an address that is already in use. More...
 
void SetSendInterface (IPAddress interfaceIpAddress)
 Sender only. Sets the sending interface IP address. More...
 
void SetSendWindowSize (PgmSendWindowSize sendWindowSize)
 Sets a new send window size. More...
 

Properties

static ProtocolType PgmProtocolType [get]
 Gets the ProtocolType for the Pragmatic General Multicast (PGM) protocol. More...
 
static SocketOptionLevel PgmSocketOptionLevel [get]
 Gets the SocketOptionLevel used to set Pragmatic General Multicast (PGM) protocol specific socket options. More...
 

Detailed Description

A socket for PGM.

Constructor & Destructor Documentation

ExitGames.Net.Sockets.Pgm.PgmSocket.PgmSocket ( )
inline

Initializes a new instance of the PgmSocket class.

Member Function Documentation

void ExitGames.Net.Sockets.Pgm.PgmSocket.AddReceiveInterface ( IPAddress  interfaceIpAddress)
inline

Receiver only. Adds an interface on which to listen (the default is the first local interface enumerated). The value specified replaces the default interface on the first call for a given socket, and adds other interfaces on subsequent calls. To obtain IPAddress.Any behavior, each network interface must be added separately.

Parameters
interfaceIpAddressIPAdress of the network interface to add.
void ExitGames.Net.Sockets.Pgm.PgmSocket.AddReceiveInterfaces ( IEnumerable< IPAddress >  interfaceIpAddresses)
inline

Receiver only. Adds an list of interfaces on which to listen.

Parameters
interfaceIpAddressesIPAdress list of the network interfaces to add.
See also
AddReceiveInterface
void ExitGames.Net.Sockets.Pgm.PgmSocket.SetHighSpeedIntranetOption ( bool  value)
inline

Receiver only. Specifies whether a high bandwidth LAN (100Mbps+) connection is used.

Parameters
valueTrue enables high speed.
void ExitGames.Net.Sockets.Pgm.PgmSocket.SetReuseAddress ( bool  value)
inline

Specifies if the socket is allowed to be bound to an address that is already in use.

Parameters
valueTrue to allow multiple sockets on one address.
void ExitGames.Net.Sockets.Pgm.PgmSocket.SetSendInterface ( IPAddress  interfaceIpAddress)
inline

Sender only. Sets the sending interface IP address.

Parameters
interfaceIpAddressIPAdress of the network interface.
void ExitGames.Net.Sockets.Pgm.PgmSocket.SetSendWindowSize ( PgmSendWindowSize  sendWindowSize)
inline

Sets a new send window size.

Parameters
sendWindowSizeThe send window size.

Property Documentation

ProtocolType ExitGames.Net.Sockets.Pgm.PgmSocket.PgmProtocolType
staticget

Gets the ProtocolType for the Pragmatic General Multicast (PGM) protocol.

Equals PgmConstants.IpProtoRm.

SocketOptionLevel ExitGames.Net.Sockets.Pgm.PgmSocket.PgmSocketOptionLevel
staticget

Gets the SocketOptionLevel used to set Pragmatic General Multicast (PGM) protocol specific socket options.

Equals PgmConstants.IpProtoRm.