Sylloge
A C# helper library
Public Member Functions | Properties
Sylloge.Net.UdpSocket Class Reference

Inherits Sylloge.Net.Socket.

List of all members.

Public Member Functions

 UdpSocket ()
 The default constructor.
 UdpSocket (string ipAddress, int port)
 Create an instance using a specific IP and port.
override Sylloge.Net.Socket Copy ()
 Create a deep copy of the current connection.
override void Close ()
 Closes the current UDP socket.
override void Connect (Socket.KeepAliveType type=KeepAliveType.NONE, byte[] msg=null, int msInterval=0)
 Connect the client.
override void Listen ()
 Initiate the listener threads for the UDP clients.
override void Send (byte[] data)
 Send data over the UDP connection.
override string ToString ()
 Returns the IP and Port of this instance.

Properties

System.Net.Sockets.UdpClient Client [get, set]
 The client to communicate on a UDP socket.

Detailed Description

Definition at line 564 of file Socket.cs.


Constructor & Destructor Documentation

Sylloge.Net.UdpSocket.UdpSocket ( )

The default constructor.

Definition at line 574 of file Socket.cs.

Sylloge.Net.UdpSocket.UdpSocket ( string  ipAddress,
int  port 
)

Create an instance using a specific IP and port.

Parameters:
ipAddressThe IP address to use
portThe port to use

Definition at line 583 of file Socket.cs.


Member Function Documentation

override void Sylloge.Net.UdpSocket.Close ( ) [virtual]

Closes the current UDP socket.

Implements Sylloge.Net.Socket.

Definition at line 607 of file Socket.cs.

override void Sylloge.Net.UdpSocket.Connect ( Socket.KeepAliveType  type = KeepAliveType.NONE,
byte[]  msg = null,
int  msInterval = 0 
) [virtual]

Connect the client.

Parameters:
typeThe keep alive type to use (defualt NONE)
msgThe custom keep alive message to send (default null)
msIntervalThe interval to send custom keep alive messages at (default 0)

Implements Sylloge.Net.Socket.

Definition at line 626 of file Socket.cs.

override Sylloge.Net.Socket Sylloge.Net.UdpSocket.Copy ( ) [virtual]

Create a deep copy of the current connection.

Returns:

Reimplemented from Sylloge.Net.Socket.

Definition at line 593 of file Socket.cs.

override void Sylloge.Net.UdpSocket.Listen ( ) [virtual]

Initiate the listener threads for the UDP clients.

Implements Sylloge.Net.Socket.

Definition at line 663 of file Socket.cs.

override void Sylloge.Net.UdpSocket.Send ( byte[]  data) [virtual]

Send data over the UDP connection.

Parameters:
dataThe data to send

Implements Sylloge.Net.Socket.

Definition at line 712 of file Socket.cs.

override string Sylloge.Net.UdpSocket.ToString ( )

Returns the IP and Port of this instance.

Returns:
A string object of this instances IP and Port

Reimplemented from Sylloge.Net.Socket.

Definition at line 742 of file Socket.cs.


Property Documentation

System.Net.Sockets.UdpClient Sylloge.Net.UdpSocket.Client [get, set]

The client to communicate on a UDP socket.

Definition at line 569 of file Socket.cs.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events