Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 17
Next »
Unknown macro: {div}
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
Unknown macro: {div}
Unknown macro: {table} Unknown macro: {tr} Unknown macro: {th} Return Types
Unknown macro: {table}
{column:width=80px|padding=0px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getReceivedPacket()
Get a packet from receive buffer, read buffer until empty (null is returned).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendPacket(destIpOrHostname, packet)
Send a packet.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendPacket(destIpOrHostname, packet, port)
Send a packet on another port.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} startSocket(port_number, method_to_call_when_packet_received_and_buffer_is_empty)
Start a UDP socket for a port.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} stopSocket()
Stop the UDP socket for a port.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} testPacket(packet)
Put a test packet in the receive buffer to test your method call and getReceivedPacket.
Unknown macro: {table}
{column:width=100%|padding=0px}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createNewPacket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} createNewPacket
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
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
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getReceivedPacket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getReceivedPacket
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var packet = null
while( ( packet = plugins.udp.getReceivedPacket() ) != null)
{
var text = packet.readUTF()
var count = packet.readInt()
}
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendPacket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} sendPacket
Unknown macro: {span} (destIpOrHostname, packet)
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} destIpOrHostname – the ip of the destination or the hostname
{JSPacket} packet – the JSPacket to send
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.sendPacket('10.0.0.1',packet)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendPacket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} sendPacket
Unknown macro: {span} (destIpOrHostname, packet, port)
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {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
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.sendPacket('10.0.0.1',packet, 4321)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} startSocket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} startSocket
Unknown macro: {span} (port_number, method_to_call_when_packet_received_and_buffer_is_empty)
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {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.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
plugins.udp.startSocket(1234,my_packet_process_method)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} stopSocket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} stopSocket
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} testPacket
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} testPacket
Unknown macro: {span} (packet)
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var packet = plugins.udp.createNewPacket()
packet.writeUTF('hello world!')
plugins.udp.testPacket(packet)
Unknown macro: {tr} Unknown macro: {td}