org.arl.fjage.connectors

Class WebSocketHubConnector

java.lang.Object

org.arl.fjage.connectors.WebSocketHubConnector

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Connector, org.eclipse.jetty.websocket.servlet.WebSocketCreator

public class WebSocketHubConnector
extends java.lang.Object
implements Connector, org.eclipse.jetty.websocket.servlet.WebSocketCreator

Web socket connector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebSocketHubConnector.WSHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jetty.server.handler.ContextHandler	handler
protected boolean	linemode
protected ConnectionListener	listener
protected java.util.logging.Logger	log
protected java.lang.String	name
protected org.arl.fjage.connectors.WebSocketHubConnector.OutputThread	outThread
protected PseudoInputStream	pin
protected PseudoOutputStream	pout
protected WebServer	server
protected java.util.List<WebSocketHubConnector.WSHandler>	wsHandlers

Constructor Summary

Constructors

Constructor and Description
WebSocketHubConnector(int port, java.lang.String context) Create a web socket connector and add it to a web server running on a given port.
WebSocketHubConnector(int port, java.lang.String context, boolean linemode) Create a web socket connector and add it to a web server running on a given port.
WebSocketHubConnector(int port, java.lang.String context, boolean linemode, int maxMsgSize) Create a web socket connector and add it to a web server running on a given port.
WebSocketHubConnector(int port, java.lang.String context, int maxMsgSize) Create a web socket connector and add it to a web server running on a given port.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
java.lang.String[]	connections() Gets a list of all known active connections
java.lang.Object	createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest req, org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse resp)
java.io.InputStream	getInputStream() Get the input stream to read data over.
java.lang.String	getName() Get a string representation of the connection.
java.io.OutputStream	getOutputStream() Get the output stream to write data to.
protected void	init(int port, java.lang.String context, int maxMsgSize)
boolean	isReliable() Check if a connection is relaible.
void	setConnectionListener(ConnectionListener listener) Set a connection state listener.
java.lang.String	toString()
boolean	waitOutputCompletion(long timeout) Wait until the output buffer is empty.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

linemode

protected boolean linemode

server

protected WebServer server

handler

protected org.eclipse.jetty.server.handler.ContextHandler handler

wsHandlers

protected java.util.List<WebSocketHubConnector.WSHandler> wsHandlers

outThread

protected org.arl.fjage.connectors.WebSocketHubConnector.OutputThread outThread

pin

protected final PseudoInputStream pin

pout

protected PseudoOutputStream pout

listener

protected ConnectionListener listener

log

protected java.util.logging.Logger log

Constructor Detail

WebSocketHubConnector

public WebSocketHubConnector(int port,
                             java.lang.String context)

Create a web socket connector and add it to a web server running on a given port. If a web server isn't already created, this will start the web server.

Throws:

java.io.UncheckedIOException - if the web server cannot be started, or the context is already in use.

WebSocketHubConnector

public WebSocketHubConnector(int port,
                             java.lang.String context,
                             boolean linemode)

Create a web socket connector and add it to a web server running on a given port. If a web server isn't already created, this will start the web server.

Throws:

java.io.UncheckedIOException - if the web server cannot be started, or the context is already in use.

WebSocketHubConnector

public WebSocketHubConnector(int port,
                             java.lang.String context,
                             int maxMsgSize)

Create a web socket connector and add it to a web server running on a given port. If a web server isn't already created, this will start the web server.

Throws:

java.io.UncheckedIOException - if the web server cannot be started, or the context is already in use.

WebSocketHubConnector

public WebSocketHubConnector(int port,
                             java.lang.String context,
                             boolean linemode,
                             int maxMsgSize)

Create a web socket connector and add it to a web server running on a given port. If a web server isn't already created, this will start the web server.

Throws:

java.io.UncheckedIOException - if the web server cannot be started, or the context is already in use.

Method Detail

init

protected void init(int port,
                    java.lang.String context,
                    int maxMsgSize)

createWebSocket

public java.lang.Object createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest req,
                                        org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse resp)

Specified by:

createWebSocket in interface org.eclipse.jetty.websocket.servlet.WebSocketCreator

getName

public java.lang.String getName()

Description copied from interface: Connector

Get a string representation of the connection.

Specified by:

getName in interface Connector

getInputStream

public java.io.InputStream getInputStream()

Description copied from interface: Connector

Get the input stream to read data over.

Specified by:

getInputStream in interface Connector

getOutputStream

public java.io.OutputStream getOutputStream()

Description copied from interface: Connector

Get the output stream to write data to.

Specified by:

getOutputStream in interface Connector

setConnectionListener

public void setConnectionListener(ConnectionListener listener)

Description copied from interface: Connector

Set a connection state listener.

Specified by:

setConnectionListener in interface Connector

Parameters:

listener - listener to call for connection/disconnection, or null to disable listener.

connections

public java.lang.String[] connections()

Description copied from interface: Connector

Gets a list of all known active connections

Specified by:

connections in interface Connector

Returns:

an array of all known active connections

isReliable

public boolean isReliable()

Description copied from interface: Connector

Check if a connection is relaible. A reliable connection throws an exception if data written to the output stream cannot be delivered.

Specified by:

isReliable in interface Connector

waitOutputCompletion

public boolean waitOutputCompletion(long timeout)

Description copied from interface: Connector

Wait until the output buffer is empty.

Specified by:

waitOutputCompletion in interface Connector

Parameters:

timeout - timeout in milliseconds.

Returns:

true if output buffer empty, false on timeout or error.

close

public void close()

Description copied from interface: Connector

Close the connection.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Connector

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object