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

Class AbstractRecordReader

java.lang.Object

org.apache.flink.runtime.io.network.api.AbstractRecordReader

All Implemented Interfaces:

ReaderBase

Direct Known Subclasses:

AbstractSingleGateRecordReader, AbstractUnionRecordReader

public abstract class AbstractRecordReader
extends Object
implements ReaderBase

This is an abstract base class for a record reader, either dealing with mutable or immutable records, and dealing with reads from single gates (single end points) or multiple gates (union).

Constructor Summary

Constructors

Constructor and Description
AbstractRecordReader()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	handleEvent(AbstractTaskEvent evt)
boolean	hasReachedEndOfSuperstep()
protected boolean	incrementEndOfSuperstepEventAndCheck()
void	setIterative(int numEventsUntilEndOfSuperstep)
void	startNextSuperstep()
void	subscribeToEvent(EventListener eventListener, Class<? extends AbstractTaskEvent> eventType) Subscribes the listener object to receive events of the given type.
void	unsubscribeFromEvent(EventListener eventListener, Class<? extends AbstractTaskEvent> eventType) Removes the subscription for events of the given type for the listener object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.io.network.api.ReaderBase

isInputClosed, publishEvent

Constructor Detail

AbstractRecordReader

public AbstractRecordReader()

Method Detail

subscribeToEvent

public void subscribeToEvent(EventListener eventListener,
                    Class<? extends AbstractTaskEvent> eventType)

Subscribes the listener object to receive events of the given type.

Specified by:

subscribeToEvent in interface ReaderBase

Parameters:

eventListener - the listener object to register

eventType - the type of event to register the listener for

unsubscribeFromEvent

public void unsubscribeFromEvent(EventListener eventListener,
                        Class<? extends AbstractTaskEvent> eventType)

Removes the subscription for events of the given type for the listener object.

Specified by:

unsubscribeFromEvent in interface ReaderBase

Parameters:

eventListener - The listener object to cancel the subscription for.

eventType - The type of the event to cancel the subscription for.

handleEvent

protected void handleEvent(AbstractTaskEvent evt)

setIterative

public void setIterative(int numEventsUntilEndOfSuperstep)

Specified by:

setIterative in interface ReaderBase

startNextSuperstep

public void startNextSuperstep()

Specified by:

startNextSuperstep in interface ReaderBase

hasReachedEndOfSuperstep

public boolean hasReachedEndOfSuperstep()

Specified by:

hasReachedEndOfSuperstep in interface ReaderBase

incrementEndOfSuperstepEventAndCheck

protected boolean incrementEndOfSuperstepEventAndCheck()