ClientFactoryOptions (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.common.util.AbstractOptions
- - com.linecorp.armeria.client.ClientFactoryOptions

public final class ClientFactoryOptions
extends AbstractOptions

A set of ClientFactoryOptions and their respective values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Function<? super io.netty.channel.EventLoopGroup,? extends io.netty.resolver.AddressResolverGroup<? extends InetSocketAddress>>`	`addressResolverGroupFactory()` Returns the factory that creates an `AddressResolverGroup` which resolves remote addresses into `InetSocketAddress`es.
`Map<ClientFactoryOption<Object>,ClientFactoryOptionValue<Object>>`	`asMap()` Converts this `ClientFactoryOptions` to a `Map`.
`Map<io.netty.channel.ChannelOption<?>,Object>`	`channelOptions()` Returns the `ChannelOption`s of the sockets created by the `ClientFactory`.
`ConnectionPoolListener`	`connectionPoolListener()` Returns the listener which is notified on a connection pool event.
`Function<? super io.netty.channel.EventLoopGroup,? extends EventLoopScheduler>`	`eventLoopSchedulerFactory()` Returns the factory that creates an `EventLoopScheduler` which is responsible for assigning an `EventLoop` to handle a connection to the specified `Endpoint`.
`<T> T`	`get(ClientFactoryOption<T> option)` Returns the value of the specified `ClientFactoryOption`.
`<T> T`	`getOrElse(ClientFactoryOption<T> option, T defaultValue)` Returns the value of the specified `ClientFactoryOption`.
`<T> T`	`getOrNull(ClientFactoryOption<T> option)` Returns the value of the specified `ClientFactoryOption`.
`int`	`http1MaxChunkSize()` Returns the maximum length of each chunk in an HTTP/1 response content.
`int`	`http1MaxHeaderSize()` Returns the maximum length of all headers in an HTTP/1 response.
`int`	`http1MaxInitialLineLength()` Returns the maximum length of an HTTP/1 response initial line.
`int`	`http2InitialConnectionWindowSize()` Returns the HTTP/2 initial connection flow-control window size.
`int`	`http2InitialStreamWindowSize()` Returns the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
`int`	`http2MaxFrameSize()` Returns the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
`long`	`http2MaxHeaderListSize()` Returns 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.
`long`	`idleTimeoutMillis()` Returns the idle timeout of a socket connection in milliseconds.
`MeterRegistry`	`meterRegistry()` Returns the `MeterRegistry` which collects various stats.
`static ClientFactoryOptions`	`of()` The default `ClientFactoryOptions`.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, ClientFactoryOptions options)` Merges the specified two `ClientFactoryOptions`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, ClientFactoryOptionValue<?>... options)` Merges the specified `ClientFactoryOptions` and `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, Iterable<ClientFactoryOptionValue<?>> options)` Merges the specified `ClientFactoryOptions` and `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptionValue<?>... options)` Returns the `ClientFactoryOptions` with the specified `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(Iterable<ClientFactoryOptionValue<?>> options)` Returns the `ClientFactoryOptions` with the specified `ClientFactoryOptionValue`s.
`boolean`	`shutdownWorkerGroupOnClose()` Returns the flag whether to shut down the worker `EventLoopGroup` when the `ClientFactory` is closed.
`Consumer<? super io.netty.handler.ssl.SslContextBuilder>`	`sslContextCustomizer()` Deprecated. Use `tlsCustomizer()`.
`Consumer<? super io.netty.handler.ssl.SslContextBuilder>`	`tlsCustomizer()` Returns the `Consumer` which can arbitrarily configure the `SslContextBuilder` that will be applied to the SSL session.
`boolean`	`useHttp1Pipelining()` Returns whether to use HTTP pipelining for HTTP/1 connections.
`boolean`	`useHttp2Preface()` Returns 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.
`io.netty.channel.EventLoopGroup`	`workerGroup()` Returns the worker `EventLoopGroup`.

Methods inherited from class com.linecorp.armeria.common.util.AbstractOptions
asMap0, get0, getOrElse0, getOrNull0, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static ClientFactoryOptions of()
```
    The default ClientFactoryOptions.
  - of
```
public static ClientFactoryOptions of(ClientFactoryOptionValue<?>... options)
```
    Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
  - of
```
public static ClientFactoryOptions of(Iterable<ClientFactoryOptionValue<?>> options)
```
    Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
  - of
```
public static ClientFactoryOptions of(ClientFactoryOptions baseOptions,
                                      ClientFactoryOptionValue<?>... options)
```
    Merges the specified ClientFactoryOptions and ClientFactoryOptionValues.
    
    Returns:
    
    the merged ClientFactoryOptions
  - of
```
public static ClientFactoryOptions of(ClientFactoryOptions baseOptions,
                                      Iterable<ClientFactoryOptionValue<?>> options)
```
    Merges the specified ClientFactoryOptions and ClientFactoryOptionValues.
    
    Returns:
    
    the merged ClientFactoryOptions
  - of
```
public static ClientFactoryOptions of(ClientFactoryOptions baseOptions,
                                      ClientFactoryOptions options)
```
    Merges the specified two ClientFactoryOptionss.
    
    Returns:
    
    the merged ClientFactoryOptions
  - get
```
public <T> T get(ClientFactoryOption<T> option)
```
    Returns the value of the specified ClientFactoryOption.
    
    Returns:
    
    the value of the specified ClientFactoryOption
    
    Throws:
    
    NoSuchElementException - if no value is set for the specified ClientFactoryOption.
  - getOrNull
```
public <T> T getOrNull(ClientFactoryOption<T> option)
```
    Returns the value of the specified ClientFactoryOption.
    
    Returns:
    
    the value of the ClientFactoryOption, or null if the specified ClientFactoryOption is not set.
  - getOrElse
```
public <T> T getOrElse(ClientFactoryOption<T> option,
                       T defaultValue)
```
    Returns the value of the specified ClientFactoryOption.
    
    Returns:
    
    the value of the ClientFactoryOption, or defaultValue if the specified ClientFactoryOption is not set.
  - asMap
```
public Map<ClientFactoryOption<Object>,ClientFactoryOptionValue<Object>> asMap()
```
    Converts this ClientFactoryOptions to a Map.
  - workerGroup
```
public io.netty.channel.EventLoopGroup workerGroup()
```
    Returns the worker EventLoopGroup.
  - shutdownWorkerGroupOnClose
```
public boolean shutdownWorkerGroupOnClose()
```
    Returns the flag whether to shut down the worker EventLoopGroup when the ClientFactory is closed.
  - eventLoopSchedulerFactory
```
public Function<? super io.netty.channel.EventLoopGroup,? extends EventLoopScheduler> eventLoopSchedulerFactory()
```
    Returns the factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
  - channelOptions
```
public Map<io.netty.channel.ChannelOption<?>,Object> channelOptions()
```
    Returns the ChannelOptions of the sockets created by the ClientFactory.
  - sslContextCustomizer
```
@Deprecated
public Consumer<? super io.netty.handler.ssl.SslContextBuilder> sslContextCustomizer()
```
    Deprecated. Use tlsCustomizer().
    
    Returns the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
  - tlsCustomizer
```
public Consumer<? super io.netty.handler.ssl.SslContextBuilder> tlsCustomizer()
```
    Returns the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
  - addressResolverGroupFactory
```
public Function<? super io.netty.channel.EventLoopGroup,? extends io.netty.resolver.AddressResolverGroup<? extends InetSocketAddress>> addressResolverGroupFactory()
```
    Returns the factory that creates an AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
  - http2InitialConnectionWindowSize
```
public int http2InitialConnectionWindowSize()
```
    Returns the HTTP/2 initial connection flow-control window size.
  - http2InitialStreamWindowSize
```
public int http2InitialStreamWindowSize()
```
    Returns the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
  - http2MaxFrameSize
```
public int http2MaxFrameSize()
```
    Returns the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
  - http2MaxHeaderListSize
```
public long http2MaxHeaderListSize()
```
    Returns 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.
  - http1MaxInitialLineLength
```
public int http1MaxInitialLineLength()
```
    Returns the maximum length of an HTTP/1 response initial line.
  - http1MaxHeaderSize
```
public int http1MaxHeaderSize()
```
    Returns the maximum length of all headers in an HTTP/1 response.
  - http1MaxChunkSize
```
public int http1MaxChunkSize()
```
    Returns the maximum length of each chunk in an HTTP/1 response content.
  - idleTimeoutMillis
```
public long idleTimeoutMillis()
```
    Returns the idle timeout of a socket connection in milliseconds.
  - useHttp2Preface
```
public boolean useHttp2Preface()
```
    Returns 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.
  - useHttp1Pipelining
```
public boolean useHttp1Pipelining()
```
    Returns whether to use HTTP pipelining for HTTP/1 connections.
  - connectionPoolListener
```
public ConnectionPoolListener connectionPoolListener()
```
    Returns the listener which is notified on a connection pool event.
  - meterRegistry
```
public MeterRegistry meterRegistry()
```
    Returns the MeterRegistry which collects various stats.

Class ClientFactoryOptions

Method Summary

Methods inherited from class com.linecorp.armeria.common.util.AbstractOptions

Methods inherited from class java.lang.Object

Method Detail

of

of

of

of

of

of

get

getOrNull

getOrElse

asMap

workerGroup

shutdownWorkerGroupOnClose

eventLoopSchedulerFactory

channelOptions

sslContextCustomizer

tlsCustomizer

addressResolverGroupFactory

http2InitialConnectionWindowSize

http2InitialStreamWindowSize

http2MaxFrameSize

http2MaxHeaderListSize

http1MaxInitialLineLength

http1MaxHeaderSize

http1MaxChunkSize

idleTimeoutMillis

useHttp2Preface

useHttp1Pipelining

connectionPoolListener

meterRegistry