Package io.vertx.core.net
Class NetClientOptions
- java.lang.Object
-
- io.vertx.core.net.NetworkOptions
-
- io.vertx.core.net.TCPSSLOptions
-
- io.vertx.core.net.ClientOptionsBase
-
- io.vertx.core.net.NetClientOptions
-
- Direct Known Subclasses:
MailConfig,MqttClientOptions,io.vertx.proton.ProtonClientOptions,RabbitMQOptions,StompClientOptions
public class NetClientOptions extends ClientOptionsBase
Options for configuring aNetClient.- Author:
- Tim Fox
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_HOSTNAME_VERIFICATION_ALGORITHMDefault value to determine hostname verification algorithm hostname verification (for SSL/TLS) = ""static intDEFAULT_RECONNECT_ATTEMPTSThe default value for reconnect attempts = 0static longDEFAULT_RECONNECT_INTERVALThe default value for reconnect interval = 1000 msstatic booleanDEFAULT_REGISTER_WRITE_HANDLERWhether a write-handler should be registered by default = false.-
Fields inherited from class io.vertx.core.net.ClientOptionsBase
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME
-
Fields inherited from class io.vertx.core.net.TCPSSLOptions
DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_TCP_USER_TIMEOUT, DEFAULT_WRITE_IDLE_TIMEOUT
-
Fields inherited from class io.vertx.core.net.NetworkOptions
DEFAULT_LOG_ACTIVITY_FORMAT, DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS
-
-
Constructor Summary
Constructors Constructor Description NetClientOptions()The default constructorNetClientOptions(JsonObject json)Create options from JSONNetClientOptions(ClientOptionsBase other)Create an instance copying the values fromotherand using the defaults ofNetClientOptions.NetClientOptions(NetClientOptions other)Copy constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NetClientOptionsaddCrlPath(String crlPath)Add a CRL pathNetClientOptionsaddCrlValue(Buffer crlValue)Add a CRL valueNetClientOptionsaddEnabledCipherSuite(String suite)Add an enabled cipher suite, appended to the ordered suites.NetClientOptionsaddEnabledSecureTransportProtocol(String protocol)Add an enabled SSL/TLS protocols, appended to the ordered protocols.NetClientOptionsaddNonProxyHost(String nonProxyHost)Add ahostto theClientOptionsBase.getNonProxyHosts()list.List<String>getApplicationLayerProtocols()StringgetHostnameVerificationAlgorithm()intgetReconnectAttempts()longgetReconnectInterval()booleanisRegisterWriteHandler()NetClientOptionsremoveEnabledCipherSuite(String suite)Removes an enabled cipher suite from the ordered suites.NetClientOptionsremoveEnabledSecureTransportProtocol(String protocol)Removes an enabled SSL/TLS protocol from the ordered protocols.NetClientOptionssetActivityLogDataFormat(ByteBufFormat activityLogDataFormat)Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.NetClientOptionssetApplicationLayerProtocols(List<String> protocols)Set the list of application-layer protocols to provide to the server during the Application-Layer Protocol Negotiation.NetClientOptionssetConnectTimeout(int connectTimeout)Set the connect timeoutNetClientOptionssetEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)Sets the list of enabled SSL/TLS protocols.NetClientOptionssetHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty StringNetClientOptionssetIdleTimeout(int idleTimeout)Set the idle timeout, default time unit is seconds.NetClientOptionssetIdleTimeoutUnit(TimeUnit idleTimeoutUnit)Set the idle timeout unit.NetClientOptionssetKeyCertOptions(KeyCertOptions options)Set the key/cert options.NetClientOptionssetLocalAddress(String localAddress)Set the local interface to bind for network connections.NetClientOptionssetLogActivity(boolean logEnabled)Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.NetClientOptionssetMetricsName(String metricsName)Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.NetClientOptionssetNonProxyHosts(List<String> nonProxyHosts)Set a list of remote hosts that are not proxied when the client is configured to use a proxy.NetClientOptionssetProxyOptions(ProxyOptions proxyOptions)Set proxy options for connections via CONNECT proxy (e.g.NetClientOptionssetReadIdleTimeout(int idleTimeout)Set the read idle timeout, default time unit is seconds.NetClientOptionssetReceiveBufferSize(int receiveBufferSize)Set the TCP receive buffer sizeNetClientOptionssetReconnectAttempts(int attempts)Set the value of reconnect attemptsNetClientOptionssetReconnectInterval(long interval)Set the reconnect intervalNetClientOptionssetRegisterWriteHandler(boolean registerWriteHandler)Whether a write-handler should be registered on theEventBus.NetClientOptionssetReuseAddress(boolean reuseAddress)Set the value of reuse addressNetClientOptionssetReusePort(boolean reusePort)Set the value of reuse port.NetClientOptionssetSendBufferSize(int sendBufferSize)Set the TCP send buffer sizeNetClientOptionssetSoLinger(int soLinger)Set whether SO_linger keep alive is enabledNetClientOptionssetSsl(boolean ssl)Set whether SSL/TLS is enabledNetClientOptionssetSslEngineOptions(SSLEngineOptions sslEngineOptions)Set to use SSL engine implementation to use.NetClientOptionssetSslHandshakeTimeout(long sslHandshakeTimeout)Set the SSL handshake timeout, default time unit is seconds.NetClientOptionssetSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)Set the SSL handshake timeout unit.NetClientOptionssetTcpCork(boolean tcpCork)Enable theTCP_CORKoption - only with linux native transport.NetClientOptionssetTcpFastOpen(boolean tcpFastOpen)Enable theTCP_FASTOPENoption - only with linux native transport.NetClientOptionssetTcpKeepAlive(boolean tcpKeepAlive)Set whether TCP keep alive is enabledNetClientOptionssetTcpNoDelay(boolean tcpNoDelay)Set whether TCP no delay is enabledNetClientOptionssetTcpQuickAck(boolean tcpQuickAck)Enable theTCP_QUICKACKoption - only with linux native transport.NetClientOptionssetTrafficClass(int trafficClass)Set the value of traffic classNetClientOptionssetTrustAll(boolean trustAll)Set whether all server certificates should be trustedNetClientOptionssetTrustOptions(TrustOptions options)Set the trust options.NetClientOptionssetUseAlpn(boolean useAlpn)Set the ALPN usage.NetClientOptionssetWriteIdleTimeout(int idleTimeout)Set the write idle timeout, default time unit is seconds.JsonObjecttoJson()Convert to JSON-
Methods inherited from class io.vertx.core.net.ClientOptionsBase
getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getOrCreateSSLOptions, getProxyOptions, getSslOptions, isTrustAll, setTcpUserTimeout
-
Methods inherited from class io.vertx.core.net.TCPSSLOptions
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getKeyCertOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTcpUserTimeout, getTrustOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn
-
Methods inherited from class io.vertx.core.net.NetworkOptions
getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort
-
-
-
-
Field Detail
-
DEFAULT_RECONNECT_ATTEMPTS
public static final int DEFAULT_RECONNECT_ATTEMPTS
The default value for reconnect attempts = 0- See Also:
- Constant Field Values
-
DEFAULT_RECONNECT_INTERVAL
public static final long DEFAULT_RECONNECT_INTERVAL
The default value for reconnect interval = 1000 ms- See Also:
- Constant Field Values
-
DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM
public static final String DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM
Default value to determine hostname verification algorithm hostname verification (for SSL/TLS) = ""- See Also:
- Constant Field Values
-
DEFAULT_REGISTER_WRITE_HANDLER
public static final boolean DEFAULT_REGISTER_WRITE_HANDLER
Whether a write-handler should be registered by default = false.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NetClientOptions
public NetClientOptions()
The default constructor
-
NetClientOptions
public NetClientOptions(NetClientOptions other)
Copy constructor- Parameters:
other- the options to copy
-
NetClientOptions
public NetClientOptions(ClientOptionsBase other)
Create an instance copying the values fromotherand using the defaults ofNetClientOptions.- Parameters:
other- the options to copy
-
NetClientOptions
public NetClientOptions(JsonObject json)
Create options from JSON- Parameters:
json- the JSON
-
-
Method Detail
-
setSendBufferSize
public NetClientOptions setSendBufferSize(int sendBufferSize)
Description copied from class:NetworkOptionsSet the TCP send buffer size- Overrides:
setSendBufferSizein classClientOptionsBase- Parameters:
sendBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReceiveBufferSize
public NetClientOptions setReceiveBufferSize(int receiveBufferSize)
Description copied from class:NetworkOptionsSet the TCP receive buffer size- Overrides:
setReceiveBufferSizein classClientOptionsBase- Parameters:
receiveBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReuseAddress
public NetClientOptions setReuseAddress(boolean reuseAddress)
Description copied from class:NetworkOptionsSet the value of reuse address- Overrides:
setReuseAddressin classClientOptionsBase- Parameters:
reuseAddress- the value of reuse address- Returns:
- a reference to this, so the API can be used fluently
-
setReusePort
public NetClientOptions setReusePort(boolean reusePort)
Description copied from class:NetworkOptionsSet the value of reuse port. This is only supported by native transports.- Overrides:
setReusePortin classClientOptionsBase- Parameters:
reusePort- the value of reuse port- Returns:
- a reference to this, so the API can be used fluently
-
setTrafficClass
public NetClientOptions setTrafficClass(int trafficClass)
Description copied from class:NetworkOptionsSet the value of traffic class- Overrides:
setTrafficClassin classClientOptionsBase- Parameters:
trafficClass- the value of traffic class- Returns:
- a reference to this, so the API can be used fluently
-
setTcpNoDelay
public NetClientOptions setTcpNoDelay(boolean tcpNoDelay)
Description copied from class:TCPSSLOptionsSet whether TCP no delay is enabled- Overrides:
setTcpNoDelayin classClientOptionsBase- Parameters:
tcpNoDelay- true if TCP no delay is enabled (Nagle disabled)- Returns:
- a reference to this, so the API can be used fluently
-
setTcpKeepAlive
public NetClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
Description copied from class:TCPSSLOptionsSet whether TCP keep alive is enabled- Overrides:
setTcpKeepAlivein classClientOptionsBase- Parameters:
tcpKeepAlive- true if TCP keep alive is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setSoLinger
public NetClientOptions setSoLinger(int soLinger)
Description copied from class:TCPSSLOptionsSet whether SO_linger keep alive is enabled- Overrides:
setSoLingerin classClientOptionsBase- Parameters:
soLinger- true if SO_linger is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeout
public NetClientOptions setIdleTimeout(int idleTimeout)
Description copied from class:TCPSSLOptionsSet 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, useTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)- Overrides:
setIdleTimeoutin classClientOptionsBase- Parameters:
idleTimeout- the timeout- Returns:
- a reference to this, so the API can be used fluently
-
setReadIdleTimeout
public NetClientOptions setReadIdleTimeout(int idleTimeout)
Description copied from class:TCPSSLOptionsSet 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, useTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)- Overrides:
setReadIdleTimeoutin classClientOptionsBase- Parameters:
idleTimeout- the read timeout- Returns:
- a reference to this, so the API can be used fluently
-
setWriteIdleTimeout
public NetClientOptions setWriteIdleTimeout(int idleTimeout)
Description copied from class:TCPSSLOptionsSet 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, useTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)- Overrides:
setWriteIdleTimeoutin classClientOptionsBase- Parameters:
idleTimeout- the write timeout- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeoutUnit
public NetClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Description copied from class:TCPSSLOptionsSet the idle timeout unit. If not specified, default is seconds.- Overrides:
setIdleTimeoutUnitin classClientOptionsBase- Parameters:
idleTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
setSsl
public NetClientOptions setSsl(boolean ssl)
Description copied from class:TCPSSLOptionsSet whether SSL/TLS is enabled- Overrides:
setSslin classClientOptionsBase- Parameters:
ssl- true if enabled- Returns:
- a reference to this, so the API can be used fluently
-
setKeyCertOptions
public NetClientOptions setKeyCertOptions(KeyCertOptions options)
Description copied from class:TCPSSLOptionsSet the key/cert options.- Overrides:
setKeyCertOptionsin classClientOptionsBase- Parameters:
options- the key store options- Returns:
- a reference to this, so the API can be used fluently
-
setTrustOptions
public NetClientOptions setTrustOptions(TrustOptions options)
Description copied from class:TCPSSLOptionsSet the trust options.- Overrides:
setTrustOptionsin classClientOptionsBase- Parameters:
options- the trust options- Returns:
- a reference to this, so the API can be used fluently
-
addEnabledCipherSuite
public NetClientOptions addEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsAdd an enabled cipher suite, appended to the ordered suites.- Overrides:
addEnabledCipherSuitein classClientOptionsBase- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
- See Also:
TCPSSLOptions.getEnabledCipherSuites()
-
removeEnabledCipherSuite
public NetClientOptions removeEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsRemoves an enabled cipher suite from the ordered suites.- Overrides:
removeEnabledCipherSuitein classClientOptionsBase- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
-
addEnabledSecureTransportProtocol
public NetClientOptions addEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsAdd an enabled SSL/TLS protocols, appended to the ordered protocols.- Overrides:
addEnabledSecureTransportProtocolin classClientOptionsBase- Parameters:
protocol- the SSL/TLS protocol to enable- Returns:
- a reference to this, so the API can be used fluently
-
removeEnabledSecureTransportProtocol
public NetClientOptions removeEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsRemoves an enabled SSL/TLS protocol from the ordered protocols.- Overrides:
removeEnabledSecureTransportProtocolin classClientOptionsBase- Parameters:
protocol- the SSL/TLS protocol to disable- Returns:
- a reference to this, so the API can be used fluently
-
setUseAlpn
public NetClientOptions setUseAlpn(boolean useAlpn)
Description copied from class:TCPSSLOptionsSet the ALPN usage.- Overrides:
setUseAlpnin classClientOptionsBase- Parameters:
useAlpn- true when Application-Layer Protocol Negotiation should be used
-
setSslEngineOptions
public NetClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Description copied from class:TCPSSLOptionsSet to use SSL engine implementation to use.- Overrides:
setSslEngineOptionsin classClientOptionsBase- Parameters:
sslEngineOptions- the ssl engine to use- Returns:
- a reference to this, so the API can be used fluently
-
setTcpFastOpen
public NetClientOptions setTcpFastOpen(boolean tcpFastOpen)
Description copied from class:TCPSSLOptionsEnable theTCP_FASTOPENoption - only with linux native transport.- Overrides:
setTcpFastOpenin classClientOptionsBase- Parameters:
tcpFastOpen- the fast open value
-
setTcpCork
public NetClientOptions setTcpCork(boolean tcpCork)
Description copied from class:TCPSSLOptionsEnable theTCP_CORKoption - only with linux native transport.- Overrides:
setTcpCorkin classClientOptionsBase- Parameters:
tcpCork- the cork value
-
setTcpQuickAck
public NetClientOptions setTcpQuickAck(boolean tcpQuickAck)
Description copied from class:TCPSSLOptionsEnable theTCP_QUICKACKoption - only with linux native transport.- Overrides:
setTcpQuickAckin classClientOptionsBase- Parameters:
tcpQuickAck- the quick ack value
-
addCrlPath
public NetClientOptions addCrlPath(String crlPath) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL path- Overrides:
addCrlPathin classClientOptionsBase- Parameters:
crlPath- the path- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
addCrlValue
public NetClientOptions addCrlValue(Buffer crlValue) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL value- Overrides:
addCrlValuein classClientOptionsBase- Parameters:
crlValue- the value- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
setTrustAll
public NetClientOptions setTrustAll(boolean trustAll)
Description copied from class:ClientOptionsBaseSet whether all server certificates should be trusted- Overrides:
setTrustAllin classClientOptionsBase- Parameters:
trustAll- true if all should be trusted- Returns:
- a reference to this, so the API can be used fluently
-
setConnectTimeout
public NetClientOptions setConnectTimeout(int connectTimeout)
Description copied from class:ClientOptionsBaseSet the connect timeout- Overrides:
setConnectTimeoutin classClientOptionsBase- Parameters:
connectTimeout- connect timeout, in ms- Returns:
- a reference to this, so the API can be used fluently
-
setMetricsName
public NetClientOptions setMetricsName(String metricsName)
Description copied from class:ClientOptionsBaseSet the metrics name identifying the reported metrics, useful for grouping metrics with the same name.- Overrides:
setMetricsNamein classClientOptionsBase- Parameters:
metricsName- the metrics name- Returns:
- a reference to this, so the API can be used fluently
-
setReconnectAttempts
public NetClientOptions setReconnectAttempts(int attempts)
Set the value of reconnect attempts- Parameters:
attempts- the maximum number of reconnect attempts- Returns:
- a reference to this, so the API can be used fluently
-
getReconnectAttempts
public int getReconnectAttempts()
- Returns:
- the value of reconnect attempts
-
setReconnectInterval
public NetClientOptions setReconnectInterval(long interval)
Set the reconnect interval- Parameters:
interval- the reconnect interval in ms- Returns:
- a reference to this, so the API can be used fluently
-
getHostnameVerificationAlgorithm
public String getHostnameVerificationAlgorithm()
- Returns:
- the value of the hostname verification algorithm
-
setHostnameVerificationAlgorithm
public NetClientOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String- Parameters:
hostnameVerificationAlgorithm- should be HTTPS, LDAPS or an empty String- Returns:
- a reference to this, so the API can be used fluently
-
getApplicationLayerProtocols
public List<String> getApplicationLayerProtocols()
- Returns:
- the list of application-layer protocols send during the Application-Layer Protocol Negotiation.
-
setApplicationLayerProtocols
public NetClientOptions setApplicationLayerProtocols(List<String> protocols)
Set the list of application-layer protocols to provide to the server during the Application-Layer Protocol Negotiation.- Parameters:
protocols- the protocols- Returns:
- a reference to this, so the API can be used fluently
-
getReconnectInterval
public long getReconnectInterval()
- Returns:
- the value of reconnect interval
-
setLogActivity
public NetClientOptions setLogActivity(boolean logEnabled)
Description copied from class:NetworkOptionsSet to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.- Overrides:
setLogActivityin classClientOptionsBase- Parameters:
logEnabled- true for logging the network activity- Returns:
- a reference to this, so the API can be used fluently
-
setActivityLogDataFormat
public NetClientOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat)
Description copied from class:NetworkOptionsSet the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.- Overrides:
setActivityLogDataFormatin classClientOptionsBase- Parameters:
activityLogDataFormat- the format to use- Returns:
- a reference to this, so the API can be used fluently
-
setProxyOptions
public NetClientOptions setProxyOptions(ProxyOptions proxyOptions)
Description copied from class:ClientOptionsBaseSet proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.- Overrides:
setProxyOptionsin classClientOptionsBase- Parameters:
proxyOptions- proxy options object- Returns:
- a reference to this, so the API can be used fluently
-
setNonProxyHosts
public NetClientOptions setNonProxyHosts(List<String> nonProxyHosts)
Description copied from class:ClientOptionsBaseSet 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 JVMnonProxyHostsconfiguration.Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.
- Overrides:
setNonProxyHostsin classClientOptionsBase- Parameters:
nonProxyHosts- the list of non proxies hosts- Returns:
- a reference to this, so the API can be used fluently
-
addNonProxyHost
public NetClientOptions addNonProxyHost(String nonProxyHost)
Description copied from class:ClientOptionsBaseAdd ahostto theClientOptionsBase.getNonProxyHosts()list.- Overrides:
addNonProxyHostin classClientOptionsBase- Parameters:
nonProxyHost- the added host- Returns:
- a reference to this, so the API can be used fluently
-
setLocalAddress
public NetClientOptions setLocalAddress(String localAddress)
Description copied from class:ClientOptionsBaseSet 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.- Overrides:
setLocalAddressin classClientOptionsBase- Parameters:
localAddress- the local address- Returns:
- a reference to this, so the API can be used fluently
-
setEnabledSecureTransportProtocols
public NetClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
Description copied from class:TCPSSLOptionsSets the list of enabled SSL/TLS protocols.- Overrides:
setEnabledSecureTransportProtocolsin classTCPSSLOptions- Parameters:
enabledSecureTransportProtocols- the SSL/TLS protocols to enable- Returns:
- a reference to this, so the API can be used fluently
-
setSslHandshakeTimeout
public NetClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)
Description copied from class:TCPSSLOptionsSet the SSL handshake timeout, default time unit is seconds.- Overrides:
setSslHandshakeTimeoutin classTCPSSLOptions- Parameters:
sslHandshakeTimeout- the SSL handshake timeout to set, in milliseconds- Returns:
- a reference to this, so the API can be used fluently
-
setSslHandshakeTimeoutUnit
public NetClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
Description copied from class:TCPSSLOptionsSet the SSL handshake timeout unit. If not specified, default is seconds.- Overrides:
setSslHandshakeTimeoutUnitin classTCPSSLOptions- Parameters:
sslHandshakeTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
toJson
public JsonObject toJson()
Description copied from class:ClientOptionsBaseConvert to JSON- Overrides:
toJsonin classClientOptionsBase- Returns:
- the JSON
-
isRegisterWriteHandler
public boolean isRegisterWriteHandler()
- Returns:
trueif a write-handler should be registered on theEventBus, otherwisefalse
-
setRegisterWriteHandler
public NetClientOptions setRegisterWriteHandler(boolean registerWriteHandler)
Whether a write-handler should be registered on theEventBus.Defaults to
false.- Parameters:
registerWriteHandler- true to register a write-handler- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetSocket.writeHandlerID()
-
-