org.ptolemy.ptango.lib.websocket

Class WebSocketEndpoint

java.lang.Object

org.ptolemy.ptango.lib.websocket.WebSocketEndpoint

All Implemented Interfaces:

org.eclipse.jetty.websocket.WebSocket, org.eclipse.jetty.websocket.WebSocket.OnTextMessage

public class WebSocketEndpoint
extends java.lang.Object
implements org.eclipse.jetty.websocket.WebSocket.OnTextMessage

A class that keeps a reference to the WebSocket connection, notifies services of incoming messages and allows services to write to the WebSocket. Uses Jetty 8 WebSocket classes. Note that Jetty 9 has substantial WebSocket revisions that are not backward compatible. Based on http://java.dzone.com/articles/creating-websocket-chat

Since:

Ptolemy II 10.0

Version:

$Id: WebSocketEndpoint.java 70392 2014-10-22 22:31:22Z cxh $

Author:

Elizabeth Latronico

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.WebSocket

org.eclipse.jetty.websocket.WebSocket.Connection, org.eclipse.jetty.websocket.WebSocket.FrameConnection, org.eclipse.jetty.websocket.WebSocket.OnBinaryMessage, org.eclipse.jetty.websocket.WebSocket.OnControl, org.eclipse.jetty.websocket.WebSocket.OnFrame, org.eclipse.jetty.websocket.WebSocket.OnTextMessage

Constructor Summary

Constructors

Constructor and Description
WebSocketEndpoint(WebSocketService parentService) Create a new WebSocketEndpoint with the given parent service.

Method Summary

Modifier and Type	Method and Description
void	addParentService(WebSocketService service) Add a parent WebSocketService of this endpoint.
org.eclipse.jetty.websocket.WebSocket.Connection	getConnection() Return the Connection object for this WebSocket.
boolean	isOpen() Return true if the connection is open; false otherwise.
void	onClose(int statusCode, java.lang.String statusMessage) Upon close, set the connection to null.
void	onMessage(java.lang.String message) Notify the parent service about a new message.
void	onOpen(org.eclipse.jetty.websocket.WebSocket.Connection connection) Upon opening, save a reference to the connection.
void	removeParentService(WebSocketService service) Remove a parent WebSocketService of this endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketEndpoint

public WebSocketEndpoint(WebSocketService parentService)

Create a new WebSocketEndpoint with the given parent service.

Parameters:

parentService - The WebSocketService to be notified of messages.

Method Detail

addParentService

public void addParentService(WebSocketService service)

Add a parent WebSocketService of this endpoint.

Parameters:

service - A parent WebSocketService of this endpoint.

See Also:

removeParentService(WebSocketService)

getConnection

public org.eclipse.jetty.websocket.WebSocket.Connection getConnection()

Return the Connection object for this WebSocket. Used for sending messages.

Returns:

The Connection object for this WebSocket.

isOpen

public boolean isOpen()

Return true if the connection is open; false otherwise.

Returns:

True if the connection is open; false otherwise.

onClose

public void onClose(int statusCode,
                    java.lang.String statusMessage)

Upon close, set the connection to null.

Specified by:

onClose in interface org.eclipse.jetty.websocket.WebSocket

Parameters:

statusCode - The status code of the closed connection.

statusMessage - The status message of the closed connection.

onMessage

public void onMessage(java.lang.String message)

Notify the parent service about a new message.

Specified by:

onMessage in interface org.eclipse.jetty.websocket.WebSocket.OnTextMessage

Parameters:

message - The message that was received.

onOpen

public void onOpen(org.eclipse.jetty.websocket.WebSocket.Connection connection)

Upon opening, save a reference to the connection.

Specified by:

onOpen in interface org.eclipse.jetty.websocket.WebSocket

Parameters:

connection - The connection that was opened.

removeParentService

public void removeParentService(WebSocketService service)

Remove a parent WebSocketService of this endpoint.

Parameters:

service - A parent WebSocketService of this endpoint.

See Also:

addParentService(WebSocketService)