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: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=7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9}{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:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_des|text=|trigger=button}{sub-section}{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_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:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_ret|text=|trigger=button}{sub-section}{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_ret|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_see|text=|trigger=button}{sub-section}{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_see|text=|trigger=button}{sub-section}{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_sam|text=|trigger=button}{sub-section}{sub-section:7A6819A4558EB253-D640BA57-4CD84EF9-A2DE96F0-F4E0B1087AA70B74A43F77B9_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=2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E}{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:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_des|text=|trigger=button}{sub-section}{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_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:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_ret|text=|trigger=button}{sub-section}{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_ret|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_see|text=|trigger=button}{sub-section}{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_see|text=|trigger=button}{sub-section}{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_sam|text=|trigger=button}{sub-section}{sub-section:2848BADBCB9CEEA9-7AE7020F-407F4482-9170A4E9-D5FBF7BA02A4ABEA9605C85E_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=D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F}{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:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_des|text=|trigger=button}{sub-section}{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_des|trigger=none|class=sIndent}Send a packet.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_prs|trigger=none}ip/host
packet
\[port\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_ret|text=|trigger=button}{sub-section}{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_see|text=|trigger=button}{sub-section}{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_see|text=|trigger=button}{sub-section}{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_sam|text=|trigger=button}{sub-section}{sub-section:D88BD989F00F79E0-CB19B46C-4B654278-A73BAF85-F074EA7E970B7E86112E0B4F_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=000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319}{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:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_des|text=|trigger=button}{sub-section}{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_des|trigger=none|class=sIndent}Start a UDP socket for a port.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_prs|trigger=none}portnumber
methodToInvokeWhenPacketReceivedAndBufferIsEmpty
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_ret|text=|trigger=button}{sub-section}{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_see|text=|trigger=button}{sub-section}{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_see|text=|trigger=button}{sub-section}{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_sam|text=|trigger=button}{sub-section}{sub-section:000B8F3727CB217D-BB0CFBBF-4ABE4F32-8F24A474-02BCB744D9AD50AC128BA319_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=BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D}{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:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_des|text=|trigger=button}{sub-section}{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_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:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_ret|text=|trigger=button}{sub-section}{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_see|text=|trigger=button}{sub-section}{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_see|text=|trigger=button}{sub-section}{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_sam|text=|trigger=button}{sub-section}{sub-section:BFFEA50605625535-175ED63F-4BC64674-969D9528-D6AB3D85EE43C90FA89DE25D_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=8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC}{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:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_des|text=|trigger=button}{sub-section}{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_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:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_prs|trigger=none}packet
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_ret|text=|trigger=button}{sub-section}{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_see|text=|trigger=button}{sub-section}{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_see|text=|trigger=button}{sub-section}{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_sam|text=|trigger=button}{sub-section}{sub-section:8165E9872602439A-DF108920-4F234145-9C149EC0-93B7F17F506D3AE9CA5FB8DC_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}
Child pages

Versions Compared

Old Version 6

New Version 7

Key
