com.rpl.rama.integration

Interface TaskGlobalObjectWithTick

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, RamaSerializable, java.io.Serializable, TaskGlobalObject

public interface TaskGlobalObjectWithTick
extends TaskGlobalObject

Defines a task global object that will have tick() called at a regular frequency.

See Also:

Integration documentation

Method Summary

Modifier and Type	Method and Description
long	getFrequencyMillis() Defines the frequency at which tick() is called.
void	tick() Implement this method to define desired behavior on each tick.

Methods inherited from interface com.rpl.rama.integration.TaskGlobalObject

gainedLeadership, prepareForTask

Methods inherited from interface java.io.Closeable

close

Method Detail

getFrequencyMillis

long getFrequencyMillis()

Defines the frequency at which tick() is called. This is called once when the object is being prepared on the task.

Returns:

Tick frequency in milliseconds

tick

void tick()

Implement this method to define desired behavior on each tick.