Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sReturnTypes

Table Row (tr)

style	height: 30px;

Table Head (th)
Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSPacket

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSPacket

Table Cell (td)
#createNewPacket() Create a new empty packet.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSPacket

Table Cell (td)
#getReceivedPacket() Get a packet from recieve buffer, read buffer until empty (null is returned).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#sendPacket(ip/host, packet, [port]) Send a packet.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#startSocket(portnumber, methodToInvokeWhenPacketReceivedAndBufferIsEmpty) Start a UDP socket for a port.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#stopSocket() Stop the UDP socket for a port.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#testPacket(packet) Put a test packet in the receive buffer to test your method call and getReceivedPacket.

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	createNewPacket
class	node

Table Row (tr)

id	name

Table Cell (td)
createNewPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSPacket

Span

style	float: left; font-weight: bold;
id	iets

createNewPacket

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Create a new empty packet.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSPacket

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')//writes UTF
packet.writeInt(12348293)//writes 4 bytes
packet.writeShort(14823)//writes 2 bytes
packet.writeByte(123)//writes 1 byte

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getReceivedPacket
class	node

Table Row (tr)

id	name

Table Cell (td)
getReceivedPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSPacket

Span

style	float: left; font-weight: bold;
id	iets

getReceivedPacket

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Get a packet from recieve buffer, read buffer until empty (null is returned).

Table Row (tr)

id	ret

Table Cell (td)
Returns JSPacket

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var packet = null
while( ( packet = plugins.udp.getReceivedPacket() ) != null)
{
	var text = packet.readUTF()
	var count = packet.readInt()
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sendPacket
class	node

Table Row (tr)

id	name

Table Cell (td)
sendPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

sendPacket

Span

style	float: left;
id	iets

(ip/host, packet, [port])

Table Row (tr)

id	des

Table Cell (td)
Send a packet.

Table Row (tr)

id	prs

Table Cell (td)
Parameters ip/host packet [port]

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.sendPacket('10.0.0.1',packet)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	startSocket
class	node

Table Row (tr)

id	name

Table Cell (td)
startSocket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

startSocket

Span

style	float: left;
id	iets

(portnumber, methodToInvokeWhenPacketReceivedAndBufferIsEmpty)

Table Row (tr)

id	des

Table Cell (td)
Start a UDP socket for a port.

Table Row (tr)

id	prs

Table Cell (td)
Parameters portnumber methodToInvokeWhenPacketReceivedAndBufferIsEmpty

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.udp.startSocket(1234,my_packet_process_method)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	stopSocket
class	node

Table Row (tr)

id	name

Table Cell (td)
stopSocket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

stopSocket

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Stop the UDP socket for a port.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.udp.stopSocket()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	testPacket
class	node

Table Row (tr)

id	name

Table Cell (td)
testPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

testPacket

Span

style	float: left;
id	iets

(packet)

Table Row (tr)

id	des

Table Cell (td)
Put a test packet in the receive buffer to test your method call and getReceivedPacket.

Table Row (tr)

id	prs

Table Cell (td)
Parameters packet

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.testPacket(packet)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 15

New Version Current

Key

createNewPacket

getReceivedPacket

sendPacket

startSocket

stopSocket

testPacket