Package com.linecorp.armeria.common.stream

Class PublisherBasedStreamMessage<T>

java.lang.Object
com.linecorp.armeria.common.stream.AggregationSupport
com.linecorp.armeria.common.stream.PublisherBasedStreamMessage<T>
Type Parameters:
T - the type of element signaled
All Implemented Interfaces:
StreamMessage<T>, org.reactivestreams.Publisher<T>
@UnstableApi public class PublisherBasedStreamMessage<T> extends AggregationSupport implements StreamMessage<T>
Adapts a Publisher into a StreamMessage.

Note that the elements in the Publisher are not released when Subscription.cancel() or abort() is called. So you should add a hook in order to release the elements. You can use doOnDiscard if you are using Reactor, or you can use doOnDispose if you are using RxJava.

  • Constructor Details

    • PublisherBasedStreamMessage

      public PublisherBasedStreamMessage(org.reactivestreams.Publisher<? extends T> publisher)
      Creates a new instance with the specified delegate Publisher.

  • Method Details

    • delegate

      protected final org.reactivestreams.Publisher<? extends T> delegate()
      Returns the delegate Publisher.

    • isOpen

      public final 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 final 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 final long demand()
      Description copied from interface: StreamMessage
      Returns the current demand of this stream.
      Specified by:
      demand in interface StreamMessage<T>

    • subscribe

      public final void subscribe(org.reactivestreams.Subscriber<? super T> subscriber, io.netty.util.concurrent.EventExecutor executor)
      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:
      Specified by:
      subscribe in interface StreamMessage<T>
      Parameters:
      executor - the executor to subscribe

    • subscribe

      public final void subscribe(org.reactivestreams.Subscriber<? super T> subscriber, io.netty.util.concurrent.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:
      Specified by:
      subscribe in interface StreamMessage<T>
      Parameters:
      executor - the executor to subscribe
      options - SubscriptionOptions to subscribe with

    • abort

      public final 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 final 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(io.netty.util.concurrent.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>

    • whenComplete

      public final 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>