org.ptolemy.ptango.lib.webSocket

Class WebSocketReader

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.ptolemy.ptango.lib.webSocket.WebSocketReader

All Implemented Interfaces:

java.lang.Cloneable, WebSocketService, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class WebSocketReader
extends TypedAtomicActor
implements WebSocketService

An actor that reads information from a websocket. Multiple readers of the same URL path are allowed.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Elizabeth Latronico

Pt.AcceptedRating:

Red (ltrnc)

Pt.ProposedRating:

Red (ltrnc)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	client A flag indicating if the reader acts as a client or as part of the server.
TypedIOPort	output A port that outputs each message received from the websocket.
StringParameter	path The URL affiliated with the websocket.

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
WebSocketReader(CompositeEntity container, java.lang.String name) Create an instance of the actor.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) React to a change in an attribute.
java.lang.Object	clone(Workspace workspace) Clone the actor.
void	fire() Send the message from the websocket to the output port.
java.net.URI	getRelativePath() Get the URI associated with this service.
void	initialize() Remember the time at which this actor was initialized in order to request firings at a particular time.
boolean	isClient() Return true if this actor acts as a client; false if it acts as a part of the server (responding to incoming messages).
void	onMessage(java.lang.String message) Upon receipt of a message, store the message and request a firing.
void	setEndpoint(WebSocketEndpoint endpoint) Do nothing here.
void	wrapup() Unsubscribe this service from the endpoint manager.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

client

public Parameter client

A flag indicating if the reader acts as a client or as part of the server. True for client; false for server.

output

public TypedIOPort output

A port that outputs each message received from the websocket.

path

public StringParameter path

The URL affiliated with the websocket. Can refer to a locally hosted websocket or a remotely hosted websocket. Locally hosted websockets have paths of the form /* such as / or /mysocket or /mysocket/first . These will internally be translated to ws://localhost:port/path e.g. ws://localhost:8078/mysocket . Paths for remotely hosted websockets should start with ws:// or wss://

Constructor Detail

WebSocketReader

public WebSocketReader(CompositeEntity container,
                       java.lang.String name)
                throws IllegalActionException,
                       NameDuplicationException

Create an instance of the actor.

Parameters:

container - The container

name - The name.

Throws:

IllegalActionException - If the superclass throws it.

NameDuplicationException - If the superclass throws it.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute. In this case, check the value of the path attribute to make sure it is a valid URI.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor.

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace in which to place the cloned attribute.

Returns:

The cloned attribute.

Throws:

java.lang.CloneNotSupportedException - Not thrown in this base class.

See Also:

Object.clone()

fire

public void fire()
          throws IllegalActionException

Send the message from the websocket to the output port.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If the message cannot be sent to the output port.

getRelativePath

public java.net.URI getRelativePath()

Get the URI associated with this service.

Specified by:

getRelativePath in interface WebSocketService

Returns:

The URI associated with this service.

initialize

public void initialize()
                throws IllegalActionException

Remember the time at which this actor was initialized in order to request firings at a particular time. Subscribe this service to the appropriate endpoint.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If the parent throws it.

isClient

public boolean isClient()

Return true if this actor acts as a client; false if it acts as a part of the server (responding to incoming messages).

Specified by:

isClient in interface WebSocketService

Returns:

True if the service is acting as a client; false if the service is acting as part of the server.

onMessage

public void onMessage(java.lang.String message)

Upon receipt of a message, store the message and request a firing.

Specified by:

onMessage in interface WebSocketService

Parameters:

message - The message that was received.

setEndpoint

public void setEndpoint(WebSocketEndpoint endpoint)

Do nothing here. The reader does not send messages and therefore does not need a reference to its endpoint.

Specified by:

setEndpoint in interface WebSocketService

Parameters:

endpoint - The endpoint.

wrapup

public void wrapup()
            throws IllegalActionException

Unsubscribe this service from the endpoint manager. The endpoint manager will close connections with no subscribers.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.