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

Class Channel

java.lang.Object

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

Direct Known Subclasses:

InputChannel, OutputChannel

public abstract class Channel
extends Object

The base class for channel objects.

Every channel has an index (at the corresponding gate), ID, and type. The connected channel is given by the ID of destination channel.

Field Summary

Fields

Modifier and Type	Field and Description
protected EnvelopeDispatcher	envelopeDispatcher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Channel(int index, ChannelID id, ChannelID connectedId, ChannelType type) Auxiliary constructor for channels

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	destroy()
ChannelType	getChannelType()
ChannelID	getConnectedId()
ChannelID	getID()
int	getIndex()
abstract JobID	getJobID()
abstract boolean	isClosed()
abstract boolean	isInputChannel()
abstract void	queueEnvelope(Envelope envelope)
void	registerEnvelopeDispatcher(EnvelopeDispatcher envelopeDispatcher) Registers an EnvelopeDispatcher with this channel at runtime.
abstract void	releaseAllResources()
abstract void	transferEvent(AbstractEvent event)

Methods inherited from class java.lang.Object

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

Field Detail

envelopeDispatcher

protected EnvelopeDispatcher envelopeDispatcher

Constructor Detail

Channel

protected Channel(int index,
       ChannelID id,
       ChannelID connectedId,
       ChannelType type)

Auxiliary constructor for channels

Parameters:

index - the index of the channel in either the output or input gate

id - the ID of the channel

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

Method Detail

getIndex

public int getIndex()

getID

public ChannelID getID()

getConnectedId

public ChannelID getConnectedId()

getChannelType

public ChannelType getChannelType()

registerEnvelopeDispatcher

public void registerEnvelopeDispatcher(EnvelopeDispatcher envelopeDispatcher)

Registers an EnvelopeDispatcher with this channel at runtime.

Parameters:

envelopeDispatcher - the envelope dispatcher to use for data transfers

getJobID

public abstract JobID getJobID()

isInputChannel

public abstract boolean isInputChannel()

isClosed

public abstract boolean isClosed()
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException

transferEvent

public abstract void transferEvent(AbstractEvent event)
                            throws IOException,
                                   InterruptedException

Throws:

IOException

InterruptedException

queueEnvelope

public abstract void queueEnvelope(Envelope envelope)

releaseAllResources

public abstract void releaseAllResources()

destroy

public abstract void destroy()