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, java.lang.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<java.lang.Long>	DEFAULT_MAX_RESPONSE_LENGTH The default maximum allowed length of a server response.
static ClientOption<java.lang.Long>	DEFAULT_RESPONSE_TIMEOUT_MILLIS The default timeout of a server reply to a client call.
static ClientOption<java.lang.Long>	DEFAULT_WRITE_TIMEOUT_MILLIS The default timeout of a socket write.
static ClientOption<HttpHeaders>	HTTP_HEADERS The additional HTTP headers to send with requests.

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(java.lang.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

DEFAULT_WRITE_TIMEOUT_MILLIS

public static final ClientOption<java.lang.Long> DEFAULT_WRITE_TIMEOUT_MILLIS

The default timeout of a socket write.

DEFAULT_RESPONSE_TIMEOUT_MILLIS

public static final ClientOption<java.lang.Long> DEFAULT_RESPONSE_TIMEOUT_MILLIS

The default timeout of a server reply to a client call.

DEFAULT_MAX_RESPONSE_LENGTH

public static final ClientOption<java.lang.Long> DEFAULT_MAX_RESPONSE_LENGTH

The default 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.

Method Detail

valueOf

public static <T> ClientOption<T> valueOf(java.lang.String name)

Returns the ClientOption of the specified name.

newValue

public ClientOptionValue<T> newValue(T value)

Creates a new value of this option.