{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:class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[JSPacket]{span}{td}{tr}{table}\\ {table:class=servoy sSummery}{colgroup}{column:width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{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:class=servoy sDetail}{colgroup}{column:width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=E3E67309-A217-49D2-A363-C25AA0EDA7D3}{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-C25AA0EDA7D3_des|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_des|trigger=none|class=sIndent}Create a new empty packet.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_ret|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_ret|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_see|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_see|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_sam|text=|trigger=button}{sub-section}{sub-section:E3E67309-A217-49D2-A363-C25AA0EDA7D3_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B8A4A34C-4B48-4B4E-8908-B645A912B52C}{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-B645A912B52C_des|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_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=prs}{td}*Parameters*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_ret|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_ret|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_see|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_see|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_sam|text=|trigger=button}{sub-section}{sub-section:B8A4A34C-4B48-4B4E-8908-B645A912B52C_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4}{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-0C053CDE0FF4_des|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_des|trigger=none|class=sIndent}Send a packet.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_prs|trigger=none}ip/host packet \[port\] {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_ret|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_see|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_see|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_sam|text=|trigger=button}{sub-section}{sub-section:7A9E3AC6-D71C-42EF-AB13-0C053CDE0FF4_sam|class=sIndent|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}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=5E89CEBF-03B9-4F96-82DE-4E6384761C81}{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-4E6384761C81_des|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_des|trigger=none|class=sIndent}Start a UDP socket for a port.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_prs|trigger=none}portnumber methodToInvokeWhenPacketReceivedAndBufferIsEmpty {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_ret|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_see|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_see|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_sam|text=|trigger=button}{sub-section}{sub-section:5E89CEBF-03B9-4F96-82DE-4E6384761C81_sam|class=sIndent|trigger=none}{code:language=javascript} plugins.udp.startSocket(1234,my_packet_process_method) {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=31F54B5B-ECA7-4BF5-AC7C-33A998560302}{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-33A998560302_des|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_des|trigger=none|class=sIndent}Stop the UDP socket for a port.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_ret|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_see|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_see|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_sam|text=|trigger=button}{sub-section}{sub-section:31F54B5B-ECA7-4BF5-AC7C-33A998560302_sam|class=sIndent|trigger=none}{code:language=javascript} plugins.udp.stopSocket() {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=B93410D7-84BD-4E44-94B2-D88BD12DA9D0}{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}{td}{tr}{tr:id=des}{td}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_des|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_des|trigger=none|class=sIndent}Put a test packet in the receive buffer to test your method call and getReceivedPacket.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_prs|trigger=none}packet {sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_ret|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_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-D88BD12DA9D0_see|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_see|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_sam|text=|trigger=button}{sub-section}{sub-section:B93410D7-84BD-4E44-94B2-D88BD12DA9D0_sam|class=sIndent|trigger=none}{code:language=javascript} var packet = plugins.udp.createNewPacket() packet.writeUTF('hello world!') plugins.udp.testPacket(packet) {code}{sub-section}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |