org.atmosphere.cpr
Interface AtmosphereResourceEventListener

All Known Subinterfaces:

WebSocketEventListener

All Known Implementing Classes:

AtmosphereResourceEventListenerAdapter, WebSocketEventListenerAdapter

public interface AtmosphereResourceEventListener

Receive notification when a resume, client disconnect or broadcast events occurs.

Author:

Jeanfrancois Arcand

Method Summary

void	onBroadcast(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event) Invoked when a Broadcaster.broadcast(T) occurs.
void	onDisconnect(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event) Invoked when the remote connection gets closed.
void	onResume(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event) Invoked when the AtmosphereResource.resume() is invoked or when the suspend's time out expires.
void	onSuspend(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event) Invoked when the AtmosphereResource.suspend() has been completed and the response considered as suspended.
void	onThrowable(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event) Invoked when an operations failed to execute for an unknown reason like : IOException because the client remotly closed the connection, a broken connection, etc.

Method Detail

onSuspend

void onSuspend(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event)

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

Parameters:

event - a AtmosphereResourceEvent

onResume

void onResume(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event)

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

Parameters:

event - a AtmosphereResourceEvent

onDisconnect

void onDisconnect(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event)

Invoked when the remote connection gets closed.

Parameters:

event - a AtmosphereResourceEvent

onBroadcast

void onBroadcast(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event)

Invoked when a Broadcaster.broadcast(T) occurs.

Parameters:

event - a AtmosphereResourceEvent

onThrowable

void onThrowable(AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> event)

Invoked when an operations failed to execute for an unknown reason like : IOException because the client remotly closed the connection, a broken connection, etc.

Parameters:

event - a AtmosphereResourceEvent