org.apache.flink.runtime.io.network.gates

Class OutputGate

java.lang.Object

org.apache.flink.runtime.io.network.gates.Gate<IOReadableWritable>

org.apache.flink.runtime.io.network.gates.OutputGate

public class OutputGate
extends Gate<IOReadableWritable>

Constructor Summary

Constructors

Constructor and Description
OutputGate(JobID jobId, GateID gateId, int index) Constructs a new output gate.

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcastBuffer(Buffer buffer)
void	broadcastEvent(AbstractEvent event)
OutputChannel[]	channels()
OutputChannel	getChannel(int index)
int	getNumChannels()
void	initializeChannels(GateDeploymentDescriptor descriptor)
boolean	isClosed() Checks if the gate is closed.
boolean	isInputGate() Checks if the considered gate is an input gate.
void	publishEvent(AbstractEvent event) Publishes an event.
void	releaseAllChannelResources() Releases the allocated resources (particularly buffer) of all channels attached to this gate.
void	requestClose()
void	sendBuffer(Buffer buffer, int targetChannel)
void	sendBufferAndEvent(Buffer buffer, AbstractEvent event, int targetChannel)
void	sendEvent(AbstractEvent event, int targetChannel)
String	toString()
void	waitForGateToBeClosed()

Methods inherited from class org.apache.flink.runtime.io.network.gates.Gate

deliverEvent, getChannelType, getEventNotificationManager, getGateID, getIndex, getJobID, setChannelType, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputGate

public OutputGate(JobID jobId,
          GateID gateId,
          int index)

Constructs a new output gate.

Parameters:

jobId - the ID of the job this input gate belongs to

gateId - the ID of the gate

index - the index assigned to this output gate at the Environment object

Method Detail

sendBuffer

public void sendBuffer(Buffer buffer,
              int targetChannel)
                throws IOException,
                       InterruptedException

Throws:

IOException

InterruptedException

sendEvent

public void sendEvent(AbstractEvent event,
             int targetChannel)
               throws IOException,
                      InterruptedException

Throws:

IOException

InterruptedException

sendBufferAndEvent

public void sendBufferAndEvent(Buffer buffer,
                      AbstractEvent event,
                      int targetChannel)
                        throws IOException,
                               InterruptedException

Throws:

IOException

InterruptedException

broadcastBuffer

public void broadcastBuffer(Buffer buffer)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

broadcastEvent

public void broadcastEvent(AbstractEvent event)
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

initializeChannels

public void initializeChannels(GateDeploymentDescriptor descriptor)

channels

public OutputChannel[] channels()

getChannel

public OutputChannel getChannel(int index)

getNumChannels

public int getNumChannels()

requestClose

public void requestClose()
                  throws IOException,
                         InterruptedException

Throws:

IOException

InterruptedException

isClosed

public boolean isClosed()

Description copied from class: Gate

Checks if the gate is closed. The gate is closed if all this associated channels are closed.

Specified by:

isClosed in class Gate<IOReadableWritable>

Returns:

true if the gate is closed, false otherwise

waitForGateToBeClosed

public void waitForGateToBeClosed()
                           throws InterruptedException

Throws:

InterruptedException

isInputGate

public boolean isInputGate()

Description copied from class: Gate

Checks if the considered gate is an input gate.

Specified by:

isInputGate in class Gate<IOReadableWritable>

Returns:

true if the considered gate is an input gate, false if it is an output gate

toString

public String toString()

Overrides:

toString in class Gate<IOReadableWritable>

publishEvent

public void publishEvent(AbstractEvent event)
                  throws IOException,
                         InterruptedException

Description copied from class: Gate

Publishes an event.

Specified by:

publishEvent in class Gate<IOReadableWritable>

Parameters:

event - the event to be published

Throws:

IOException - thrown if an error occurs while transmitting the event

InterruptedException - thrown if the thread is interrupted while waiting for the event to be published

releaseAllChannelResources

public void releaseAllChannelResources()

Description copied from class: Gate

Releases the allocated resources (particularly buffer) of all channels attached to this gate. This method should only be called after the respected task has stopped running.

Specified by:

releaseAllChannelResources in class Gate<IOReadableWritable>