org.ptolemy.ptango.lib.webSocket

Interface WebSocketService

All Known Implementing Classes:

WebSocketReader, WebSocketWriter

public interface WebSocketService

An interface for actors that handle WebSocket requests. The interface allows the relative path for the WebSocket request to be set and obtained, and provides a servlet to handle requests. If this interface is implemented by an actor or attribute in a model that contains an instance of WebServer, then requests to that server that match the relative path set by the setEndpoint(WebSocketEndpoint) method of this interface will be delegated to that actor or attribute.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Elizabeth Latronico and Edward A. Lee

See Also:

WebServer, WebServer

Pt.AcceptedRating:

Red (ltrnc)

Pt.ProposedRating:

Red (ltrnc)

Method Summary

Modifier and Type	Method and Description
java.net.URI	getRelativePath() Get the URI associated with this service.
boolean	isClient() Return true if the service is acting as a client; false if the service is acting as part of the server.
void	onMessage(java.lang.String message) Notify service of a WebSocket message event.
void	setEndpoint(WebSocketEndpoint endpoint) Set the endpoint responsible for this service's communication.

Method Detail

getRelativePath

java.net.URI getRelativePath()

Get the URI associated with this service.

Returns:

the URI associated with this service.

isClient

boolean isClient()

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

Returns:

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

onMessage

void onMessage(java.lang.String message)

Notify service of a WebSocket message event.

Parameters:

message - The message that was received

setEndpoint

void setEndpoint(WebSocketEndpoint endpoint)

Set the endpoint responsible for this service's communication.

Parameters:

endpoint - The endpoint.