org.atmosphere.websocket

Interface WebSocketEventListener

All Superinterfaces:

AtmosphereResourceEventListener, AtmosphereResourceHeartbeatEventListener

All Known Implementing Classes:

WebSocketEventListenerAdapter

public interface WebSocketEventListener
extends AtmosphereResourceEventListener

A listener for monitoring what's occurring on a WebSocket, independently of the underlying implementation. The WebSocketEventListener.WebSocketEvent.webSocket can be used to directly write bytes.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketEventListener.WebSocketEvent<T>

Method Summary

Methods

Modifier and Type	Method and Description
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(WebSocketEventListener.WebSocketEvent event) When the disconnect occurs
void	onHandshake(WebSocketEventListener.WebSocketEvent event) When the hanshake occurs
void	onMessage(WebSocketEventListener.WebSocketEvent event) When a message is sent

Methods inherited from interface org.atmosphere.cpr.AtmosphereResourceEventListener

onBroadcast, onClose, onDisconnect, onPreSuspend, onResume, onSuspend, onThrowable

Methods inherited from interface org.atmosphere.cpr.AtmosphereResourceHeartbeatEventListener

onHeartbeat

Method Detail

onHandshake

void onHandshake(WebSocketEventListener.WebSocketEvent event)

When the hanshake occurs

Parameters:

event - WebSocketEventListener.WebSocketEvent

onMessage

void onMessage(WebSocketEventListener.WebSocketEvent event)

When a message is sent

Parameters:

event - WebSocketEventListener.WebSocketEvent

onClose

void onClose(WebSocketEventListener.WebSocketEvent event)

When the close occurs

Parameters:

event - WebSocketEventListener.WebSocketEvent

onControl

void onControl(WebSocketEventListener.WebSocketEvent event)

When the control occurs

Parameters:

event - WebSocketEventListener.WebSocketEvent

onDisconnect

void onDisconnect(WebSocketEventListener.WebSocketEvent event)

When the disconnect occurs

Parameters:

event - WebSocketEventListener.WebSocketEvent

onConnect

void onConnect(WebSocketEventListener.WebSocketEvent event)

When the connect occurs

Parameters:

event - WebSocketEventListener.WebSocketEvent