Package org.atmosphere.container.version

Class JSR356WebSocket

java.lang.Object

org.atmosphere.cpr.AsyncIOWriterAdapter

org.atmosphere.cpr.AtmosphereInterceptorWriter

org.atmosphere.websocket.WebSocket

org.atmosphere.container.version.JSR356WebSocket

All Implemented Interfaces:

AsyncIOWriter, KeepOpenStreamAware

public class JSR356WebSocket
extends WebSocket

Asynchronous based Session websocket

Field Summary

Fields inherited from class org.atmosphere.websocket.WebSocket

bb, binaryWrite, cb, CLEAN_CLOSE, lastWrite, NOT_SUPPORTED, uuid, WEBSOCKET_ACCEPT_DONE, WEBSOCKET_INITIATED, WEBSOCKET_RESUME, WEBSOCKET_SUSPEND

Fields inherited from class org.atmosphere.cpr.AtmosphereInterceptorWriter

filters, reversedFilters

Constructor Summary

Constructors

Constructor	Description
JSR356WebSocket(Session session, AtmosphereConfig config)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying WebSocket
void	close(int statusCode, String reasonText)	Allow the underlying WebSocket to close with a code and a reason.
boolean	isOpen()	Is the underlying WebSocket open.
WebSocket	sendPing(byte[] payload)	Send a WebSocket Ping.
WebSocket	sendPong(byte[] payload)	Send a WebSocket Pong.
WebSocket	write(byte[] data, int offset, int length)	Use the underlying container's websocket to write the byte.
WebSocket	write(String s)	Use the underlying container's websocket to write the String.

Methods inherited from class org.atmosphere.websocket.WebSocket

attachment, attachment, attributes, binaryWrite, broadcast, close, config, flush, lastWriteTimeStampInMilliseconds, notSupported, redirect, resource, resource, shiftAttributes, transform, transform, uuid, webSocketHandler, webSocketHandler, write, write, write, write, writeError

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorWriter

filters, interceptor, interceptor, invokeInterceptor, writeReady

Methods inherited from class java.lang.Object

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

Constructor Details

JSR356WebSocket

public JSR356WebSocket(Session session,
 AtmosphereConfig config)

Method Details

isOpen

public boolean isOpen()

Description copied from class: WebSocket

Is the underlying WebSocket open.

Specified by:

isOpen in class WebSocket

Returns:

true is opened

write

public WebSocket write(String s)
                throws IOException

Description copied from class: WebSocket

Use the underlying container's websocket to write the String.

Specified by:

write in class WebSocket

Parameters:

s - a websocket String message

Returns:

this

Throws:

IOException

write

public WebSocket write(byte[] data,
 int offset,
 int length)
                throws IOException

Description copied from class: WebSocket

Use the underlying container's websocket to write the byte.

Specified by:

write in class WebSocket

Parameters:

data - a websocket byte message

offset - start

length - end

Returns:

this

Throws:

IOException

close

public void close()

Description copied from class: WebSocket

Close the underlying WebSocket

Specified by:

close in class WebSocket

close

public void close(int statusCode,
 String reasonText)

Description copied from class: WebSocket

Allow the underlying WebSocket to close with a code and a reason. The base implementation closes the socket without transmitting the code and reason — bindings whose native API can carry them override this. It must never silently leave the connection open.

Overrides:

close in class WebSocket

sendPing

public WebSocket sendPing(byte[] payload)

Description copied from class: WebSocket

Send a WebSocket Ping. Supported by the JSR356 binding (every servlet container); bindings whose native API has no control-frame access throw UnsupportedOperationException.

Overrides:

sendPing in class WebSocket

Parameters:

payload - the bytes to send

Returns:

this

sendPong

public WebSocket sendPong(byte[] payload)

Description copied from class: WebSocket

Send a WebSocket Pong. Supported by the JSR356 binding (every servlet container); bindings whose native API has no control-frame access throw UnsupportedOperationException.

Overrides:

sendPong in class WebSocket

Parameters:

payload - the bytes to send

Returns:

this