Package org.apache.flink.streaming.api.operators

Class InternalTimeServiceManagerImpl<K>

java.lang.Object

org.apache.flink.streaming.api.operators.InternalTimeServiceManagerImpl<K>

Type Parameters:

K - The type of keys used for the timers and the registry.

All Implemented Interfaces:

InternalTimeServiceManager<K>

@Internal
public class InternalTimeServiceManagerImpl<K>
extends Object
implements InternalTimeServiceManager<K>

An entity keeping all the time-related services. Right now, this is only a timer services.

NOTE: These services are only available to keyed operators.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.operators.InternalTimeServiceManager

InternalTimeServiceManager.Provider, InternalTimeServiceManager.ShouldStopAdvancingFn

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method	Description
void	advanceWatermark(Watermark watermark)	Advances the Watermark of all managed timer services, potentially firing event time timers.
static <K> InternalTimeServiceManagerImpl<K>	create(TaskIOMetricGroup taskIOMetricGroup, PriorityQueueSetFactory factory, KeyGroupRange keyGroupRange, ClassLoader userClassloader, KeyContext keyContext, ProcessingTimeService processingTimeService, Iterable<KeyGroupStatePartitionStreamProvider> rawKeyedStates, StreamTaskCancellationContext cancellationContext)	A factory method for creating the InternalTimeServiceManagerImpl.
<N> InternalTimerService<N>	getAsyncInternalTimerService(String name, TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer, Triggerable<K,N> triggerable, AsyncExecutionController<K> asyncExecutionController)	Creates an InternalTimerServiceAsyncImpl for handling a group of timers identified by the given name.
<N> InternalTimerService<N>	getInternalTimerService(String name, TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer, Triggerable<K,N> triggerable)	Creates an InternalTimerService for handling a group of timers identified by the given name.
int	numEventTimeTimers()
int	numProcessingTimeTimers()
void	snapshotToRawKeyedState(KeyedStateCheckpointOutputStream out, String operatorName)	Snapshots the timers to raw keyed state.
boolean	tryAdvanceWatermark(Watermark watermark, InternalTimeServiceManager.ShouldStopAdvancingFn shouldStopAdvancingFn)	Try to InternalTimeServiceManager.advanceWatermark(Watermark), but if InternalTimeServiceManager.ShouldStopAdvancingFn returns true, stop the advancement and return as soon as possible.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Method Detail

create

public static <K> InternalTimeServiceManagerImpl<K> create(TaskIOMetricGroup taskIOMetricGroup,
                                                           PriorityQueueSetFactory factory,
                                                           KeyGroupRange keyGroupRange,
                                                           ClassLoader userClassloader,
                                                           KeyContext keyContext,
                                                           ProcessingTimeService processingTimeService,
                                                           Iterable<KeyGroupStatePartitionStreamProvider> rawKeyedStates,
                                                           StreamTaskCancellationContext cancellationContext)
                                                    throws Exception

A factory method for creating the InternalTimeServiceManagerImpl.

IMPORTANT: Keep in sync with InternalTimeServiceManager.Provider.

Throws:

Exception

getInternalTimerService

public <N> InternalTimerService<N> getInternalTimerService(String name,
                                                           TypeSerializer<K> keySerializer,
                                                           TypeSerializer<N> namespaceSerializer,
                                                           Triggerable<K,N> triggerable)

Description copied from interface: InternalTimeServiceManager

Creates an InternalTimerService for handling a group of timers identified by the given name. The timers are scoped to a key and namespace.

When a timer fires the given Triggerable will be invoked.

Specified by:

getInternalTimerService in interface InternalTimeServiceManager<K>

getAsyncInternalTimerService

public <N> InternalTimerService<N> getAsyncInternalTimerService(String name,
                                                                TypeSerializer<K> keySerializer,
                                                                TypeSerializer<N> namespaceSerializer,
                                                                Triggerable<K,N> triggerable,
                                                                AsyncExecutionController<K> asyncExecutionController)

Description copied from interface: InternalTimeServiceManager

Creates an InternalTimerServiceAsyncImpl for handling a group of timers identified by the given name. The timers are scoped to a key and namespace. Mainly used by async operators.

Some essential order preservation will be added when the given Triggerable is invoked.

Specified by:

getAsyncInternalTimerService in interface InternalTimeServiceManager<K>

advanceWatermark

public void advanceWatermark(Watermark watermark)
                      throws Exception

Description copied from interface: InternalTimeServiceManager

Advances the Watermark of all managed timer services, potentially firing event time timers.

Specified by:

advanceWatermark in interface InternalTimeServiceManager<K>

Throws:

Exception

tryAdvanceWatermark

public boolean tryAdvanceWatermark(Watermark watermark,
                                   InternalTimeServiceManager.ShouldStopAdvancingFn shouldStopAdvancingFn)
                            throws Exception

Description copied from interface: InternalTimeServiceManager

Try to InternalTimeServiceManager.advanceWatermark(Watermark), but if InternalTimeServiceManager.ShouldStopAdvancingFn returns true, stop the advancement and return as soon as possible.

Specified by:

tryAdvanceWatermark in interface InternalTimeServiceManager<K>

Returns:

true if Watermark has been fully processed, false otherwise.

Throws:

Exception

snapshotToRawKeyedState

public void snapshotToRawKeyedState(KeyedStateCheckpointOutputStream out,
                                    String operatorName)
                             throws Exception

Description copied from interface: InternalTimeServiceManager

Snapshots the timers to raw keyed state.

TODO: This can be removed once heap-based timers are integrated with RocksDB incremental snapshots.

Specified by:

snapshotToRawKeyedState in interface InternalTimeServiceManager<K>

Throws:

Exception

numProcessingTimeTimers

@VisibleForTesting
public int numProcessingTimeTimers()

numEventTimeTimers

@VisibleForTesting
public int numEventTimeTimers()