Page History

Wiki Markup
{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{hidden}
{sub-section:description|text=}{sub-section}\\ 

{table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types Details{th}{tr}{tr}{td}{span:class=sWordList}[JSPacket]{span}{td}{tr}{table}\\ 

{table:id=|class=servoy sSummery}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method SummarySummery{th}{tr}{tbody}{tr}{td}[JSPacket]{td}{td}[#createNewPacket]\()
Create a new empty packet.{td}{tr}{tbody}{tbody}{tr}{td}[JSPacket]{td}{td}[#getReceivedPacket]\()
Get a packet from recieve buffer, read buffer until empty (null is returned).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#sendPacket]\(ip/host, packet, \[port])
Send a packet.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#startSocket]\(portnumber, methodToInvokeWhenPacketReceivedAndBufferIsEmpty)
Start a UDP socket for a port.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#stopSocket]\()
Stop the UDP socket for a port.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#testPacket]\(packet)
Put a test packet in the receive buffer to test your method call and getReceivedPacket.{td}{tr}{tbody}{table}\\ 

{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=E3E67309-A217-49D2-A363-C25AA0EDA7D3=createNewPacket|class=node}{tr:id=name}{td}h6.createNewPacket{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSPacket]{span}{span:id=iets|style=float: left; font-weight: bold;}createNewPacket{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3createNewPacket_des|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3createNewPacket_des|trigger=none|class=sIndent}Create a new empty packet.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_prs|createNewPacket_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_prscreateNewPacket_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_retcreateNewPacket_prs|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_retcreateNewPacket_prs|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_seecreateNewPacket_ret|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_seecreateNewPacket_ret|trigger=none|class=sIndent|trigger=none}}[JSPacket]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3createNewPacket_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_link|class=sIndent|createNewPacket_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_samcreateNewPacket_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_sam|class=sIndent|trigger=none}{code:language=javascript}
var createNewPacket_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:createNewPacket_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:createNewPacket_sam|trigger=none}{code: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
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B8A4A34C-4B48-4B4E-8908-B645A912B52CgetReceivedPacket|class=node}{tr:id=name}{td}h6.getReceivedPacket{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSPacket]{span}{span:id=iets|style=float: left; font-weight: bold;}getReceivedPacket{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52CgetReceivedPacket_des|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52CgetReceivedPacket_des|trigger=none|class=sIndent}Get a packet from recieve buffer, read buffer until empty (null is returned).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_prsgetReceivedPacket_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_prsgetReceivedPacket_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_retgetReceivedPacket_prs|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_retgetReceivedPacket_prs|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_seegetReceivedPacket_ret|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_seegetReceivedPacket_ret|trigger=none|class=sIndent|trigger=none}}[JSPacket]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52CgetReceivedPacket_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_link|class=sIndent|getReceivedPacket_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_samgetReceivedPacket_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_sam|class=sIndentgetReceivedPacket_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getReceivedPacket_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:getReceivedPacket_sam|trigger=none}{code:language=javascript}
var packet = null
while( ( packet = plugins.udp.getReceivedPacket() ) != null)
{
	var text = packet.readUTF()
	var count = packet.readInt()
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4sendPacket|class=node}{tr:id=name}{td}h6.sendPacket{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}sendPacket{span}{span:id=iets|style=float: left;}\(ip/host, packet, \[port]){span}{td}{tr}{tr:id=des}{td}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4sendPacket_des|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4sendPacket_des|trigger=none|class=sIndent}Send a packet.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_prssendPacket_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_prssub-section:sendPacket_snc|trigger=none}ip/host
packet
\[port\]
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_retsendPacket_prs|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_retsendPacket_prs|trigger=none|class=sIndent}[Boolean]ip/host
packet
\[port]
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_seesendPacket_ret|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_seesendPacket_ret|trigger=none|class=sIndent|trigger=none}}[Boolean]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4sendPacket_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_link|class=sIndent|sendPacket_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_samsendPacket_link|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_sam|class=sIndent|trigger=none}{code:language=div:class=sIndent}{sub-section:sendPacket_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:sendPacket_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:sendPacket_sam|trigger=none}{code:language=javascript}
var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.sendPacket('10.0.0.1',packet)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=5E89CEBF-03B9-4F96-82DE-4E6384761C81startSocket|class=node}{tr:id=name}{td}h6.startSocket{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}startSocket{span}{span:id=iets|style=float: left;}\(portnumber, methodToInvokeWhenPacketReceivedAndBufferIsEmpty){span}{td}{tr}{tr:id=des}{td}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81startSocket_des|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81startSocket_des|trigger=none|class=sIndent}Start a UDP socket for a port.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_prsstartSocket_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_prsstartSocket_snc|trigger=none}portnumber
methodToInvokeWhenPacketReceivedAndBufferIsEmpty
|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_retstartSocket_prs|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_retstartSocket_prs|trigger=none|class=sIndent}[Boolean]portnumber
methodToInvokeWhenPacketReceivedAndBufferIsEmpty
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_seestartSocket_ret|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_seestartSocket_ret|trigger=none|class=sIndent|trigger=none}}[Boolean]{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81startSocket_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_link|class=sIndent|startSocket_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_samstartSocket_link|text=|trigger=button}{sub-section}{subdiv:class=sIndent}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_sam|class=sIndent|startSocket_link|trigger=none}{code:language=javascript}
plugins.udp.startSocket(1234,my_packet_process_method)
{code}{sub-section}{div}{td}{tr}{builder-show}{tr:classid=lastDetailRowsam}{td}{td}{tr}{tbody}{tbody:id=31F54B5B-ECA7-4BF5-AC7C-33A998560302}{tr:id=name}{td}h6.stopSocket{td}{tr}{tr:id=*Sample*\\{sub-section:startSocket_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:startSocket_sam|trigger=none}{code:language=javascript}
plugins.udp.startSocket(1234,my_packet_process_method)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stopSocket|class=node}{tr:id=name}{td}h6.stopSocket{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}stopSocket{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302stopSocket_des|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302stopSocket_des|trigger=none|class=sIndent}Stop the UDP socket for a port.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prssnc}{td}*ParametersSince*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_prsstopSocket_snc|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_prsstopSocket_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{divtd}{tdtr}{trbuilder-show}{builder-show:permission=edit}{tr:id=retprs}{td}*ReturnsParameters*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_retstopSocket_prs|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_retstopSocket_prs|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=seeret}{td}*Also seeReturns*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_seestopSocket_ret|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_seestopSocket_ret|trigger=none|class=sIndent|trigger=none}void{sub-section}{td}{tr}{builder-show}{builder-show::permission=edit}{tr:id=linksee}{td}*ExternalAlso linkssee*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302stopSocket_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_link|class=sIndent|stopSocket_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=samlink}{td}*SampleExternal links*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_sam|textstopSocket_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_sam|class=sIndent|stopSocket_link|trigger=none}{code:language=javascript}
plugins.udp.stopSocket()
{code}{sub-section}{div}{td}{tr}{builder-show}{tr:classid=lastDetailRowsam}{td}{td}{tr}{tbody}{tbody:id=B93410D7-84BD-4E44-94B2-D88BD12DA9D0}{tr:id=name}{td}h6.testPacket*Sample*\\{sub-section:stopSocket_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:stopSocket_sam|trigger=none}{code:language=javascript}
plugins.udp.stopSocket()
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=testPacket|class=node}{tr:id=name}{td}h6.testPacket{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}testPacket{span}{span:id=iets|style=float: left;}\(packet){span bold;}testPacket{span}{span:id=iets|style=float: left;}\(packet){span}{td}{tr}{tr:id=des}{td}{sub-section:testPacket_des|text=|trigger=button}{sub-section}{sub-section:testPacket_des|trigger=none|class=sIndent}Put a test packet in the receive buffer to test your method call and getReceivedPacket.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=dessnc}{td}*Since*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_destestPacket_snc|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_des-section:testPacket_snc|trigger=none|class=sIndent}Put aReplace testwith packet in the receive buffer to test your method call and getReceivedPacket.version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0-section}{sub-section:testPacket_prs|trigger=none|class=sIndent}packet
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_ret|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_see|class=sIndent|trigger=none}{sub-sectionsection}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_seetestPacket_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_link|class=sIndent|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0testPacket_sam|class=sIndent|trigger=none}{code:language=javascript}
var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.testPacket(packet)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Child pages

Versions Compared

Old Version 9

New Version 10

Key
