ptolemy.actor.lib.jjs.modules.udpSocket

Class UDPSocketHelper.UDPSocket

java.lang.Object

ptolemy.actor.lib.jjs.modules.udpSocket.UDPSocketHelper.UDPSocket

Enclosing class:

UDPSocketHelper

public class UDPSocketHelper.UDPSocket
extends java.lang.Object

Socket helper for individual sockets.

Constructor Summary

Constructors

Constructor and Description
UDPSocket(jdk.nashorn.api.scripting.ScriptObjectMirror currentObj, boolean enableBroadcast) Construct a socket.

Method Summary

Modifier and Type	Method and Description
protected void	_emitMessage(io.vertx.core.buffer.Buffer buffer, java.lang.String sender) Convert the buffer to a message depending on the specified receive type and emit a 'message' event.
void	bind(int port, java.lang.String address, jdk.nashorn.api.scripting.ScriptObjectMirror callback) Listen for datagram messages on the specified port and optional address.
void	close() Close the UDP socket.
void	send(java.lang.Object data, int port, java.lang.String hostname, jdk.nashorn.api.scripting.ScriptObjectMirror callback) Send a datagram message.
void	setRawBytes(boolean rawBytes) Set raw bytes support.
void	setReceiveType(java.lang.String type) Set the receive type.
void	setSendType(java.lang.String type) Set the send type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UDPSocket

public UDPSocket(jdk.nashorn.api.scripting.ScriptObjectMirror currentObj,
                 boolean enableBroadcast)

Construct a socket.

Parameters:

currentObj - The corresponding JavaScript Socket object.

enableBroadcast - enabling or not message broadcasting

Method Detail

bind

public void bind(int port,
                 java.lang.String address,
                 jdk.nashorn.api.scripting.ScriptObjectMirror callback)

Listen for datagram messages on the specified port and optional address. Once binding is complete, a 'listening' event is emitted and the optional callback function is called.

Parameters:

port - The port number.

address - The address of the network interface on which to listen, or "0.0.0.0" to listen on all addresses.

callback - A callback function to invoke when the binding is complete, or null to not request a callback.

close

public void close()

Close the UDP socket.

send

public void send(java.lang.Object data,
                 int port,
                 java.lang.String hostname,
                 jdk.nashorn.api.scripting.ScriptObjectMirror callback)

Send a datagram message.

Parameters:

data - The data to send.

port - The destination port.

hostname - The name of the destination host (a hostname or IP address).

callback - An optional callback function to invoke when the send is complete, or if an error occurs. In the latter case, the cause of the error will be passed as an argument to the callback.

setRawBytes

public void setRawBytes(boolean rawBytes)

Set raw bytes support. If this is not called, the attribute defaults to false.

Parameters:

rawBytes - The value of rawBytes.

setReceiveType

public void setReceiveType(java.lang.String type)

Set the receive type. If this is not called, the type defaults to "string".

Parameters:

type - The name of the receive type.

setSendType

public void setSendType(java.lang.String type)

Set the send type. If this is not called, the type defaults to "string".

Parameters:

type - The name of the send type.

_emitMessage

protected void _emitMessage(io.vertx.core.buffer.Buffer buffer,
                            java.lang.String sender)

Convert the buffer to a message depending on the specified receive type and emit a 'message' event. Both the message and sender address are emitted.

Parameters:

buffer - The buffer containing the message.

sender - A string containing the IP address and port of the sender.