org.apache.flink.runtime.io.network.api.writer

Class ChannelSelectorRecordWriter<T extends org.apache.flink.core.io.IOReadableWritable>

java.lang.Object

org.apache.flink.runtime.io.network.api.writer.RecordWriter<T>

org.apache.flink.runtime.io.network.api.writer.ChannelSelectorRecordWriter<T>

Type Parameters:

T - the type of the record that can be emitted with this record writer

All Implemented Interfaces:

AvailabilityProvider

public final class ChannelSelectorRecordWriter<T extends org.apache.flink.core.io.IOReadableWritable>
extends RecordWriter<T>

A regular record-oriented runtime result writer.

The ChannelSelectorRecordWriter extends the RecordWriter and maintains an array of BufferBuilders for all the channels. The emit(IOReadableWritable) operation is based on ChannelSelector to select the target channel.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

AvailabilityProvider.AvailabilityHelper

Field Summary

Fields inherited from class org.apache.flink.runtime.io.network.api.writer.RecordWriter

DEFAULT_OUTPUT_FLUSH_THREAD_NAME, numberOfChannels, rng, serializer, targetPartition

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

AVAILABLE

Method Summary

Modifier and Type	Method and Description
void	broadcastEmit(T record) The record is serialized into intermediate serialization buffer which is then copied into the target buffer for every channel.
void	clearBuffers() Closes the BufferBuilders for all the channels.
void	closeBufferBuilder(int targetChannel) Marks the current BufferBuilder as finished and releases the resources for the target channel.
void	emit(T record) This is used to send regular records.
void	emptyCurrentBufferBuilder(int targetChannel) Marks the current BufferBuilder as empty for the target channel.
BufferBuilder	getBufferBuilder(int targetChannel) The BufferBuilder may already exist if not filled up last time, otherwise we need request a new one for this target channel.
void	randomEmit(T record) This is used to send LatencyMarks to a random target channel.
BufferBuilder	requestNewBufferBuilder(int targetChannel) Requests a new BufferBuilder for the target channel and returns it.
void	tryFinishCurrentBufferBuilder(int targetChannel) Marks the current BufferBuilder as finished if present and clears the state for next one.

Methods inherited from class org.apache.flink.runtime.io.network.api.writer.RecordWriter

broadcastEvent, checkErroneous, close, copyFromSerializerToTargetChannel, emit, finishBufferBuilder, flushAll, flushTargetPartition, getAvailableFuture, setMetricGroup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

isApproximatelyAvailable, isAvailable

Method Detail

emit

public void emit(T record)
          throws IOException,
                 InterruptedException

Description copied from class: RecordWriter

This is used to send regular records.

Specified by:

emit in class RecordWriter<T extends org.apache.flink.core.io.IOReadableWritable>

Throws:

IOException

InterruptedException

randomEmit

public void randomEmit(T record)
                throws IOException,
                       InterruptedException

Description copied from class: RecordWriter

This is used to send LatencyMarks to a random target channel.

Specified by:

randomEmit in class RecordWriter<T extends org.apache.flink.core.io.IOReadableWritable>

Throws:

IOException

InterruptedException

broadcastEmit

public void broadcastEmit(T record)
                   throws IOException,
                          InterruptedException

The record is serialized into intermediate serialization buffer which is then copied into the target buffer for every channel.

Specified by:

broadcastEmit in class RecordWriter<T extends org.apache.flink.core.io.IOReadableWritable>

Throws:

IOException

InterruptedException

getBufferBuilder

public BufferBuilder getBufferBuilder(int targetChannel)
                               throws IOException,
                                      InterruptedException

Description copied from class: RecordWriter

The BufferBuilder may already exist if not filled up last time, otherwise we need request a new one for this target channel.

Throws:

IOException

InterruptedException

requestNewBufferBuilder

public BufferBuilder requestNewBufferBuilder(int targetChannel)
                                      throws IOException,
                                             InterruptedException

Description copied from class: RecordWriter

Requests a new BufferBuilder for the target channel and returns it.

Throws:

IOException

InterruptedException

tryFinishCurrentBufferBuilder

public void tryFinishCurrentBufferBuilder(int targetChannel)

Description copied from class: RecordWriter

Marks the current BufferBuilder as finished if present and clears the state for next one.

emptyCurrentBufferBuilder

public void emptyCurrentBufferBuilder(int targetChannel)

Description copied from class: RecordWriter

Marks the current BufferBuilder as empty for the target channel.

closeBufferBuilder

public void closeBufferBuilder(int targetChannel)

Description copied from class: RecordWriter

Marks the current BufferBuilder as finished and releases the resources for the target channel.

clearBuffers

public void clearBuffers()

Description copied from class: RecordWriter

Closes the BufferBuilders for all the channels.

Specified by:

clearBuffers in class RecordWriter<T extends org.apache.flink.core.io.IOReadableWritable>