Page History

Div

style	display:none

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.

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

JSPacket

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
JSPacket

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

Table Row (tr)

Table Cell (td)
JSPacket

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendPacket(destIpOrHostname, packet) Send a packet.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
sendPacket(destIpOrHostname, packet, port) Send a packet on another port.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
startSocket(port_number, method_to_call_when_packet_received_and_buffer_is_empty) Start a UDP socket for a port.

Table Row (tr)

Table Cell (td)
void

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

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

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	createNewPacket

Table Row (tr)

id	name

Table Cell (td)
createNewPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPacket

Span

style	font-weight: bold;

createNewPacket

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a new empty packet.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
getReceivedPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPacket

Span

style	font-weight: bold;

getReceivedPacket

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a packet from receive buffer, read buffer until empty (null is returned).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-String_JSPacket

Table Row (tr)

id	name

Table Cell (td)
sendPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendPacket

Span
(destIpOrHostname, packet)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Send a packet.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} destIpOrHostname - the ip of the destination or the hostname
{JSPacket} packet - the JSPacket to send

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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	sendPacket-String_JSPacket_Number

Table Row (tr)

id	name

Table Cell (td)
sendPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

sendPacket

Span
(destIpOrHostname, packet, port)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Send a packet on another port.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} destIpOrHostname - the ip of the destination or the hostname
{JSPacket} packet - the JSPacket to send
{Number} port - the port on which to send the packet

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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, 4321)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	startSocket-Number_Object

Table Row (tr)

id	name

Table Cell (td)
startSocket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

startSocket

Span
(port_number, method_to_call_when_packet_received_and_buffer_is_empty)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Start a UDP socket for a port.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} port_number - the local port that this UDP socket will bind to.
{Object} method_to_call_when_packet_received_and_buffer_is_empty - when the socket receives one or more packages, it calls this method once.
The method will no longer be called even if new packages are received - until a call to UDPProvider#js_getReceivedPacket() returns null. So you should
consume all available packets before you expect this method to be called again.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
stopSocket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

stopSocket

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Stop the UDP socket for a port.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-JSPacket

Table Row (tr)

id	name

Table Cell (td)
testPacket

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

testPacket

Span
(packet)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Put a test packet in the receive buffer to test your method call and getReceivedPacket.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSPacket} packet

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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 25

New Version Current

Key

createNewPacket

getReceivedPacket

sendPacket

sendPacket

startSocket

stopSocket

testPacket