org.apache.flink.runtime.io.network.partition.consumer

Class RemoteInputChannel

java.lang.Object

org.apache.flink.runtime.io.network.partition.consumer.InputChannel

org.apache.flink.runtime.io.network.partition.consumer.RemoteInputChannel

All Implemented Interfaces:

BufferListener, BufferRecycler

public class RemoteInputChannel
extends InputChannel
implements BufferRecycler, BufferListener

An input channel, which requests a remote partition queue.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.io.network.partition.consumer.InputChannel

InputChannel.BufferAndAvailability

Field Summary

Fields inherited from class org.apache.flink.runtime.io.network.partition.consumer.InputChannel

channelIndex, inputGate, numBuffersIn, numBytesIn, partitionId

Constructor Summary

Constructors

Constructor and Description
RemoteInputChannel(SingleInputGate inputGate, int channelIndex, ResultPartitionID partitionId, ConnectionID connectionId, ConnectionManager connectionManager, int initialBackOff, int maxBackoff, TaskIOMetricGroup metrics)
RemoteInputChannel(SingleInputGate inputGate, int channelIndex, ResultPartitionID partitionId, ConnectionID connectionId, ConnectionManager connectionManager, TaskIOMetricGroup metrics)

Method Summary

Modifier and Type	Method and Description
int	getAndResetUnannouncedCredit() Gets the unannounced credit and resets it to 0 atomically.
BufferProvider	getBufferProvider()
int	getInitialCredit()
InputChannelID	getInputChannelId()
int	getNumberOfAvailableBuffers()
int	getNumberOfQueuedBuffers() Gets the current number of received buffers which have not been processed yet.
int	getNumberOfRequiredBuffers()
int	getSenderBacklog()
int	getUnannouncedCredit() Gets the currently unannounced credit.
boolean	isReleased()
boolean	notifyBufferAvailable(Buffer buffer) The Buffer pool notifies this channel of an available floating buffer.
void	notifyBufferDestroyed() Notification callback if the buffer provider is destroyed.
void	onBuffer(Buffer buffer, int sequenceNumber, int backlog)
void	onEmptyBuffer(int sequenceNumber, int backlog)
void	onError(Throwable cause)
void	onFailedPartitionRequest()
void	recycle(MemorySegment segment) Exclusive buffer is recycled to this input channel directly and it may trigger return extra floating buffer and notify increased credit to the producer.
Buffer	requestBuffer() Requests buffer from input channel directly for receiving network data.
void	requestSubpartition(int subpartitionIndex) Requests a remote subpartition.
String	toString()
int	unsynchronizedGetNumberOfQueuedBuffers()

Methods inherited from class org.apache.flink.runtime.io.network.partition.consumer.InputChannel

checkError, getCurrentBackoff, getPartitionId, increaseBackoff, notifyChannelNonEmpty, setError

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteInputChannel

public RemoteInputChannel(SingleInputGate inputGate,
                          int channelIndex,
                          ResultPartitionID partitionId,
                          ConnectionID connectionId,
                          ConnectionManager connectionManager,
                          TaskIOMetricGroup metrics)

RemoteInputChannel

public RemoteInputChannel(SingleInputGate inputGate,
                          int channelIndex,
                          ResultPartitionID partitionId,
                          ConnectionID connectionId,
                          ConnectionManager connectionManager,
                          int initialBackOff,
                          int maxBackoff,
                          TaskIOMetricGroup metrics)

Method Detail

requestSubpartition

@VisibleForTesting
public void requestSubpartition(int subpartitionIndex)
                                            throws IOException,
                                                   InterruptedException

Requests a remote subpartition.

Throws:

IOException

InterruptedException

isReleased

public boolean isReleased()

toString

public String toString()

Overrides:

toString in class Object

recycle

public void recycle(MemorySegment segment)

Exclusive buffer is recycled to this input channel directly and it may trigger return extra floating buffer and notify increased credit to the producer.

Specified by:

recycle in interface BufferRecycler

Parameters:

segment - The exclusive segment of this channel.

getNumberOfAvailableBuffers

public int getNumberOfAvailableBuffers()

getNumberOfRequiredBuffers

public int getNumberOfRequiredBuffers()

getSenderBacklog

public int getSenderBacklog()

notifyBufferAvailable

public boolean notifyBufferAvailable(Buffer buffer)

The Buffer pool notifies this channel of an available floating buffer. If the channel is released or currently does not need extra buffers, the buffer should be recycled to the buffer pool. Otherwise, the buffer will be added into the bufferQueue and the unannounced credit is increased by one.

Specified by:

notifyBufferAvailable in interface BufferListener

Parameters:

buffer - Buffer that becomes available in buffer pool.

Returns:

True when this channel is waiting for more floating buffers, otherwise false.

notifyBufferDestroyed

public void notifyBufferDestroyed()

Description copied from interface: BufferListener

Notification callback if the buffer provider is destroyed.

Specified by:

notifyBufferDestroyed in interface BufferListener

getUnannouncedCredit

public int getUnannouncedCredit()

Gets the currently unannounced credit.

Returns:

Credit which was not announced to the sender yet.

getAndResetUnannouncedCredit

public int getAndResetUnannouncedCredit()

Gets the unannounced credit and resets it to 0 atomically.

Returns:

Credit which was not announced to the sender yet.

getNumberOfQueuedBuffers

public int getNumberOfQueuedBuffers()

Gets the current number of received buffers which have not been processed yet.

Returns:

Buffers queued for processing.

unsynchronizedGetNumberOfQueuedBuffers

public int unsynchronizedGetNumberOfQueuedBuffers()

getInputChannelId

public InputChannelID getInputChannelId()

getInitialCredit

public int getInitialCredit()

getBufferProvider

public BufferProvider getBufferProvider()
                                 throws IOException

Throws:

IOException

requestBuffer

@Nullable
public Buffer requestBuffer()

Requests buffer from input channel directly for receiving network data. It should always return an available buffer in credit-based mode unless the channel has been released.

Returns:

The available buffer.

onBuffer

public void onBuffer(Buffer buffer,
                     int sequenceNumber,
                     int backlog)
              throws IOException

Throws:

IOException

onEmptyBuffer

public void onEmptyBuffer(int sequenceNumber,
                          int backlog)
                   throws IOException

Throws:

IOException

onFailedPartitionRequest

public void onFailedPartitionRequest()

onError

public void onError(Throwable cause)