edu.snu.coral.runtime.executor.data.blocktransfer

Class BlockOutputStream<T>

java.lang.Object

edu.snu.coral.runtime.executor.data.blocktransfer.BlockOutputStream<T>

Type Parameters:

T - the type of element

All Implemented Interfaces:

BlockStream, AutoCloseable

public final class BlockOutputStream<T>
extends Object
implements AutoCloseable, BlockStream

Output stream for block transfer. close() must be called after finishing write.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream.
void	closeExceptionally(Throwable cause) Closes this stream, exceptionally.
String	getBlockId() Gets the block id.
Optional<DataStoreProperty.Value>	getBlockStore() Gets the block store type.
KeyRange	getKeyRange() Gets the key range.
String	getRemoteExecutorId() Gets the id of the remote executor.
String	getRuntimeEdgeId() Gets the runtime edge id.
boolean	isEncodePartialBlockEnabled() Gets whether the sender should start encoding even though the whole block has not been written yet.
String	toString()
BlockOutputStream	writeElements(Iterator<T> iterator) Writes a Iterable of elements.
BlockOutputStream	writeFileAreas(Iterable<FileArea> fileAreas) Writes a Iterable of FileAreas.
BlockOutputStream	writeSerializedPartitions(Iterable<SerializedPartition> serializedPartitions) Writes a collection of SerializedPartitions.

Methods inherited from class java.lang.Object

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getRemoteExecutorId

public String getRemoteExecutorId()

Description copied from interface: BlockStream

Gets the id of the remote executor.

Specified by:

getRemoteExecutorId in interface BlockStream

Returns:

the remote executor id

isEncodePartialBlockEnabled

public boolean isEncodePartialBlockEnabled()

Description copied from interface: BlockStream

Gets whether the sender should start encoding even though the whole block has not been written yet.

Specified by:

isEncodePartialBlockEnabled in interface BlockStream

Returns:

whether the sender should start encoding even though the whole block has not been written yet

getBlockStore

public Optional<DataStoreProperty.Value> getBlockStore()

Description copied from interface: BlockStream

Gets the block store type.

Specified by:

getBlockStore in interface BlockStream

Returns:

an Optional with block store type if this stream belongs to a pull-based transfer, an empty Optional otherwise.

getBlockId

public String getBlockId()

Description copied from interface: BlockStream

Gets the block id.

Specified by:

getBlockId in interface BlockStream

Returns:

the block id

getRuntimeEdgeId

public String getRuntimeEdgeId()

Description copied from interface: BlockStream

Gets the runtime edge id.

Specified by:

getRuntimeEdgeId in interface BlockStream

Returns:

the runtime edge id

getKeyRange

public KeyRange getKeyRange()

Description copied from interface: BlockStream

Gets the key range.

Specified by:

getKeyRange in interface BlockStream

Returns:

the KeyRange

writeElements

public BlockOutputStream writeElements(Iterator<T> iterator)
                                throws IOException

Writes a Iterable of elements.

Parameters:

iterator - the Iterator to write

Returns:

BlockOutputStream (i.e. this)

Throws:

IOException - if an exception was set

IllegalStateException - if this stream is closed already

writeFileAreas

public BlockOutputStream writeFileAreas(Iterable<FileArea> fileAreas)
                                 throws IOException

Writes a Iterable of FileAreas. Zero-copy transfer is used if possible.

Parameters:

fileAreas - the list of the file areas

Returns:

BlockOutputStream (i.e. this)

Throws:

IOException - if an exception was set

IllegalStateException - if this stream is closed already

writeSerializedPartitions

public BlockOutputStream writeSerializedPartitions(Iterable<SerializedPartition> serializedPartitions)
                                            throws IOException

Writes a collection of SerializedPartitions.

Parameters:

serializedPartitions - the collection of SerializedPartition

Returns:

BlockOutputStream (i.e. this)

Throws:

IOException - if an exception was set

IllegalStateException - if this stream is closed already

close

public void close()
           throws IOException

Closes this stream.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an exception was set

IllegalStateException - if this stream is closed already

closeExceptionally

public void closeExceptionally(Throwable cause)

Closes this stream, exceptionally.

Parameters:

cause - the cause of the exceptional control flow