org.apache.flink.runtime.taskmanager

类 InputGateWithMetrics

java.lang.Object

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

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

org.apache.flink.runtime.taskmanager.InputGateWithMetrics

所有已实现的接口:

AutoCloseable, AvailabilityProvider, ChannelStateHolder, CheckpointableInput, PullingAsyncDataInput<BufferOrEvent>

public class InputGateWithMetrics
extends IndexedInputGate

This class wraps InputGate provided by shuffle service and it is mainly used for increasing general input metrics from TaskIOMetricGroup.

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.runtime.io.network.partition.consumer.InputGate

InputGate.InputWithData<INPUT,DATA>

从接口继承的嵌套类/接口 org.apache.flink.runtime.io.AvailabilityProvider

AvailabilityProvider.AvailabilityHelper

字段概要

从类继承的字段 org.apache.flink.runtime.io.network.partition.consumer.InputGate

availabilityHelper, priorityAvailabilityHelper

从接口继承的字段 org.apache.flink.runtime.io.AvailabilityProvider

AVAILABLE

构造器概要

构造器

构造器和说明
InputGateWithMetrics(IndexedInputGate inputGate, org.apache.flink.metrics.Counter numBytesIn)

方法概要

限定符和类型	方法和说明
void	close()
void	finishReadRecoveredState()
CompletableFuture<?>	getAvailableFuture()
InputChannel	getChannel(int channelIndex) Returns the channel of this gate.
int	getGateIndex() Returns the index of this input gate.
Optional<BufferOrEvent>	getNext() Blocking call waiting for next BufferOrEvent.
int	getNumberOfInputChannels()
CompletableFuture<?>	getPriorityEventAvailableFuture() Notifies when a priority event has been enqueued.
CompletableFuture<Void>	getStateConsumedFuture()
boolean	isFinished()
Optional<BufferOrEvent>	pollNext() Poll the BufferOrEvent.
void	requestPartitions()
void	resumeConsumption(InputChannelInfo channelInfo)
void	sendTaskEvent(TaskEvent event)
void	setChannelStateWriter(ChannelStateWriter channelStateWriter) Injects the ChannelStateWriter.
void	setup() Setup gate, potentially heavy-weight, blocking operation comparing to just creation.

从类继承的方法 org.apache.flink.runtime.io.network.partition.consumer.IndexedInputGate

blockConsumption, checkpointStarted, checkpointStopped, getInputGateIndex

从类继承的方法 org.apache.flink.runtime.io.network.partition.consumer.InputGate

getChannelInfos

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput

getChannelInfos

从接口继承的方法 org.apache.flink.runtime.io.AvailabilityProvider

and, isApproximatelyAvailable, isAvailable, or

构造器详细资料

InputGateWithMetrics

public InputGateWithMetrics(IndexedInputGate inputGate,
                            org.apache.flink.metrics.Counter numBytesIn)

方法详细资料

getAvailableFuture

public CompletableFuture<?> getAvailableFuture()

指定者:

getAvailableFuture 在接口中 AvailabilityProvider

覆盖:

getAvailableFuture 在类中 InputGate

返回:

a future that is completed if there are more records available. If there are more records available immediately, AvailabilityProvider.AVAILABLE should be returned. Previously returned not completed futures should become completed once there are more records available.

resumeConsumption

public void resumeConsumption(InputChannelInfo channelInfo)
                       throws IOException

指定者:

resumeConsumption 在接口中 CheckpointableInput

指定者:

resumeConsumption 在类中 InputGate

抛出:

IOException

getNumberOfInputChannels

public int getNumberOfInputChannels()

指定者:

getNumberOfInputChannels 在接口中 CheckpointableInput

指定者:

getNumberOfInputChannels 在类中 InputGate

getChannel

public InputChannel getChannel(int channelIndex)

从类复制的说明: InputGate

Returns the channel of this gate.

指定者:

getChannel 在类中 InputGate

getGateIndex

public int getGateIndex()

从类复制的说明: IndexedInputGate

Returns the index of this input gate. Only supported on

指定者:

getGateIndex 在类中 IndexedInputGate

isFinished

public boolean isFinished()

指定者:

isFinished 在接口中 PullingAsyncDataInput<BufferOrEvent>

指定者:

isFinished 在类中 InputGate

返回:

true if is finished and for example end of input was reached, false otherwise.

setup

public void setup()
           throws IOException

从类复制的说明: InputGate

Setup gate, potentially heavy-weight, blocking operation comparing to just creation.

指定者:

setup 在类中 InputGate

抛出:

IOException

getStateConsumedFuture

public CompletableFuture<Void> getStateConsumedFuture()

指定者:

getStateConsumedFuture 在类中 InputGate

requestPartitions

public void requestPartitions()
                       throws IOException

指定者:

requestPartitions 在类中 InputGate

抛出:

IOException

setChannelStateWriter

public void setChannelStateWriter(ChannelStateWriter channelStateWriter)

从接口复制的说明: ChannelStateHolder

Injects the ChannelStateWriter. Must only be called once.

指定者:

setChannelStateWriter 在接口中 ChannelStateHolder

覆盖:

setChannelStateWriter 在类中 InputGate

getNext

public Optional<BufferOrEvent> getNext()
                                throws IOException,
                                       InterruptedException

从类复制的说明: InputGate

Blocking call waiting for next BufferOrEvent.

Note: It should be guaranteed that the previous returned buffer has been recycled before getting next one.

指定者:

getNext 在类中 InputGate

返回:

Optional.empty() if InputGate.isFinished() returns true.

抛出:

IOException

InterruptedException

pollNext

public Optional<BufferOrEvent> pollNext()
                                 throws IOException,
                                        InterruptedException

从类复制的说明: InputGate

Poll the BufferOrEvent.

Note: It should be guaranteed that the previous returned buffer has been recycled before polling next one.

指定者:

pollNext 在接口中 PullingAsyncDataInput<BufferOrEvent>

指定者:

pollNext 在类中 InputGate

返回:

Optional.empty() if there is no data to return or if InputGate.isFinished() returns true.

抛出:

IOException

InterruptedException

sendTaskEvent

public void sendTaskEvent(TaskEvent event)
                   throws IOException

指定者:

sendTaskEvent 在类中 InputGate

抛出:

IOException

close

public void close()
           throws Exception

抛出:

Exception

getPriorityEventAvailableFuture

public CompletableFuture<?> getPriorityEventAvailableFuture()

从类复制的说明: InputGate

Notifies when a priority event has been enqueued. If this future is queried from task thread, it is guaranteed that a priority event is available and retrieved through InputGate.getNext().

覆盖:

getPriorityEventAvailableFuture 在类中 InputGate

finishReadRecoveredState

public void finishReadRecoveredState()
                              throws IOException

指定者:

finishReadRecoveredState 在类中 InputGate

抛出:

IOException