akka.stream.impl

Class SourceQueueAdapter<T>

java.lang.Object

akka.stream.impl.SourceQueueAdapter<T>

All Implemented Interfaces:

SourceQueue<T>, SourceQueueWithComplete<T>

public final class SourceQueueAdapter<T>
extends java.lang.Object
implements SourceQueueWithComplete<T>

Constructor Summary

Constructors

Constructor and Description
SourceQueueAdapter(SourceQueueWithComplete<T> delegate)

Method Summary

Modifier and Type	Method and Description
void	complete() Complete the stream normally.
void	fail(java.lang.Throwable ex) Complete the stream with a failure.
java.util.concurrent.CompletionStage<QueueOfferResult>	offer(T elem) Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed or you cannot call offer in this moment because of implementation rules (like for backpressure mode and full buffer you need to wait for last offer call Future completion)
java.util.concurrent.CompletionStage<Done>	watchCompletion() Method returns future that completes when stream is completed and fails when stream failed

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceQueueAdapter

public SourceQueueAdapter(SourceQueueWithComplete<T> delegate)

Method Detail

offer

public java.util.concurrent.CompletionStage<QueueOfferResult> offer(T elem)

Description copied from interface: SourceQueue

Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed or you cannot call offer in this moment because of implementation rules (like for backpressure mode and full buffer you need to wait for last offer call Future completion)

Specified by:

offer in interface SourceQueue<T>

Parameters:

elem - element to send to a stream

Returns:

(undocumented)

watchCompletion

public java.util.concurrent.CompletionStage<Done> watchCompletion()

Description copied from interface: SourceQueue

Method returns future that completes when stream is completed and fails when stream failed

Specified by:

watchCompletion in interface SourceQueue<T>

Returns:

(undocumented)

complete

public void complete()

Description copied from interface: SourceQueueWithComplete

Complete the stream normally. Use watchCompletion to be notified of this operation&rsquo;s success.

Specified by:

complete in interface SourceQueueWithComplete<T>

fail

public void fail(java.lang.Throwable ex)

Description copied from interface: SourceQueueWithComplete

Complete the stream with a failure. Use watchCompletion to be notified of this operation&rsquo;s success.

Specified by:

fail in interface SourceQueueWithComplete<T>

Parameters:

ex - (undocumented)