com.simsilica.ethereal.zone

Class StateCollector

java.lang.Object

com.simsilica.ethereal.zone.StateCollector

public class StateCollector
extends java.lang.Object

Uses a background thread to periodically collect the accumulated state for the zones and send the blocks of state to zone state listeners.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_PERIOD

Constructor Summary

Constructors

Constructor and Description
StateCollector(ZoneManager zones)
StateCollector(ZoneManager zones, long collectionPeriod)

Method Summary

Modifier and Type	Method and Description
void	addListener(StateListener l) Adds a listener that self-indicates which specific zones it is interested in from one frame to the next.
protected void	collect() Called by the background thread to collect all of the accumulated state since the last collection and distribute it to the state listeners.
protected void	collectionError(java.lang.Exception e)
long	getIdleSleepTime()
protected java.util.List<StateListener>	getListeners(ZoneKey key, boolean create)
protected void	initialize() Called from the background thread when it first starts up.
protected void	publish(StateBlock b)
protected void	publishFrame(StateFrame frame) Adjusts the per-listener zone interest based on latest listener state, then publishes the state frame to all interested listeners.
void	removeListener(StateListener l)
void	setIdleSleepTime(long millis) Sets the sleep() time for the state collector's idle periods.
void	shutdown()
void	start()
protected void	terminate() Called by the background thread when it is shutting down.
protected void	unwatch(ZoneKey key, StateListener l)
protected void	unwatchAll(StateListener l)
protected void	watch(ZoneKey key, StateListener l)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PERIOD

public static final long DEFAULT_PERIOD

See Also:

Constant Field Values

Constructor Detail

StateCollector

public StateCollector(ZoneManager zones)

StateCollector

public StateCollector(ZoneManager zones,
                      long collectionPeriod)

Method Detail

start

public void start()

shutdown

public void shutdown()

addListener

public void addListener(StateListener l)

Adds a listener that self-indicates which specific zones it is interested in from one frame to the next. This is necessary so that it syncs with the background state collection in a way that does not cause partial state, etc... it's also nicer to to the background threads and synchronization if zone interest is synched with updates.

removeListener

public void removeListener(StateListener l)

setIdleSleepTime

public void setIdleSleepTime(long millis)

Sets the sleep() time for the state collector's idle periods. This defaults to 1 which keeps the CPU happier while also providing timely checks against the interval time. However, for higher rates of state collection (lower collectionPeriods such as 16 ms or 60 FPS) on windows, sleep(1) may take longer than 1/60th of a second or close enough to still cause collection frame drops. In that case, it can be configured to 0 which should provide timelier updates. Set to -1 to avoid sleeping at all in which case the thread will consume 100% of a single core in order to busy wait between collection intervals.

getIdleSleepTime

public long getIdleSleepTime()

getListeners

protected java.util.List<StateListener> getListeners(ZoneKey key,
                                                     boolean create)

watch

protected void watch(ZoneKey key,
                     StateListener l)

unwatch

protected void unwatch(ZoneKey key,
                       StateListener l)

unwatchAll

protected void unwatchAll(StateListener l)

initialize

protected void initialize()

Called from the background thread when it first starts up.

publish

protected void publish(StateBlock b)

publishFrame

protected void publishFrame(StateFrame frame)

Adjusts the per-listener zone interest based on latest listener state, then publishes the state frame to all interested listeners.

collect

protected void collect()

Called by the background thread to collect all of the accumulated state since the last collection and distribute it to the state listeners. This is called once per "collectionPeriod".

terminate

protected void terminate()

Called by the background thread when it is shutting down. Currently does nothing.

collectionError

protected void collectionError(java.lang.Exception e)