com.linecorp.armeria.common.stream

Class PublisherBasedStreamMessage<T>

java.lang.Object

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

Type Parameters:

T - the type of element signaled

All Implemented Interfaces:

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

public class PublisherBasedStreamMessage<T>
extends java.lang.Object
implements StreamMessage<T>

Adapts a Publisher into a StreamMessage.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	abort() Cancels the Subscription if any and closes this publisher.
java.util.concurrent.CompletableFuture<java.lang.Void>	closeFuture() Returns a CompletableFuture that completes when this publisher is complete, either successfully or exceptionally.
protected org.reactivestreams.Publisher<? extends T>	delegate() Returns the delegate Publisher.
boolean	isEmpty() Returns true if this stream has been closed and did not publish any elements.
boolean	isOpen() Returns true if this publisher is not closed yet.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber) Requests to start streaming data to the specified Subscriber.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber, java.util.concurrent.Executor executor) Requests to start streaming data, invoking the specified Subscriber from the specified Executor.

Methods inherited from class java.lang.Object

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

Constructor Detail

PublisherBasedStreamMessage

public PublisherBasedStreamMessage(org.reactivestreams.Publisher<? extends T> publisher)

Creates a new instance with the specified delegate Publisher.

Method Detail

delegate

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

Returns the delegate Publisher.

isOpen

public boolean isOpen()

Description copied from interface: StreamMessage

Returns true if this publisher is not closed yet.

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>

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super T> subscriber)

Description copied from interface: StreamMessage

Requests to start streaming data to the specified Subscriber.

Specified by:

subscribe in interface StreamMessage<T>

Specified by:

subscribe in interface org.reactivestreams.Publisher<T>

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super T> subscriber,
                      java.util.concurrent.Executor executor)

Description copied from interface: StreamMessage

Requests to start streaming data, invoking the specified Subscriber from the specified Executor.

Specified by:

subscribe in interface StreamMessage<T>

abort

public void abort()

Description copied from interface: StreamMessage

Cancels the Subscription if any and closes this publisher.

Specified by:

abort in interface StreamMessage<T>

closeFuture

public java.util.concurrent.CompletableFuture<java.lang.Void> closeFuture()

Description copied from interface: StreamMessage

Returns a CompletableFuture that completes when this publisher is complete, either successfully or exceptionally.

Specified by:

closeFuture in interface StreamMessage<T>