org.apache.flink.runtime.io.network.channels

Class InputChannel<T extends IOReadableWritable>

java.lang.Object

org.apache.flink.runtime.io.network.channels.Channel

org.apache.flink.runtime.io.network.channels.InputChannel<T>

Type Parameters:

T - The Type of the record that can be transported through the channel.

All Implemented Interfaces:

BufferProvider

public class InputChannel<T extends IOReadableWritable>
extends Channel
implements BufferProvider

InputChannel is an abstract base class to all different kinds of concrete input channels that can be used. Input channels are always parameterized to a specific type that can be transported through the channel.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.bufferprovider.BufferProvider

BufferProvider.BufferAvailabilityRegistration

Field Summary

Fields inherited from class org.apache.flink.runtime.io.network.channels.Channel

envelopeDispatcher

Constructor Summary

Constructors

Constructor and Description
InputChannel(InputGate<T> inputGate, int channelIndex, ChannelID channelID, ChannelID connectedChannelID, ChannelType type) Constructs an input channel with a given input gate associated.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	destroy()
int	getBufferSize() Returns the size of buffers (in bytes) available at this buffer provider.
ChannelType	getChannelType()
AbstractTaskEvent	getCurrentEvent()
InputGate<T>	getInputGate() Returns the input gate associated with the input channel.
JobID	getJobID()
BufferOrEvent	getNextBufferOrEvent()
boolean	isClosed()
boolean	isInputChannel()
void	logQueuedEnvelopes()
void	notifyDataUnitConsumed() Notify the channel that a data unit has been consumed.
void	notifyGateThatInputIsAvailable()
void	queueEnvelope(Envelope envelope)
InputChannelResult	readRecord(T target)
BufferProvider.BufferAvailabilityRegistration	registerBufferAvailabilityListener(BufferAvailabilityListener listener) Registers the given BufferAvailabilityListener with an empty buffer pool.
void	releaseAllResources()
void	reportAsynchronousEvent() Reports an asynchronous event and interrupts each blocking method of this buffer provider in order to allow the blocked thread to respond to the event.
void	reportIOException(IOException ioe)
Buffer	requestBuffer(int minBufferSize) Requests a buffer with a minimum size of minBufferSize.
Buffer	requestBufferBlocking(int minBufferSize) Requests a buffer with a minimum size of minBufferSize.
void	transferEvent(AbstractEvent event)
void	transferEventToOutputChannel(AbstractEvent event)

Methods inherited from class org.apache.flink.runtime.io.network.channels.Channel

getConnectedId, getID, getIndex, registerEnvelopeDispatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

InputChannel

public InputChannel(InputGate<T> inputGate,
            int channelIndex,
            ChannelID channelID,
            ChannelID connectedChannelID,
            ChannelType type)

Constructs an input channel with a given input gate associated.

Parameters:

inputGate - the input gate this channel is connected to

channelIndex - the index of the channel in the input gate

channelID - the ID of the channel

connectedChannelID - the ID of the channel this channel is connected to

Method Detail

getInputGate

public InputGate<T> getInputGate()

Returns the input gate associated with the input channel.

Returns:

the input gate associated with the input channel.

isInputChannel

public boolean isInputChannel()

Specified by:

isInputChannel in class Channel

getJobID

public JobID getJobID()

Specified by:

getJobID in class Channel

readRecord

public InputChannelResult readRecord(T target)
                              throws IOException

Throws:

IOException

getChannelType

public ChannelType getChannelType()

Overrides:

getChannelType in class Channel

isClosed

public boolean isClosed()
                 throws IOException

Specified by:

isClosed in class Channel

Throws:

IOException

close

public void close()
           throws IOException,
                  InterruptedException

Throws:

IOException

InterruptedException

notifyGateThatInputIsAvailable

public void notifyGateThatInputIsAvailable()

transferEvent

public void transferEvent(AbstractEvent event)
                   throws IOException,
                          InterruptedException

Specified by:

transferEvent in class Channel

Throws:

IOException

InterruptedException

reportIOException

public void reportIOException(IOException ioe)

releaseAllResources

public void releaseAllResources()

Specified by:

releaseAllResources in class Channel

notifyDataUnitConsumed

public void notifyDataUnitConsumed()

Notify the channel that a data unit has been consumed.

getCurrentEvent

public AbstractTaskEvent getCurrentEvent()

queueEnvelope

public void queueEnvelope(Envelope envelope)

Specified by:

queueEnvelope in class Channel

destroy

public void destroy()

Specified by:

destroy in class Channel

logQueuedEnvelopes

public void logQueuedEnvelopes()

requestBuffer

public Buffer requestBuffer(int minBufferSize)
                     throws IOException

Description copied from interface: BufferProvider

Requests a buffer with a minimum size of minBufferSize. The method returns immediately, even if the request could not be fulfilled.

Specified by:

requestBuffer in interface BufferProvider

Parameters:

minBufferSize - minimum size of the requested buffer (in bytes)

Returns:

buffer with at least the requested size or null if no such buffer is currently available

Throws:

IOException

requestBufferBlocking

public Buffer requestBufferBlocking(int minBufferSize)
                             throws IOException,
                                    InterruptedException

Description copied from interface: BufferProvider

Requests a buffer with a minimum size of minBufferSize. The method blocks until the request has been fulfilled or BufferProvider.reportAsynchronousEvent() has been called.

Specified by:

requestBufferBlocking in interface BufferProvider

Parameters:

minBufferSize - minimum size of the requested buffer (in bytes)

Returns:

buffer with at least the requested size

Throws:

IOException

InterruptedException

getBufferSize

public int getBufferSize()

Description copied from interface: BufferProvider

Returns the size of buffers (in bytes) available at this buffer provider.

Specified by:

getBufferSize in interface BufferProvider

Returns:

size of buffers (in bytes) available at this buffer provider

reportAsynchronousEvent

public void reportAsynchronousEvent()

Description copied from interface: BufferProvider

Reports an asynchronous event and interrupts each blocking method of this buffer provider in order to allow the blocked thread to respond to the event.

Specified by:

reportAsynchronousEvent in interface BufferProvider

registerBufferAvailabilityListener

public BufferProvider.BufferAvailabilityRegistration registerBufferAvailabilityListener(BufferAvailabilityListener listener)

Description copied from interface: BufferProvider

Registers the given BufferAvailabilityListener with an empty buffer pool.

The registration only succeeds, if the buffer pool is empty and has not been destroyed yet.

The registered listener will receive a notification when at least one buffer has become available again. After the notification, the listener will be unregistered.

Specified by:

registerBufferAvailabilityListener in interface BufferProvider

Parameters:

listener - the listener to be registered

Returns:

true if the registration has been successful; false if the registration failed, because the buffer pool was not empty or has already been destroyed

getNextBufferOrEvent

public BufferOrEvent getNextBufferOrEvent()
                                   throws IOException

Throws:

IOException

transferEventToOutputChannel

public void transferEventToOutputChannel(AbstractEvent event)
                                  throws IOException,
                                         InterruptedException

Throws:

IOException

InterruptedException