org.ptolemy.ptango.lib.websocket

Class WebSocketConnectionManager

java.lang.Object

org.ptolemy.ptango.lib.websocket.WebSocketConnectionManager

public class WebSocketConnectionManager
extends java.lang.Object

A singleton factory class that creates and tracks websocket connections.

Since:

Ptolemy II 10.0

Version:

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

Author:

Elizabeth Latronico

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Method Summary

Modifier and Type	Method and Description
static WebSocketConnectionManager	getInstance() Get the factory instance, creating a new one if none created yet.
void	newConnection(java.net.URI path, WebSocketService service) Return a new, unshared connection.
void	releaseConnection(java.net.URI path, WebSocketService service) Release access to a websocket connection.
void	requestConnection(java.net.URI path, WebSocketService service) Set a connection if one has already been established for the given path; return null otherwise.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static WebSocketConnectionManager getInstance()

Get the factory instance, creating a new one if none created yet.

Returns:

The websocket client factory instance.

newConnection

public void newConnection(java.net.URI path,
                          WebSocketService service)
                   throws IllegalActionException

Return a new, unshared connection.

Parameters:

path - The URL to connect to.

service - The WebSocketService requesting the connection.

Throws:

IllegalActionException

requestConnection

public void requestConnection(java.net.URI path,
                              WebSocketService service)
                       throws IllegalActionException

Set a connection if one has already been established for the given path; return null otherwise. Parts are synchronized so that only one object may request or release a connection at a time. This method does NOT block waiting for a connection.

Parameters:

path - The path to which the connection is established.

Throws:

IllegalActionException

See Also:

#releaseConnection(WebSocketService)

releaseConnection

public void releaseConnection(java.net.URI path,
                              WebSocketService service)

Release access to a websocket connection.

Parameters:

path - The path of the service.

service - Theservice requesting release.