class HttpClientOptions extends ClientOptionsBase
Options describing how an io.vertx.scala.core.http.HttpClient will make connections.
- Alphabetic
- By Inheritance
- HttpClientOptions
- ClientOptionsBase
- TCPSSLOptions
- NetworkOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HttpClientOptions(_asJava: core.http.HttpClientOptions)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addCrlPath(value: String): HttpClientOptions
Add a CRL path
Add a CRL path
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addCrlValue(value: Buffer): HttpClientOptions
Add a CRL value
Add a CRL value
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addEnabledCipherSuite(value: String): HttpClientOptions
Add an enabled cipher suite, appended to the ordered suites.
Add an enabled cipher suite, appended to the ordered suites.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addEnabledSecureTransportProtocol(value: String): HttpClientOptions
Sets the list of enabled SSL/TLS protocols.
Sets the list of enabled SSL/TLS protocols.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: core.http.HttpClientOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def getAlpnVersions: Buffer[HttpVersion]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getConnectTimeout: Int
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
getCrlPaths: Buffer[String]
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getCrlValues: Buffer[Buffer]
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def getDecoderInitialBufferSize: Int
- def getDefaultHost: String
- def getDefaultPort: Int
-
def
getEnabledCipherSuites: Set[String]
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getEnabledSecureTransportProtocols: Set[String]
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def getHttp2ConnectionWindowSize: Int
- def getHttp2KeepAliveTimeout: Int
- def getHttp2MaxPoolSize: Int
- def getHttp2MultiplexingLimit: Int
-
def
getIdleTimeout: Int
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getIdleTimeoutUnit: TimeUnit
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def getInitialSettings: Http2Settings
-
def
getJdkSslEngineOptions: JdkSSLEngineOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def getKeepAliveTimeout: Int
-
def
getKeyStoreOptions: JksOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getLocalAddress: String
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
getLogActivity: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
- def getMaxChunkSize: Int
- def getMaxHeaderSize: Int
- def getMaxInitialLineLength: Int
- def getMaxPoolSize: Int
- def getMaxRedirects: Int
- def getMaxWaitQueueSize: Int
- def getMaxWebsocketFrameSize: Int
- def getMaxWebsocketMessageSize: Int
-
def
getMetricsName: String
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
getOpenSslEngineOptions: OpenSSLEngineOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPemKeyCertOptions: PemKeyCertOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPemTrustOptions: PemTrustOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPfxKeyCertOptions: PfxOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPfxTrustOptions: PfxOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def getPipeliningLimit: Int
- def getPoolCleanerPeriod: Int
- def getProtocolVersion: HttpVersion
-
def
getProxyOptions: ProxyOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
getReceiveBufferSize: Int
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getSendBufferSize: Int
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getSoLinger: Int
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getTrafficClass: Int
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getTrustStoreOptions: JksOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def getWebsocketCompressionAllowClientNoContext: Boolean
- def getWebsocketCompressionLevel: Int
- def getWebsocketCompressionRequestServerNoContext: Boolean
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isForceSni: Boolean
- def isHttp2ClearTextUpgrade: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isKeepAlive: Boolean
- def isPipelining: Boolean
-
def
isReuseAddress: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
isReusePort: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
- def isSendUnmaskedFrames: Boolean
-
def
isSsl: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpCork: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpFastOpen: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpKeepAlive: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpNoDelay: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpQuickAck: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTrustAll: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase
- def isTryUseCompression: Boolean
-
def
isUseAlpn: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isUsePooledBuffers: Boolean
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
- def isVerifyHost: Boolean
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
setAlpnVersions(value: Buffer[HttpVersion]): HttpClientOptions
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
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:
- : [ "h2", "http/1.1" ]
- otherwise: [HttpClientOptions]
-
def
setConnectTimeout(value: Int): HttpClientOptions
Set the connect timeout
Set the connect timeout
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
setDecoderInitialBufferSize(value: Int): HttpClientOptions
set to
initialBufferSizeHttpDecoder
the initial buffer of the HttpDecoder. -
def
setDefaultHost(value: String): HttpClientOptions
Set the default host name to be used by this client in requests if none is provided when making the request.
-
def
setDefaultPort(value: Int): HttpClientOptions
Set the default port to be used by this client in requests if none is provided when making the request.
-
def
setEnabledSecureTransportProtocols(value: Set[String]): HttpClientOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setForceSni(value: Boolean): 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. -
def
setHttp2ClearTextUpgrade(value: Boolean): HttpClientOptions
Set to
true
when an h2c connection is established using an HTTP/1.1 upgrade request, andfalse
when an h2c connection is established directly (with prior knowledge). -
def
setHttp2ConnectionWindowSize(value: Int): HttpClientOptions
Set the default HTTP/2 connection window size.
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. -
def
setHttp2KeepAliveTimeout(value: Int): HttpClientOptions
Set the keep alive timeout for HTTP/2 connections, in seconds.
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.
-
def
setHttp2MaxPoolSize(value: Int): HttpClientOptions
Set the maximum pool size for HTTP/2 connections
-
def
setHttp2MultiplexingLimit(value: Int): HttpClientOptions
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.
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. -
def
setIdleTimeout(value: Int): HttpClientOptions
Set the idle timeout, default time unit is seconds.
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 within the timeout.
If you want change default time unit, use HttpClientOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setIdleTimeoutUnit(value: TimeUnit): HttpClientOptions
Set the idle timeout unit.
Set the idle timeout unit. If not specified, default is seconds.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setInitialSettings(value: Http2Settings): HttpClientOptions
Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
-
def
setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpClientOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setKeepAlive(value: Boolean): HttpClientOptions
Set whether keep alive is enabled on the client
-
def
setKeepAliveTimeout(value: Int): HttpClientOptions
Set the keep alive timeout for HTTP/1.x, in seconds.
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.
-
def
setKeyStoreOptions(value: JksOptions): HttpClientOptions
Set the key/cert options in jks format, aka Java keystore.
Set the key/cert options in jks format, aka Java keystore.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setLocalAddress(value: String): HttpClientOptions
Set the local interface to bind for network connections.
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.
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
setLogActivity(value: Boolean): HttpClientOptions
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setMaxChunkSize(value: Int): HttpClientOptions
Set the maximum HTTP chunk size
-
def
setMaxHeaderSize(value: Int): HttpClientOptions
Set the maximum length of all headers for HTTP/1.x .
-
def
setMaxInitialLineLength(value: Int): HttpClientOptions
Set the maximum length of the initial line for HTTP/1.x (e.g.
Set the maximum length of the initial line for HTTP/1.x (e.g.
"HTTP/1.1 200 OK"
) -
def
setMaxPoolSize(value: Int): HttpClientOptions
Set the maximum pool size for connections
-
def
setMaxRedirects(value: Int): HttpClientOptions
Set to
maxRedirects
the maximum number of redirection a request can follow. -
def
setMaxWaitQueueSize(value: Int): HttpClientOptions
Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException.
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.
-
def
setMaxWebsocketFrameSize(value: Int): HttpClientOptions
Set the max websocket frame size
-
def
setMaxWebsocketMessageSize(value: Int): HttpClientOptions
Set the max websocket message size
-
def
setMetricsName(value: String): HttpClientOptions
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpClientOptions
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPemKeyCertOptions(value: PemKeyCertOptions): HttpClientOptions
Set the key/cert store options in pem format.
Set the key/cert store options in pem format.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPemTrustOptions(value: PemTrustOptions): HttpClientOptions
Set the trust options in pem format
Set the trust options in pem format
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPfxKeyCertOptions(value: PfxOptions): HttpClientOptions
Set the key/cert options in pfx format.
Set the key/cert options in pfx format.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPfxTrustOptions(value: PfxOptions): HttpClientOptions
Set the trust options in pfx format
Set the trust options in pfx format
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPipelining(value: Boolean): HttpClientOptions
Set whether pipe-lining is enabled on the client
-
def
setPipeliningLimit(value: Int): HttpClientOptions
Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
-
def
setPoolCleanerPeriod(value: Int): HttpClientOptions
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.
-
def
setProtocolVersion(value: HttpVersion): HttpClientOptions
Set the protocol version.
-
def
setProxyOptions(value: ProxyOptions): HttpClientOptions
Set proxy options for connections via CONNECT proxy (e.g.
Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
setReceiveBufferSize(value: Int): HttpClientOptions
Set the TCP receive buffer size
Set the TCP receive buffer size
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setReuseAddress(value: Boolean): HttpClientOptions
Set the value of reuse address
Set the value of reuse address
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setReusePort(value: Boolean): HttpClientOptions
Set the value of reuse port.
Set the value of reuse port.
This is only supported by native transports.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setSendBufferSize(value: Int): HttpClientOptions
Set the TCP send buffer size
Set the TCP send buffer size
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setSendUnmaskedFrames(value: Boolean): HttpClientOptions
Set true when the client wants to skip frame masking.
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.
-
def
setSoLinger(value: Int): HttpClientOptions
Set whether SO_linger keep alive is enabled
Set whether SO_linger keep alive is enabled
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setSsl(value: Boolean): HttpClientOptions
Set whether SSL/TLS is enabled
Set whether SSL/TLS is enabled
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpCork(value: Boolean): HttpClientOptions
Enable the
TCP_CORK
option - only with linux native transport.Enable the
TCP_CORK
option - only with linux native transport.- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpFastOpen(value: Boolean): HttpClientOptions
Enable the
TCP_FASTOPEN
option - only with linux native transport.Enable the
TCP_FASTOPEN
option - only with linux native transport.- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpKeepAlive(value: Boolean): HttpClientOptions
Set whether TCP keep alive is enabled
Set whether TCP keep alive is enabled
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpNoDelay(value: Boolean): HttpClientOptions
Set whether TCP no delay is enabled
Set whether TCP no delay is enabled
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpQuickAck(value: Boolean): HttpClientOptions
Enable the
TCP_QUICKACK
option - only with linux native transport.Enable the
TCP_QUICKACK
option - only with linux native transport.- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTrafficClass(value: Int): HttpClientOptions
Set the value of traffic class
Set the value of traffic class
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setTrustAll(value: Boolean): HttpClientOptions
Set whether all server certificates should be trusted
Set whether all server certificates should be trusted
- Definition Classes
- HttpClientOptions → ClientOptionsBase
-
def
setTrustStoreOptions(value: JksOptions): HttpClientOptions
Set the trust options in jks format, aka Java truststore
Set the trust options in jks format, aka Java truststore
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTryUseCompression(value: Boolean): HttpClientOptions
Set whether compression is enabled
-
def
setTryUsePerFrameWebsocketCompression(value: Boolean): HttpClientOptions
Set option to offer per frame WebSocket compression.
-
def
setTryUsePerMessageWebsocketCompression(value: Boolean): HttpClientOptions
Set option to offer per message WebSocket compression.
-
def
setUseAlpn(value: Boolean): HttpClientOptions
Set the ALPN usage.
Set the ALPN usage.
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setUsePooledBuffers(value: Boolean): HttpClientOptions
Set whether Netty pooled buffers are enabled
Set whether Netty pooled buffers are enabled
- Definition Classes
- HttpClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setVerifyHost(value: Boolean): HttpClientOptions
Set whether hostname verification is enabled
-
def
setWebsocketCompressionAllowClientNoContext(value: Boolean): HttpClientOptions
Set the WebSocket compression allow client no context option.
-
def
setWebsocketCompressionLevel(value: Int): HttpClientOptions
Set WebSocket compression level
-
def
setWebsocketCompressionRequestServerNoContext(value: Boolean): HttpClientOptions
Set the WebSocket compression server no context option
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )