Add a CRL path
Add a CRL value
Add an enabled cipher suite, appended to the ordered suites.
Sets the list of enabled SSL/TLS protocols.
Set a list of remote hosts that are not proxied when the client is configured to use a proxy. This
list serves the same purpose than the JVM nonProxyHosts configuration.
Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.
Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
Set 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 HttpClientOptions:
Set the connect timeout
Add a CRL path
Add a CRL value
set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.
Set the default host name to be used by this client in requests if none is provided when making the request.
Set the default port to be used by this client in requests if none is provided when making the request.
Add an enabled cipher suite, appended to the ordered suites.
Sets the list of enabled SSL/TLS protocols.
Set the default HTTP/2 connection window size. It overrides the initial window size set by Http2Settings, 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.
Set 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. A timeout of0 means there is no timeout.
Set the maximum pool size for HTTP/2 connections
Set 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.
Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout.
If you want change default time unit, use HttpClientOptions
Set the idle timeout unit. If not specified, default is seconds.
Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
Set 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. A timeout of0 means there is no timeout.
Set the key/cert options in jks format, aka Java keystore.
Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
Set the maximum HTTP chunk size
Set the maximum length of all headers for HTTP/1.x .
Set the maximum length of the initial line for HTTP/1.x (e.g. "HTTP/1.1 200 OK")
Set the maximum pool size for connections
Set to maxRedirects the maximum number of redirection a request can follow.
Set 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.
Set the max WebSocket frame size
Set the max WebSocket message size
Set the max number of WebSockets per endpoint.
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
Set the client name, used when the client is shared, otherwise ignored.
Set a list of remote hosts that are not proxied when the client is configured to use a proxy. This
list serves the same purpose than the JVM nonProxyHosts configuration.
Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.
Set the key/cert store options in pem format.
Set the trust options in pem format
Set the key/cert options in pfx format.
Set the trust options in pfx format
Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
Set 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.
Set the number of event-loop the pool use.
0, the client pool will use the current event-loopThe default size is 0.
Set the protocol version.
Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.
Set the read idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.
If you want change default time unit, use HttpClientOptions
Set the TCP receive buffer size
Set the TCP send buffer size
Set whether SO_linger keep alive is enabled
Set to use SSL engine implementation to use.
Set the SSL handshake timeout, default time unit is seconds.
Set the SSL handshake timeout unit. If not specified, default is seconds.
Sets the TCP_USER_TIMEOUT option - only with linux native transport.
Set the tracing policy for the client behavior when Vert.x has tracing enabled.
Set the value of traffic class
Set the trust options.
Set the trust options in jks format, aka Java truststore
Set whether the client will offer the WebSocket per-message deflate compression extension.
Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.
When a WebSocket is closed, the server should close the TCP connection. This timeout will close the TCP connection on the client when it expires.
Set to 0L closes the TCP connection immediately after receiving the close frame.
Set to a negative value to disable it.
Set whether the client_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered.
Set the WebSocket deflate compression level.
Set whether the server_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered.
Set the write idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is sent within the timeout.
If you want change default time unit, use HttpClientOptions
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to true forces the server name to be always sent.
Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false
when an h2c connection is established directly (with prior knowledge).
Set to true when an h2c connection established using an HTTP/1.1 upgrade request should perform
a preflight OPTIONS request to the origin server to establish the h2c connection.
Set whether keep alive is enabled on the client
Set whether pipe-lining is enabled on the client
Set the value of reuse address
Set the value of reuse port.
This is only supported by native transports.Set 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.
Set to true to share the client.
There can be multiple shared clients distinguished by HttpClientOptions, when no specific name is set, the HttpClientOptions is used.
Set whether SSL/TLS is enabled
Enable the TCP_CORK option - only with linux native transport.
Enable the TCP_FASTOPEN option - only with linux native transport.
Set whether TCP keep alive is enabled
Set whether TCP no delay is enabled
Enable the TCP_QUICKACK option - only with linux native transport.
Set whether all server certificates should be trusted
Set whether compression is enabled
Set the ALPN usage.
Set whether hostname verification is enabled
Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
Set 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 HttpClientOptions:
Set the connect timeout
set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.
Set the default host name to be used by this client in requests if none is provided when making the request.
Set the default port to be used by this client in requests if none is provided when making the request.
Sets the list of enabled SSL/TLS protocols.
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to true forces the server name to be always sent.
Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false
when an h2c connection is established directly (with prior knowledge).
Set to true when an h2c connection established using an HTTP/1.1 upgrade request should perform
a preflight OPTIONS request to the origin server to establish the h2c connection.
Set the default HTTP/2 connection window size. It overrides the initial window size set by Http2Settings, 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.
Set 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. A timeout of0 means there is no timeout.
Set the maximum pool size for HTTP/2 connections
Set 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.
Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout.
If you want change default time unit, use HttpClientOptions
Set the idle timeout unit. If not specified, default is seconds.
Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
Set whether keep alive is enabled on the client
Set 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. A timeout of0 means there is no timeout.
Set the key/cert options.
Set the key/cert options in jks format, aka Java keystore.
Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
Set the maximum HTTP chunk size
Set the maximum length of all headers for HTTP/1.x .
Set the maximum length of the initial line for HTTP/1.x (e.g. "HTTP/1.1 200 OK")
Set the maximum pool size for connections
Set to maxRedirects the maximum number of redirection a request can follow.
Set 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.
Set the max WebSocket frame size
Set the max WebSocket message size
Set the max number of WebSockets per endpoint.
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
Set the client name, used when the client is shared, otherwise ignored.
Set a list of remote hosts that are not proxied when the client is configured to use a proxy. This
list serves the same purpose than the JVM nonProxyHosts configuration.
Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.
Set the key/cert store options in pem format.
Set the trust options in pem format
Set the key/cert options in pfx format.
Set the trust options in pfx format
Set whether pipe-lining is enabled on the client
Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
Set 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.
Set the number of event-loop the pool use.
0, the client pool will use the current event-loopThe default size is 0.
Set the protocol version.
Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.
Set the read idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.
If you want change default time unit, use HttpClientOptions
Set the TCP receive buffer size
Set the value of reuse address
Set the value of reuse port.
This is only supported by native transports.Set the TCP send buffer size
Set 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.
Set to true to share the client.
There can be multiple shared clients distinguished by HttpClientOptions, when no specific name is set, the HttpClientOptions is used.
Set whether SO_linger keep alive is enabled
Set whether SSL/TLS is enabled
Set to use SSL engine implementation to use.
Set the SSL handshake timeout, default time unit is seconds.
Set the SSL handshake timeout unit. If not specified, default is seconds.
Enable the TCP_CORK option - only with linux native transport.
Enable the TCP_FASTOPEN option - only with linux native transport.
Set whether TCP keep alive is enabled
Set whether TCP no delay is enabled
Enable the TCP_QUICKACK option - only with linux native transport.
Sets the TCP_USER_TIMEOUT option - only with linux native transport.
Set the tracing policy for the client behavior when Vert.x has tracing enabled.
Set the value of traffic class
Set whether all server certificates should be trusted
Set the trust options.
Set the trust options in jks format, aka Java truststore
Set whether compression is enabled
Set whether the client will offer the WebSocket per-frame deflate compression extension.
Set whether the client will offer the WebSocket per-message deflate compression extension.
Set the ALPN usage.
Set whether hostname verification is enabled
Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.
When a WebSocket is closed, the server should close the TCP connection. This timeout will close the TCP connection on the client when it expires.
Set to 0L closes the TCP connection immediately after receiving the close frame.
Set to a negative value to disable it.
Set whether the client_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered.
Set the WebSocket deflate compression level.
Set whether the server_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered.
Set the write idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is sent within the timeout.
If you want change default time unit, use HttpClientOptions
Generated using TypeDoc
Options describing how an HttpClient will make connections.