org.atmosphere.websocket

Class WebSocket

java.lang.Object

org.atmosphere.cpr.AsyncIOWriterAdapter

org.atmosphere.websocket.WebSocket

All Implemented Interfaces:

AsyncIOWriter

Direct Known Subclasses:

Grizzly2WebSocket, GrizzlyWebSocket, Jetty8WebSocket, Jetty9WebSocket, TomcatWebSocket

public abstract class WebSocket
extends AsyncIOWriterAdapter

Represent a portable WebSocket implementation which can be used to write message.

Author:

Jeanfrancois Arcand

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	binaryWrite
protected long	lastWrite
static java.lang.String	WEBSOCKET_ACCEPT_DONE
static java.lang.String	WEBSOCKET_INITIATED
static java.lang.String	WEBSOCKET_RESUME
static java.lang.String	WEBSOCKET_SUSPEND
protected WebSocketResponseFilter	webSocketResponseFilter

Constructor Summary

Constructors

Constructor and Description
WebSocket(AtmosphereConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
AtmosphereConfig	config()
long	lastWriteTimeStampInMilliseconds() The last time, in milliseconds, a write operation occurred.
AtmosphereResource	resource() Return the an AtmosphereResource used by this WebSocket, or null if the WebSocket has been closed before the WebSocket message has been processed.
WebSocket	resource(AtmosphereResource r) Associate an AtmosphereResource to this WebSocket
protected java.lang.String	retrieveUUID()
WebSocket	webSocketResponseFilter(WebSocketResponseFilter w) Associate a WebSocketResponseFilter that will be invoked before any write operation.

Methods inherited from class org.atmosphere.cpr.AsyncIOWriterAdapter

close, close, flush, flush, redirect, redirect, write, write, write, write, write, write, writeError, writeError

Methods inherited from class java.lang.Object

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

Field Detail

WEBSOCKET_INITIATED

public static final java.lang.String WEBSOCKET_INITIATED

WEBSOCKET_SUSPEND

public static final java.lang.String WEBSOCKET_SUSPEND

WEBSOCKET_RESUME

public static final java.lang.String WEBSOCKET_RESUME

WEBSOCKET_ACCEPT_DONE

public static final java.lang.String WEBSOCKET_ACCEPT_DONE

lastWrite

protected long lastWrite

webSocketResponseFilter

protected WebSocketResponseFilter webSocketResponseFilter

binaryWrite

protected final boolean binaryWrite

Constructor Detail

WebSocket

public WebSocket(AtmosphereConfig config)

Method Detail

config

public AtmosphereConfig config()

resource

public WebSocket resource(AtmosphereResource r)

Associate an AtmosphereResource to this WebSocket

Parameters:

r - an AtmosphereResource to this WebSocket

Returns:

this

resource

public AtmosphereResource resource()

Return the an AtmosphereResource used by this WebSocket, or null if the WebSocket has been closed before the WebSocket message has been processed.

Returns:

AtmosphereResource

lastWriteTimeStampInMilliseconds

public long lastWriteTimeStampInMilliseconds()

The last time, in milliseconds, a write operation occurred.

Returns:

this

webSocketResponseFilter

public WebSocket webSocketResponseFilter(WebSocketResponseFilter w)

Associate a WebSocketResponseFilter that will be invoked before any write operation.

Parameters:

w - WebSocketResponseFilter

Returns:

this

retrieveUUID

protected java.lang.String retrieveUUID()