public abstract Class ClientOptionsBase

The default value of connect timeout = 60000 ms

The default value of the client metrics = "":

The default value of whether all servers (SSL/TLS) should be trusted = false

Overrides io.vertx.core.net.TCPSSLOptions.addCrlPath.

Doc from io.vertx.core.net.TCPSSLOptions.addCrlPath.

Add a CRL path

Parameters

crlPath:String

the path

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.addCrlValue.

Doc from io.vertx.core.net.TCPSSLOptions.addCrlValue.

Add a CRL value

Parameters

crlValue:Buffer

the value

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.addEnabledCipherSuite.

Doc from io.vertx.core.net.TCPSSLOptions.addEnabledCipherSuite.

Add an enabled cipher suite, appended to the ordered suites.

Parameters

suite:String

the suite

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.addEnabledSecureTransportProtocol.

Doc from io.vertx.core.net.TCPSSLOptions.addEnabledSecureTransportProtocol.

Add an enabled SSL/TLS protocols, appended to the ordered protocols.

Parameters

protocol:String

the SSL/TLS protocol to enable

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Add a host to the getNonProxyHosts() list.

Parameters

host:String

the added host

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Returns:int

the value of connect timeout

Returns:String

the local interface to bind for network connections.

Returns:String

the metrics name identifying the reported metrics.

Returns:List<String>

the list of non proxies hosts

Get proxy options for connections

Returns:ProxyOptions

proxy options

Returns:boolean

true if all server certificates should be trusted

Overrides io.vertx.core.net.TCPSSLOptions.removeEnabledCipherSuite.

Doc from io.vertx.core.net.TCPSSLOptions.removeEnabledCipherSuite.

Removes an enabled cipher suite from the ordered suites.

Parameters

suite:String

the suite

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.removeEnabledSecureTransportProtocol.

Doc from io.vertx.core.net.TCPSSLOptions.removeEnabledSecureTransportProtocol.

Removes an enabled SSL/TLS protocol from the ordered protocols.

Parameters

protocol:String

the SSL/TLS protocol to disable

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setActivityLogDataFormat.

Doc from io.vertx.core.net.NetworkOptions.setActivityLogDataFormat.

Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

Parameters

activityLogDataFormat:ByteBufFormat

the format to use

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Set the connect timeout

Parameters

connectTimeout:int

connect timeout, in ms

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Overrides io.vertx.core.net.TCPSSLOptions.setIdleTimeout.

Doc from io.vertx.core.net.TCPSSLOptions.setIdleTimeout.

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 setIdleTimeoutUnit(TimeUnit)

Parameters

idleTimeout:int

the timeout

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setIdleTimeoutUnit.

Doc from io.vertx.core.net.TCPSSLOptions.setIdleTimeoutUnit.

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

Parameters

idleTimeoutUnit:TimeUnit

specify time unit.

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setJdkSslEngineOptions.

Annotations

@Deprecated

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setKeyCertOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setKeyCertOptions.

Set the key/cert options.

Parameters

options:KeyCertOptions

the key store options

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setKeyStoreOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setKeyStoreOptions.

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

Parameters

options:JksOptions

the key store in jks format

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Deprecated

@Override

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.

Parameters

localAddress:String

the local address

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Overrides io.vertx.core.net.TCPSSLOptions.setLogActivity.

Doc from io.vertx.core.net.NetworkOptions.setLogActivity.

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

Parameters

logEnabled:boolean

true for logging the network activity

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

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

Parameters

metricsName:String

the metrics name

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

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.

Parameters

nonProxyHosts:List<String>

the list of non proxies hosts

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Overrides io.vertx.core.net.TCPSSLOptions.setOpenSslEngineOptions.

Annotations

@Deprecated

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setPemKeyCertOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setPemKeyCertOptions.

Set the key/cert store options in pem format.

Parameters

options:PemKeyCertOptions

the options in pem format

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Deprecated

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setPemTrustOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setPemTrustOptions.

Set the trust options in pem format

Parameters

options:PemTrustOptions

the trust options in pem format

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Deprecated

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setPfxKeyCertOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setPfxKeyCertOptions.

Set the key/cert options in pfx format.

Parameters

options:PfxOptions

the key cert options in pfx format

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Deprecated

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setPfxTrustOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setPfxTrustOptions.

Set the trust options in pfx format

Parameters

options:PfxOptions

the trust options in pfx format

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Deprecated

@Override

Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

Parameters

proxyOptions:ProxyOptions

proxy options object

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Overrides io.vertx.core.net.TCPSSLOptions.setReadIdleTimeout.

Doc from io.vertx.core.net.TCPSSLOptions.setReadIdleTimeout.

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 setIdleTimeoutUnit(TimeUnit)

Parameters

idleTimeout:int

the read timeout

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setReceiveBufferSize.

Doc from io.vertx.core.net.NetworkOptions.setReceiveBufferSize.

Set the TCP receive buffer size

Parameters

receiveBufferSize:int

the buffers size, in bytes

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setReuseAddress.

Doc from io.vertx.core.net.NetworkOptions.setReuseAddress.

Set the value of reuse address

Parameters

reuseAddress:boolean

the value of reuse address

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setReusePort.

Doc from io.vertx.core.net.NetworkOptions.setReusePort.

Set the value of reuse port.

This is only supported by native transports.

Parameters

reusePort:boolean

the value of reuse port

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setSendBufferSize.

Doc from io.vertx.core.net.NetworkOptions.setSendBufferSize.

Set the TCP send buffer size

Parameters

sendBufferSize:int

the buffers size, in bytes

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setSoLinger.

Doc from io.vertx.core.net.TCPSSLOptions.setSoLinger.

Set whether SO_linger keep alive is enabled

Parameters

soLinger:int

true if SO_linger is enabled

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setSsl.

Doc from io.vertx.core.net.TCPSSLOptions.setSsl.

Set whether SSL/TLS is enabled

Parameters

ssl:boolean

true if enabled

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setSslEngineOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setSslEngineOptions.

Set to use SSL engine implementation to use.

Parameters

sslEngineOptions:SSLEngineOptions

the ssl engine to use

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTcpCork.

Doc from io.vertx.core.net.TCPSSLOptions.setTcpCork.

Enable the TCP_CORK option - only with linux native transport.

Parameters

tcpCork:boolean

the cork value

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTcpFastOpen.

Doc from io.vertx.core.net.TCPSSLOptions.setTcpFastOpen.

Enable the TCP_FASTOPEN option - only with linux native transport.

Parameters

tcpFastOpen:boolean

the fast open value

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTcpKeepAlive.

Doc from io.vertx.core.net.TCPSSLOptions.setTcpKeepAlive.

Set whether TCP keep alive is enabled

Parameters

tcpKeepAlive:boolean

true if TCP keep alive is enabled

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTcpNoDelay.

Doc from io.vertx.core.net.TCPSSLOptions.setTcpNoDelay.

Set whether TCP no delay is enabled

Parameters

tcpNoDelay:boolean

true if TCP no delay is enabled (Nagle disabled)

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTcpQuickAck.

Doc from io.vertx.core.net.TCPSSLOptions.setTcpQuickAck.

Enable the TCP_QUICKACK option - only with linux native transport.

Parameters

tcpQuickAck:boolean

the quick ack value

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTcpUserTimeout.

Doc from io.vertx.core.net.TCPSSLOptions.setTcpUserTimeout.

Sets the TCP_USER_TIMEOUT option - only with linux native transport.

Parameters

tcpUserTimeout:int

the tcp user timeout value

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTrafficClass.

Doc from io.vertx.core.net.NetworkOptions.setTrafficClass.

Set the value of traffic class

Parameters

trafficClass:int

the value of traffic class

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Set whether all server certificates should be trusted

Parameters

trustAll:boolean

true if all should be trusted

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Overrides io.vertx.core.net.TCPSSLOptions.setTrustOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setTrustOptions.

Set the trust options.

Parameters

options:TrustOptions

the trust options

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setTrustStoreOptions.

Doc from io.vertx.core.net.TCPSSLOptions.setTrustStoreOptions.

Set the trust options in jks format, aka Java truststore

Parameters

options:JksOptions

the trust options in jks format

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Deprecated

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setUseAlpn.

Doc from io.vertx.core.net.TCPSSLOptions.setUseAlpn.

Set the ALPN usage.

Parameters

useAlpn:boolean

true when Application-Layer Protocol Negotiation should be used

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.setWriteIdleTimeout.

Doc from io.vertx.core.net.TCPSSLOptions.setWriteIdleTimeout.

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 setIdleTimeoutUnit(TimeUnit)

Parameters

idleTimeout:int

the write timeout

Returns:ClientOptionsBase

a reference to this, so the API can be used fluently

Annotations

@Override

Overrides io.vertx.core.net.TCPSSLOptions.toJson.

Convert to JSON

Returns:JsonObject

the JSON