Package org.apache.sysds.runtime.ooc.stream

Class SubOOCStream<T>

java.lang.Object

org.apache.sysds.runtime.ooc.stream.SubOOCStream<T>

All Implemented Interfaces:

OOCStream<T>, OOCStreamable<T>

public class SubOOCStream<T>
extends Object
implements OOCStream<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sysds.runtime.instructions.ooc.OOCStream

OOCStream.GroupQueueCallback<T>, OOCStream.QueueCallback<T>, OOCStream.SimpleQueueCallback<T>

Constructor Summary

Constructors

Constructor	Description
SubOOCStream(OOCStream<T> sourceStream)

Method Summary

Modifier and Type	Method	Description
void	addDownstreamMessageRelay(Consumer<OOCStreamMessage> relay)
void	addUpstreamMessageRelay(Consumer<OOCStreamMessage> relay)
void	clearDownstreamMessageRelays()
void	clearUpstreamMessageRelays()
void	closeInput()
T	dequeue()
OOCStream.QueueCallback<T>	dequeueCB()
void	enqueue(OOCStream.QueueCallback<T> callback)
void	enqueue(T t)
CacheableData<?>	getData()
DataCharacteristics	getDataCharacteristics()
OOCStream<T>	getReadStream()
CachingStream	getStreamCache()
OOCStream<T>	getWriteStream()
boolean	hasStreamCache()
boolean	isProcessed()
void	messageDownstream(OOCStreamMessage msg)
void	messageUpstream(OOCStreamMessage msg)
void	propagateFailure(DMLRuntimeException re)
void	setData(CacheableData<?> data)
void	setDownstreamMessageRelay(Consumer<OOCStreamMessage> relay)
void	setIXTransform(BiFunction<Boolean,IndexRange,IndexRange> transform)
void	setSubscriber(Consumer<OOCStream.QueueCallback<T>> subscriber)	Registers a new subscriber that consumes the stream.
void	setUpstreamMessageRelay(Consumer<OOCStreamMessage> relay)

Methods inherited from class java.lang.Object

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

Constructor Details

SubOOCStream

public SubOOCStream(OOCStream<T> sourceStream)

Method Details

enqueue

public void enqueue(OOCStream.QueueCallback<T> callback)

Specified by:

enqueue in interface OOCStream<T>

enqueue

public void enqueue(T t)

Specified by:

enqueue in interface OOCStream<T>

dequeue

public T dequeue()

Specified by:

dequeue in interface OOCStream<T>

dequeueCB

public OOCStream.QueueCallback<T> dequeueCB()

Specified by:

dequeueCB in interface OOCStream<T>

closeInput

public void closeInput()

Specified by:

closeInput in interface OOCStream<T>

propagateFailure

public void propagateFailure(DMLRuntimeException re)

Specified by:

propagateFailure in interface OOCStream<T>

hasStreamCache

public boolean hasStreamCache()

Specified by:

hasStreamCache in interface OOCStreamable<T>

getStreamCache

public CachingStream getStreamCache()

Specified by:

getStreamCache in interface OOCStreamable<T>

setSubscriber

public void setSubscriber(Consumer<OOCStream.QueueCallback<T>> subscriber)

Description copied from interface: OOCStream

Registers a new subscriber that consumes the stream. While there is no guarantee for any specific order, the closing item LocalTaskQueue.NO_MORE_TASKS is guaranteed to be invoked after every other item has finished processing. Thus, the NO_MORE_TASKS callback can be used to free dependent resources and close output streams.

Specified by:

setSubscriber in interface OOCStream<T>

getReadStream

public OOCStream<T> getReadStream()

Specified by:

getReadStream in interface OOCStreamable<T>

getWriteStream

public OOCStream<T> getWriteStream()

Specified by:

getWriteStream in interface OOCStreamable<T>

isProcessed

public boolean isProcessed()

Specified by:

isProcessed in interface OOCStreamable<T>

getDataCharacteristics

public DataCharacteristics getDataCharacteristics()

Specified by:

getDataCharacteristics in interface OOCStreamable<T>

getData

public CacheableData<?> getData()

Specified by:

getData in interface OOCStreamable<T>

setData

public void setData(CacheableData<?> data)

Specified by:

setData in interface OOCStreamable<T>

messageUpstream

public void messageUpstream(OOCStreamMessage msg)

Specified by:

messageUpstream in interface OOCStreamable<T>

messageDownstream

public void messageDownstream(OOCStreamMessage msg)

Specified by:

messageDownstream in interface OOCStreamable<T>

setUpstreamMessageRelay

public void setUpstreamMessageRelay(Consumer<OOCStreamMessage> relay)

Specified by:

setUpstreamMessageRelay in interface OOCStreamable<T>

setDownstreamMessageRelay

public void setDownstreamMessageRelay(Consumer<OOCStreamMessage> relay)

Specified by:

setDownstreamMessageRelay in interface OOCStreamable<T>

addUpstreamMessageRelay

public void addUpstreamMessageRelay(Consumer<OOCStreamMessage> relay)

Specified by:

addUpstreamMessageRelay in interface OOCStreamable<T>

addDownstreamMessageRelay

public void addDownstreamMessageRelay(Consumer<OOCStreamMessage> relay)

Specified by:

addDownstreamMessageRelay in interface OOCStreamable<T>

clearUpstreamMessageRelays

public void clearUpstreamMessageRelays()

Specified by:

clearUpstreamMessageRelays in interface OOCStreamable<T>

clearDownstreamMessageRelays

public void clearDownstreamMessageRelays()

Specified by:

clearDownstreamMessageRelays in interface OOCStreamable<T>

setIXTransform

public void setIXTransform(BiFunction<Boolean,IndexRange,IndexRange> transform)

Specified by:

setIXTransform in interface OOCStreamable<T>