com.linecorp.armeria.common

Class DefaultHttpResponse

java.lang.Object

com.linecorp.armeria.common.stream.DefaultStreamMessage<HttpObject>

com.linecorp.armeria.common.DefaultHttpResponse

All Implemented Interfaces:

HttpResponse, HttpResponseWriter, Response, StreamMessage<HttpObject>, StreamWriter<HttpObject>, org.reactivestreams.Publisher<HttpObject>

Deprecated.

Use HttpResponse.streaming().

@Deprecated
public class DefaultHttpResponse
extends DefaultStreamMessage<HttpObject>
implements HttpResponseWriter

Default HttpResponse instance.

Constructor Summary

Constructors

Constructor and Description
DefaultHttpResponse() Deprecated.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	completionFuture() Returns a CompletableFuture that completes when this stream is complete, either successfully or exceptionally, including cancellation and abortion.
protected io.netty.util.concurrent.EventExecutor	defaultSubscriberExecutor() Returns the default EventExecutor which will be used when a user subscribes using subscribe(Subscriber) or subscribe(Subscriber, SubscriptionOption...).
CompletableFuture<List<T>>	drainAll() Subscribes to this StreamMessage and retrieves all elements from it.
CompletableFuture<List<T>>	drainAll(boolean withPooledObjects) Subscribes to this StreamMessage and retrieves all elements from it.
CompletableFuture<List<T>>	drainAll(io.netty.util.concurrent.EventExecutor executor) Subscribes to this StreamMessage and retrieves all elements from it.
CompletableFuture<List<T>>	drainAll(io.netty.util.concurrent.EventExecutor executor, boolean withPooledObjects) Subscribes to this StreamMessage and retrieves all elements from it.
CompletableFuture<List<T>>	drainAll(io.netty.util.concurrent.EventExecutor executor, SubscriptionOption... options) Subscribes to this StreamMessage and retrieves all elements from it.
CompletableFuture<List<T>>	drainAll(SubscriptionOption... options) Subscribes to this StreamMessage and retrieves all elements from it.
CompletableFuture<Void>	onDemand(Runnable task) Performs the specified task when there are enough demands from the Subscriber.
protected void	onRemoval(T obj) Invoked after an element is removed from the StreamMessage and before Subscriber.onNext(Object) is invoked.
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, boolean withPooledObjects) Requests to start streaming data to the specified Subscriber.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber, io.netty.util.concurrent.EventExecutor executor) Requests to start streaming data to the specified Subscriber.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber, io.netty.util.concurrent.EventExecutor executor, boolean withPooledObjects) Requests to start streaming data, invoking the specified Subscriber from the specified Executor.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber, io.netty.util.concurrent.EventExecutor executor, SubscriptionOption... options) Requests to start streaming data to the specified Subscriber.
void	subscribe(org.reactivestreams.Subscriber<? super T> subscriber, SubscriptionOption... options) Requests to start streaming data to the specified Subscriber.
String	toString() Deprecated.
boolean	tryWrite(T obj) Writes the specified object to the StreamMessage.

Methods inherited from class com.linecorp.armeria.common.stream.DefaultStreamMessage

abort, abort, close, close, isEmpty, isOpen, tryClose

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.HttpResponseWriter

close, respond, respond, respond, respond, respond, respond, respond

Methods inherited from interface com.linecorp.armeria.common.HttpResponse

aggregate, aggregate, aggregateWithPooledObjects, aggregateWithPooledObjects, closeFuture, completionFuture, delayed, delayed, delayed, delayed, from, from, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, ofFailed, ofFailure, streaming

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

abort, abort, drainAll, drainAll, drainAll, drainAll, drainAll, drainAll, isComplete, isEmpty, isOpen, of, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe

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

close, close, close, isOpen, onDemand, tryWrite, tryWrite, write, write

Constructor Detail

DefaultHttpResponse

public DefaultHttpResponse()

Deprecated.

Method Detail

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

tryWrite

public boolean tryWrite(T obj)

Description copied from interface: StreamWriter

Writes the specified object to the StreamMessage. The written object will be transferred to the Subscriber.

Returns:

true if the specified object has been scheduled for publication. false if the stream has been closed already.

See Also:

Life cycle of reference-counted objects

onDemand

public CompletableFuture<Void> onDemand(Runnable task)

Description copied from interface: StreamWriter

Performs the specified task when there are enough demands from the Subscriber.

Returns:

the future that completes successfully when the task finishes or exceptionally when the StreamMessage is closed unexpectedly.

subscribe

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

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>

Specified by:

subscribe in interface org.reactivestreams.Publisher<T>

subscribe

public final void subscribe(org.reactivestreams.Subscriber<? super T> subscriber,
                            boolean withPooledObjects)

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>

subscribe

public final void subscribe(org.reactivestreams.Subscriber<? super T> subscriber,
                            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>

options - SubscriptionOptions to subscribe with

subscribe

public final void subscribe(org.reactivestreams.Subscriber<? super T> subscriber,
                            io.netty.util.concurrent.EventExecutor executor,
                            boolean withPooledObjects)

Description copied from interface: StreamMessage

Requests to start streaming data, invoking the specified Subscriber from the specified Executor. 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

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:

• 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

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:

• 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

protected io.netty.util.concurrent.EventExecutor defaultSubscriberExecutor()

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

drainAll

public final CompletableFuture<List<T>> drainAll()

Description copied from interface: StreamMessage

Subscribes to this StreamMessage and retrieves all elements from it. The returned CompletableFuture may be completed exceptionally with the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

drainAll in interface StreamMessage<T>

Returns:

the CompletableFuture which will be completed with the list of the elements retrieved.

drainAll

public final CompletableFuture<List<T>> drainAll(boolean withPooledObjects)

Description copied from interface: StreamMessage

Subscribes to this StreamMessage and retrieves all elements from it. The returned CompletableFuture may be completed exceptionally with the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

drainAll in interface StreamMessage<T>

Returns:

the CompletableFuture which will be completed with the list of the elements retrieved.

drainAll

public final CompletableFuture<List<T>> drainAll(SubscriptionOption... options)

Description copied from interface: StreamMessage

Subscribes to this StreamMessage and retrieves all elements from it. The returned CompletableFuture may be completed exceptionally with the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

drainAll in interface StreamMessage<T>

Parameters:

options - SubscriptionOptions to subscribe with. Note that SubscriptionOption.NOTIFY_CANCELLATION is ineffective because there's no cancelling while draining all elements.

Returns:

the CompletableFuture which will be completed with the list of the elements retrieved.

drainAll

public final CompletableFuture<List<T>> drainAll(io.netty.util.concurrent.EventExecutor executor,
                                                 boolean withPooledObjects)

Description copied from interface: StreamMessage

Subscribes to this StreamMessage and retrieves all elements from it. The returned CompletableFuture may be completed exceptionally with the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

drainAll in interface StreamMessage<T>

Parameters:

executor - the executor to retrieve all elements

Returns:

the CompletableFuture which will be completed with the list of the elements retrieved.

drainAll

public final CompletableFuture<List<T>> drainAll(io.netty.util.concurrent.EventExecutor executor)

Description copied from interface: StreamMessage

Subscribes to this StreamMessage and retrieves all elements from it. The returned CompletableFuture may be completed exceptionally with the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

drainAll in interface StreamMessage<T>

Parameters:

executor - the executor to retrieve all elements

Returns:

the CompletableFuture which will be completed with the list of the elements retrieved.

drainAll

public final CompletableFuture<List<T>> drainAll(io.netty.util.concurrent.EventExecutor executor,
                                                 SubscriptionOption... options)

Description copied from interface: StreamMessage

Subscribes to this StreamMessage and retrieves all elements from it. The returned CompletableFuture may be completed exceptionally with the following exceptions:

• IllegalStateException if other Subscriber subscribed to this stream already.
• AbortedStreamException if this stream has been aborted.
• Other exceptions that occurred due to an error while retrieving the elements.

Specified by:

drainAll in interface StreamMessage<T>

Parameters:

executor - the executor to retrieve all elements

options - SubscriptionOptions to subscribe with. Note that SubscriptionOption.NOTIFY_CANCELLATION is ineffective because there's no cancelling while draining all elements.

Returns:

the CompletableFuture which will be completed with the list of the elements retrieved.

completionFuture

public final CompletableFuture<Void> completionFuture()

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:

completionFuture in interface StreamMessage<T>

onRemoval

protected void onRemoval(T obj)

Invoked after an element is removed from the StreamMessage and before Subscriber.onNext(Object) is invoked.

Parameters:

obj - the removed element