org.ptolemy.ptango.lib.websocket

Class PtolemyWebSocketClientFactory

java.lang.Object

org.ptolemy.ptango.lib.websocket.PtolemyWebSocketClientFactory

public class PtolemyWebSocketClientFactory
extends java.lang.Object

A singleton factory class that creates websocket clients.

Since:

Ptolemy II 10.0

Version:

$Id: PtolemyWebSocketClientFactory.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 PtolemyWebSocketClientFactory	getInstance() Get the factory instance, creating a new one if none created yet.
org.eclipse.jetty.websocket.WebSocketClient	newSharedWebSocketClient(java.net.URI path) Create a new WebSocket client that can be shared among other WebSocketServices affiliated with this path.
org.eclipse.jetty.websocket.WebSocketClient	newWebSocketClient() Create a new WebSocket client.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PtolemyWebSocketClientFactory getInstance()

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

Returns:

The websocket client factory instance.

newWebSocketClient

public org.eclipse.jetty.websocket.WebSocketClient newWebSocketClient()
                                                               throws java.lang.Exception

Create a new WebSocket client.

Returns:

A new WebSocketClient.

Throws:

java.lang.Exception - If the WebSocketClientFactory cannot be started.

newSharedWebSocketClient

public org.eclipse.jetty.websocket.WebSocketClient newSharedWebSocketClient(java.net.URI path)
                                                                     throws java.lang.Exception

Create a new WebSocket client that can be shared among other WebSocketServices affiliated with this path.

Returns:

A new WebSocketClient.

Throws:

java.lang.Exception - If the WebSocketClientFactory cannot be started.