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

Class UnionInputGate

java.lang.Object

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

All Implemented Interfaces:

InputGate

public class UnionInputGate
extends Object
implements InputGate

Input gate wrapper to union the input from multiple input gates.

Each input gate has input channels attached from which it reads data. At each input gate, the input channels have unique IDs from 0 (inclusive) to the number of input channels (exclusive).

 +---+---+      +---+---+---+
 | 0 | 1 |      | 0 | 1 | 2 |
 +--------------+--------------+
 | Input gate 0 | Input gate 1 |
 +--------------+--------------+
 

The union input gate maps these IDs from 0 to the *total* number of input channels across all unioned input gates, e.g. the channels of input gate 0 keep their original indexes and the channel indexes of input gate 1 are set off by 2 to 2--4.

 +---+---++---+---+---+
 | 0 | 1 || 2 | 3 | 4 |
 +--------------------+
 | Union input gate   |
 +--------------------+
 

It is possible to recursively union union input gates.

Constructor Summary

Constructors

Constructor and Description
UnionInputGate(InputGate... inputGates)

Method Summary

Modifier and Type	Method and Description
BufferOrEvent	getNextBufferOrEvent()
int	getNumberOfInputChannels() Returns the total number of input channels across all unioned input gates.
int	getPageSize()
boolean	isFinished()
void	registerListener(EventListener<InputGate> listener)
void	requestPartitions()
void	sendTaskEvent(TaskEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnionInputGate

public UnionInputGate(InputGate... inputGates)

Method Detail

getNumberOfInputChannels

public int getNumberOfInputChannels()

Returns the total number of input channels across all unioned input gates.

Specified by:

getNumberOfInputChannels in interface InputGate

isFinished

public boolean isFinished()

Specified by:

isFinished in interface InputGate

requestPartitions

public void requestPartitions()
                       throws IOException,
                              InterruptedException

Specified by:

requestPartitions in interface InputGate

Throws:

IOException

InterruptedException

getNextBufferOrEvent

public BufferOrEvent getNextBufferOrEvent()
                                   throws IOException,
                                          InterruptedException

Specified by:

getNextBufferOrEvent in interface InputGate

Throws:

IOException

InterruptedException

sendTaskEvent

public void sendTaskEvent(TaskEvent event)
                   throws IOException

Specified by:

sendTaskEvent in interface InputGate

Throws:

IOException

registerListener

public void registerListener(EventListener<InputGate> listener)

Specified by:

registerListener in interface InputGate

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface InputGate