ptolemy.actor.lib.jjs.modules.udpSocket

Class UDPSocketHelper

java.lang.Object

ptolemy.actor.lib.jjs.HelperBase

ptolemy.actor.lib.jjs.VertxHelperBase

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

public class UDPSocketHelper
extends VertxHelperBase

A helper class for the udpSocket module in JavaScript. See the documentation of that module for instructions.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Hokeun Kim

Pt.AcceptedRating:

Red (bilung)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UDPSocketHelper.UDPSocket Socket helper for individual sockets.

Nested classes/interfaces inherited from class ptolemy.actor.lib.jjs.VertxHelperBase

VertxHelperBase.AccessorVerticle

Nested classes/interfaces inherited from class ptolemy.actor.lib.jjs.HelperBase

HelperBase.DATA_TYPE

Field Summary

Fields inherited from class ptolemy.actor.lib.jjs.VertxHelperBase

_verticle, _vertx

Fields inherited from class ptolemy.actor.lib.jjs.HelperBase

_actor, _currentObj

Constructor Summary

Constructors

Constructor and Description
UDPSocketHelper(java.lang.Object actor, jdk.nashorn.api.scripting.ScriptObjectMirror helping) Constructor for UDPSocketHelper for the specified actor.

Method Summary

Modifier and Type	Method and Description
UDPSocketHelper.UDPSocket	createSocket(jdk.nashorn.api.scripting.ScriptObjectMirror scriptObjectMirror, boolean enableBroadcast) Create the UDP socket.
static UDPSocketHelper	getOrCreateHelper(java.lang.Object actor, jdk.nashorn.api.scripting.ScriptObjectMirror helping) Get or create a helper for the specified actor.
static java.lang.String[]	supportedReceiveTypes() Return an array of the types supported by the current host for receiveType arguments.
static java.lang.String[]	supportedSendTypes() Return an array of the types supported by the current host for sendType arguments.

Methods inherited from class ptolemy.actor.lib.jjs.VertxHelperBase

_issueOrDeferResponse, _processPendingJob, _setBusy, closeVertx, getHelper, getImageTypes, reset, submit, undeploy

Methods inherited from class ptolemy.actor.lib.jjs.HelperBase

_appendNumericToBuffer, _appendToBuffer, _error, _error, _error, _error, _extractFromBuffer, _issueResponse, _removeDuplicates, _sizeOfType, _toJavaBytes, _toJSArray, getHelping

Methods inherited from class java.lang.Object

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

Constructor Detail

UDPSocketHelper

public UDPSocketHelper(java.lang.Object actor,
                       jdk.nashorn.api.scripting.ScriptObjectMirror helping)

Constructor for UDPSocketHelper for the specified actor.

Parameters:

actor - The actor that this will help.

helping - The JavaScript object that this helping.

Method Detail

createSocket

public UDPSocketHelper.UDPSocket createSocket(jdk.nashorn.api.scripting.ScriptObjectMirror scriptObjectMirror,
                                              boolean enableBroadcast)

Create the UDP socket.

Parameters:

scriptObjectMirror - The JavaScript instance invoking the shell.

enableBroadcast - enabling or not message broadcasting

Returns:

The UDP socket helper.

getOrCreateHelper

public static UDPSocketHelper getOrCreateHelper(java.lang.Object actor,
                                                jdk.nashorn.api.scripting.ScriptObjectMirror helping)

Get or create a helper for the specified actor. If one has been created before and has not been garbage collected, return that one. Otherwise, create a new one.

Parameters:

actor - Either a JavaScript actor or a RestrictedJavaScriptInterface.

helping - The JavaScript object that this is helping.

Returns:

The UDPSocketHelper.

supportedReceiveTypes

public static java.lang.String[] supportedReceiveTypes()

Return an array of the types supported by the current host for receiveType arguments.

Returns:

An array of types.

supportedSendTypes

public static java.lang.String[] supportedSendTypes()

Return an array of the types supported by the current host for sendType arguments.

Returns:

An array of types.