org.apache.flink.streaming.api.operators

Class HeapInternalTimerService<K,N>

java.lang.Object

org.apache.flink.streaming.api.operators.HeapInternalTimerService<K,N>

All Implemented Interfaces:

InternalTimerService<N>, ProcessingTimeCallback

public class HeapInternalTimerService<K,N>
extends Object
implements InternalTimerService<N>, ProcessingTimeCallback

InternalTimerService that stores timers on the Java heap.

Constructor Summary

Constructors

Constructor and Description
HeapInternalTimerService(int totalKeyGroups, KeyGroupsList localKeyGroupRange, KeyContext keyContext, ProcessingTimeService processingTimeService)

Method Summary

Modifier and Type	Method and Description
void	advanceWatermark(long time)
long	currentProcessingTime() Returns the current processing time.
long	currentWatermark() Returns the current event-time watermark.
void	deleteEventTimeTimer(N namespace, long time) Deletes the timer for the given key and namespace.
void	deleteProcessingTimeTimer(N namespace, long time) Deletes the timer for the given key and namespace.
Set<InternalTimer<K,N>>[]	getEventTimeTimersPerKeyGroup()
int	getLocalKeyGroupRangeStartIdx()
Set<InternalTimer<K,N>>[]	getProcessingTimeTimersPerKeyGroup()
int	numEventTimeTimers()
int	numEventTimeTimers(N namespace)
int	numProcessingTimeTimers()
int	numProcessingTimeTimers(N namespace)
void	onProcessingTime(long time) This method is invoked with the timestamp for which the trigger was scheduled.
void	registerEventTimeTimer(N namespace, long time) Registers a timer to be fired when event time watermark passes the given time.
void	registerProcessingTimeTimer(N namespace, long time) Registers a timer to be fired when processing time passes the given time.
void	restoreTimersForKeyGroup(InternalTimersSnapshot<?,?> restoredTimersSnapshot, int keyGroupIdx) Restore the timers (both processing and event time ones) for a given keyGroupIdx.
InternalTimersSnapshot<K,N>	snapshotTimersForKeyGroup(int keyGroupIdx) Snapshots the timers (both processing and event time ones) for a given keyGroupIdx.
void	startTimerService(TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer, Triggerable<K,N> triggerTarget) Starts the local HeapInternalTimerService by: Setting the keySerialized and namespaceSerializer for the timers it will contain. Setting the triggerTarget which contains the action to be performed when a timer fires. Re-registering timers that were retrieved after recovering from a node failure, if any. This method can be called multiple times, as long as it is called with the same serializers.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeapInternalTimerService

public HeapInternalTimerService(int totalKeyGroups,
                                KeyGroupsList localKeyGroupRange,
                                KeyContext keyContext,
                                ProcessingTimeService processingTimeService)

Method Detail

startTimerService

public void startTimerService(TypeSerializer<K> keySerializer,
                              TypeSerializer<N> namespaceSerializer,
                              Triggerable<K,N> triggerTarget)

Starts the local HeapInternalTimerService by:

1. Setting the keySerialized and namespaceSerializer for the timers it will contain.
2. Setting the triggerTarget which contains the action to be performed when a timer fires.
3. Re-registering timers that were retrieved after recovering from a node failure, if any.

This method can be called multiple times, as long as it is called with the same serializers.

currentProcessingTime

public long currentProcessingTime()

Description copied from interface: InternalTimerService

Returns the current processing time.

Specified by:

currentProcessingTime in interface InternalTimerService<N>

currentWatermark

public long currentWatermark()

Description copied from interface: InternalTimerService

Returns the current event-time watermark.

Specified by:

currentWatermark in interface InternalTimerService<N>

registerProcessingTimeTimer

public void registerProcessingTimeTimer(N namespace,
                                        long time)

Description copied from interface: InternalTimerService

Registers a timer to be fired when processing time passes the given time. The namespace you pass here will be provided when the timer fires.

Specified by:

registerProcessingTimeTimer in interface InternalTimerService<N>

registerEventTimeTimer

public void registerEventTimeTimer(N namespace,
                                   long time)

Description copied from interface: InternalTimerService

Registers a timer to be fired when event time watermark passes the given time. The namespace you pass here will be provided when the timer fires.

Specified by:

registerEventTimeTimer in interface InternalTimerService<N>

deleteProcessingTimeTimer

public void deleteProcessingTimeTimer(N namespace,
                                      long time)

Description copied from interface: InternalTimerService

Deletes the timer for the given key and namespace.

Specified by:

deleteProcessingTimeTimer in interface InternalTimerService<N>

deleteEventTimeTimer

public void deleteEventTimeTimer(N namespace,
                                 long time)

Description copied from interface: InternalTimerService

Deletes the timer for the given key and namespace.

Specified by:

deleteEventTimeTimer in interface InternalTimerService<N>

onProcessingTime

public void onProcessingTime(long time)
                      throws Exception

Description copied from interface: ProcessingTimeCallback

This method is invoked with the timestamp for which the trigger was scheduled.

If the triggering is delayed for whatever reason (trigger timer was blocked, JVM stalled due to a garbage collection), the timestamp supplied to this function will still be the original timestamp for which the trigger was scheduled.

Specified by:

onProcessingTime in interface ProcessingTimeCallback

Parameters:

time - The timestamp for which the trigger event was scheduled.

Throws:

Exception

advanceWatermark

public void advanceWatermark(long time)
                      throws Exception

Throws:

Exception

snapshotTimersForKeyGroup

public InternalTimersSnapshot<K,N> snapshotTimersForKeyGroup(int keyGroupIdx)

Snapshots the timers (both processing and event time ones) for a given keyGroupIdx.

Parameters:

keyGroupIdx - the id of the key-group to be put in the snapshot.

Returns:

a snapshot containing the timers for the given key-group, and the serializers for them

restoreTimersForKeyGroup

public void restoreTimersForKeyGroup(InternalTimersSnapshot<?,?> restoredTimersSnapshot,
                                     int keyGroupIdx)
                              throws IOException

Restore the timers (both processing and event time ones) for a given keyGroupIdx.

Parameters:

restoredTimersSnapshot - the restored snapshot containing the key-group's timers, and the serializers that were used to write them

keyGroupIdx - the id of the key-group to be put in the snapshot.

Throws:

IOException

numProcessingTimeTimers

public int numProcessingTimeTimers()

numEventTimeTimers

public int numEventTimeTimers()

numProcessingTimeTimers

public int numProcessingTimeTimers(N namespace)

numEventTimeTimers

public int numEventTimeTimers(N namespace)

getLocalKeyGroupRangeStartIdx

@VisibleForTesting
public int getLocalKeyGroupRangeStartIdx()

getEventTimeTimersPerKeyGroup

@VisibleForTesting
public Set<InternalTimer<K,N>>[] getEventTimeTimersPerKeyGroup()

getProcessingTimeTimersPerKeyGroup

@VisibleForTesting
public Set<InternalTimer<K,N>>[] getProcessingTimeTimersPerKeyGroup()