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

Class BlockInputStream<T>

java.lang.Object

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

Type Parameters:

T - the type of element

All Implemented Interfaces:

BlockStream

public final class BlockInputStream<T>
extends Object
implements BlockStream

Input stream for block transfer.

Method Summary

Modifier and Type	Method and Description
String	getBlockId() Gets the block id.
Optional<DataStoreProperty.Value>	getBlockStore() Gets the block store type.
CompletableFuture<Iterator<T>>	getCompleteFuture() Gets a CompletableFuture that completes with the block transfer being done.
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()

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

getCompleteFuture

public CompletableFuture<Iterator<T>> getCompleteFuture()

Gets a CompletableFuture that completes with the block transfer being done. This future is completed by one of the decoding thread. Consider using separate ExecutorService when chaining a task to this future.

Returns:

a CompletableFuture that completes with the block transfer being done