UdpClientHelper Class Reference

UDP client helper.
Class instance accessor: UdpClient More...

Public Member Functions
UdpClientHelper	Sender (string address, int port)
	Sets the client as a sender to address:port.
bool	Receiver (int port)
	Connects to the remote using the specified port and returns true if successful, false otherwise.
UdpClientHelper	Disconnect ()
	Disconnects from the remote host.
void	SendMessage (string message)
	Sends a string message.
void	SendMessage (byte[] message)
	Sends a raw data message.
UdpClientHelper	OnStringReceived (Action< string > receivedAction)
	Sets the function to call when a new string message is received.
UdpClientHelper	OnMessageReceived (Action< byte[]> receivedAction)
	Sets the function to call when a new raw message is received.
UdpClientHelper	OnStatusChanged (Action< bool > statusChangeAction)
	Sets the function to call when the status of the connection changes.

Properties
bool	IsConnected [get]
	Gets a value indicating whether the connection to the service is estabilished.
string	EndOfLine [get, set]
	Gets or sets the end of line delimiter used in text messaging.

Detailed Description

UDP client helper.
Class instance accessor: UdpClient

Member Function Documentation

Sender()

UdpClientHelper Sender	(	string	address,
		int	port
	)

Sets the client as a sender to address:port.

Returns

UdpClientHelper.

Parameters

address	Remote DNS or IP address.
port	port to send to

Receiver()

bool Receiver

(

int

port

)

Connects to the remote using the specified port and returns true if successful, false otherwise.

Returns

bool

Parameters

port	Port number.

SendMessage() [1/2]

void SendMessage

(

string

message

)

Sends a string message.

Parameters

message

Message.

SendMessage() [2/2]

void SendMessage

(

byte[]

message

)

Sends a raw data message.

Parameters

message

Message.

OnStringReceived()

UdpClientHelper OnStringReceived

(

Action< string >

receivedAction

)

Sets the function to call when a new string message is received.

Parameters

receivedAction

Function or inline delegate.

OnMessageReceived()

UdpClientHelper OnMessageReceived

(

Action< byte[]>

receivedAction

)

Sets the function to call when a new raw message is received.

Parameters

receivedAction

Function or inline delegate.

OnStatusChanged()

UdpClientHelper OnStatusChanged

(

Action< bool >

statusChangeAction

)

Sets the function to call when the status of the connection changes.

Parameters

statusChangeAction

Function or inline delegate.

Property Documentation

IsConnected

bool IsConnected

get

Gets a value indicating whether the connection to the service is estabilished.

true if connected; otherwise, false.

EndOfLine

string EndOfLine

getset

Gets or sets the end of line delimiter used in text messaging.

The end of line.

---

The documentation for this class was generated from the following file:

• UdpClientHelper.cs