org.arl.fjage.connectors

Class WebSocketConnector

java.lang.Object

org.arl.fjage.connectors.WebSocketConnector

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Connector

@WebSocket(maxIdleTime=2147483647,
           batchMode=OFF)
public class WebSocketConnector
extends java.lang.Object
implements Connector

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	log

Constructor Summary

Constructors

Constructor and Description
WebSocketConnector(java.lang.String context)

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.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.
boolean	isReliable() Check if a connection is relaible.
void	onWebSocketClose(int statusCode, java.lang.String reason)
void	onWebSocketConnect(org.eclipse.jetty.websocket.api.Session session)
void	onWebSocketError(java.lang.Throwable cause)
void	onWebSocketText(java.lang.String message)
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

log

protected java.util.logging.Logger log

Constructor Detail

WebSocketConnector

public WebSocketConnector(java.lang.String context)

Method Detail

onWebSocketClose

@OnWebSocketClose
public void onWebSocketClose(int statusCode,
                                               java.lang.String reason)

onWebSocketConnect

@OnWebSocketConnect
public void onWebSocketConnect(org.eclipse.jetty.websocket.api.Session session)

onWebSocketError

@OnWebSocketError
public void onWebSocketError(java.lang.Throwable cause)

onWebSocketText

@OnWebSocketMessage
public void onWebSocketText(java.lang.String message)

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

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.

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

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