JSPacket

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

index
Returns the current position in the byte array of the packet.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

byte[]

Unknown macro: {td}

getByteArray()
Returns the content of the package into a byte array.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

getHost()
Returns the name of the host that sent the packet.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

getLength()
Returns the length of the packet in bytes.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

getPort()
Returns the port where the packet originated from.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

readByte()
Reads an 8 bits byte value from the packet, starting from the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

readInt()
Reads a 32 bits int value from the packet, starting from the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

readShort()
Reads a 32 bits short value from the packet, starting from the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

readUTF()
Reads a UTF-8 string from the packet, starting from the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

readUTF(length)
Reads a UTF-8 string from the packet, starting from the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

writeByte(number)
Writes one byte into the packet, at the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

writeBytes(bytes)
Writes an array of bytes into the packet, at the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

writeInt(number)
Writes a 32 bits int into the packet, at the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

writeShort(number)
Writes a 16 bits short value into the packet, at the current index.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

writeUTF(string)
Writes an UTF-8 encoded string into the packet, at the current index.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

index

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the current position in the byte array of the packet. The next read/write operation will occur at this position.
This is a 0 based index.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('an int is: ' + packet.readInt());
		application.output('moved to index: ' + packet.index);
		application.output('a short is: ' + packet.readShort());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getByteArray

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

byte[]

Unknown macro: {span}

getByteArray

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the content of the package into a byte array.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		var bytes = packet.getByteArray();
		application.output('received a packet of length: ' + bytes.length);
		for (var i=0; i<bytes.length; i++)
			application.output(bytes[i]);
		}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getHost

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getHost

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the name of the host that sent the packet.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('message is: ' + packet.readUTF());
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getLength

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

getLength

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the length of the packet in bytes.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('message is: ' + packet.readUTF());
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getPort

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

getPort

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Returns the port where the packet originated from.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('message is: ' + packet.readUTF());
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

readByte

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

readByte

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Reads an 8 bits byte value from the packet, starting from the current index. Advances the index with one position.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('an int is: ' + packet.readInt());
		application.output('moved to index: ' + packet.index);
		application.output('a short is: ' + packet.readShort());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

readInt

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

readInt

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Reads a 32 bits int value from the packet, starting from the current index. Advances the index with 4 positions.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('an int is: ' + packet.readInt());
		application.output('moved to index: ' + packet.index);
		application.output('a short is: ' + packet.readShort());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

readShort

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

readShort

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Reads a 32 bits short value from the packet, starting from the current index. Advances the index with 2 positions.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('an int is: ' + packet.readInt());
		application.output('moved to index: ' + packet.index);
		application.output('a short is: ' + packet.readShort());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
		application.output('a byte is: ' + packet.readByte());
		application.output('moved to index: ' + packet.index);
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

readUTF

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

readUTF

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Reads a UTF-8 string from the packet, starting from the current index. If an argument is specified, then it represents the length (in UTF-8 encoded bytes, not characters) of the string to read. If no argument is specified, then first a 32 bits (4 byte) int is read from the packet and that will be the byte length of the string. Advances the index with a number of positions that depends on the length of the read string.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('message is: ' + packet.readUTF());
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

readUTF

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

readUTF

Unknown macro: {span}

(length)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Reads a UTF-8 string from the packet, starting from the current index. If an argument is specified, then it represents the length (in UTF-8 encoded bytes, not characters) of the string to read. If no argument is specified, then first a 32 bits (4 byte) int is read from the packet and that will be the byte length of the string. Advances the index with a number of positions that depends on the length of the read string.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} length

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var packet;
while (packet = plugins.udp.getReceivedPacket()) {
	application.output('packet received from ' + packet.getHost() + ':' + packet.getPort());
	if (packet.getLength() > 0) {
		application.output('message is: ' + packet.readUTF());
	}
	else {
		application.output('end of communication.');
		break;
	}
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

writeByte

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

writeByte

Unknown macro: {span}

(number)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Writes one byte into the packet, at the current index. The index is advanced with one position.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} number

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

if (!plugins.udp.startSocket('5555', packetReceived)) {
	application.output('Failed to start socket.');
} else {
	var packet = plugins.udp.createNewPacket();
	packet.writeUTF('hello world!');
	plugins.udp.sendPacket('localhost', packet, 1234);
	packet = plugins.udp.createNewPacket();
	packet.writeByte(0xFF);
	packet.writeShort(10001);
	packet.writeInt(2000000001);
	plugins.udp.sendPacket('localhost', packet, 1234);
	var imgBytes = plugins.file.readFile('logo.jpg', 1024);
	packet = plugins.udp.createNewPacket();
	packet.writeBytes(imgBytes);
	plugins.udp.sendPacket('localhost', packet, 1234);
	plugins.udp.stopSocket();
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

writeBytes

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

writeBytes

Unknown macro: {span}

(bytes)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Writes an array of bytes into the packet, at the current index. The index is advanced with a number of positions equal to the length of the written array.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{byte[]} bytes

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

if (!plugins.udp.startSocket('5555', packetReceived)) {
	application.output('Failed to start socket.');
} else {
	var packet = plugins.udp.createNewPacket();
	packet.writeUTF('hello world!');
	plugins.udp.sendPacket('localhost', packet, 1234);
	packet = plugins.udp.createNewPacket();
	packet.writeByte(0xFF);
	packet.writeShort(10001);
	packet.writeInt(2000000001);
	plugins.udp.sendPacket('localhost', packet, 1234);
	var imgBytes = plugins.file.readFile('logo.jpg', 1024);
	packet = plugins.udp.createNewPacket();
	packet.writeBytes(imgBytes);
	plugins.udp.sendPacket('localhost', packet, 1234);
	plugins.udp.stopSocket();
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

writeInt

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

writeInt

Unknown macro: {span}

(number)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Writes a 32 bits int into the packet, at the current index. The index is advances with 4 positions.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} number

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

if (!plugins.udp.startSocket('5555', packetReceived)) {
	application.output('Failed to start socket.');
} else {
	var packet = plugins.udp.createNewPacket();
	packet.writeUTF('hello world!');
	plugins.udp.sendPacket('localhost', packet, 1234);
	packet = plugins.udp.createNewPacket();
	packet.writeByte(0xFF);
	packet.writeShort(10001);
	packet.writeInt(2000000001);
	plugins.udp.sendPacket('localhost', packet, 1234);
	var imgBytes = plugins.file.readFile('logo.jpg', 1024);
	packet = plugins.udp.createNewPacket();
	packet.writeBytes(imgBytes);
	plugins.udp.sendPacket('localhost', packet, 1234);
	plugins.udp.stopSocket();
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

writeShort

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

writeShort

Unknown macro: {span}

(number)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Writes a 16 bits short value into the packet, at the current index. The index is advances with 2 positions.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} number

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

if (!plugins.udp.startSocket('5555', packetReceived)) {
	application.output('Failed to start socket.');
} else {
	var packet = plugins.udp.createNewPacket();
	packet.writeUTF('hello world!');
	plugins.udp.sendPacket('localhost', packet, 1234);
	packet = plugins.udp.createNewPacket();
	packet.writeByte(0xFF);
	packet.writeShort(10001);
	packet.writeInt(2000000001);
	plugins.udp.sendPacket('localhost', packet, 1234);
	var imgBytes = plugins.file.readFile('logo.jpg', 1024);
	packet = plugins.udp.createNewPacket();
	packet.writeBytes(imgBytes);
	plugins.udp.sendPacket('localhost', packet, 1234);
	plugins.udp.stopSocket();
}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

writeUTF

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

writeUTF

Unknown macro: {span}

(string)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Writes an UTF-8 encoded string into the packet, at the current index. First the length of the string is written on 4 bytes, then the string is written. The index is advanced with a number of positions equal to the length of the string plus 4.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} string

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

if (!plugins.udp.startSocket('5555', packetReceived)) {
	application.output('Failed to start socket.');
} else {
	var packet = plugins.udp.createNewPacket();
	packet.writeUTF('hello world!');
	plugins.udp.sendPacket('localhost', packet, 1234);
	packet = plugins.udp.createNewPacket();
	packet.writeByte(0xFF);
	packet.writeShort(10001);
	packet.writeInt(2000000001);
	plugins.udp.sendPacket('localhost', packet, 1234);
	var imgBytes = plugins.file.readFile('logo.jpg', 1024);
	packet = plugins.udp.createNewPacket();
	packet.writeBytes(imgBytes);
	plugins.udp.sendPacket('localhost', packet, 1234);
	plugins.udp.stopSocket();
}

Unknown macro: {tr}

Unknown macro: {td}

Child pages

JSPacket

index

getByteArray

getHost

getLength

getPort

readByte

readInt

readShort

readUTF

readUTF

writeByte

writeBytes

writeInt

writeShort

writeUTF