Options describing how an HttpClient will make connections.
AnythingHttpClientOptionsBaseDataObjectClientOptionsBaseBaseDataObjectTCPSSLOptionsBaseDataObjectNetworkOptionsBaseDataObjectBasicIdentifiableObjectAnythingno subtypes hierarchy
| Initializer |
HttpClientOptions({HttpVersion*}? alpnVersions = null, Integer? connectTimeout = null, {String*}? crlPaths = null, Integer? decoderInitialBufferSize = null, String? defaultHost = null, Integer? defaultPort = null, {String*}? enabledCipherSuites = null, {String*}? enabledSecureTransportProtocols = null, Boolean? forceSni = null, Boolean? http2ClearTextUpgrade = null, Integer? http2ConnectionWindowSize = null, Integer? http2KeepAliveTimeout = null, Integer? http2MaxPoolSize = null, Integer? http2MultiplexingLimit = null, Integer? idleTimeout = null, Http2Settings? initialSettings = null, JdkSSLEngineOptions? jdkSslEngineOptions = null, Boolean? keepAlive = null, Integer? keepAliveTimeout = null, JksOptions? keyStoreOptions = null, String? localAddress = null, Boolean? logActivity = null, Integer? maxChunkSize = null, Integer? maxHeaderSize = null, Integer? maxInitialLineLength = null, Integer? maxPoolSize = null, Integer? maxRedirects = null, Integer? maxWaitQueueSize = null, Integer? maxWebsocketFrameSize = null, Integer? maxWebsocketMessageSize = null, String? metricsName = null, OpenSSLEngineOptions? openSslEngineOptions = null, PemKeyCertOptions? pemKeyCertOptions = null, PemTrustOptions? pemTrustOptions = null, PfxOptions? pfxKeyCertOptions = null, PfxOptions? pfxTrustOptions = null, Boolean? pipelining = null, Integer? pipeliningLimit = null, Integer? poolCleanerPeriod = null, HttpVersion? protocolVersion = null, ProxyOptions? proxyOptions = null, Integer? receiveBufferSize = null, Boolean? reuseAddress = null, Boolean? reusePort = null, Integer? sendBufferSize = null, Boolean? sendUnmaskedFrames = null, Integer? soLinger = null, Boolean? ssl = null, Boolean? tcpCork = null, Boolean? tcpFastOpen = null, Boolean? tcpKeepAlive = null, Boolean? tcpNoDelay = null, Boolean? tcpQuickAck = null, Integer? trafficClass = null, Boolean? trustAll = null, JksOptions? trustStoreOptions = null, Boolean? tryUseCompression = null, Boolean? useAlpn = null, Boolean? usePooledBuffers = null, Boolean? verifyHost = null)Parameters:
|
| Attributes | |
alpnVersions | shared {HttpVersion*}? alpnVersionsSet the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to setProtocolVersion:
|
decoderInitialBufferSize | shared Integer? decoderInitialBufferSizeset to |
defaultHost | shared String? defaultHostSet the default host name to be used by this client in requests if none is provided when making the request. |
defaultPort | shared Integer? defaultPortSet the default port to be used by this client in requests if none is provided when making the request. |
forceSni | shared Boolean? forceSniBy default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to |
http2ClearTextUpgrade | shared Boolean? http2ClearTextUpgradeSet to |
http2ConnectionWindowSize | shared Integer? http2ConnectionWindowSizeSet the default HTTP/2 connection window size. It overrides the initial window size set by getInitialWindowSize, so the connection window size is greater than for its streams, in order the data throughput. A value of-1 reuses the initial window size setting.
|
http2KeepAliveTimeout | shared Integer? http2KeepAliveTimeoutSet the keep alive timeout for HTTP/2 connections, in seconds. This value determines how long a connection remains unused in the pool before being evicted and closed. |
http2MaxPoolSize | shared Integer? http2MaxPoolSizeSet the maximum pool size for HTTP/2 connections |
http2MultiplexingLimit | shared Integer? http2MultiplexingLimitSet a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings. Setting the value to-1 means to use the value sent by the server's initial settings.
-1 is the default value.
|
initialSettings | shared Http2Settings? initialSettingsSet the HTTP/2 connection settings immediately sent by to the server when the client connects. |
keepAlive | shared Boolean? keepAliveSet whether keep alive is enabled on the client |
keepAliveTimeout | shared Integer? keepAliveTimeoutSet the keep alive timeout for HTTP/1.x, in seconds. This value determines how long a connection remains unused in the pool before being evicted and closed. |
maxChunkSize | shared Integer? maxChunkSizeSet the maximum HTTP chunk size |
maxHeaderSize | shared Integer? maxHeaderSizeSet the maximum length of all headers for HTTP/1.x . |
maxInitialLineLength | shared Integer? maxInitialLineLengthSet the maximum length of the initial line for HTTP/1.x (e.g. |
maxPoolSize | shared Integer? maxPoolSizeSet the maximum pool size for connections |
maxRedirects | shared Integer? maxRedirectsSet to |
maxWaitQueueSize | shared Integer? maxWaitQueueSizeSet the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded. |
maxWebsocketFrameSize | shared Integer? maxWebsocketFrameSizeSet the max websocket frame size |
maxWebsocketMessageSize | shared Integer? maxWebsocketMessageSizeSet the max websocket message size |
pipelining | shared Boolean? pipeliningSet whether pipe-lining is enabled on the client |
pipeliningLimit | shared Integer? pipeliningLimitSet the limit of pending requests a pipe-lined HTTP/1 connection can send. |
poolCleanerPeriod | shared Integer? poolCleanerPeriodSet the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed. |
protocolVersion | shared HttpVersion? protocolVersionSet the protocol version. |
sendUnmaskedFrames | shared Boolean? sendUnmaskedFramesSet true when the client wants to skip frame masking. You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. It's false as default. |
tryUseCompression | shared Boolean? tryUseCompressionSet whether compression is enabled |
verifyHost | shared Boolean? verifyHostSet whether hostname verification is enabled |
| Inherited Attributes |
Attributes inherited from: ClientOptionsBase |
Attributes inherited from: NetworkOptions |
Attributes inherited from: Objecthash, string |
Attributes inherited from: TCPSSLOptionscrlPaths, enabledCipherSuites, enabledSecureTransportProtocols, idleTimeout, jdkSslEngineOptions, keyStoreOptions, openSslEngineOptions, pemKeyCertOptions, pemTrustOptions, pfxKeyCertOptions, pfxTrustOptions, soLinger, ssl, tcpCork, tcpFastOpen, tcpKeepAlive, tcpNoDelay, tcpQuickAck, trustStoreOptions, useAlpn, usePooledBuffers |
| Methods | |
toJson | shared actual default JsonObject toJson() |
| Inherited Methods |
Methods inherited from: ClientOptionsBase |
Methods inherited from: NetworkOptions |
Methods inherited from: Objectequals |
Methods inherited from: TCPSSLOptions |
Methods inherited from: BaseDataObjecttoJson |