Udp

This object allows you to establish a connection to an UDP peer.

Constructor function.

var myObject = new Udp(events);

1. events - (object) the events that can be called
   • onConnected - (onConnected) called when the object is connected to the peer
   • onDisconnected - (onDisconnected) called when the object is disconnected from the peer
   • onReadyRead - (onReadyRead) called when the object is ready to read data sent from the peer
   • onError - (onError) called when an error has occured

var myObject = new Udp();

var myObject = new Udp({
	onConnected: function()
	{
		Console.print("Connected!");
	},
	onDisconnected: function()
	{
		Console.print("Disconnected!");
	}
});

Opens a connection to a peer.

myObject.connect(hostname, port, openMode);

myObject.connect(hostname, port);

1. hostname - (string) the hostname to connect to (ip address or dns)
2. port - (integer) the port number
3. openMode - (OpenMode) the open mode (default: read & write)

• (Udp) this Udp

This method is asynchronous, this means that it will return before a connection is established. To know when a connection is made use the onConnected event or the waitForConnected method.

Writes some data to the peer.

myObject.write(data);

1. data - (mixed) the data to write

• (Udp) this Udp

This method is asynchronous, this means that it will return before the data has been written. Due to the unreliable nature of UDP you have no means to know if the data has arrived.

Writes some text to the peer.

myObject.writeText(text);

1. text - (string) the text to write

• (Udp) this Udp

This method is asynchronous, this means that it will return before the data has been written. Due to the unreliable nature of UDP you have no means to know if the data has arrived.

Closes a connection with a peer.

myObject.disconnect();

myObject.disconnect();

• (Udp) this Udp

This method is asynchronous, this means that it will return before the connection is closed. To know when the connection is closed use the onDisconnected event or the waitForDisconnected method.

Returns the data sent by the peer.

myObject.read();

• (mixed) the data

To know when data is available use the onReadyRead event or the waitForReadyRead method.

Returns the text sent by the peer.

myObject.readText(encoding);

myObject.readText();

1. encoding - (Encoding) the encoding to use

• (string) the text

To know when text is available use the onReadyRead event or the waitForReadyRead method.

Freezes the execution until a connection has been established or waitTime time elapsed.

myObject.waitForConnected(waitTime);

myObject.waitForConnected();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Udp) this Udp

• (ConnectionError) cannot establish a connection to the host

Freezes the execution until the connection has been closed or waitTime time elapsed.

myObject.waitForDisconnected(waitTime);

myObject.waitForDisconnected();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Udp) this Udp

• (DisconnectionError) waiting for disconnection failed

Freezes the execution until data is available or waitTime time elapsed.

myObject.waitForReadyRead(waitTime);

myObject.waitForReadyRead();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Udp) this Udp

• (ReadyReadError) waiting for ready read failed

Called when a connection is established.

myObject.onConnected = function() {};

myObject.onConnected = function()
{
	//Event action
};

Called when a connection is closed.

myObject.onDisconnected = function() {};

myObject.onDisconnected = function()
{
	//Event action
};

Called when data is available and can be read using the read method.

myObject.onReadyRead = function() {};

myObject.onReadyRead = function()
{
	//Event action
};

Called when an error has occurred.

myObject.onError = function(errorMessage) {};

1. errorMessage - (string) text describing the error

myObject.errorMessage = function(errorMessage)
{
	//Event action
};

Udp open mode.

1. ReadOnly: socked opened for reading only
2. WriteOnly: socked opened for writing only
3. ReadWrite: socked opened for reading and writing
4. Unbuffered: socked opened in unbuffered mode

This is a flag enumeration, that means that you can use multiple values using the | operator. Example:

myObject.connect("127.0.0.1", 80, Udp.ReadOnly | Udp.Unbuffered);