com.linecorp.armeria.client

Class ClientOption<T>

java.lang.Object

io.netty.util.AbstractConstant

com.linecorp.armeria.common.util.AbstractOption<T>

com.linecorp.armeria.client.ClientOption<T>

Type Parameters:

T - the type of the option value

All Implemented Interfaces:

io.netty.util.Constant, Comparable

public final class ClientOption<T>
extends AbstractOption<T>

A client option.

Field Summary

Fields

Modifier and Type	Field and Description
static ClientOption<ClientDecoration>	DECORATION The Function that decorates the client components.
static ClientOption<Long>	DEFAULT_MAX_RESPONSE_LENGTH Deprecated. Use MAX_RESPONSE_LENGTH;
static ClientOption<Long>	DEFAULT_RESPONSE_TIMEOUT_MILLIS Deprecated. Use RESPONSE_TIMEOUT_MILLIS.
static ClientOption<Long>	DEFAULT_WRITE_TIMEOUT_MILLIS Deprecated. Use WRITE_TIMEOUT_MILLIS.
static ClientOption<Function<? super Endpoint,? extends EndpointGroup>>	ENDPOINT_REMAPPER A Function that remaps a target Endpoint into an EndpointGroup.
static ClientOption<ClientFactory>	FACTORY The ClientFactory used for creating a client.
static ClientOption<HttpHeaders>	HTTP_HEADERS The additional HTTP headers to send with requests.
static ClientOption<Long>	MAX_RESPONSE_LENGTH The maximum allowed length of a server response.
static ClientOption<Supplier<RequestId>>	REQUEST_ID_GENERATOR The Supplier that generates a RequestId.
static ClientOption<Long>	RESPONSE_TIMEOUT_MILLIS The timeout of a server reply to a client call.
static ClientOption<Long>	WRITE_TIMEOUT_MILLIS The timeout of a socket write.

Method Summary

Modifier and Type	Method and Description
ClientOptionValue<T>	newValue(T value) Creates a new value of this option.
static <T> ClientOption<T>	valueOf(String name) Returns the ClientOption of the specified name.

Methods inherited from class io.netty.util.AbstractConstant

compareTo, equals, hashCode, id, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FACTORY

public static final ClientOption<ClientFactory> FACTORY

The ClientFactory used for creating a client.

WRITE_TIMEOUT_MILLIS

public static final ClientOption<Long> WRITE_TIMEOUT_MILLIS

The timeout of a socket write.

DEFAULT_WRITE_TIMEOUT_MILLIS

@Deprecated
public static final ClientOption<Long> DEFAULT_WRITE_TIMEOUT_MILLIS

Deprecated. Use WRITE_TIMEOUT_MILLIS.

The timeout of a socket write.

RESPONSE_TIMEOUT_MILLIS

public static final ClientOption<Long> RESPONSE_TIMEOUT_MILLIS

The timeout of a server reply to a client call.

DEFAULT_RESPONSE_TIMEOUT_MILLIS

@Deprecated
public static final ClientOption<Long> DEFAULT_RESPONSE_TIMEOUT_MILLIS

Deprecated. Use RESPONSE_TIMEOUT_MILLIS.

The timeout of a server reply to a client call.

MAX_RESPONSE_LENGTH

public static final ClientOption<Long> MAX_RESPONSE_LENGTH

The maximum allowed length of a server response.

DEFAULT_MAX_RESPONSE_LENGTH

@Deprecated
public static final ClientOption<Long> DEFAULT_MAX_RESPONSE_LENGTH

Deprecated. Use MAX_RESPONSE_LENGTH;

The maximum allowed length of a server response.

HTTP_HEADERS

public static final ClientOption<HttpHeaders> HTTP_HEADERS

The additional HTTP headers to send with requests. Used only when the underlying SessionProtocol is HTTP.

DECORATION

public static final ClientOption<ClientDecoration> DECORATION

The Function that decorates the client components.

REQUEST_ID_GENERATOR

public static final ClientOption<Supplier<RequestId>> REQUEST_ID_GENERATOR

The Supplier that generates a RequestId.

ENDPOINT_REMAPPER

public static final ClientOption<Function<? super Endpoint,? extends EndpointGroup>> ENDPOINT_REMAPPER

A Function that remaps a target Endpoint into an EndpointGroup.

See Also:

ClientBuilder.endpointRemapper(Function)

Method Detail

valueOf

public static <T> ClientOption<T> valueOf(String name)

Returns the ClientOption of the specified name.

newValue

public ClientOptionValue<T> newValue(T value)

Creates a new value of this option.