Class DatagramSocket

A datagram socket.

Inheritance
System.Object
ManagedSocket
DatagramSocket
UdpSocket
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public abstract class DatagramSocket : ManagedSocket

Properties

MaxQueuedPackets

Gets or sets the maximum number of packets that can be queued at any given point in time.

Declaration
public abstract int MaxQueuedPackets { get; set; }
Property Value
Type Description
System.Int32

ReceiveBufferSize

Gets the current receive buffer size.

Declaration
public abstract int ReceiveBufferSize { get; }
Property Value
Type Description
System.Int32

SendBufferSize

Gets the current send buffer size.

Declaration
public abstract int SendBufferSize { get; }
Property Value
Type Description
System.Int32

Methods

RaiseReceiveFailure(Action1<Exception>, Exception)

Invokes the receive failure callback.

Declaration
protected void RaiseReceiveFailure(Action1<Exception> callback, Exception exception)
Parameters
Type Name Description
Action1<System.Exception> callback

The callback.
System.Exception exception

The exception.

RaiseReceiveSuccess(Action3<DataBuffer, String, Int32>, DataBuffer, String, Int32)

Invokes the receive success callback.

Declaration
protected virtual void RaiseReceiveSuccess(Action3<DataBuffer, string, int> callback, DataBuffer buffer, string ipAddress, int port)
Parameters
Type Name Description
Action3<DataBuffer, System.String, System.Int32> callback

The callback.
DataBuffer buffer

The buffer.
System.String ipAddress

The IP address.
System.Int32 port

The port.

ReceiveAsync(Action3<DataBuffer, String, Int32>, Action1<Exception>)

Receives data asynchronously.

Declaration
public abstract void ReceiveAsync(Action3<DataBuffer, string, int> onSuccess, Action1<Exception> onFailure)
Parameters
Type Name Description
Action3<DataBuffer, System.String, System.Int32> onSuccess

The callback to invoke on success.
Action1<System.Exception> onFailure

The callback to invoke on failure.

Send(DataBuffer, String, Int32)

Sends data synchronously.

Declaration
public abstract Error Send(DataBuffer buffer, string ipAddress, int port)
Parameters
Type Name Description
DataBuffer buffer

The buffer.
System.String ipAddress

The remote IP address.
System.Int32 port

The remote port.
Returns
Type Description
Error