Servoy 2020 Documentation
Child pages
  • udp

Versions Compared

Old Version 5

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version 6

changes.mady.by.user Servoy Docs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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=09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7}{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:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_des|text=|trigger=button}{sub-section}{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_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:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_ret|text=|trigger=button}{sub-section}{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_ret|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_see|text=|trigger=button}{sub-section}{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_see|text=|trigger=button}{sub-section}{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_sam|text=|trigger=button}{sub-section}{sub-section:09384ACD7A6819A4-DBB6D640-4F204CD8-A0FEA2DE-87F5CD9B94CCF4E0B1087AA7_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=2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4}{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:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_des|text=|trigger=button}{sub-section}{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_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:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_ret|text=|trigger=button}{sub-section}{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_ret|trigger=none|class=sIndent}[JSPacket]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_see|text=|trigger=button}{sub-section}{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_see|text=|trigger=button}{sub-section}{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_sam|text=|trigger=button}{sub-section}{sub-section:2C80E30C2848BADB-B9C67AE7-47FA407F-A2D19170-6865D700DA91D5FBF7BA02A4_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=87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B}{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:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_des|text=|trigger=button}{sub-section}{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_des|trigger=none|class=sIndent}Send a packet.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_prs|trigger=none}ip/host
packet
\[port\]
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_ret|text=|trigger=button}{sub-section}{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_see|text=|trigger=button}{sub-section}{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_see|text=|trigger=button}{sub-section}{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_sam|text=|trigger=button}{sub-section}{sub-section:87550448D88BD989-8D89CB19-4DA24B65-9D46A73B-E1F5B508F9D2F074EA7E970B_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=EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD}{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:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_des|text=|trigger=button}{sub-section}{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_des|trigger=none|class=sIndent}Start a UDP socket for a port.{sub-section}{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_prs|trigger=none}portnumber
methodToInvokeWhenPacketReceivedAndBufferIsEmpty
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_ret|text=|trigger=button}{sub-section}{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_see|text=|trigger=button}{sub-section}{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_see|text=|trigger=button}{sub-section}{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_sam|text=|trigger=button}{sub-section}{sub-section:EF137884000B8F37-BBD2BB0C-493A4ABE-A5548F24-B547E8536A7802BCB744D9AD_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=97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43}{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:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_des|text=|trigger=button}{sub-section}{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_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:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_prs|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_ret|text=|trigger=button}{sub-section}{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_see|text=|trigger=button}{sub-section}{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_see|text=|trigger=button}{sub-section}{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_sam|text=|trigger=button}{sub-section}{sub-section:97DD1CBDBFFEA506-A7A7175E-44164BC6-96B5969D-0B643EB29E7BD6AB3D85EE43_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=3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D}{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:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_des|text=|trigger=button}{sub-section}{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_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:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_prs|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_prs|trigger=none}packet
{sub-section}{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_ret|text=|trigger=button}{sub-section}{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_see|text=|trigger=button}{sub-section}{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_see|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_see|text=|trigger=button}{sub-section}{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_link|class=sIndent|trigger=none}{sub-section}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_sam|text=|trigger=button}{sub-section}{sub-section:3F3B8F238165E987-58DADF10-4A5F4F23-87AF9C14-3A85EFD952EA93B7F17F506D_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}