ClientFactoryOption (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- io.netty.util.AbstractConstant
- - com.linecorp.armeria.common.util.AbstractOption<T>
  - - com.linecorp.armeria.client.ClientFactoryOption<T>

Type Parameters:

T - the type of the option value

All Implemented Interfaces:

io.netty.util.Constant, Comparable
```
public final class ClientFactoryOption<T>
extends AbstractOption<T>
```
A ClientFactory option.

Field Summary

Fields
Modifier and Type	Field and Description
`static ClientFactoryOption<Function<? super io.netty.channel.EventLoopGroup,? extends io.netty.resolver.AddressResolverGroup<? extends InetSocketAddress>>>`	`ADDRESS_RESOLVER_GROUP_FACTORY` The factory that creates an `AddressResolverGroup` which resolves remote addresses into `InetSocketAddress`es.
`static ClientFactoryOption<Map<io.netty.channel.ChannelOption<?>,Object>>`	`CHANNEL_OPTIONS` The `ChannelOption`s of the sockets created by the `ClientFactory`.
`static ClientFactoryOption<ConnectionPoolListener>`	`CONNECTION_POOL_LISTENER` The listener which is notified on a connection pool event.
`static ClientFactoryOption<Function<? super io.netty.channel.EventLoopGroup,? extends EventLoopScheduler>>`	`EVENT_LOOP_SCHEDULER_FACTORY` The factory that creates an `EventLoopScheduler` which is responsible for assigning an `EventLoop` to handle a connection to the specified `Endpoint`.
`static ClientFactoryOption<Integer>`	`HTTP1_MAX_CHUNK_SIZE` The maximum length of each chunk in an HTTP/1 response content.
`static ClientFactoryOption<Integer>`	`HTTP1_MAX_HEADER_SIZE` The maximum length of all headers in an HTTP/1 response.
`static ClientFactoryOption<Integer>`	`HTTP1_MAX_INITIAL_LINE_LENGTH` The maximum length of an HTTP/1 response initial line.
`static ClientFactoryOption<Integer>`	`HTTP2_INITIAL_CONNECTION_WINDOW_SIZE` The HTTP/2 initial connection flow-control window size.
`static ClientFactoryOption<Integer>`	`HTTP2_INITIAL_STREAM_WINDOW_SIZE` The SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
`static ClientFactoryOption<Integer>`	`HTTP2_MAX_FRAME_SIZE` The SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
`static ClientFactoryOption<Long>`	`HTTP2_MAX_HEADER_LIST_SIZE` The HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
`static ClientFactoryOption<Long>`	`IDLE_TIMEOUT_MILLIS` The idle timeout of a socket connection in milliseconds.
`static ClientFactoryOption<MeterRegistry>`	`METER_REGISTRY` The `MeterRegistry` which collects various stats.
`static ClientFactoryOption<Boolean>`	`SHUTDOWN_WORKER_GROUP_ON_CLOSE` Whether to shut down the worker `EventLoopGroup` when the `ClientFactory` is closed.
`static ClientFactoryOption<Consumer<? super io.netty.handler.ssl.SslContextBuilder>>`	`SSL_CONTEXT_CUSTOMIZER` Deprecated. Use `TLS_CUSTOMIZER`.
`static ClientFactoryOption<Consumer<? super io.netty.handler.ssl.SslContextBuilder>>`	`TLS_CUSTOMIZER` The `Consumer` which can arbitrarily configure the `SslContextBuilder` that will be applied to the SSL session.
`static ClientFactoryOption<Boolean>`	`USE_HTTP1_PIPELINING` Whether to use HTTP pipelining for HTTP/1 connections.
`static ClientFactoryOption<Boolean>`	`USE_HTTP2_PREFACE` Whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
`static ClientFactoryOption<io.netty.channel.EventLoopGroup>`	`WORKER_GROUP` The worker `EventLoopGroup`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientFactoryOptionValue<T>`	`newValue(T value)` Creates a new value of this option.
`static <T> ClientFactoryOption<T>`	`valueOf(String name)` Returns the `ClientFactoryOption` 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
  - WORKER_GROUP
```
public static final ClientFactoryOption<io.netty.channel.EventLoopGroup> WORKER_GROUP
```
    The worker EventLoopGroup.
  - SHUTDOWN_WORKER_GROUP_ON_CLOSE
```
public static final ClientFactoryOption<Boolean> SHUTDOWN_WORKER_GROUP_ON_CLOSE
```
    Whether to shut down the worker EventLoopGroup when the ClientFactory is closed.
  - EVENT_LOOP_SCHEDULER_FACTORY
```
public static final ClientFactoryOption<Function<? super io.netty.channel.EventLoopGroup,? extends EventLoopScheduler>> EVENT_LOOP_SCHEDULER_FACTORY
```
    The factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
  - CHANNEL_OPTIONS
```
public static final ClientFactoryOption<Map<io.netty.channel.ChannelOption<?>,Object>> CHANNEL_OPTIONS
```
    The ChannelOptions of the sockets created by the ClientFactory.
  - TLS_CUSTOMIZER
```
public static final ClientFactoryOption<Consumer<? super io.netty.handler.ssl.SslContextBuilder>> TLS_CUSTOMIZER
```
    The Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
  - SSL_CONTEXT_CUSTOMIZER
```
@Deprecated
public static final ClientFactoryOption<Consumer<? super io.netty.handler.ssl.SslContextBuilder>> SSL_CONTEXT_CUSTOMIZER
```
    Deprecated. Use TLS_CUSTOMIZER.
    
    The Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
  - ADDRESS_RESOLVER_GROUP_FACTORY
```
public static final ClientFactoryOption<Function<? super io.netty.channel.EventLoopGroup,? extends io.netty.resolver.AddressResolverGroup<? extends InetSocketAddress>>> ADDRESS_RESOLVER_GROUP_FACTORY
```
    The factory that creates an AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
  - HTTP2_INITIAL_CONNECTION_WINDOW_SIZE
```
public static final ClientFactoryOption<Integer> HTTP2_INITIAL_CONNECTION_WINDOW_SIZE
```
    The HTTP/2 initial connection flow-control window size.
  - HTTP2_INITIAL_STREAM_WINDOW_SIZE
```
public static final ClientFactoryOption<Integer> HTTP2_INITIAL_STREAM_WINDOW_SIZE
```
    The SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
  - HTTP2_MAX_FRAME_SIZE
```
public static final ClientFactoryOption<Integer> HTTP2_MAX_FRAME_SIZE
```
    The SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
  - HTTP2_MAX_HEADER_LIST_SIZE
```
public static final ClientFactoryOption<Long> HTTP2_MAX_HEADER_LIST_SIZE
```
    The HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
  - HTTP1_MAX_INITIAL_LINE_LENGTH
```
public static final ClientFactoryOption<Integer> HTTP1_MAX_INITIAL_LINE_LENGTH
```
    The maximum length of an HTTP/1 response initial line.
  - HTTP1_MAX_HEADER_SIZE
```
public static final ClientFactoryOption<Integer> HTTP1_MAX_HEADER_SIZE
```
    The maximum length of all headers in an HTTP/1 response.
  - HTTP1_MAX_CHUNK_SIZE
```
public static final ClientFactoryOption<Integer> HTTP1_MAX_CHUNK_SIZE
```
    The maximum length of each chunk in an HTTP/1 response content.
  - IDLE_TIMEOUT_MILLIS
```
public static final ClientFactoryOption<Long> IDLE_TIMEOUT_MILLIS
```
    The idle timeout of a socket connection in milliseconds.
  - USE_HTTP2_PREFACE
```
public static final ClientFactoryOption<Boolean> USE_HTTP2_PREFACE
```
    Whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
  - USE_HTTP1_PIPELINING
```
public static final ClientFactoryOption<Boolean> USE_HTTP1_PIPELINING
```
    Whether to use HTTP pipelining for HTTP/1 connections.
  - CONNECTION_POOL_LISTENER
```
public static final ClientFactoryOption<ConnectionPoolListener> CONNECTION_POOL_LISTENER
```
    The listener which is notified on a connection pool event.
  - METER_REGISTRY
```
public static final ClientFactoryOption<MeterRegistry> METER_REGISTRY
```
    The MeterRegistry which collects various stats.
- Method Detail
  - valueOf
```
public static <T> ClientFactoryOption<T> valueOf(String name)
```
    Returns the ClientFactoryOption of the specified name.
  - newValue
```
public ClientFactoryOptionValue<T> newValue(T value)
```
    Creates a new value of this option.

Class ClientFactoryOption<T>

Field Summary

Method Summary

Methods inherited from class io.netty.util.AbstractConstant

Methods inherited from class java.lang.Object

Field Detail

WORKER_GROUP

SHUTDOWN_WORKER_GROUP_ON_CLOSE

EVENT_LOOP_SCHEDULER_FACTORY

CHANNEL_OPTIONS

TLS_CUSTOMIZER

SSL_CONTEXT_CUSTOMIZER

ADDRESS_RESOLVER_GROUP_FACTORY

HTTP2_INITIAL_CONNECTION_WINDOW_SIZE

HTTP2_INITIAL_STREAM_WINDOW_SIZE

HTTP2_MAX_FRAME_SIZE

HTTP2_MAX_HEADER_LIST_SIZE

HTTP1_MAX_INITIAL_LINE_LENGTH

HTTP1_MAX_HEADER_SIZE

HTTP1_MAX_CHUNK_SIZE

IDLE_TIMEOUT_MILLIS

USE_HTTP2_PREFACE

USE_HTTP1_PIPELINING

CONNECTION_POOL_LISTENER

METER_REGISTRY

Method Detail

valueOf

newValue