Package com.linecorp.armeria.common.stream

Class StreamMessageWrapper<T>

java.lang.Object

com.linecorp.armeria.common.stream.StreamMessageWrapper<T>

Type Parameters:

T - the type of elements

All Implemented Interfaces:

StreamMessage<T>, org.reactivestreams.Publisher<T>

public class StreamMessageWrapper<T>
extends Object
implements StreamMessage<T>

Wraps a StreamMessage and forwards its method invocations to delegate.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamMessageWrapper(StreamMessage<? extends T> delegate)	Creates a new instance that wraps a delegate.

Method Summary

Modifier and Type	Method	Description
void	abort()	Closes this stream with AbortedStreamException and prevents further subscription.
void	abort(Throwable cause)	Closes this stream with the specified Throwable and prevents further subscription.
CompletableFuture<List<T>>	collect(EventExecutor executor, SubscriptionOption... options)	Collects the elements published by this StreamMessage with the specified EventExecutor and SubscriptionOptions.
EventExecutor	defaultSubscriberExecutor()	Returns the default EventExecutor which will be used when a user subscribes using StreamMessage.subscribe(Subscriber), StreamMessage.subscribe(Subscriber, SubscriptionOption...).
protected final StreamMessage<? extends T>	delegate()	Returns the StreamMessage being decorated.
long	demand()	Returns the current demand of this stream.
boolean	isEmpty()	Returns true if this stream has been closed and did not publish any elements.
boolean	isOpen()	Returns true if this stream is not closed yet.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber, EventExecutor executor, SubscriptionOption... options)	Requests to start streaming data to the specified Subscriber.
StreamMessageDuplicator<T>	toDuplicator()	Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements.
StreamMessageDuplicator<T>	toDuplicator(EventExecutor executor)	Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements.
String	toString()
CompletableFuture<Void>	whenComplete()	Returns a CompletableFuture that completes when this stream is complete, either successfully or exceptionally, including cancellation and abortion.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.stream.StreamMessage

collect, collect, decode, decode, filter, isComplete, map, mapAsync, mapError, mapParallel, mapParallel, peek, peek, peekError, recoverAndResume, subscribe, subscribe, subscribe, subscribe, toInputStream, toInputStream, writeTo

Constructor Details

StreamMessageWrapper

protected StreamMessageWrapper(StreamMessage<? extends T> delegate)

Creates a new instance that wraps a delegate.

Method Details

delegate

protected final StreamMessage<? extends T> delegate()

Returns the StreamMessage being decorated.

isOpen

public boolean isOpen()

Description copied from interface: StreamMessage

Returns true if this stream is not closed yet. Note that a stream may not be complete even if it's closed; a stream is complete when it's fully consumed by a Subscriber.

Specified by:

isOpen in interface StreamMessage<T>

isEmpty

public boolean isEmpty()

Description copied from interface: StreamMessage

Returns true if this stream has been closed and did not publish any elements. Note that this method will not return true when the stream is open even if it has not published anything so far, because it may publish something later.

Specified by:

isEmpty in interface StreamMessage<T>

demand

public long demand()

Description copied from interface: StreamMessage

Returns the current demand of this stream.

Specified by:

demand in interface StreamMessage<T>

whenComplete

public CompletableFuture<Void> whenComplete()

Description copied from interface: StreamMessage

Returns a CompletableFuture that completes when this stream is complete, either successfully or exceptionally, including cancellation and abortion.

A StreamMessage is complete (or 'fully consumed') when:

• the Subscriber consumes all elements and Subscriber.onComplete() is invoked,
• an error occurred and Subscriber.onError(Throwable) is invoked,
• the Subscription has been cancelled or
• StreamMessage.abort() has been requested.

Specified by:

whenComplete in interface StreamMessage<T>

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super T> subscriber,
 EventExecutor executor,
 SubscriptionOption... options)

Description copied from interface: StreamMessage

Requests to start streaming data to the specified Subscriber. If there is a problem subscribing, Subscriber.onError(Throwable) will be invoked with one of the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• CancelledSubscriptionException if this stream has been cancelled and SubscriptionOption.NOTIFY_CANCELLATION is specified when subscribed.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

subscribe in interface StreamMessage<T>

executor - the executor to subscribe

options - SubscriptionOptions to subscribe with

defaultSubscriberExecutor

public EventExecutor defaultSubscriberExecutor()

Description copied from interface: StreamMessage

Returns the default EventExecutor which will be used when a user subscribes using StreamMessage.subscribe(Subscriber), StreamMessage.subscribe(Subscriber, SubscriptionOption...).

Please note that if this method is called multiple times, the returned EventExecutors can be different depending on this StreamMessage implementation.

Specified by:

defaultSubscriberExecutor in interface StreamMessage<T>

abort

public void abort()

Description copied from interface: StreamMessage

Closes this stream with AbortedStreamException and prevents further subscription. A Subscriber that attempts to subscribe to an aborted stream will be notified with an AbortedStreamException via Subscriber.onError(Throwable). Calling this method on a closed or aborted stream has no effect.

Specified by:

abort in interface StreamMessage<T>

abort

public void abort(Throwable cause)

Description copied from interface: StreamMessage

Closes this stream with the specified Throwable and prevents further subscription. A Subscriber that attempts to subscribe to an aborted stream will be notified with the specified Throwable via Subscriber.onError(Throwable). Calling this method on a closed or aborted stream has no effect.

Specified by:

abort in interface StreamMessage<T>

collect

public CompletableFuture<List<T>> collect(EventExecutor executor,
 SubscriptionOption... options)

Description copied from interface: StreamMessage

Collects the elements published by this StreamMessage with the specified EventExecutor and SubscriptionOptions. The returned CompletableFuture will be notified when the elements are fully consumed.

Note that if this StreamMessage was subscribed by other Subscriber already, the returned CompletableFuture will be completed with an IllegalStateException.

Specified by:

collect in interface StreamMessage<T>

toDuplicator

public StreamMessageDuplicator<T> toDuplicator()

Description copied from interface: StreamMessage

Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements. Note that you cannot subscribe to this StreamMessage anymore after you call this method. To subscribe, call StreamMessageDuplicator.duplicate() from the returned StreamMessageDuplicator.

Specified by:

toDuplicator in interface StreamMessage<T>

toDuplicator

public StreamMessageDuplicator<T> toDuplicator(EventExecutor executor)

Description copied from interface: StreamMessage

Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements. Note that you cannot subscribe to this StreamMessage anymore after you call this method. To subscribe, call StreamMessageDuplicator.duplicate() from the returned StreamMessageDuplicator.

Specified by:

toDuplicator in interface StreamMessage<T>

Parameters:

executor - the executor to duplicate

toString

public String toString()

Overrides:

toString in class Object