Package com.linecorp.armeria.common

Interface HttpMessage

All Superinterfaces:

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

All Known Subinterfaces:

HttpRequest, HttpRequestWriter, HttpResponse, HttpResponseWriter

All Known Implementing Classes:

FilteredHttpRequest, FilteredHttpResponse

public interface HttpMessage
extends StreamMessage<HttpObject>

A streamed HTTP/2 message.

Method Summary

Modifier and Type	Method	Description
default <T> StreamMessage<T>	decode(HttpDecoder<T> decoder)	Creates a decoded StreamMessage which is decoded from a stream of HttpObjects using the specified HttpDecoder.
default <T> StreamMessage<T>	decode(HttpDecoder<T> decoder, ByteBufAllocator alloc)	Creates a decoded StreamMessage which is decoded from a stream of HttpObjects using the specified HttpDecoder and ByteBufAllocator.
HttpMessage	mapData(Function<? super HttpData,? extends HttpData> function)	Transforms the HttpDatas emitted by this HttpMessage by applying the specified Function.
HttpMessage	mapTrailers(Function<? super HttpHeaders,? extends HttpHeaders> function)	Transforms the trailers emitted by this HttpMessage by applying the specified Function.
HttpMessage	peekData(Consumer<? super HttpData> action)	Applies the specified Consumer to the HttpDatas emitted by this HttpMessage.
HttpMessage	peekTrailers(Consumer<? super HttpHeaders> action)	Applies the specified Consumer to the trailers emitted by this HttpMessage.
StreamMessageDuplicator<HttpObject>	toDuplicator(long maxContentLength)	Returns a new StreamMessageDuplicator that duplicates this HttpMessage into one or more HttpMessages, which publish the same elements.
StreamMessageDuplicator<HttpObject>	toDuplicator(EventExecutor executor, long maxContentLength)	Returns a new StreamMessageDuplicator that duplicates this HttpMessage into one or more HttpMessages, which publish the same elements.

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

abort, abort, collect, collect, collect, decode, decode, defaultSubscriberExecutor, demand, filter, isComplete, isEmpty, isOpen, map, mapAsync, mapError, mapParallel, mapParallel, peek, peek, peekError, recoverAndResume, recoverAndResume, subscribe, subscribe, subscribe, subscribe, subscribe, toDuplicator, toDuplicator, toInputStream, toInputStream, whenComplete, writeTo

Method Details

toDuplicator

StreamMessageDuplicator<HttpObject> toDuplicator(long maxContentLength)

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

Parameters:

maxContentLength - the maximum content length that the duplicator can hold in its buffer. ContentTooLargeException is raised if the length of the buffered HttpData is greater than this value.

toDuplicator

StreamMessageDuplicator<HttpObject> toDuplicator(EventExecutor executor,
 long maxContentLength)

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

Parameters:

executor - the executor to duplicate

maxContentLength - the maximum content length that the duplicator can hold in its buffer. ContentTooLargeException is raised if the length of the buffered HttpData is greater than this value.

decode

default <T> StreamMessage<T> decode(HttpDecoder<T> decoder)

Creates a decoded StreamMessage which is decoded from a stream of HttpObjects using the specified HttpDecoder.

decode

default <T> StreamMessage<T> decode(HttpDecoder<T> decoder,
 ByteBufAllocator alloc)

Creates a decoded StreamMessage which is decoded from a stream of HttpObjects using the specified HttpDecoder and ByteBufAllocator.

mapData

HttpMessage mapData(Function<? super HttpData,? extends HttpData> function)

Transforms the HttpDatas emitted by this HttpMessage by applying the specified Function.

mapTrailers

HttpMessage mapTrailers(Function<? super HttpHeaders,? extends HttpHeaders> function)

Transforms the trailers emitted by this HttpMessage by applying the specified Function.

peekData

HttpMessage peekData(Consumer<? super HttpData> action)

Applies the specified Consumer to the HttpDatas emitted by this HttpMessage.

peekTrailers

HttpMessage peekTrailers(Consumer<? super HttpHeaders> action)

Applies the specified Consumer to the trailers emitted by this HttpMessage.