org.apache.flink.runtime.taskexecutor.slot

Class TimerService<K>

java.lang.Object

org.apache.flink.runtime.taskexecutor.slot.TimerService<K>

Type Parameters:

K - Type of the key

public class TimerService<K>
extends Object

Service to register timeouts for a given key. The timeouts are identified by a ticket so that newly registered timeouts for the same key can be distinguished from older timeouts.

Constructor Summary

Constructors

Constructor and Description
TimerService(ScheduledExecutorService scheduledExecutorService, long shutdownTimeout)

Method Summary

Modifier and Type	Method and Description
boolean	isValid(K key, UUID ticket) Check whether the timeout for the given key and ticket is still valid (not yet unregistered and not yet overwritten).
void	registerTimeout(K key, long delay, TimeUnit unit) Register a timeout for the given key which shall occur in the given delay.
void	start(TimeoutListener<K> initialTimeoutListener)
void	stop()
protected void	unregisterAllTimeouts() Unregister all timeouts.
void	unregisterTimeout(K key) Unregister the timeout for the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerService

public TimerService(ScheduledExecutorService scheduledExecutorService,
                    long shutdownTimeout)

Method Detail

start

public void start(TimeoutListener<K> initialTimeoutListener)

stop

public void stop()

registerTimeout

public void registerTimeout(K key,
                            long delay,
                            TimeUnit unit)

Register a timeout for the given key which shall occur in the given delay.

Parameters:

key - for which to register the timeout

delay - until the timeout

unit - of the timeout delay

unregisterTimeout

public void unregisterTimeout(K key)

Unregister the timeout for the given key.

Parameters:

key - for which to unregister the timeout

unregisterAllTimeouts

protected void unregisterAllTimeouts()

Unregister all timeouts.

isValid

public boolean isValid(K key,
                       UUID ticket)

Check whether the timeout for the given key and ticket is still valid (not yet unregistered and not yet overwritten).

Parameters:

key - for which to check the timeout

ticket - of the timeout

Returns:

True if the timeout ticket is still valid; otherwise false