org.atmosphere.websocket
Interface WebSocketProcessor

All Known Implementing Classes:

DefaultWebSocketProcessor

public interface WebSocketProcessor

Atmosphere's WebSocket Support implementation. The default behavior is implemented in DefaultWebSocketProcessor. This class is targeted at framework developer as it requires Atmosphere's internal knowledge.
This class can also be used to implement the JSR 345 recommendation.

Author:

Jeanfrancois Arcand

Nested Class Summary

static class

WebSocketProcessor.WebSocketException An exception that can be used to flag problems with the WebSocket processing.

Method Summary

void	close(int closeCode) Invked when the WebServer is closing the native WebSocket
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 webSocketEvent) Notify all WebSocketEventListener
void	open(AtmosphereRequest request) Invoked when a WebSocket gets opened by the underlying container
WebSocket	webSocket() Return the underlying WebSocket.

Method Detail

open

void open(AtmosphereRequest request)
          throws IOException

Invoked when a WebSocket gets opened by the underlying container

Parameters:

request -

Throws:

IOException

invokeWebSocketProtocol

void invokeWebSocketProtocol(String webSocketMessage)

Invoked when a WebSocket message gets received from the underlying container

Parameters:

webSocketMessage -

invokeWebSocketProtocol

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

Invoked when a WebSocket message gets received from the underlying container

Parameters:

data -

webSocket

WebSocket webSocket()

Return the underlying WebSocket.

Returns:

close

void close(int closeCode)

Invked when the WebServer is closing the native WebSocket

Parameters:

closeCode -

notifyListener

void notifyListener(WebSocketEventListener.WebSocketEvent webSocketEvent)

Notify all WebSocketEventListener

Parameters:

webSocketEvent -