All Superinterfaces:: RequestContext

All Known Implementing Classes:: ClientRequestContextWrapper, DefaultClientRequestContext

public interface ClientRequestContext
extends RequestContext

Provides information about a Request, its Response and its related utilities. Every client request has its own ClientRequestContext instance.

Method Summary

Modifier and Type	Method	Description
`void`	`addAdditionalRequestHeader(CharSequence name, Object value)`	Adds a header with the specified `name` and `value`.
`HttpHeaders`	`additionalRequestHeaders()`	Returns an `HttpHeaders` which will be included when a `Client` sends an `HttpRequest`.
`<V> V`	`attr(AttributeKey<V> key)`	Returns the value mapped to the given `AttributeKey` or `null` if there's no value set by `RequestContext.setAttr(AttributeKey, Object)` or `RequestContext.setAttrIfAbsent(AttributeKey, Object)`.
`Iterator<Map.Entry<AttributeKey<?>,Object>>`	`attrs()`	Returns the `Iterator` of all `Map.Entry`s this context contains.
`static ClientRequestContextBuilder`	`builder(HttpRequest request)`	Returns a new `ClientRequestContextBuilder` created from the specified `HttpRequest`.
`static ClientRequestContextBuilder`	`builder(RpcRequest request, String uri)`	Returns a new `ClientRequestContextBuilder` created from the specified `RpcRequest` and `uri`.
`static ClientRequestContextBuilder`	`builder(RpcRequest request, URI uri)`	Returns a new `ClientRequestContextBuilder` created from the specified `RpcRequest` and `URI`.
`void`	`clearResponseTimeout()`	Clears the previously scheduled response timeout, if any.
`static ClientRequestContext`	`current()`	Returns the client-side context of the `Request` that is being handled in the current thread.
`static ClientRequestContext`	`currentOrNull()`	Returns the client-side context of the `Request` that is being handled in the current thread.
`Endpoint`	`endpoint()`	Returns the remote `Endpoint` of the current `Request`.
`EndpointGroup`	`endpointGroup()`	Returns the `EndpointGroup` used for the current `Request`.
`default void`	`extendResponseTimeout(Duration adjustment)`	Deprecated. Use `setResponseTimeout(TimeoutMode, Duration)` with `TimeoutMode.EXTEND`
`default void`	`extendResponseTimeoutMillis(long adjustmentMillis)`	Deprecated. Use `setResponseTimeoutMillis(TimeoutMode, long)` with `TimeoutMode.EXTEND`
`String`	`fragment()`	Returns the fragment part of the URI of the current `Request`, as defined in the section 3.5 of RFC3986.
`static <T> T`	`mapCurrent(Function<? super ClientRequestContext,T> mapper, Supplier<T> defaultValueSupplier)`	Maps the client-side context of the `Request` that is being handled in the current thread.
`long`	`maxResponseLength()`	Returns the maximum length of the received `Response`.
`void`	`mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder> mutator)`	Mutates the `HttpHeaders` which will be included when a `Client` sends an `HttpRequest`.
`default ClientRequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq)`	Creates a new `ClientRequestContext` whose properties and `Attribute`s are copied from this `ClientRequestContext`, except having a different `Request` and its own `RequestLog`.
`ClientRequestContext`	`newDerivedContext(RequestId id, HttpRequest req, RpcRequest rpcReq, Endpoint endpoint)`	Creates a new `ClientRequestContext` whose properties and `Attribute`s are copied from this `ClientRequestContext`, except having different `Request`, `Endpoint` and its own `RequestLog`.
`static ClientRequestContext`	`of(HttpRequest request)`	Returns a new `ClientRequestContext` created from the specified `HttpRequest`.
`static ClientRequestContext`	`of(RpcRequest request, String uri)`	Returns a new `ClientRequestContext` created from the specified `RpcRequest` and URI.
`static ClientRequestContext`	`of(RpcRequest request, URI uri)`	Returns a new `ClientRequestContext` created from the specified `RpcRequest` and `URI`.
`ClientOptions`	`options()`	Returns the `ClientOptions` of the current `Request`.
`<V> V`	`ownAttr(AttributeKey<V> key)`	Returns the value mapped to the given `AttributeKey` or `null` if there's no value set by `RequestContext.setAttr(AttributeKey, Object)` or `RequestContext.setAttrIfAbsent(AttributeKey, Object)`.
`Iterator<Map.Entry<AttributeKey<?>,Object>>`	`ownAttrs()`	Returns the `Iterator` of all `Map.Entry`s this context contains.
`default SafeCloseable`	`push()`	Pushes this context to the thread-local stack.
`HttpRequest`	`request()`	Returns the `HttpRequest` associated with this context, or `null` if there's no `HttpRequest` associated with this context yet.
`Runnable`	`responseTimeoutHandler()`	Returns `Response` timeout handler which is executed when the `Response` is not completely received within the allowed `responseTimeoutMillis()` or the default `ClientOption.RESPONSE_TIMEOUT_MILLIS`.
`long`	`responseTimeoutMillis()`	Returns the amount of time allowed until receiving the `Response` completely since the transfer of the `Response` started.
`ServiceRequestContext`	`root()`	Returns the `ServiceRequestContext` whose `Service` invokes the `Client` `Request` which created this `ClientRequestContext`, or `null` if this client request was not made in the context of a server request.
`RpcRequest`	`rpcRequest()`	Returns the `RpcRequest` associated with this context, or `null` if there's no `RpcRequest` associated with this context.
`void`	`setAdditionalRequestHeader(CharSequence name, Object value)`	Sets a header with the specified `name` and `value`.
`void`	`setMaxResponseLength(long maxResponseLength)`	Sets the maximum length of the received `Response`.
`default void`	`setResponseTimeout(TimeoutMode mode, Duration responseTimeout)`	Schedules the response timeout that is triggered when the `Response` is not fully received within the specified `TimeoutMode` and the specified `responseTimeoutMillis` since the `Response` started or `Request` was fully sent.
`default void`	`setResponseTimeout(Duration responseTimeout)`	Schedules the response timeout that is triggered when the `Response` is not fully received within the specified amount of time from now.
`default void`	`setResponseTimeoutAfter(Duration responseTimeout)`	Deprecated. Use `setResponseTimeout(TimeoutMode, Duration)`} with `TimeoutMode.SET_FROM_NOW`
`default void`	`setResponseTimeoutAfterMillis(long responseTimeoutMillis)`	Deprecated. Use `setResponseTimeoutMillis(TimeoutMode, long)` with `TimeoutMode.SET_FROM_NOW`
`default void`	`setResponseTimeoutAt(Instant responseTimeoutAt)`	Deprecated. This method will be removed without a replacement.
`void`	`setResponseTimeoutAtMillis(long responseTimeoutAtMillis)`	Deprecated. This method will be removed without a replacement.
`void`	`setResponseTimeoutHandler(Runnable responseTimeoutHandler)`	Sets a handler to run when the response times out.
`default void`	`setResponseTimeoutMillis(long responseTimeoutMillis)`	Schedules the response timeout that is triggered when the `Response` is not fully received within the specified amount of time from now.
`void`	`setResponseTimeoutMillis(TimeoutMode mode, long responseTimeoutMillis)`	Schedules the response timeout that is triggered when the `Response` is not fully received within the specified `TimeoutMode` and the specified `responseTimeoutMillis` since the `Response` started or `Request` was fully sent.
`void`	`setWriteTimeout(Duration writeTimeout)`	Returns the amount of time allowed until the initial write attempt of the current `Request` succeeds.
`void`	`setWriteTimeoutMillis(long writeTimeoutMillis)`	Returns the amount of time allowed until the initial write attempt of the current `Request` succeeds.
`long`	`writeTimeoutMillis()`	Returns the amount of time allowed until the initial write attempt of the current `Request` succeeds.

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

alloc, computeAttrIfAbsent, contextAwareEventLoop, contextAwareExecutor, decodedPath, eventLoop, executor, id, localAddress, log, logBuilder, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, makeContextAware, meterRegistry, method, path, query, remoteAddress, replace, sessionProtocol, setAttr, setAttrIfAbsent, sslSession, updateRequest, updateRpcRequest

Method Details

current

static ClientRequestContext current()

Returns the client-side context of the Request that is being handled in the current thread.

Throws:

IllegalStateException - if the context is unavailable in the current thread or the current context is not a ClientRequestContext.
currentOrNull

@Nullable static ClientRequestContext currentOrNull()

Returns the client-side context of the Request that is being handled in the current thread.

Returns:

the ClientRequestContext available in the current thread, or null if unavailable.

Throws:

IllegalStateException - if the current context is not a ClientRequestContext.
mapCurrent

@Nullable static <T> T mapCurrent(Function<? super ClientRequestContext,T> mapper, @Nullable Supplier<T> defaultValueSupplier)

Maps the client-side context of the Request that is being handled in the current thread.

Parameters:

mapper - the Function that maps the ClientRequestContext

defaultValueSupplier - the Supplier that provides the value when the context is unavailable in the current thread. If null, the null will be returned when the context is unavailable in the current thread.

Throws:

IllegalStateException - if the current context is not a ClientRequestContext.
of

static ClientRequestContext of(HttpRequest request)

Returns a new ClientRequestContext created from the specified HttpRequest. Note that it is not usually required to create a new context by yourself, because Armeria will always provide a context object for you. However, it may be useful in some cases such as unit testing.

See Also:

ClientRequestContextBuilder
of

static ClientRequestContext of(RpcRequest request, String uri)

Returns a new ClientRequestContext created from the specified RpcRequest and URI. Note that it is not usually required to create a new context by yourself, because Armeria will always provide a context object for you. However, it may be useful in some cases such as unit testing.

See Also:

ClientRequestContextBuilder
of

static ClientRequestContext of(RpcRequest request, URI uri)

Returns a new ClientRequestContext created from the specified RpcRequest and URI. Note that it is not usually required to create a new context by yourself, because Armeria will always provide a context object for you. However, it may be useful in some cases such as unit testing.

See Also:

ClientRequestContextBuilder
builder

static ClientRequestContextBuilder builder(HttpRequest request)

Returns a new ClientRequestContextBuilder created from the specified HttpRequest.
builder

static ClientRequestContextBuilder builder(RpcRequest request, String uri)

Returns a new ClientRequestContextBuilder created from the specified RpcRequest and uri.
builder

static ClientRequestContextBuilder builder(RpcRequest request, URI uri)

Returns a new ClientRequestContextBuilder created from the specified RpcRequest and URI.
root

@Nullable ServiceRequestContext root()

Returns the ServiceRequestContext whose Service invokes the Client Request which created this ClientRequestContext, or null if this client request was not made in the context of a server request.
attr

@Nullable <V> V attr(AttributeKey<V> key)
Returns the value mapped to the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object) or RequestContext.setAttrIfAbsent(AttributeKey, Object).
If the value does not exist in this context but only in root(), this method will return the value from the root().
```
 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;
 
```
If the value exists both in this context and root(), this method will return the value from this context.
```
 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY).equals("child");
 assert ctx.attr(KEY).equals("child");
 
```
Specified by:

attr in interface RequestContext

See Also:

ownAttr(AttributeKey)
ownAttr

@Nullable <V> V ownAttr(AttributeKey<V> key)

Returns the value mapped to the given AttributeKey or null if there's no value set by RequestContext.setAttr(AttributeKey, Object) or RequestContext.setAttrIfAbsent(AttributeKey, Object). Unlike attr(AttributeKey), this does not search in root().

See Also:

attr(AttributeKey)

attrs

Iterator<Map.Entry<AttributeKey<?>,Object>> attrs()

Returns the Iterator of all Map.Entrys this context contains.

The Iterator returned by this method will also yield the Map.Entrys from the root() except those whose AttributeKey exist already in this context, e.g.


 ClientRequestContext ctx = ...;
 assert ctx.ownAttr(KEY_A).equals("child_a");
 assert ctx.root().attr(KEY_A).equals("root_a");
 assert ctx.root().attr(KEY_B).equals("root_b");

 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.attrs();
 assert attrs.next().getValue().equals("child_a"); // KEY_A
 // Skip KEY_A in the root.
 assert attrs.next().getValue().equals("root_b"); // KEY_B
 assert attrs.hasNext() == false;

Please note that any changes made to the Map.Entry returned by Iterator.next() never affects the Map.Entry owned by root(). For example:


 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;

 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.attrs();
 Entry<AttributeKey<?>, Object> next = attrs.next();
 assert next.getKey() == KEY;
 // Overriding the root entry creates the client context's own entry.
 next.setValue("child");
 assert ctx.attr(KEY).equals("child");
 assert ctx.ownAttr(KEY).equals("child");
 // root attribute remains unaffected.
 assert ctx.root().attr(KEY).equals("root");

If you want to change the value from the root while iterating, please call attrs() from root().


 ClientRequestContext ctx = ...;
 assert ctx.root().attr(KEY).equals("root");
 assert ctx.ownAttr(KEY) == null;

 // Call attrs() from the root to set a value directly while iterating.
 Iterator<Entry<AttributeKey<?>, Object>> attrs = ctx.root().attrs();
 Entry<AttributeKey<?>, Object> next = attrs.next();
 assert next.getKey() == KEY;
 next.setValue("another_root");
 // The ctx does not have its own attribute.
 assert ctx.ownAttr(KEY) == null;
 assert ctx.attr(KEY).equals("another_root");

Specified by:: attrs in interface RequestContext
See Also:: ownAttrs()

ownAttrs

Iterator<Map.Entry<AttributeKey<?>,Object>> ownAttrs()

Returns the Iterator of all Map.Entrys this context contains. Unlike attrs(), this does not iterate root().

See Also:

attrs()
request

@Nullable HttpRequest request()

Returns the HttpRequest associated with this context, or null if there's no HttpRequest associated with this context yet. For example, when you send an RPC request, this method will return null until the RPC request is translated into an HTTP request.

Specified by:

request in interface RequestContext
rpcRequest

@Nullable RpcRequest rpcRequest()

Returns the RpcRequest associated with this context, or null if there's no RpcRequest associated with this context. For example, this method will return null when you are not sending an RPC request but just a plain HTTP request.

Specified by:

rpcRequest in interface RequestContext
push

default SafeCloseable push()
Pushes this context to the thread-local stack. To pop the context from the stack, call SafeCloseable.close(), which can be done using a try-with-resources block:
```
 try (SafeCloseable ignored = ctx.push()) {
     ...
 }
 
```
In order to call this method, the current thread-local state must meet one of the following conditions:
- the thread-local does not have any RequestContext in it
- the thread-local has the same ClientRequestContext as this - reentrance
- the thread-local has the ServiceRequestContext which is the same as root()
- the thread-local has the ClientRequestContext whose root() is the same root()
- the thread-local has the ClientRequestContext whose root() is null and this root() is null
Otherwise, this method will throw an IllegalStateException.
Specified by:

push in interface RequestContext
newDerivedContext

default ClientRequestContext newDerivedContext(RequestId id, @Nullable HttpRequest req, @Nullable RpcRequest rpcReq)

Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having a different Request and its own RequestLog.
Note that this method does not copy the RequestLog properties to the derived context.

Specified by:

newDerivedContext in interface RequestContext
newDerivedContext

ClientRequestContext newDerivedContext(RequestId id, @Nullable HttpRequest req, @Nullable RpcRequest rpcReq, Endpoint endpoint)

Creates a new ClientRequestContext whose properties and Attributes are copied from this ClientRequestContext, except having different Request, Endpoint and its own RequestLog.
Note that this method does not copy the RequestLog properties to the derived context.
endpointGroup

@Nullable EndpointGroup endpointGroup()

Returns the EndpointGroup used for the current Request.

Returns:

the EndpointGroup if a user specified an EndpointGroup when initiating a Request. null if a user specified an Endpoint.
endpoint

@Nullable Endpoint endpoint()

Returns the remote Endpoint of the current Request.

Returns:

the remote Endpoint, or null if the Request has failed because its remote Endpoint couldn't be determined.
options

ClientOptions options()

Returns the ClientOptions of the current Request.
fragment

@Nullable String fragment()

Returns the fragment part of the URI of the current Request, as defined in the section 3.5 of RFC3986.

Returns:

the fragment part of the request URI, or null if no fragment was specified
writeTimeoutMillis

long writeTimeoutMillis()

Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOption.WRITE_TIMEOUT_MILLIS.
setWriteTimeoutMillis

void setWriteTimeoutMillis(long writeTimeoutMillis)

Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOption.WRITE_TIMEOUT_MILLIS.
setWriteTimeout

void setWriteTimeout(Duration writeTimeout)

Returns the amount of time allowed until the initial write attempt of the current Request succeeds. This value is initially set from ClientOption.WRITE_TIMEOUT_MILLIS.
responseTimeoutMillis

long responseTimeoutMillis()

Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
clearResponseTimeout

void clearResponseTimeout()

Clears the previously scheduled response timeout, if any. Note that calling this will prevent the response from ever being timed out.

setResponseTimeoutMillis

void setResponseTimeoutMillis(TimeoutMode mode, long responseTimeoutMillis)

Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.

Timeout mode	description
`TimeoutMode.SET_FROM_NOW`	Sets a given amount of timeout from the current time.
`TimeoutMode.SET_FROM_START`	Sets a given amount of timeout since the current `Response` began processing.
`TimeoutMode.EXTEND`	Extends the previously scheduled timeout by the given amount of timeout.

For example:


 ClientRequestContext ctx = ...;
 // Schedules a timeout from the start time of the response
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, 2000);
 assert ctx.responseTimeoutMillis() == 2000;
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, 1000);
 assert ctx.responseTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_NOW, 3000);

 // Extends the previously scheduled timeout.
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.setResponseTimeoutMillis(TimeoutMode.EXTEND, 1000);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.extendResponseTimeoutMillis(TimeoutMode.EXTEND, -500);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;

setResponseTimeoutMillis

default void setResponseTimeoutMillis(long responseTimeoutMillis)
Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now. Note that the specified responseTimeoutMillis must be positive. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS. This method is a shortcut for setResponseTimeoutMillis(TimeoutMode.SET_FROM_NOW, responseTimeoutMillis).
For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutMillis(1000);
 
```
Parameters:

responseTimeoutMillis - the amount of time allowed in milliseconds from now

setResponseTimeout

default void setResponseTimeout(TimeoutMode mode, Duration responseTimeout)

Schedules the response timeout that is triggered when the Response is not fully received within the specified TimeoutMode and the specified responseTimeoutMillis since the Response started or Request was fully sent. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS.

Timeout mode	description
`TimeoutMode.SET_FROM_NOW`	Sets a given amount of timeout from the current time.
`TimeoutMode.SET_FROM_START`	Sets a given amount of timeout since the current `Response` began processing.
`TimeoutMode.EXTEND`	Extends the previously scheduled timeout by the given amount of timeout.

For example:


 ClientRequestContext ctx = ...;
 // Schedules a timeout from the start time of the response
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, Duration.ofSeconds(2));
 assert ctx.responseTimeoutMillis() == 2000;
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_START, Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == 1000;

 // Schedules timeout after 3 seconds from now.
 ctx.setResponseTimeoutMillis(TimeoutMode.SET_FROM_NOW, Duration.ofSeconds(3));

 // Extends the previously scheduled timeout.
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.setResponseTimeoutMillis(TimeoutMode.EXTEND, Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.setResponseTimeoutMillis(TimeoutMode.EXTEND, Duration.ofMillis(-500));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;

setResponseTimeout

default void setResponseTimeout(Duration responseTimeout)
Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now. Note that the specified responseTimeout must be positive. This value is initially set from ClientOption.RESPONSE_TIMEOUT_MILLIS. This method is a shortcut for setResponseTimeout(TimeoutMode.SET_FROM_NOW, responseTimeout).
For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeout(Duration.ofSeconds(1));
 
```
Parameters:

responseTimeout - the amount of time allowed from now
extendResponseTimeoutMillis

@Deprecated default void extendResponseTimeoutMillis(long adjustmentMillis)

Deprecated.
Use setResponseTimeoutMillis(TimeoutMode, long) with TimeoutMode.EXTEND
Extends the previously scheduled response timeout by the specified amount of adjustmentMillis. This method does nothing if no response timeout was scheduled previously. Note that a negative adjustmentMillis reduces the current timeout. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
For example:
```
 ClientRequestContext ctx = ...;
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.extendResponseTimeoutMillis(1000);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.extendResponseTimeoutMillis(-500);
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;
 
```
Parameters:

adjustmentMillis - the amount of time in milliseconds to extend the current timeout by
extendResponseTimeout

@Deprecated default void extendResponseTimeout(Duration adjustment)

Deprecated.
Use setResponseTimeout(TimeoutMode, Duration) with TimeoutMode.EXTEND
Extends the previously scheduled response timeout by the specified amount of adjustment. This method does nothing if no response timeout was scheduled previously. Note that a negative adjustment reduces the current timeout. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
For example:
```
 ClientRequestContext ctx = ...;
 long oldResponseTimeoutMillis = ctx.responseTimeoutMillis();
 ctx.extendResponseTimeout(Duration.ofSeconds(1));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 1000;
 ctx.extendResponseTimeout(Duration.ofMillis(-500));
 assert ctx.responseTimeoutMillis() == oldResponseTimeoutMillis + 500;
 
```
Parameters:

adjustment - the amount of time to extend the current timeout by
setResponseTimeoutAfterMillis

@Deprecated default void setResponseTimeoutAfterMillis(long responseTimeoutMillis)

Deprecated.
Use setResponseTimeoutMillis(TimeoutMode, long) with TimeoutMode.SET_FROM_NOW
Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now. Note that the specified responseTimeoutMillis must be positive. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutAfterMillis(1000);
 
```
Parameters:

responseTimeoutMillis - the amount of time allowed in milliseconds from now
setResponseTimeoutAfter

@Deprecated default void setResponseTimeoutAfter(Duration responseTimeout)

Deprecated.
Use setResponseTimeout(TimeoutMode, Duration)} with TimeoutMode.SET_FROM_NOW
Schedules the response timeout that is triggered when the Response is not fully received within the specified amount of time from now. Note that the specified responseTimeout must be positive. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutAfter(Duration.ofSeconds(1));
 
```
Parameters:

responseTimeout - the amount of time allowed from now
setResponseTimeoutAtMillis

@Deprecated void setResponseTimeoutAtMillis(long responseTimeoutAtMillis)

Deprecated.
This method will be removed without a replacement. Use setResponseTimeoutMillis(TimeoutMode, long)}.
Schedules the response timeout that is triggered at the specified time represented as the number since the epoch (1970-01-01T00:00:00Z). Note that the response will be timed out immediately if the specified time is before now. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 long responseTimeoutAt = Instant.now().plus(1, ChronoUnit.SECONDS).toEpochMilli();
 ctx.setResponseTimeoutAtMillis(responseTimeoutAt);
 
```
Parameters:

responseTimeoutAtMillis - the response timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
setResponseTimeoutAt

@Deprecated default void setResponseTimeoutAt(Instant responseTimeoutAt)

Deprecated.
This method will be removed without a replacement. Use setResponseTimeout(TimeoutMode, Duration).
Schedules the response timeout that is triggered at the specified time represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z). Note that the response will be timed out immediately if the specified time is before now. The initial timeout is set from ClientOption.RESPONSE_TIMEOUT_MILLIS.
For example:
```
 ClientRequestContext ctx = ...;
 // Schedules timeout after 1 seconds from now.
 ctx.setResponseTimeoutAt(Instant.now().plus(1, ChronoUnit.SECONDS));
 
```
Parameters:

responseTimeoutAt - the response timeout represented as the number of milliseconds since the epoch (1970-01-01T00:00:00Z)
responseTimeoutHandler

@Nullable Runnable responseTimeoutHandler()

Returns Response timeout handler which is executed when the Response is not completely received within the allowed responseTimeoutMillis() or the default ClientOption.RESPONSE_TIMEOUT_MILLIS.
setResponseTimeoutHandler

void setResponseTimeoutHandler(Runnable responseTimeoutHandler)
Sets a handler to run when the response times out. responseTimeoutHandler must abort the response, e.g., by calling StreamMessage.abort(Throwable). If not set, the response will be closed with ResponseTimeoutException.
For example,
```
 HttpResponseWriter res = HttpResponse.streaming();
 ctx.setResponseTimeoutHandler(() -> {
    res.abort(new IllegalStateException("Server is in a bad state."));
 });
 ...
 
```
maxResponseLength

long maxResponseLength()

Returns the maximum length of the received Response. This value is initially set from ClientOption.MAX_RESPONSE_LENGTH.

Returns:

the maximum length of the response. 0 if unlimited.

See Also:

ContentTooLargeException
setMaxResponseLength

void setMaxResponseLength(long maxResponseLength)

Sets the maximum length of the received Response. This value is initially set from ClientOption.MAX_RESPONSE_LENGTH. Specify 0 to disable the limit of the length of a response.

See Also:

ContentTooLargeException
additionalRequestHeaders

HttpHeaders additionalRequestHeaders()

Returns an HttpHeaders which will be included when a Client sends an HttpRequest.
setAdditionalRequestHeader

void setAdditionalRequestHeader(CharSequence name, Object value)

Sets a header with the specified name and value. This will remove all previous values associated with the specified name. The header will be included when a Client sends an HttpRequest.
addAdditionalRequestHeader

void addAdditionalRequestHeader(CharSequence name, Object value)

Adds a header with the specified name and value. The header will be included when a Client sends an HttpRequest.
mutateAdditionalRequestHeaders

void mutateAdditionalRequestHeaders(Consumer<HttpHeadersBuilder> mutator)

Mutates the HttpHeaders which will be included when a Client sends an HttpRequest.

Parameters:

mutator - the Consumer that mutates the additional request headers

Interface ClientRequestContext

Method Summary

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

Method Details