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

This PGM receiver is a ISocketReceiver implementation that wraps a PgmListener. More...

Inheritance diagram for ExitGames.Net.Sockets.Pgm.PgmReceiver:
ExitGames.Net.Sockets.ISocketReceiver

Public Member Functions

 PgmReceiver (IPEndPoint endPoint)
 Initializes a new instance of the PgmReceiver class. More...
 
 PgmReceiver (IPAddress address, int port)
 Initializes a new instance of the PgmReceiver class. More...
 
 PgmReceiver (string address, int port)
 Initializes a new instance of the PgmReceiver class. More...
 
void Start ()
 Starts the underlying PgmListener. More...
 
void Dispose ()
 Disposes the PgmReceiver. More...
 

Properties

IPEndPoint EndPoint [get]
 Gets the multicast end point. More...
 
bool IsRunning [get]
 Gets a value indicating whether the receiver is running. More...
 
int ReadBufferSize [get, set]
 Gets or sets the read buffer size. More...
 
int ReceiveBufferSize [get, set]
 Gets or sets the size in bytes of the receive buffer of the System.Net.Sockets.Socket. More...
 
IPAddressCollection ReceiveInterfaces [get]
 Gets the list of interfaces that the instance receives messages from. If no interface is specified the first local interface enumerated is used. More...
 
bool ReuseAddress [get, set]
 Gets or sets a value indicating whether the receiver socket is allowed to be bound to an address that is already in use. More...
 
long TotalBytesReceived [get, set]
 Gets or sets the total number of received bytes. More...
 
bool UseHighSpeedIntranet [get, set]
 Gets or sets a value indicating whether a high bandwidth LAN (100Mbps+) connection is used. More...
 
- Properties inherited from ExitGames.Net.Sockets.ISocketReceiver
IPEndPoint EndPoint [get]
 Gets the remote end point. More...
 
long TotalBytesReceived [get]
 Gets the total number of resecived bytes. More...
 

Events

EventHandler< SocketAcceptEventArgsAccept
 Event for new PGM connections. More...
 
EventHandler< SocketDisconnectEventArgsDisconnected
 Event for disconnected PGM connections. More...
 
EventHandler< SocketReceiveEventArgsReceive
 Event for received PGM messages. More...
 
- Events inherited from ExitGames.Net.Sockets.ISocketReceiver
EventHandler< SocketReceiveEventArgsReceive
 Event that is invoked when new data is received. More...
 

Detailed Description

This PGM receiver is a ISocketReceiver implementation that wraps a PgmListener.

Constructor & Destructor Documentation

ExitGames.Net.Sockets.Pgm.PgmReceiver.PgmReceiver ( IPEndPoint  endPoint)
inline

Initializes a new instance of the PgmReceiver class.

Parameters
endPointThe multicast end point.
ExitGames.Net.Sockets.Pgm.PgmReceiver.PgmReceiver ( IPAddress  address,
int  port 
)
inline

Initializes a new instance of the PgmReceiver class.

Parameters
addressThe multicast address.
portThe port.
ExitGames.Net.Sockets.Pgm.PgmReceiver.PgmReceiver ( string  address,
int  port 
)
inline

Initializes a new instance of the PgmReceiver class.

Parameters
addressThe multicast address.
portThe port.

Member Function Documentation

void ExitGames.Net.Sockets.Pgm.PgmReceiver.Dispose ( )
inline

Disposes the PgmReceiver.

void ExitGames.Net.Sockets.Pgm.PgmReceiver.Start ( )
inline

Starts the underlying PgmListener.

Property Documentation

IPEndPoint ExitGames.Net.Sockets.Pgm.PgmReceiver.EndPoint
get

Gets the multicast end point.

The end point.

bool ExitGames.Net.Sockets.Pgm.PgmReceiver.IsRunning
get

Gets a value indicating whether the receiver is running.

True if listening.

int ExitGames.Net.Sockets.Pgm.PgmReceiver.ReadBufferSize
getset

Gets or sets the read buffer size.

The buffer size for incoming messages.

int ExitGames.Net.Sockets.Pgm.PgmReceiver.ReceiveBufferSize
getset

Gets or sets the size in bytes of the receive buffer of the System.Net.Sockets.Socket.

The receive buffer size of the System.Net.Sockets.Socket.

IPAddressCollection ExitGames.Net.Sockets.Pgm.PgmReceiver.ReceiveInterfaces
get

Gets the list of interfaces that the instance receives messages from. If no interface is specified the first local interface enumerated is used.

An IPAddressCollection that contains the IPs of all listening interfaces.

bool ExitGames.Net.Sockets.Pgm.PgmReceiver.ReuseAddress
getset

Gets or sets a value indicating whether the receiver socket is allowed to be bound to an address that is already in use.

Default is true.

long ExitGames.Net.Sockets.Pgm.PgmReceiver.TotalBytesReceived
getset

Gets or sets the total number of received bytes.

The total number of received bytes.

bool ExitGames.Net.Sockets.Pgm.PgmReceiver.UseHighSpeedIntranet
getset

Gets or sets a value indicating whether a high bandwidth LAN (100Mbps+) connection is used.

Default is true.

Event Documentation

EventHandler<SocketAcceptEventArgs> ExitGames.Net.Sockets.Pgm.PgmReceiver.Accept

Event for new PGM connections.

EventHandler<SocketDisconnectEventArgs> ExitGames.Net.Sockets.Pgm.PgmReceiver.Disconnected

Event for disconnected PGM connections.

EventHandler<SocketReceiveEventArgs> ExitGames.Net.Sockets.Pgm.PgmReceiver.Receive

Event for received PGM messages.