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

Interface ReaderBase

All Known Subinterfaces:

MutableReader<T>, Reader<T>

All Known Implementing Classes:

AbstractRecordReader, AbstractSingleGateRecordReader, AbstractUnionRecordReader, MutableRecordReader, MutableUnionRecordReader, RecordReader, UnionRecordReader

public interface ReaderBase

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasReachedEndOfSuperstep()
boolean	isInputClosed()
void	publishEvent(AbstractTaskEvent event) Publishes an event.
void	publishEvent(AbstractTaskEvent event, int inputNumber) Publishes an event to a specific input.
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.

Method Detail

isInputClosed

boolean isInputClosed()

subscribeToEvent

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

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

Parameters:

eventListener - the listener object to register

eventType - the type of event to register the listener for

unsubscribeFromEvent

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

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

Parameters:

eventListener - the listener object to cancel the subscription for

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

publishEvent

void publishEvent(AbstractTaskEvent event)
                  throws IOException,
                         InterruptedException

Publishes an event.

Parameters:

event - the event to be published

Throws:

IOException - thrown if an error occurs while transmitting the event

InterruptedException - thrown if the thread is interrupted while waiting for the event to be published

publishEvent

void publishEvent(AbstractTaskEvent event,
                int inputNumber)
                  throws IOException,
                         InterruptedException

Publishes an event to a specific input.

Parameters:

event - the event to be published

inputNumber - the number of the input that we want to publish the event to

Throws:

IOException - thrown if an error occurs while transmitting the event

InterruptedException - thrown if the thread is interrupted while waiting for the event to be published

setIterative

void setIterative(int numEventsUntilEndOfSuperstep)

startNextSuperstep

void startNextSuperstep()

hasReachedEndOfSuperstep

boolean hasReachedEndOfSuperstep()