Vert.x 4.5.13 · io.vertx.core.net.TCPSSLOptions · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final List<String>	DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS See `SSLOptions#DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS`
public static final int	DEFAULT_IDLE_TIMEOUT Default idle timeout = 0
public static final TimeUnit	DEFAULT_IDLE_TIMEOUT_TIME_UNIT Default idle time unit = SECONDS
public static final int	DEFAULT_READ_IDLE_TIMEOUT Default read idle timeout = 0
public static final int	DEFAULT_SO_LINGER The default value of SO_linger = -1
public static final boolean	DEFAULT_SSL SSL enable by default = false
public static final SSLEngineOptions	DEFAULT_SSL_ENGINE The default SSL engine options = null (autoguess)
public static final long	DEFAULT_SSL_HANDSHAKE_TIMEOUT See `SSLOptions#DEFAULT_SSL_HANDSHAKE_TIMEOUT`
public static final TimeUnit	DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT See `SSLOptions#DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT`
public static final boolean	DEFAULT_TCP_CORK The default TCP_CORK value = false
public static final boolean	DEFAULT_TCP_FAST_OPEN The default TCP_FASTOPEN value = false
public static final int	DEFAULT_TCP_KEEAPLIVE_INTERVAL_SECONDS Default value for tcp keepalive interval -1 defaults to OS settings
public static final boolean	DEFAULT_TCP_KEEP_ALIVE The default value of TCP keep alive = false
public static final int	DEFAULT_TCP_KEEPALIVE_COUNT Default value for tcp keepalive count -1 defaults to OS settings
public static final int	DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS Default value for tcp keepalive idle time -1 defaults to OS settings
public static final boolean	DEFAULT_TCP_NO_DELAY The default value of TCP-no-delay = true (Nagle disabled)
public static final boolean	DEFAULT_TCP_QUICKACK The default TCP_QUICKACK value = false
public static final int	DEFAULT_TCP_USER_TIMEOUT The default TCP_USER_TIMEOUT value in milliseconds = 0 When the default value of 0 is used, TCP will use the system default.
public static final boolean	DEFAULT_USE_ALPN See `SSLOptions#DEFAULT_USE_ALPN`
public static final int	DEFAULT_WRITE_IDLE_TIMEOUT Default write idle timeout = 0
private int	idleTimeout
private TimeUnit	idleTimeoutUnit
private int	readIdleTimeout
private int	soLinger
private boolean	ssl
private SSLEngineOptions	sslEngineOptions
private SSLOptions	sslOptions
private boolean	tcpCork
private boolean	tcpFastOpen
private boolean	tcpKeepAlive
private int	tcpKeepAliveCount
private int	tcpKeepAliveIdleSeconds
private int	tcpKeepAliveIntervalSeconds
private boolean	tcpNoDelay
private boolean	tcpQuickAck
private int	tcpUserTimeout
private int	writeIdleTimeout

Inherited from 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

Access	Constructor and Description
public	TCPSSLOptions() Default constructor
public	TCPSSLOptions(TCPSSLOptions the options to copy other) Copy constructor
public	TCPSSLOptions(JsonObject the JSON json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Create options from JSON

Method Summary

Modifier and Type	Method and Description
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently addCrlPath(String the path crlPath) Add a CRL path
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently addCrlValue(Buffer the value crlValue) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Add a CRL value
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently addEnabledCipherSuite(String the suite suite) Add an enabled cipher suite, appended to the ordered suites.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently addEnabledSecureTransportProtocol(String the SSL/TLS protocol to enable protocol) Add an enabled SSL/TLS protocols, appended to the ordered protocols.
public List<String>	Returns: the CRL (Certificate revocation list) paths getCrlPaths()
public List<Buffer>	Returns: the list of values getCrlValues() Get the CRL values
public Set<String>	Returns: the enabled cipher suites getEnabledCipherSuites() Return an ordered set of the cipher suites.
public Set<String>	Returns: the enabled protocols getEnabledSecureTransportProtocols() Returns the enabled SSL/TLS protocols
public int	Returns: the idle timeout, in time unit specified by `getIdleTimeoutUnit()`. getIdleTimeout()
public TimeUnit	Returns: the idle timeout unit. getIdleTimeoutUnit()
public JdkSSLEngineOptions	getJdkSslEngineOptions() Deprecated instead use `getSslEngineOptions()`
public KeyCertOptions	Returns: the key/cert options getKeyCertOptions()
public JksOptions	Returns: the key/cert options in jks format, aka Java keystore. getKeyStoreOptions() Deprecated instead use `getKeyCertOptions()` Get the key/cert options in jks format, aka Java keystore.
public OpenSSLEngineOptions	getOpenSslEngineOptions() Deprecated instead use `getSslEngineOptions()`
public PemKeyCertOptions	Returns: the key/cert store options in pem format. getPemKeyCertOptions() Deprecated instead use `getKeyCertOptions()` Get the key/cert store options in pem format.
public PemTrustOptions	Returns: the trust options in pem format getPemTrustOptions() Deprecated instead use `getTrustOptions()` Get the trust options in pem format
public PfxOptions	Returns: the key/cert options in pfx format. getPfxKeyCertOptions() Deprecated instead use `getKeyCertOptions()` Get the key/cert options in pfx format.
public PfxOptions	Returns: the trust options in pfx format getPfxTrustOptions() Deprecated instead use `getTrustOptions()` Get the trust options in pfx format
public int	Returns: the read idle timeout, in time unit specified by `getIdleTimeoutUnit()`. getReadIdleTimeout()
public int	Returns: is SO_linger enabled getSoLinger()
public SSLEngineOptions	Returns: the SSL engine implementation to use getSslEngineOptions()
public long	Returns: the SSL handshake timeout, in time unit specified by `getSslHandshakeTimeoutUnit()`. getSslHandshakeTimeout()
public TimeUnit	Returns: the SSL handshake timeout unit. getSslHandshakeTimeoutUnit()
public SSLOptions	getSslOptions()
public int	Returns: the maximum number of keepalive probes TCP should send before dropping the connection. getTcpKeepAliveCount()
public int	Returns: the time in seconds the connection needs to remain idle before TCP starts sending keepalive probes getTcpKeepAliveIdleSeconds()
public int	Returns: the time in seconds between individual keepalive probes. getTcpKeepAliveIntervalSeconds()
public int	Returns: the `TCP_USER_TIMEOUT` value getTcpUserTimeout()
public TrustOptions	Returns: the trust options getTrustOptions()
public JksOptions	Returns: the trust options in jks format, aka Java truststore getTrustStoreOptions() Deprecated instead use `getTrustOptions()` Get the trust options in jks format, aka Java truststore
public int	Returns: the write idle timeout, in time unit specified by `getIdleTimeoutUnit()`. getWriteIdleTimeout()
private void	init()
public boolean	Returns: is SSL/TLS enabled? isSsl()
public boolean	Returns: wether `TCP_CORK` option is enabled isTcpCork()
public boolean	Returns: wether `TCP_FASTOPEN` option is enabled isTcpFastOpen()
public boolean	Returns: is TCP keep alive enabled? isTcpKeepAlive()
public boolean	Returns: TCP no delay enabled ? isTcpNoDelay()
public boolean	Returns: wether `TCP_QUICKACK` option is enabled isTcpQuickAck()
public boolean	Returns: whether to use or not Application-Layer Protocol Negotiation isUseAlpn()
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently removeEnabledCipherSuite(String the suite suite) Removes an enabled cipher suite from the ordered suites.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently removeEnabledSecureTransportProtocol(String the SSL/TLS protocol to disable protocol) Removes an enabled SSL/TLS protocol from the ordered protocols.
public TCPSSLOptions	setActivityLogDataFormat(ByteBufFormat the format to use activityLogDataFormat) Overrides 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.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setEnabledSecureTransportProtocols(Set<String> the SSL/TLS protocols to enable enabledSecureTransportProtocols) Sets the list of enabled SSL/TLS protocols.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setIdleTimeout(int the timeout idleTimeout) Set the idle timeout, default time unit is seconds.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setIdleTimeoutUnit(TimeUnit specify time unit. idleTimeoutUnit) Set the idle timeout unit.
public TCPSSLOptions	setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions) Deprecated instead use `setSslEngineOptions(SSLEngineOptions)`
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setKeyCertOptions(KeyCertOptions the key store options options) Set the key/cert options.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setKeyStoreOptions(JksOptions the key store in jks format options) Deprecated instead use `setKeyCertOptions(KeyCertOptions)` Set the key/cert options in jks format, aka Java keystore.
public TCPSSLOptions	setLogActivity(boolean true for logging the network activity logEnabled) Overrides 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.
public TCPSSLOptions	setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions) Deprecated instead use `setSslEngineOptions(SSLEngineOptions)`
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setPemKeyCertOptions(PemKeyCertOptions the options in pem format options) Deprecated instead use `setKeyCertOptions(KeyCertOptions)` Set the key/cert store options in pem format.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setPemTrustOptions(PemTrustOptions the trust options in pem format options) Deprecated instead use `setTrustOptions(TrustOptions)` Set the trust options in pem format
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setPfxKeyCertOptions(PfxOptions the key cert options in pfx format options) Deprecated instead use `setKeyCertOptions(KeyCertOptions)` Set the key/cert options in pfx format.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setPfxTrustOptions(PfxOptions the trust options in pfx format options) Deprecated instead use `setTrustOptions(TrustOptions)` Set the trust options in pfx format
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setReadIdleTimeout(int the read timeout idleTimeout) Set the read idle timeout, default time unit is seconds.
public TCPSSLOptions	setReceiveBufferSize(int the buffers size, in bytes receiveBufferSize) Overrides io.vertx.core.net.NetworkOptions.setReceiveBufferSize. Set the TCP receive buffer size
public TCPSSLOptions	setReuseAddress(boolean the value of reuse address reuseAddress) Overrides io.vertx.core.net.NetworkOptions.setReuseAddress. Set the value of reuse address
public TCPSSLOptions	setReusePort(boolean the value of reuse port reusePort) Overrides io.vertx.core.net.NetworkOptions.setReusePort. Set the value of reuse port.
public TCPSSLOptions	setSendBufferSize(int the buffers size, in bytes sendBufferSize) Overrides io.vertx.core.net.NetworkOptions.setSendBufferSize. Set the TCP send buffer size
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setSoLinger(int true if SO_linger is enabled soLinger) Set whether SO_linger keep alive is enabled
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setSsl(boolean true if enabled ssl) Set whether SSL/TLS is enabled
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setSslEngineOptions(SSLEngineOptions the ssl engine to use sslEngineOptions) Set to use SSL engine implementation to use.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setSslHandshakeTimeout(long the SSL handshake timeout to set, in milliseconds sslHandshakeTimeout) Set the SSL handshake timeout, default time unit is seconds.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setSslHandshakeTimeoutUnit(TimeUnit specify time unit. sslHandshakeTimeoutUnit) Set the SSL handshake timeout unit.
public TCPSSLOptions	setTcpCork(boolean the cork value tcpCork) Enable the `TCP_CORK` option - only with linux native transport.
public TCPSSLOptions	setTcpFastOpen(boolean the fast open value tcpFastOpen) Enable the `TCP_FASTOPEN` option - only with linux native transport.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setTcpKeepAlive(boolean true if TCP keep alive is enabled tcpKeepAlive) Set whether TCP keep alive is enabled
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setTcpKeepAliveCount(int tcpKeepAliveCount) The maximum number of keepalive probes TCP should send before dropping the connection.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setTcpKeepAliveIdleSeconds(int tcpKeepAliveIdleSeconds) The time in seconds the connection needs to remain idle before TCP starts sending keepalive probes, if the socket option keepalive has been set.
public TCPSSLOptions	setTcpKeepAliveIntervalSeconds(int tcpKeepAliveIntervalSeconds) The time in seconds between individual keepalive probes.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setTcpNoDelay(boolean true if TCP no delay is enabled (Nagle disabled) tcpNoDelay) Set whether TCP no delay is enabled
public TCPSSLOptions	setTcpQuickAck(boolean the quick ack value tcpQuickAck) Enable the `TCP_QUICKACK` option - only with linux native transport.
public TCPSSLOptions	setTcpUserTimeout(int the tcp user timeout value tcpUserTimeout) Sets the `TCP_USER_TIMEOUT` option - only with linux native transport.
public TCPSSLOptions	setTrafficClass(int the value of traffic class trafficClass) Overrides io.vertx.core.net.NetworkOptions.setTrafficClass. Set the value of traffic class
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setTrustOptions(TrustOptions the trust options options) Set the trust options.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setTrustStoreOptions(JksOptions the trust options in jks format options) Deprecated instead use `setTrustOptions(TrustOptions)` Set the trust options in jks format, aka Java truststore
public TCPSSLOptions	setUseAlpn(boolean true when Application-Layer Protocol Negotiation should be used useAlpn) Set the ALPN usage.
public TCPSSLOptions	Returns: a reference to this, so the API can be used fluently setWriteIdleTimeout(int the write timeout idleTimeout) Set the write idle timeout, default time unit is seconds.
public JsonObject	Returns: the JSON toJson() Overrides io.vertx.core.net.NetworkOptions.toJson. References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Convert to JSON

Inherited from io.vertx.core.net.NetworkOptions:: getActivityLogDataFormat getLogActivity getReceiveBufferSize getSendBufferSize getTrafficClass isReuseAddress isReusePort

public abstract Class TCPSSLOptions

Field Summary

Constructor Summary

Method Summary