org.apache.flink.streaming.api.operators

Class StreamSource.ManualWatermarkContext<T>

java.lang.Object

org.apache.flink.streaming.api.operators.StreamSource.ManualWatermarkContext<T>

All Implemented Interfaces:

SourceFunction.SourceContext<T>

Enclosing class:

StreamSource<T>

public static class StreamSource.ManualWatermarkContext<T>
extends Object
implements SourceFunction.SourceContext<T>

SourceFunction.SourceContext to be used for sources with manual timestamp assignment and manual watermark emission.

Constructor Summary

Constructors

Constructor and Description
StreamSource.ManualWatermarkContext(Object lockingObject, Output<StreamRecord<T>> output)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This must be called when closing the source operator to allow the SourceFunction.SourceContext to clean up internal state.
void	collect(T element) Emits one element from the source.
void	collectWithTimestamp(T element, long timestamp) Emits one element from the source with the given timestamp.
void	emitWatermark(Watermark mark) Emits the given Watermark.
Object	getCheckpointLock() Returns the checkpoint lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamSource.ManualWatermarkContext

public StreamSource.ManualWatermarkContext(Object lockingObject,
                                   Output<StreamRecord<T>> output)

Method Detail

collect

public void collect(T element)

Description copied from interface: SourceFunction.SourceContext

Emits one element from the source. The result of System.currentTimeMillis() is set as the timestamp of the emitted element.

Specified by:

collect in interface SourceFunction.SourceContext<T>

Parameters:

element - The element to emit

collectWithTimestamp

public void collectWithTimestamp(T element,
                        long timestamp)

Description copied from interface: SourceFunction.SourceContext

Emits one element from the source with the given timestamp.

Specified by:

collectWithTimestamp in interface SourceFunction.SourceContext<T>

Parameters:

element - The element to emit

timestamp - The timestamp in milliseconds

emitWatermark

public void emitWatermark(Watermark mark)

Description copied from interface: SourceFunction.SourceContext

Emits the given Watermark.

Important: Sources must only manually emit watermarks when they implement EventTimeSourceFunction. Otherwise, elements automatically get the current timestamp assigned at ingress and the system automatically emits watermarks.

Specified by:

emitWatermark in interface SourceFunction.SourceContext<T>

Parameters:

mark - The Watermark to emit

getCheckpointLock

public Object getCheckpointLock()

Description copied from interface: SourceFunction.SourceContext

Returns the checkpoint lock. Please refer to the explanation about checkpointed sources in SourceFunction.

Specified by:

getCheckpointLock in interface SourceFunction.SourceContext<T>

Returns:

The object to use as the lock.

close

public void close()

Description copied from interface: SourceFunction.SourceContext

This must be called when closing the source operator to allow the SourceFunction.SourceContext to clean up internal state.

Specified by:

close in interface SourceFunction.SourceContext<T>