Package org.apache.flink.runtime.io.network.api.reader

Class AbstractReader

java.lang.Object

org.apache.flink.runtime.io.network.api.reader.AbstractReader

All Implemented Interfaces:

ReaderBase

Direct Known Subclasses:

MutableRecordReader, RecordReader

public abstract class AbstractReader
extends Object
implements ReaderBase

A basic reader implementation, which wraps an input gate and handles events.

Field Summary

Fields

Modifier and Type	Field	Description
protected final InputGate	inputGate	The input gate to read from.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReader(InputGate inputGate)

Method Summary

Modifier and Type	Method	Description
protected boolean	handleEvent(AbstractEvent event)	Handles the event and returns whether the reader reached an end-of-stream event (either the end of the whole stream or the end of an superstep).
boolean	hasReachedEndOfSuperstep()
boolean	isFinished()	Returns whether the reader has consumed the input.
void	publish(TaskEvent event)
void	registerTaskEventListener(EventListener<TaskEvent> listener, Class<? extends TaskEvent> eventType)
void	sendTaskEvent(TaskEvent event)
void	setIterativeReader()
void	startNextSuperstep()

Methods inherited from class java.lang.Object

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

Field Details

inputGate

protected final InputGate inputGate

The input gate to read from.

Constructor Details

AbstractReader

protected AbstractReader(InputGate inputGate)

Method Details

isFinished

public boolean isFinished()

Description copied from interface: ReaderBase

Returns whether the reader has consumed the input.

Specified by:

isFinished in interface ReaderBase

registerTaskEventListener

public void registerTaskEventListener(EventListener<TaskEvent> listener,
 Class<? extends TaskEvent> eventType)

Specified by:

registerTaskEventListener in interface ReaderBase

sendTaskEvent

public void sendTaskEvent(TaskEvent event)
                   throws IOException

Specified by:

sendTaskEvent in interface ReaderBase

Throws:

IOException

handleEvent

protected boolean handleEvent(AbstractEvent event)
                       throws IOException

Handles the event and returns whether the reader reached an end-of-stream event (either the end of the whole stream or the end of an superstep).

Throws:

IOException

publish

public void publish(TaskEvent event)

setIterativeReader

public void setIterativeReader()

Specified by:

setIterativeReader in interface ReaderBase

startNextSuperstep

public void startNextSuperstep()

Specified by:

startNextSuperstep in interface ReaderBase

hasReachedEndOfSuperstep

public boolean hasReachedEndOfSuperstep()

Specified by:

hasReachedEndOfSuperstep in interface ReaderBase