com.linecorp.armeria.common.util.AbstractOptions<ClientFactoryOption<Object>,ClientFactoryOptionValue<Object>>

com.linecorp.armeria.client.ClientFactoryOptions

All Implemented Interfaces:: Iterable<ClientFactoryOptionValue<Object>>

public final class ClientFactoryOptions
extends AbstractOptions<ClientFactoryOption<Object>,ClientFactoryOptionValue<Object>>

A set of ClientFactoryOptions and their respective values.

Method Summary

Modifier and Type	Method	Description
`Function<? super EventLoopGroup,? extends AddressResolverGroup<? extends InetSocketAddress>>`	`addressResolverGroupFactory()`	Returns the factory that creates an `AddressResolverGroup` which resolves remote addresses into `InetSocketAddress`es.
`Map<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 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`.
`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()`	Returns an empty singleton `ClientFactoryOptions`.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, ClientFactoryOptionValue<?>... additionalValues)`	Merges the specified `ClientFactoryOptions` and `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, Iterable<? extends ClientFactoryOptionValue<?>> additionalValues)`	Merges the specified `ClientFactoryOptions` and `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptionValue<?>... values)`	Returns the `ClientFactoryOptions` with the specified `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(Iterable<? extends ClientFactoryOptionValue<?>> values)`	Returns the `ClientFactoryOptions` with the specified `ClientFactoryOptionValue`s.
`long`	`pingIntervalMillis()`	Returns the PING interval in milliseconds.
`ProxyConfig`	`proxyConfig()`	The `ProxyConfig` which contains the proxy configuration.
`boolean`	`shutdownWorkerGroupOnClose()`	Returns the flag whether to shut down the worker `EventLoopGroup` when the `ClientFactory` is closed.
`Consumer<? super 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.
`EventLoopGroup`	`workerGroup()`	Returns the worker `EventLoopGroup`.

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

asMap, get, iterator, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details
- of
  
  public static ClientFactoryOptions of()
  
  Returns an empty singleton ClientFactoryOptions.
- of
  
  public static ClientFactoryOptions of(ClientFactoryOptionValue<?>... values)
  
  Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
- of
  
  public static ClientFactoryOptions of(Iterable<? extends ClientFactoryOptionValue<?>> values)
  
  Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
- of
  
  public static ClientFactoryOptions of(ClientFactoryOptions baseOptions, ClientFactoryOptionValue<?>... additionalValues)
  
  Merges the specified ClientFactoryOptions and ClientFactoryOptionValues.
  
  Returns:
  
  the merged ClientFactoryOptions
- of
  
  public static ClientFactoryOptions of(ClientFactoryOptions baseOptions, Iterable<? extends ClientFactoryOptionValue<?>> additionalValues)
  
  Merges the specified ClientFactoryOptions and ClientFactoryOptionValues.
  
  Returns:
  
  the merged ClientFactoryOptions
- workerGroup
  
  public 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 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<ChannelOption<?>,Object> channelOptions()
  
  Returns the ChannelOptions of the sockets created by the ClientFactory.
- tlsCustomizer
  
  public Consumer<? super SslContextBuilder> tlsCustomizer()
  
  Returns the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
- addressResolverGroupFactory
  
  public Function<? super EventLoopGroup,? extends 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.
- pingIntervalMillis
  
  public long pingIntervalMillis()
  
  Returns the PING interval in milliseconds. When neither read nor write was performed for the specified period of time, a PING frame is sent for HTTP/2 or an OPTIONS request with an asterisk ("*") is sent for HTTP/1.
- 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.
- proxyConfig
  
  public ProxyConfig proxyConfig()
  
  The ProxyConfig which contains the proxy configuration.

Class ClientFactoryOptions

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Details