org.ptolemy.ptango.lib.webSocket

Class PtolemyWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.WebSocketServlet

org.ptolemy.ptango.lib.webSocket.PtolemyWebSocketServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.eclipse.jetty.websocket.WebSocketFactory.Acceptor

public class PtolemyWebSocketServlet
extends org.eclipse.jetty.websocket.WebSocketServlet

A servlet that manages locally hosted websockets. There is one servlet per URI path. Each servlet maintains a set of WebSockets affiliated with this path. WebSockets are pairwise (client - server). 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 11.0

Version:

$Id$

Author:

Elizabeth Latronico

See Also:

Serialized Form

Pt.AcceptedRating:

Red (ltrnc)

Pt.ProposedRating:

Red (ltrnc)

Constructor Summary

Constructors

Constructor and Description
PtolemyWebSocketServlet(WebSocketEndpoint endpoint) Create a new servlet associated with the given endpoint.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jetty.websocket.WebSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest request, java.lang.String protocol) Upon receiving a connect request, create a new websocket endpoint to manage communication.

Methods inherited from class org.eclipse.jetty.websocket.WebSocketServlet

checkOrigin, destroy, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

PtolemyWebSocketServlet

public PtolemyWebSocketServlet(WebSocketEndpoint endpoint)

Create a new servlet associated with the given endpoint.

Parameters:

endpoint - The endpoint (WebSocket implementer) associated with this servlet.

Method Detail

doWebSocketConnect

public org.eclipse.jetty.websocket.WebSocket doWebSocketConnect(javax.servlet.http.HttpServletRequest request,
                                                                java.lang.String protocol)

Upon receiving a connect request, create a new websocket endpoint to manage communication.

Parameters:

request - The request.

protocol - The protocol of the request.

Returns:

A websocket to handle the new connection.