Package com.linecorp.armeria.common

Interface AggregationOptions

@UnstableApi
public interface AggregationOptions

An AggregationOptions to control the aggregation behavior of HttpMessage.

Method Summary

Modifier and Type	Method	Description
@Nullable ByteBufAllocator	alloc()	(Advanced users only) Returns the ByteBufAllocator that can be used to create a PooledObjects without making a copy.
static AggregationOptionsBuilder	builder()	Returns a new AggregationOptionsBuilder.
boolean	cacheResult()	Returns whether to cache the aggregation result.
@Nullable EventExecutor	executor()	Returns the EventExecutor that executes the aggregation.

Method Details

builder

static AggregationOptionsBuilder builder()

Returns a new AggregationOptionsBuilder.

executor

@Nullable
@Nullable EventExecutor executor()

Returns the EventExecutor that executes the aggregation.

cacheResult

boolean cacheResult()

Returns whether to cache the aggregation result.

alloc

@Nullable
@Nullable ByteBufAllocator alloc()

(Advanced users only) Returns the ByteBufAllocator that can be used to create a PooledObjects without making a copy. If null, a byte[]-based HttpData is created.

PooledObjects cannot be cached since they have their own life cycle. Therefore, if cacheResult() is set to true, this method always returns null.