public class InputGateWithMetrics extends IndexedInputGate
InputGate
provided by shuffle service and it is mainly used for
increasing general input metrics from TaskIOMetricGroup
.InputGate.InputWithData<INPUT,DATA>
AvailabilityProvider.AvailabilityHelper
availabilityHelper
AVAILABLE
Constructor and Description |
---|
InputGateWithMetrics(IndexedInputGate inputGate,
Counter numBytesIn) |
Modifier and Type | Method and Description |
---|---|
void |
close() |
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() |
boolean |
isFinished() |
Optional<BufferOrEvent> |
pollNext()
Poll the
BufferOrEvent . |
CompletableFuture<?> |
readRecoveredState(ExecutorService executor,
ChannelStateReader reader)
Reads the previous unaligned checkpoint states before requesting partition data.
|
void |
registerBufferReceivedListener(BufferReceivedListener listener) |
void |
requestPartitions() |
void |
resumeConsumption(int channelIndex) |
void |
sendTaskEvent(TaskEvent event) |
void |
setup()
Setup gate, potentially heavy-weight, blocking operation comparing to just creation.
|
getChannelInfos
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isApproximatelyAvailable, isAvailable
public InputGateWithMetrics(IndexedInputGate inputGate, Counter numBytesIn)
public CompletableFuture<?> getAvailableFuture()
getAvailableFuture
in interface AvailabilityProvider
getAvailableFuture
in class InputGate
AvailabilityProvider.AVAILABLE
should be returned. Previously returned
not completed futures should become completed once there are more records available.public void resumeConsumption(int channelIndex) throws IOException
resumeConsumption
in class InputGate
IOException
public int getNumberOfInputChannels()
getNumberOfInputChannels
in class InputGate
public InputChannel getChannel(int channelIndex)
InputGate
getChannel
in class InputGate
public int getGateIndex()
IndexedInputGate
getGateIndex
in class IndexedInputGate
public boolean isFinished()
isFinished
in interface PullingAsyncDataInput<BufferOrEvent>
isFinished
in class InputGate
public void setup() throws IOException
InputGate
setup
in class InputGate
IOException
public CompletableFuture<?> readRecoveredState(ExecutorService executor, ChannelStateReader reader) throws IOException
InputGate
readRecoveredState
in class InputGate
executor
- the dedicated executor for performing this action for all the internal
channels.reader
- the dedicated reader for unspilling the respective channel state from
snapshots.IOException
public void requestPartitions() throws IOException
requestPartitions
in class InputGate
IOException
public Optional<BufferOrEvent> getNext() throws IOException, InterruptedException
InputGate
BufferOrEvent
.
Note: It should be guaranteed that the previous returned buffer has been recycled before getting next one.
getNext
in class InputGate
Optional.empty()
if InputGate.isFinished()
returns true.IOException
InterruptedException
public Optional<BufferOrEvent> pollNext() throws IOException, InterruptedException
InputGate
BufferOrEvent
.
Note: It should be guaranteed that the previous returned buffer has been recycled before polling next one.
pollNext
in interface PullingAsyncDataInput<BufferOrEvent>
pollNext
in class InputGate
Optional.empty()
if there is no data to return or if InputGate.isFinished()
returns true.IOException
InterruptedException
public void sendTaskEvent(TaskEvent event) throws IOException
sendTaskEvent
in class InputGate
IOException
public void registerBufferReceivedListener(BufferReceivedListener listener)
registerBufferReceivedListener
in class InputGate
Copyright © 2014–2021 The Apache Software Foundation. All rights reserved.