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 ofWebSocketEventListenerwith 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidonBroadcast(AtmosphereResourceEvent event)Invoked when aBroadcaster.broadcast(java.lang.Object)occurs.voidonClose(AtmosphereResourceEvent event)Invoked whenAtmosphereResource.close()gets called.voidonClose(WebSocketEventListener.WebSocketEvent<?> event)When the close occursvoidonConnect(WebSocketEventListener.WebSocketEvent<?> event)When the connect occursvoidonControl(WebSocketEventListener.WebSocketEvent<?> event)When the control occursvoidonDisconnect(AtmosphereResourceEvent event)Invoked when the remote connection gets closed.voidonDisconnect(WebSocketEventListener.WebSocketEvent<?> event)When the disconnect occursvoidonHandshake(WebSocketEventListener.WebSocketEvent<?> event)When the hanshake occursvoidonHeartbeat(AtmosphereResourceEvent event)Invoked when the remote connections send a heartbeat.voidonMessage(WebSocketEventListener.WebSocketEvent<?> event)When a message is sentvoidonPreSuspend(AtmosphereResourceEvent event)Invoked when theAtmosphereResource.suspend()is in the process of being suspended but nothing has yet been written on the connection.voidonResume(AtmosphereResourceEvent event)Invoked when theAtmosphereResource.resume()is invoked or when the suspend's time out expires.voidonSuspend(AtmosphereResourceEvent event)Invoked when theAtmosphereResource.suspend()has been completed and the response is considered as suspended.voidonThrowable(AtmosphereResourceEvent event)Invoked when an operations failed to execute for an unknown reason (eg.
-
-
-
Method Detail
-
onPreSuspend
public void onPreSuspend(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked when theAtmosphereResource.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:
onPreSuspendin interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onHandshake
public void onHandshake(WebSocketEventListener.WebSocketEvent<?> event)
Description copied from interface:WebSocketEventListenerWhen the hanshake occurs- Specified by:
onHandshakein interfaceWebSocketEventListener- Parameters:
event-WebSocketEventListener.WebSocketEvent
-
onMessage
public void onMessage(WebSocketEventListener.WebSocketEvent<?> event)
Description copied from interface:WebSocketEventListenerWhen a message is sent- Specified by:
onMessagein interfaceWebSocketEventListener- Parameters:
event-WebSocketEventListener.WebSocketEvent
-
onClose
public void onClose(WebSocketEventListener.WebSocketEvent<?> event)
Description copied from interface:WebSocketEventListenerWhen the close occurs- Specified by:
onClosein interfaceWebSocketEventListener- Parameters:
event-WebSocketEventListener.WebSocketEvent
-
onControl
public void onControl(WebSocketEventListener.WebSocketEvent<?> event)
Description copied from interface:WebSocketEventListenerWhen the control occurs- Specified by:
onControlin interfaceWebSocketEventListener- Parameters:
event-WebSocketEventListener.WebSocketEvent
-
onDisconnect
public void onDisconnect(WebSocketEventListener.WebSocketEvent<?> event)
Description copied from interface:WebSocketEventListenerWhen the disconnect occurs- Specified by:
onDisconnectin interfaceWebSocketEventListener- Parameters:
event-WebSocketEventListener.WebSocketEvent
-
onConnect
public void onConnect(WebSocketEventListener.WebSocketEvent<?> event)
Description copied from interface:WebSocketEventListenerWhen the connect occurs- Specified by:
onConnectin interfaceWebSocketEventListener- Parameters:
event-WebSocketEventListener.WebSocketEvent
-
onSuspend
public void onSuspend(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked when theAtmosphereResource.suspend()has been completed and the response is considered as suspended.- Specified by:
onSuspendin interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onResume
public void onResume(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked when theAtmosphereResource.resume()is invoked or when the suspend's time out expires.- Specified by:
onResumein interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onHeartbeat
public void onHeartbeat(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceHeartbeatEventListenerInvoked when the remote connections send a heartbeat.- Specified by:
onHeartbeatin interfaceAtmosphereResourceHeartbeatEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onDisconnect
public void onDisconnect(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked when the remote connection gets closed.- Specified by:
onDisconnectin interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onBroadcast
public void onBroadcast(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked when aBroadcaster.broadcast(java.lang.Object)occurs.- Specified by:
onBroadcastin interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onThrowable
public void onThrowable(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked 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:
onThrowablein interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
onClose
public void onClose(AtmosphereResourceEvent event)
Description copied from interface:AtmosphereResourceEventListenerInvoked whenAtmosphereResource.close()gets called.- Specified by:
onClosein interfaceAtmosphereResourceEventListener- Parameters:
event- aAtmosphereResourceEvent
-
-