org.apache.flink.streaming.api.operators

Class InternalTimeServiceManager<K,N>

java.lang.Object

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

Type Parameters:

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

N - The type of namespace used for the timers.

@Internal
public class InternalTimeServiceManager<K,N>
extends Object

An entity keeping all the time-related services available to all operators extending the AbstractStreamOperator. Right now, this is only a timer services. NOTE: These services are only available to keyed operators.

Method Summary

Modifier and Type	Method and Description
void	advanceWatermark(Watermark watermark)
InternalTimerService<N>	getInternalTimerService(String name, TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer, Triggerable<K,N> triggerable) Returns a InternalTimerService that can be used to query current processing time and event time and to set timers.
int	numEventTimeTimers()
int	numProcessingTimeTimers()
void	restoreStateForKeyGroup(InputStream stream, int keyGroupIdx, ClassLoader userCodeClassLoader)
void	snapshotStateForKeyGroup(DataOutputView stream, int keyGroupIdx)

Methods inherited from class java.lang.Object

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

Method Detail

getInternalTimerService

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

Returns a InternalTimerService that can be used to query current processing time and event time and to set timers. An operator can have several timer services, where each has its own namespace serializer. Timer services are differentiated by the string key that is given when requesting them, if you call this method with the same key multiple times you will get the same timer service instance in subsequent requests.

Timers are always scoped to a key, the currently active key of a keyed stream operation. When a timer fires, this key will also be set as the currently active key.

Each timer has attached metadata, the namespace. Different timer services can have a different namespace type. If you don't need namespace differentiation you can use VoidNamespaceSerializer as the namespace serializer.

Parameters:

name - The name of the requested timer service. If no service exists under the given name a new one will be created and returned.

keySerializer - TypeSerializer for the timer keys.

namespaceSerializer - TypeSerializer for the timer namespace.

triggerable - The Triggerable that should be invoked when timers fire

advanceWatermark

public void advanceWatermark(Watermark watermark)
                      throws Exception

Throws:

Exception

snapshotStateForKeyGroup

public void snapshotStateForKeyGroup(DataOutputView stream,
                                     int keyGroupIdx)
                              throws IOException

Throws:

IOException

restoreStateForKeyGroup

public void restoreStateForKeyGroup(InputStream stream,
                                    int keyGroupIdx,
                                    ClassLoader userCodeClassLoader)
                             throws IOException

Throws:

IOException

numProcessingTimeTimers

@VisibleForTesting
public int numProcessingTimeTimers()

numEventTimeTimers

@VisibleForTesting
public int numEventTimeTimers()