com.linecorp.armeria.common

Class HttpRequestDuplicator

java.lang.Object

com.linecorp.armeria.common.stream.AbstractStreamMessageDuplicator<HttpObject,HttpRequest>

com.linecorp.armeria.common.HttpRequestDuplicator

All Implemented Interfaces:

SafeCloseable, AutoCloseable

public class HttpRequestDuplicator
extends AbstractStreamMessageDuplicator<HttpObject,HttpRequest>

Allows subscribing to an HttpRequest multiple times by duplicating the stream.

 final HttpRequest originalReq = ...
 final HttpRequestDuplicator reqDuplicator = new HttpRequestDuplicator(originalReq);

 final HttpRequest dupReq1 = reqDuplicator.duplicateStream();
 final HttpRequest dupReq2 = reqDuplicator.duplicateStream(true); // the last stream

 dupReq1.subscribe(new FooSubscriber() {
     ...
     // Do something according to the first few elements of the request.
 });

 final CompletableFuture<AggregatedHttpRequest> future2 = dupReq2.aggregate();
 future2.handle((message, cause) -> {
     // Do something with message.
 }
 

Constructor Summary

Constructors

Constructor and Description
HttpRequestDuplicator(HttpRequest req) Creates a new instance wrapping an HttpRequest and publishing to multiple subscribers.
HttpRequestDuplicator(HttpRequest req, long maxSignalLength) Creates a new instance wrapping an HttpRequest and publishing to multiple subscribers.
HttpRequestDuplicator(HttpRequest req, long maxSignalLength, io.netty.util.concurrent.EventExecutor executor) Creates a new instance wrapping an HttpRequest and publishing to multiple subscribers.

Method Summary

Modifier and Type	Method and Description
HttpRequest	duplicateStream() Creates a new StreamMessage that duplicates the upstream StreamMessage specified when creating this duplicator.
HttpRequest	duplicateStream(boolean lastStream) Creates a new StreamMessage that duplicates the upstream StreamMessage specified when creating this duplicator.
HttpRequest	duplicateStream(RequestHeaders newHeaders) Creates a new HttpRequest instance that publishes data from the publisher you create this factory with.
HttpRequest	duplicateStream(RequestHeaders newHeaders, boolean lastStream) Creates a new HttpRequest instance that publishes data from the publisher you create this factory with.

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

abort, abort, close, duplicatorExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestDuplicator

public HttpRequestDuplicator(HttpRequest req)

Creates a new instance wrapping an HttpRequest and publishing to multiple subscribers. The length of request is limited by default with the server-side parameter which is Flags.defaultMaxResponseLength(). If you are at client-side, you need to use HttpRequestDuplicator(HttpRequest, long) and the long value should be greater than the length of request or 0 which disables the limit.

Parameters:

req - the request that will publish data to subscribers

HttpRequestDuplicator

public HttpRequestDuplicator(HttpRequest req,
                             long maxSignalLength)

Creates a new instance wrapping an HttpRequest and publishing to multiple subscribers.

Parameters:

req - the request that will publish data to subscribers

maxSignalLength - the maximum length of signals. 0 disables the length limit

HttpRequestDuplicator

public HttpRequestDuplicator(HttpRequest req,
                             long maxSignalLength,
                             @Nullable
                             io.netty.util.concurrent.EventExecutor executor)

Creates a new instance wrapping an HttpRequest and publishing to multiple subscribers.

Parameters:

req - the request that will publish data to subscribers

maxSignalLength - the maximum length of signals. 0 disables the length limit

executor - the executor to use for upstream signals.

Method Detail

duplicateStream

public HttpRequest duplicateStream()

Description copied from class: AbstractStreamMessageDuplicator

Creates a new StreamMessage that duplicates the upstream StreamMessage specified when creating this duplicator.

Overrides:

duplicateStream in class AbstractStreamMessageDuplicator<HttpObject,HttpRequest>

duplicateStream

public HttpRequest duplicateStream(boolean lastStream)

Description copied from class: AbstractStreamMessageDuplicator

Creates a new StreamMessage that duplicates the upstream StreamMessage specified when creating this duplicator.

Overrides:

duplicateStream in class AbstractStreamMessageDuplicator<HttpObject,HttpRequest>

Parameters:

lastStream - whether to prevent further duplication

duplicateStream

public HttpRequest duplicateStream(RequestHeaders newHeaders)

Creates a new HttpRequest instance that publishes data from the publisher you create this factory with.

duplicateStream

public HttpRequest duplicateStream(RequestHeaders newHeaders,
                                   boolean lastStream)

Creates a new HttpRequest instance that publishes data from the publisher you create this factory with. If you specify the lastStream as true, it will prevent further creation of duplicate stream.