com.simsilica.es.server

Class ComponentUsageTracker

java.lang.Object

com.simsilica.es.server.ComponentUsageTracker

public class ComponentUsageTracker
extends java.lang.Object

Keeps track of a 'frame' of 'version' for any active entity ID + component type combination. Basically this is implementing a mark-and-sweep style usage tracking that the HostedEntityData will use to keep track of what's relevant for the client when sending updates.

Constructor Summary

Constructors

Constructor and Description
ComponentUsageTracker()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	get(com.simsilica.es.EntityId id, java.lang.Class<? extends com.simsilica.es.EntityComponent> type) Returns the last stored version for the specified ID and type or null if there is no tracking for the specified ID and type combination.
java.lang.Long	getAndExpire(com.simsilica.es.EntityId id, java.lang.Class<? extends com.simsilica.es.EntityComponent> type, java.lang.Long current) Returns the last stored version for the ID and type, removing it if the last stored version is older than the current version.
protected java.util.Map<com.simsilica.es.EntityId,java.lang.Long>	getFrameMap(java.lang.Class<? extends com.simsilica.es.EntityComponent> type, boolean create)
void	set(java.util.Collection<com.simsilica.es.EntityId> ids, java.lang.Class<? extends com.simsilica.es.EntityComponent> type, java.lang.Long frame) Sets the current frame counter for all of the specified EntityIds and component type combination.
java.lang.Long	set(com.simsilica.es.EntityId id, java.lang.Class<? extends com.simsilica.es.EntityComponent> type, java.lang.Long frame) Sets the current frame counter for the specified EntityId and component type combination.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentUsageTracker

public ComponentUsageTracker()

Method Detail

getFrameMap

protected java.util.Map<com.simsilica.es.EntityId,java.lang.Long> getFrameMap(java.lang.Class<? extends com.simsilica.es.EntityComponent> type,
                                                                              boolean create)

set

public java.lang.Long set(com.simsilica.es.EntityId id,
                          java.lang.Class<? extends com.simsilica.es.EntityComponent> type,
                          java.lang.Long frame)

Sets the current frame counter for the specified EntityId and component type combination.

set

public void set(java.util.Collection<com.simsilica.es.EntityId> ids,
                java.lang.Class<? extends com.simsilica.es.EntityComponent> type,
                java.lang.Long frame)

Sets the current frame counter for all of the specified EntityIds and component type combination.

getAndExpire

public java.lang.Long getAndExpire(com.simsilica.es.EntityId id,
                                   java.lang.Class<? extends com.simsilica.es.EntityComponent> type,
                                   java.lang.Long current)

Returns the last stored version for the ID and type, removing it if the last stored version is older than the current version. If there is no stored version then null is returned.

get

public java.lang.Long get(com.simsilica.es.EntityId id,
                          java.lang.Class<? extends com.simsilica.es.EntityComponent> type)

Returns the last stored version for the specified ID and type or null if there is no tracking for the specified ID and type combination.