Package org.atmosphere.websocket.protocol

Class EchoProtocol

java.lang.Object

org.atmosphere.websocket.protocol.EchoProtocol

All Implemented Interfaces:

AtmosphereConfigAware, WebSocketProtocol

public class EchoProtocol
extends java.lang.Object
implements WebSocketProtocol

Simple WebSocketProcessor that invoke the Broadcaster.broadcast(java.lang.Object) API when a WebSocket message is received.

NOTE: If WebSocket frame are used the bytes will be decoded into a String, which reduce performance.

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor	Description
EchoProtocol()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
void	onClose(WebSocket webSocket)	Invoked when a WebSocket is closed
void	onError(WebSocket webSocket, WebSocketProcessor.WebSocketException t)	Invoked when an error occurs.
java.util.List<AtmosphereRequest>	onMessage(WebSocket webSocket, byte[] data, int offset, int length)	Parse the WebSocket message, and delegate the processing to the AtmosphereFramework.asyncSupport or to any existing technology.
java.util.List<AtmosphereRequest>	onMessage(WebSocket webSocket, java.lang.String data)	Parse the WebSocket message, and delegate the processing to the AtmosphereFramework.asyncSupport or to any existing technology.
void	onOpen(WebSocket webSocket)	Invoked when a WebSocket is opened

Methods inherited from class java.lang.Object

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

Constructor Detail

EchoProtocol

public EchoProtocol()

Method Detail

onMessage

public java.util.List<AtmosphereRequest> onMessage(WebSocket webSocket,
                                                   java.lang.String data)

Description copied from interface: WebSocketProtocol

Parse the WebSocket message, and delegate the processing to the AtmosphereFramework.asyncSupport or to any existing technology. Invoking AtmosphereFramework.asyncSupport will delegate the request processing to the AtmosphereHandler implementation. Returning null means this implementation will handle itself the processing/dispatching of the WebSocket's request;
As an example, this is how Websocket messages are delegated to the Jersey runtime.

Specified by:

onMessage in interface WebSocketProtocol

Parameters:

webSocket - The WebSocket connection

data - The Websocket message

Returns:

a List of AtmosphereRequest

onMessage

public java.util.List<AtmosphereRequest> onMessage(WebSocket webSocket,
                                                   byte[] data,
                                                   int offset,
                                                   int length)

Description copied from interface: WebSocketProtocol

Parse the WebSocket message, and delegate the processing to the AtmosphereFramework.asyncSupport or to any existing technology. Invoking AtmosphereFramework.asyncSupport will delegate the request processing to the AtmosphereHandler implementation. Returning null means this implementation will handle itself the processing/dispatching of the WebSocket's request;
As an example, this is how Websocket messages are delegated to the Jersey runtime.

Specified by:

onMessage in interface WebSocketProtocol

Parameters:

webSocket - The WebSocket connection

offset - offset message index

length - length of the message.

Returns:

a List of AtmosphereRequest

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Parameters:

config - AtmosphereConfig

onOpen

public void onOpen(WebSocket webSocket)

Description copied from interface: WebSocketProtocol

Invoked when a WebSocket is opened

Specified by:

onOpen in interface WebSocketProtocol

Parameters:

webSocket - WebSocket

onClose

public void onClose(WebSocket webSocket)

Description copied from interface: WebSocketProtocol

Invoked when a WebSocket is closed

Specified by:

onClose in interface WebSocketProtocol

Parameters:

webSocket - WebSocket

onError

public void onError(WebSocket webSocket,
                    WebSocketProcessor.WebSocketException t)

Description copied from interface: WebSocketProtocol

Invoked when an error occurs.

Specified by:

onError in interface WebSocketProtocol

Parameters:

webSocket - WebSocket

t - a WebSocketProcessor.WebSocketException