Package org.atmosphere.websocket

Class WebSocketEventListenerAdapter

java.lang.Object

org.atmosphere.websocket.WebSocketEventListenerAdapter

All Implemented Interfaces:

AtmosphereResourceEventListener, AtmosphereResourceHeartbeatEventListener, WebSocketEventListener

public class WebSocketEventListenerAdapter
extends java.lang.Object
implements WebSocketEventListener

An implementation of WebSocketEventListener with just log event as trace.

Author:

Jeanfrancois Arcand

Nested Class Summary

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

WebSocketEventListener.WebSocketEvent<T>

Constructor Summary

Constructors

Constructor	Description
WebSocketEventListenerAdapter()

Method Summary

Modifier and Type	Method	Description
void	onBroadcast(AtmosphereResourceEvent event)	Invoked when a Broadcaster.broadcast(java.lang.Object) occurs.
void	onClose(AtmosphereResourceEvent event)	Invoked when AtmosphereResource.close() gets called.
void	onClose(WebSocketEventListener.WebSocketEvent<?> event)	When the close occurs
void	onConnect(WebSocketEventListener.WebSocketEvent<?> event)	When the connect occurs
void	onControl(WebSocketEventListener.WebSocketEvent<?> event)	When the control occurs
void	onDisconnect(AtmosphereResourceEvent event)	Invoked when the remote connection gets closed.
void	onDisconnect(WebSocketEventListener.WebSocketEvent<?> event)	When the disconnect occurs
void	onHandshake(WebSocketEventListener.WebSocketEvent<?> event)	When the hanshake occurs
void	onHeartbeat(AtmosphereResourceEvent event)	Invoked when the remote connections send a heartbeat.
void	onMessage(WebSocketEventListener.WebSocketEvent<?> event)	When a message is sent
void	onPreSuspend(AtmosphereResourceEvent event)	Invoked when the AtmosphereResource.suspend() is in the process of being suspended but nothing has yet been written on the connection.
void	onResume(AtmosphereResourceEvent event)	Invoked when the AtmosphereResource.resume() is invoked or when the suspend's time out expires.
void	onSuspend(AtmosphereResourceEvent event)	Invoked when the AtmosphereResource.suspend() has been completed and the response is considered as suspended.
void	onThrowable(AtmosphereResourceEvent event)	Invoked when an operations failed to execute for an unknown reason (eg.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketEventListenerAdapter

public WebSocketEventListenerAdapter()

Method Detail

onPreSuspend

public void onPreSuspend(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when the AtmosphereResource.suspend() is in the process of being suspended but nothing has yet been written on the connection. An implementation could configure the request's headers, flush some data, etc. during that stage.

Specified by:

onPreSuspend in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent

onHandshake

public void onHandshake(WebSocketEventListener.WebSocketEvent<?> event)

Description copied from interface: WebSocketEventListener

When the hanshake occurs

Specified by:

onHandshake in interface WebSocketEventListener

Parameters:

event - WebSocketEventListener.WebSocketEvent

onMessage

public void onMessage(WebSocketEventListener.WebSocketEvent<?> event)

Description copied from interface: WebSocketEventListener

When a message is sent

Specified by:

onMessage in interface WebSocketEventListener

Parameters:

event - WebSocketEventListener.WebSocketEvent

onClose

public void onClose(WebSocketEventListener.WebSocketEvent<?> event)

Description copied from interface: WebSocketEventListener

When the close occurs

Specified by:

onClose in interface WebSocketEventListener

Parameters:

event - WebSocketEventListener.WebSocketEvent

onControl

public void onControl(WebSocketEventListener.WebSocketEvent<?> event)

Description copied from interface: WebSocketEventListener

When the control occurs

Specified by:

onControl in interface WebSocketEventListener

Parameters:

event - WebSocketEventListener.WebSocketEvent

onDisconnect

public void onDisconnect(WebSocketEventListener.WebSocketEvent<?> event)

Description copied from interface: WebSocketEventListener

When the disconnect occurs

Specified by:

onDisconnect in interface WebSocketEventListener

Parameters:

event - WebSocketEventListener.WebSocketEvent

onConnect

public void onConnect(WebSocketEventListener.WebSocketEvent<?> event)

Description copied from interface: WebSocketEventListener

When the connect occurs

Specified by:

onConnect in interface WebSocketEventListener

Parameters:

event - WebSocketEventListener.WebSocketEvent

onSuspend

public void onSuspend(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when the AtmosphereResource.suspend() has been completed and the response is considered as suspended.

Specified by:

onSuspend in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent

onResume

public void onResume(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when the AtmosphereResource.resume() is invoked or when the suspend's time out expires.

Specified by:

onResume in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent

onHeartbeat

public void onHeartbeat(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceHeartbeatEventListener

Invoked when the remote connections send a heartbeat.

Specified by:

onHeartbeat in interface AtmosphereResourceHeartbeatEventListener

Parameters:

event - a AtmosphereResourceEvent

onDisconnect

public void onDisconnect(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when the remote connection gets closed.

Specified by:

onDisconnect in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent

onBroadcast

public void onBroadcast(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when a Broadcaster.broadcast(java.lang.Object) occurs.

Specified by:

onBroadcast in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent

onThrowable

public void onThrowable(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when an operations failed to execute for an unknown reason (eg. IOException because the client remotely closed the connection, a broken connection, etc.).

Specified by:

onThrowable in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent

onClose

public void onClose(AtmosphereResourceEvent event)

Description copied from interface: AtmosphereResourceEventListener

Invoked when AtmosphereResource.close() gets called.

Specified by:

onClose in interface AtmosphereResourceEventListener

Parameters:

event - a AtmosphereResourceEvent