Package org.atmosphere.cpr

Interface BroadcasterListener

All Known Implementing Classes:

AtmosphereResourceStateRecovery.B, BroadcasterLifecyclePolicyHandler, BroadcasterListenerAdapter

public interface BroadcasterListener

A listener for a Broadcaster's event lifecycle.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BroadcasterListener.BroadcastListenerException	Throw this exception to interrupt the Broadcaster.destroy() operation.

Method Summary

Modifier and Type	Method	Description
void	onAddAtmosphereResource(Broadcaster b, AtmosphereResource r)	Invoked when an AtmosphereResource is getting associated to a Broadcaster.
void	onComplete(Broadcaster b)	Invoked when the Broadcast operation completes for all AtmosphereResource.
void	onMessage(Broadcaster b, Deliver deliver)	Invoked when a Broadcaster.broadcast(Object) is called.
void	onPostCreate(Broadcaster b)	Invoked just after the Broadcaster has been created.
void	onPreDestroy(Broadcaster b)	Invoked before a Broadcaster is about to be deleted.
void	onRemoveAtmosphereResource(Broadcaster b, AtmosphereResource r)	Invoked when an AtmosphereResource is getting removed to a Broadcaster.

Method Details

onPostCreate

void onPostCreate(Broadcaster b)

Invoked just after the Broadcaster has been created.

Parameters:

b - a Broadcaster

onComplete

void onComplete(Broadcaster b)

Invoked when the Broadcast operation completes for all AtmosphereResource.

Parameters:

b - a Broadcaster

onPreDestroy

void onPreDestroy(Broadcaster b)

Invoked before a Broadcaster is about to be deleted.

Parameters:

b - a Broadcaster

onAddAtmosphereResource

void onAddAtmosphereResource(Broadcaster b,
 AtmosphereResource r)

Invoked when an AtmosphereResource is getting associated to a Broadcaster.

Parameters:

b - a Broadcaster

r - an AtmosphereResource

onRemoveAtmosphereResource

void onRemoveAtmosphereResource(Broadcaster b,
 AtmosphereResource r)

Invoked when an AtmosphereResource is getting removed to a Broadcaster.

Parameters:

b - a Broadcaster

r - an AtmosphereResource

onMessage

void onMessage(Broadcaster b,
 Deliver deliver)

Invoked when a Broadcaster.broadcast(Object) is called.

Parameters:

b - a Broadcaster

deliver - the Deliver