org.apache.flink.runtime.taskmanager

Class InputGateWithMetrics

java.lang.Object

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

org.apache.flink.runtime.taskmanager.InputGateWithMetrics

All Implemented Interfaces:

AutoCloseable, AsyncDataInput<BufferOrEvent>, AvailabilityListener

public class InputGateWithMetrics
extends InputGate

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

Nested Class Summary

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

InputGate.InputWithData<INPUT,DATA>

Field Summary

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

isAvailable

Fields inherited from interface org.apache.flink.runtime.io.AvailabilityListener

AVAILABLE

Constructor Summary

Constructors

Constructor and Description
InputGateWithMetrics(InputGate inputGate, Counter numBytesIn)

Method Summary

Modifier and Type	Method and Description
void	close()
Optional<BufferOrEvent>	getNext() Blocking call waiting for next BufferOrEvent.
int	getNumberOfInputChannels()
CompletableFuture<?>	isAvailable() Check if this instance is available for further processing.
boolean	isFinished()
Optional<BufferOrEvent>	pollNext() Poll the BufferOrEvent.
void	sendTaskEvent(TaskEvent event)
void	setup() Setup gate, potentially heavy-weight, blocking operation comparing to just creation.

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

resetIsAvailable

Methods inherited from class java.lang.Object

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

Constructor Detail

InputGateWithMetrics

public InputGateWithMetrics(InputGate inputGate,
                            Counter numBytesIn)

Method Detail

isAvailable

public CompletableFuture<?> isAvailable()

Description copied from interface: AvailabilityListener

Check if this instance is available for further processing.

When hot looping to avoid volatile access in CompletableFuture.isDone() user of this method should do the following check:

 
	AvailabilityListener input = ...;
	if (input.isAvailable() == AvailabilityListener.AVAILABLE || input.isAvailable().isDone()) {
		// do something;
	}
 
 

Specified by:

isAvailable in interface AvailabilityListener

Overrides:

isAvailable in class InputGate

Returns:

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

getNumberOfInputChannels

public int getNumberOfInputChannels()

Specified by:

getNumberOfInputChannels in class InputGate

isFinished

public boolean isFinished()

Specified by:

isFinished in interface AvailabilityListener

Specified by:

isFinished in class InputGate

Returns:

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

setup

public void setup()
           throws IOException,
                  InterruptedException

Description copied from class: InputGate

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

Specified by:

setup in class InputGate

Throws:

IOException

InterruptedException

getNext

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

Description copied from class: InputGate

Blocking call waiting for next BufferOrEvent.

Specified by:

getNext in class InputGate

Returns:

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

Throws:

IOException

InterruptedException

pollNext

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

Description copied from class: InputGate

Poll the BufferOrEvent.

Specified by:

pollNext in interface AsyncDataInput<BufferOrEvent>

Specified by:

pollNext in class InputGate

Returns:

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

Throws:

IOException

InterruptedException

sendTaskEvent

public void sendTaskEvent(TaskEvent event)
                   throws IOException

Specified by:

sendTaskEvent in class InputGate

Throws:

IOException

close

public void close()
           throws Exception

Throws:

Exception