Package org.atmosphere.cpr

Class BroadcasterLifecycle

java.lang.Object

org.atmosphere.cpr.BroadcasterLifecycle

public class BroadcasterLifecycle
extends Object

Encapsulates the lifecycle management concern for a DefaultBroadcaster.

Manages lifecycle policy, lifecycle policy listeners, the lifecycle handler, and the scheduled lifecycle task reference. Extracted from DefaultBroadcaster to separate lifecycle management from the message dispatch hot path.

Constructor Summary

Constructors

Constructor	Description
BroadcasterLifecycle()

Method Summary

Modifier and Type	Method	Description
void	addLifeCycleListener(BroadcasterLifeCyclePolicyListener listener)	Add a BroadcasterLifeCyclePolicyListener.
void	clearListeners()	Clear all lifecycle listeners.
Future<?>	currentLifecycleTask()	Return the current scheduled lifecycle task.
void	currentLifecycleTask(Future<?> task)	Set the current scheduled lifecycle task.
LifecycleHandler	lifecycleHandler()	Return the current LifecycleHandler.
void	lifecycleHandler(LifecycleHandler handler)	Set the LifecycleHandler.
ConcurrentLinkedQueue<BroadcasterLifeCyclePolicyListener>	lifeCycleListeners()	Return the lifecycle policy listeners.
BroadcasterLifeCyclePolicy	policy()	Return the current BroadcasterLifeCyclePolicy.
AtomicBoolean	recentActivity()	Return the AtomicBoolean tracking recent activity.
void	removeLifeCycleListener(BroadcasterLifeCyclePolicyListener listener)	Remove a BroadcasterLifeCyclePolicyListener.
void	setPolicy(BroadcasterLifeCyclePolicy policy, DefaultBroadcaster broadcaster)	Set the BroadcasterLifeCyclePolicy and activate the lifecycle handler if one is set.

Methods inherited from class java.lang.Object

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

Constructor Details

BroadcasterLifecycle

public BroadcasterLifecycle()

Method Details

policy

public BroadcasterLifeCyclePolicy policy()

Return the current BroadcasterLifeCyclePolicy.

Returns:

the lifecycle policy

setPolicy

public void setPolicy(BroadcasterLifeCyclePolicy policy,
 DefaultBroadcaster broadcaster)

Set the BroadcasterLifeCyclePolicy and activate the lifecycle handler if one is set.

Parameters:

policy - the new lifecycle policy

broadcaster - the broadcaster to apply the policy on

addLifeCycleListener

public void addLifeCycleListener(BroadcasterLifeCyclePolicyListener listener)

Add a BroadcasterLifeCyclePolicyListener.

Parameters:

listener - the listener to add

removeLifeCycleListener

public void removeLifeCycleListener(BroadcasterLifeCyclePolicyListener listener)

Remove a BroadcasterLifeCyclePolicyListener.

Parameters:

listener - the listener to remove

lifeCycleListeners

public ConcurrentLinkedQueue<BroadcasterLifeCyclePolicyListener> lifeCycleListeners()

Return the lifecycle policy listeners.

Returns:

the concurrent queue of lifecycle listeners

recentActivity

public AtomicBoolean recentActivity()

Return the AtomicBoolean tracking recent activity.

Returns:

the recent activity flag

lifecycleHandler

public LifecycleHandler lifecycleHandler()

Return the current LifecycleHandler.

Returns:

the lifecycle handler, may be null

lifecycleHandler

public void lifecycleHandler(LifecycleHandler handler)

Set the LifecycleHandler.

Parameters:

handler - the lifecycle handler

currentLifecycleTask

public Future<?> currentLifecycleTask()

Return the current scheduled lifecycle task.

Returns:

the lifecycle task future, may be null

currentLifecycleTask

public void currentLifecycleTask(Future<?> task)

Set the current scheduled lifecycle task.

Parameters:

task - the lifecycle task future

clearListeners

public void clearListeners()

Clear all lifecycle listeners. Called during broadcaster destruction.