org.atmosphere.websocket
Class DefaultWebSocketProcessor

java.lang.Object
  org.atmosphere.websocket.DefaultWebSocketProcessor

All Implemented Interfaces:

Serializable, WebSocketProcessor

public class DefaultWebSocketProcessor
extends Object
implements WebSocketProcessor, Serializable

Like the AsynchronousProcessor class, this class is responsible for dispatching WebSocket request to the proper WebSocket implementation. This class can be extended in order to support any protocol running on top websocket.

Author:

Jeanfrancois Arcand

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.websocket.WebSocketProcessor

WebSocketProcessor.WebSocketException

Constructor Summary

DefaultWebSocketProcessor(AtmosphereFramework framework, WebSocket webSocket, WebSocketProtocol webSocketProtocol)

Method Summary

void	close(int closeCode) Invked when the WebServer is closing the native WebSocket
static Map<String,String>	configureHeader(AtmosphereRequest request)
void	dispatch(AtmosphereRequest request, AtmosphereResponse r) Dispatch to request/response to the AsyncSupport implementation as it was a normal HTTP request.
void	invokeWebSocketProtocol(byte[] data, int offset, int length) Invoked when a WebSocket message gets received from the underlying container
void	invokeWebSocketProtocol(String webSocketMessage) Invoked when a WebSocket message gets received from the underlying container
void	notifyListener(WebSocketEventListener.WebSocketEvent event) Notify all WebSocketEventListener
void	open(AtmosphereRequest request) Invoked when a WebSocket gets opened by the underlying container
String	toString()
WebSocket	webSocket() Return the underlying WebSocket.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebSocketProcessor

public DefaultWebSocketProcessor(AtmosphereFramework framework,
                                 WebSocket webSocket,
                                 WebSocketProtocol webSocketProtocol)

Method Detail

open

public final void open(AtmosphereRequest request)
                throws IOException

Invoked when a WebSocket gets opened by the underlying container

Specified by:

open in interface WebSocketProcessor

Throws:

IOException

invokeWebSocketProtocol

public void invokeWebSocketProtocol(String webSocketMessage)

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

invokeWebSocketProtocol

public void invokeWebSocketProtocol(byte[] data,
                                    int offset,
                                    int length)

Invoked when a WebSocket message gets received from the underlying container

Specified by:

invokeWebSocketProtocol in interface WebSocketProcessor

dispatch

public final void dispatch(AtmosphereRequest request,
                           AtmosphereResponse r)

Dispatch to request/response to the AsyncSupport implementation as it was a normal HTTP request.

Parameters:

request - a AtmosphereRequest

r - a AtmosphereResponse

webSocket

public WebSocket webSocket()

Return the underlying WebSocket.

Specified by:

webSocket in interface WebSocketProcessor

Returns:

close

public void close(int closeCode)

Invked when the WebServer is closing the native WebSocket

Specified by:

close in interface WebSocketProcessor

toString

public String toString()

Overrides:

toString in class Object

notifyListener

public void notifyListener(WebSocketEventListener.WebSocketEvent event)

Notify all WebSocketEventListener

Specified by:

notifyListener in interface WebSocketProcessor

configureHeader

public static final Map<String,String> configureHeader(AtmosphereRequest request)