vertx-lang-scala-docs_2.12 3.6.2 API - io.vertx.scala.ext.web.client.WebClientOptions

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]

Definition Classes: WebClientOptions → HttpClientOptions

def setConnectTimeout(value: Int): WebClientOptions

Set the connect timeout

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase

def setDecoderInitialBufferSize(value: Int): WebClientOptions

set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

Definition Classes: WebClientOptions → HttpClientOptions

def setDefaultHost(value: String): WebClientOptions

Set the default host name to be used by this client in requests if none is provided when making the request.

Definition Classes: WebClientOptions → HttpClientOptions

def setDefaultPort(value: Int): WebClientOptions

Set the default port to be used by this client in requests if none is provided when making the request.

Definition Classes: WebClientOptions → HttpClientOptions

def setEnabledSecureTransportProtocols(value: Set[String]): WebClientOptions

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setFollowRedirects(value: Boolean): WebClientOptions

Configure the default behavior of the client to follow HTTP 30x redirections.

def setForceSni(value: Boolean): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setHttp2ClearTextUpgrade(value: Boolean): WebClientOptions

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).

Definition Classes: WebClientOptions → HttpClientOptions

def setHttp2ConnectionWindowSize(value: Int): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setHttp2KeepAliveTimeout(value: Int): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setHttp2MaxPoolSize(value: Int): WebClientOptions

Set the maximum pool size for HTTP/2 connections

Definition Classes: WebClientOptions → HttpClientOptions

def setHttp2MultiplexingLimit(value: Int): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setIdleTimeout(value: Int): WebClientOptions

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: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setIdleTimeoutUnit(value: TimeUnit): WebClientOptions

Set the idle timeout unit.

Set the idle timeout unit. If not specified, default is seconds.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setInitialSettings(value: Http2Settings): WebClientOptions

Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

Definition Classes: WebClientOptions → HttpClientOptions

def setJdkSslEngineOptions(value: JdkSSLEngineOptions): WebClientOptions

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setKeepAlive(value: Boolean): WebClientOptions

Set whether keep alive is enabled on the client

Definition Classes: WebClientOptions → HttpClientOptions

def setKeepAliveTimeout(value: Int): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setKeyStoreOptions(value: JksOptions): WebClientOptions

Set the key/cert options in jks format, aka Java keystore.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setLocalAddress(value: String): WebClientOptions

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: WebClientOptions → HttpClientOptions → ClientOptionsBase

def setLogActivity(value: Boolean): WebClientOptions

Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setMaxChunkSize(value: Int): WebClientOptions

Set the maximum HTTP chunk size

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxHeaderSize(value: Int): WebClientOptions

Set the maximum length of all headers for HTTP/1.x .

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxInitialLineLength(value: Int): WebClientOptions

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")

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxPoolSize(value: Int): WebClientOptions

Set the maximum pool size for connections

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxRedirects(value: Int): WebClientOptions

Set to maxRedirects the maximum number of redirection a request can follow.

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxWaitQueueSize(value: Int): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxWebsocketFrameSize(value: Int): WebClientOptions

Set the max websocket frame size

Definition Classes: WebClientOptions → HttpClientOptions

def setMaxWebsocketMessageSize(value: Int): WebClientOptions

Set the max websocket message size

Definition Classes: WebClientOptions → HttpClientOptions

def setMetricsName(value: String): WebClientOptions

Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase

def setOpenSslEngineOptions(value: OpenSSLEngineOptions): WebClientOptions

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPemKeyCertOptions(value: PemKeyCertOptions): WebClientOptions

Set the key/cert store options in pem format.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPemTrustOptions(value: PemTrustOptions): WebClientOptions

Set the trust options in pem format

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPfxKeyCertOptions(value: PfxOptions): WebClientOptions

Set the key/cert options in pfx format.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPfxTrustOptions(value: PfxOptions): WebClientOptions

Set the trust options in pfx format

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions

def setPipelining(value: Boolean): WebClientOptions

Set whether pipe-lining is enabled on the client

Definition Classes: WebClientOptions → HttpClientOptions

def setPipeliningLimit(value: Int): WebClientOptions

Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

Definition Classes: WebClientOptions → HttpClientOptions

def setPoolCleanerPeriod(value: Int): WebClientOptions

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.

Definition Classes: WebClientOptions → HttpClientOptions

def setProtocolVersion(value: HttpVersion): WebClientOptions

Set the protocol version.

Definition Classes: WebClientOptions → HttpClientOptions

def setProxyOptions(value: ProxyOptions): WebClientOptions

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: WebClientOptions → HttpClientOptions → ClientOptionsBase

def setReceiveBufferSize(value: Int): WebClientOptions

Set the TCP receive buffer size

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setReuseAddress(value: Boolean): WebClientOptions

Set the value of reuse address

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setReusePort(value: Boolean): WebClientOptions

Set the value of reuse port.

This is only supported by native transports.

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setSendBufferSize(value: Int): WebClientOptions

Set the TCP send buffer size

Definition Classes: WebClientOptions → HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions

def setSendUnmaskedFrames(value: Boolean): WebClientOptions

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.