org.apache.flink.streaming.api.functions.source

Interface SourceFunction.SourceContext<T>

Type Parameters:

T - The type of the elements produced by the source.

All Known Implementing Classes:

StreamSource.AutomaticWatermarkContext, StreamSource.ManualWatermarkContext, StreamSource.NonTimestampContext

Enclosing interface:

SourceFunction<T>

@Public
public static interface SourceFunction.SourceContext<T>

Interface that source functions use to emit elements, and possibly watermarks.

Method Summary

Modifier and Type	Method and Description
void	close() This method is called by the system to shut down the context.
void	collect(T element) Emits one element from the source, without attaching a timestamp.
void	collectWithTimestamp(T element, long timestamp) Emits one element from the source, and attaches the given timestamp.
void	emitWatermark(Watermark mark) Emits the given Watermark.
Object	getCheckpointLock() Returns the checkpoint lock.

Method Detail

collect

void collect(T element)

Emits one element from the source, without attaching a timestamp. In most cases, this is the default way of emitting elements.

The timestamp that the element will get assigned depends on the time characteristic of the streaming program:

• On TimeCharacteristic.ProcessingTime, the element has no timestamp.
• On TimeCharacteristic.IngestionTime, the element gets the system's current time as the timestamp.
• On TimeCharacteristic.EventTime, the element will have no timestamp initially. It needs to get a timestamp (via a TimestampAssigner) before any time-dependent operation (like time windows).

Parameters:

element - The element to emit

collectWithTimestamp

@PublicEvolving
void collectWithTimestamp(T element,
                                          long timestamp)

Emits one element from the source, and attaches the given timestamp. This method is relevant for programs using TimeCharacteristic.EventTime, where the sources assign timestamps themselves, rather than relying on a TimestampAssigner on the stream.

On certain time characteristics, this timestamp may be ignored or overwritten. This allows programs to switch between the different time characteristics and behaviors without changing the code of the source functions.

• On TimeCharacteristic.ProcessingTime, the timestamp will be ignored, because processing time never works with element timestamps.
• On TimeCharacteristic.IngestionTime, the timestamp is overwritten with the system's current time, to realize proper ingestion time semantics.
• On TimeCharacteristic.EventTime, the timestamp will be used.

Parameters:

element - The element to emit

timestamp - The timestamp in milliseconds since the Epoch

emitWatermark

@PublicEvolving
void emitWatermark(Watermark mark)

Emits the given Watermark. A Watermark of value t declares that no elements with a timestamp t' <= t will occur any more. If further such elements will be emitted, those elements are considered late.

This method is only relevant when running on TimeCharacteristic.EventTime. On TimeCharacteristic.ProcessingTime,Watermarks will be ignored. On TimeCharacteristic.IngestionTime, the Watermarks will be replaced by the automatic ingestion time watermarks.

Parameters:

mark - The Watermark to emit

getCheckpointLock

Object getCheckpointLock()

Returns the checkpoint lock. Please refer to the class-level comment in SourceFunction for details about how to write a consistent checkpointed source.

Returns:

The object to use as the lock

close

void close()

This method is called by the system to shut down the context.