org.ptolemy.ptango.lib.websocket

Interface WebSocketService

All Known Implementing Classes:

PtolemyWebSocketServlet, 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 setRelativePath(URI) method of this interface will be delegated to that actor or attribute.

Since:

Ptolemy II 10.0

Version:

$Id: WebSocketService.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Elizabeth Latronico and Edward A. Lee

See Also:

WebServer, WebServer

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Method Summary

Modifier and Type	Method and Description
java.net.URI	getRelativePath() Returns the relative path that this WebSocketService is mapped to, which is the value set previously by a call to setRelativePath(URI).
void	onMessage(WebSocketEndpoint sender, java.lang.String message) Notify service of a WebSocket message event.
void	setConnection(org.eclipse.jetty.websocket.WebSocket.Connection connection) Set the websocket connection that the service should use.
void	setRelativePath(java.net.URI relativePath) Set the relative path that this WebSocketService is mapped to.

Method Detail

getRelativePath

java.net.URI getRelativePath()

Returns the relative path that this WebSocketService is mapped to, which is the value set previously by a call to setRelativePath(URI).

Returns:

The relative path that this HttpService is mapped to.

See Also:

setRelativePath(URI)

onMessage

void onMessage(WebSocketEndpoint sender,
               java.lang.String message)

Notify service of a WebSocket message event.

Parameters:

sender - The PtolemyWebSocketEndpoint that sent the message

message - The message that was received

setConnection

void setConnection(org.eclipse.jetty.websocket.WebSocket.Connection connection)

Set the websocket connection that the service should use.

Parameters:

The - connection that the service should use.

setRelativePath

void setRelativePath(java.net.URI relativePath)

Set the relative path that this WebSocketService is mapped to.

Parameters:

relativePath - The relative path that this HttpService is mapped to.

See Also:

getRelativePath()