Package io.vertx.core.eventbus
Class EventBusOptions
- java.lang.Object
-
- io.vertx.core.net.NetworkOptions
-
- io.vertx.core.net.TCPSSLOptions
-
- io.vertx.core.eventbus.EventBusOptions
-
public class EventBusOptions extends TCPSSLOptions
Options to configure the event bus.- Author:
- Clement Escoffier
-
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_ACCEPT_BACKLOGThe default accept backlog = 1024static ClientAuthDEFAULT_CLIENT_AUTHDefault value of whether client auth is required (SSL/TLS) = Nostatic StringDEFAULT_CLUSTER_HOSTThe default cluster host = null which means use the same as the cluster manager, if possible.static longDEFAULT_CLUSTER_PING_INTERVALThe default value of cluster ping interval = 20000 ms.static longDEFAULT_CLUSTER_PING_REPLY_INTERVALThe default value of cluster ping reply interval = 20000 ms.static intDEFAULT_CLUSTER_PORTThe default cluster port = 0 which means assign a random port.static StringDEFAULT_CLUSTER_PUBLIC_HOSTThe default cluster public host = null which means use the same as the cluster host.static intDEFAULT_CLUSTER_PUBLIC_PORTThe default cluster public port = -1 which means use the same as the cluster port.static intDEFAULT_CONNECT_TIMEOUTThe default value of connect timeout = 60000 msstatic intDEFAULT_RECONNECT_ATTEMPTSThe default value for reconnect attempts = 0static longDEFAULT_RECONNECT_INTERVALThe default value for reconnect interval = 1000 msstatic booleanDEFAULT_TRUST_ALLThe default value of whether all servers (SSL/TLS) should be trusted = true-
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 EventBusOptions()Creates a new instance ofEventBusOptionsusing the default configuration.EventBusOptions(EventBusOptions other)Copy constructor to create an instance ofEventBusOptionsusing the values of the given object.EventBusOptions(JsonObject json)Creates a new instance ofEventBusOptionsfrom the JSON object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EventBusOptionsaddCrlPath(String crlPath)Add a CRL pathEventBusOptionsaddCrlValue(Buffer crlValue)Add a CRL valueEventBusOptionsaddEnabledCipherSuite(String suite)Add an enabled cipher suite, appended to the ordered suites.EventBusOptionsaddEnabledSecureTransportProtocol(String protocol)Add an enabled SSL/TLS protocols, appended to the ordered protocols.intgetAcceptBacklog()ClientAuthgetClientAuth()JsonObjectgetClusterNodeMetadata()User-supplied information about this node when Vert.x is clustered.longgetClusterPingInterval()Get the value of cluster ping reply interval, in ms.longgetClusterPingReplyInterval()Get the value of cluster ping reply interval, in ms.StringgetClusterPublicHost()Get the public facing host to be used when clustering.intgetClusterPublicPort()Gets the public facing port to be used when clustering.intgetConnectTimeout()StringgetHost()intgetPort()intgetReconnectAttempts()longgetReconnectInterval()booleanisTrustAll()EventBusOptionsremoveEnabledCipherSuite(String suite)Removes an enabled cipher suite from the ordered suites.EventBusOptionsremoveEnabledSecureTransportProtocol(String protocol)Removes an enabled SSL/TLS protocol from the ordered protocols.EventBusOptionssetAcceptBacklog(int acceptBacklog)Set the accept back log.EventBusOptionssetClientAuth(ClientAuth clientAuth)Set whether client auth is requiredEventBusOptionssetClusterNodeMetadata(JsonObject clusterNodeMetadata)Set information about this node when Vert.x is clustered.EventBusOptionssetClusterPingInterval(long clusterPingInterval)Set the value of cluster ping interval, in ms.EventBusOptionssetClusterPingReplyInterval(long clusterPingReplyInterval)Set the value of cluster ping reply interval, in ms.EventBusOptionssetClusterPublicHost(String clusterPublicHost)Set the public facing hostname to be used for clustering.EventBusOptionssetClusterPublicPort(int clusterPublicPort)SeesetClusterPublicHost(String)for an explanation.EventBusOptionssetConnectTimeout(int connectTimeout)Sets the connect timeoutEventBusOptionssetEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)Sets the list of enabled SSL/TLS protocols.EventBusOptionssetHost(String host)Sets the host.EventBusOptionssetIdleTimeout(int idleTimeout)Set the idle timeout, default time unit is seconds.EventBusOptionssetIdleTimeoutUnit(TimeUnit idleTimeoutUnit)Set the idle timeout unit.EventBusOptionssetKeyCertOptions(KeyCertOptions options)Set the key/cert options.EventBusOptionssetLogActivity(boolean logEnabled)Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.EventBusOptionssetPort(int port)Sets the port.EventBusOptionssetReadIdleTimeout(int idleTimeout)Set the read idle timeout, default time unit is seconds.EventBusOptionssetReceiveBufferSize(int receiveBufferSize)Set the TCP receive buffer sizeEventBusOptionssetReconnectAttempts(int attempts)Sets the value of reconnect attempts.EventBusOptionssetReconnectInterval(long interval)Set the reconnect interval.EventBusOptionssetReuseAddress(boolean reuseAddress)Set the value of reuse addressEventBusOptionssetReusePort(boolean reusePort)Set the value of reuse port.EventBusOptionssetSendBufferSize(int sendBufferSize)Set the TCP send buffer sizeEventBusOptionssetSoLinger(int soLinger)Set whether SO_linger keep alive is enabledEventBusOptionssetSsl(boolean ssl)Set whether SSL/TLS is enabledEventBusOptionssetSslEngineOptions(SSLEngineOptions sslEngineOptions)Set to use SSL engine implementation to use.EventBusOptionssetSslHandshakeTimeout(long sslHandshakeTimeout)Set the SSL handshake timeout, default time unit is seconds.EventBusOptionssetSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)Set the SSL handshake timeout unit.EventBusOptionssetTcpCork(boolean tcpCork)Enable theTCP_CORKoption - only with linux native transport.EventBusOptionssetTcpFastOpen(boolean tcpFastOpen)Enable theTCP_FASTOPENoption - only with linux native transport.EventBusOptionssetTcpKeepAlive(boolean tcpKeepAlive)Set whether TCP keep alive is enabledEventBusOptionssetTcpNoDelay(boolean tcpNoDelay)Set whether TCP no delay is enabledEventBusOptionssetTcpQuickAck(boolean tcpQuickAck)Enable theTCP_QUICKACKoption - only with linux native transport.EventBusOptionssetTcpUserTimeout(int tcpUserTimeout)Sets theTCP_USER_TIMEOUToption - only with linux native transport.EventBusOptionssetTrafficClass(int trafficClass)Set the value of traffic classEventBusOptionssetTrustAll(boolean trustAll)Set whether all server certificates should be trusted.EventBusOptionssetTrustOptions(TrustOptions options)Set the trust options.EventBusOptionssetUseAlpn(boolean useAlpn)Set the ALPN usage.EventBusOptionssetWriteIdleTimeout(int idleTimeout)Set the write idle timeout, default time unit is seconds.JsonObjecttoJson()Builds a JSON object representing the currentEventBusOptions.-
Methods inherited from class io.vertx.core.net.TCPSSLOptions
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getKeyCertOptions, getOrCreateSSLOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getSslOptions, getTcpUserTimeout, getTrustOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, setActivityLogDataFormat
-
Methods inherited from class io.vertx.core.net.NetworkOptions
getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort
-
-
-
-
Field Detail
-
DEFAULT_CLUSTER_HOST
public static final String DEFAULT_CLUSTER_HOST
The default cluster host = null which means use the same as the cluster manager, if possible.
-
DEFAULT_CLUSTER_PORT
public static final int DEFAULT_CLUSTER_PORT
The default cluster port = 0 which means assign a random port.- See Also:
- Constant Field Values
-
DEFAULT_CLUSTER_PUBLIC_HOST
public static final String DEFAULT_CLUSTER_PUBLIC_HOST
The default cluster public host = null which means use the same as the cluster host.
-
DEFAULT_CLUSTER_PUBLIC_PORT
public static final int DEFAULT_CLUSTER_PUBLIC_PORT
The default cluster public port = -1 which means use the same as the cluster port.- See Also:
- Constant Field Values
-
DEFAULT_CLUSTER_PING_INTERVAL
public static final long DEFAULT_CLUSTER_PING_INTERVAL
The default value of cluster ping interval = 20000 ms.
-
DEFAULT_CLUSTER_PING_REPLY_INTERVAL
public static final long DEFAULT_CLUSTER_PING_REPLY_INTERVAL
The default value of cluster ping reply interval = 20000 ms.
-
DEFAULT_ACCEPT_BACKLOG
public static final int DEFAULT_ACCEPT_BACKLOG
The default accept backlog = 1024- See Also:
- Constant Field Values
-
DEFAULT_CLIENT_AUTH
public static final ClientAuth DEFAULT_CLIENT_AUTH
Default value of whether client auth is required (SSL/TLS) = No
-
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_CONNECT_TIMEOUT
public static final int DEFAULT_CONNECT_TIMEOUT
The default value of connect timeout = 60000 ms- See Also:
- Constant Field Values
-
DEFAULT_TRUST_ALL
public static final boolean DEFAULT_TRUST_ALL
The default value of whether all servers (SSL/TLS) should be trusted = true- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EventBusOptions
public EventBusOptions()
Creates a new instance ofEventBusOptionsusing the default configuration.
-
EventBusOptions
public EventBusOptions(EventBusOptions other)
Copy constructor to create an instance ofEventBusOptionsusing the values of the given object.- Parameters:
other- the otherEventBusOptions
-
EventBusOptions
public EventBusOptions(JsonObject json)
Creates a new instance ofEventBusOptionsfrom the JSON object. This JSOn object has (generally) be generated usingtoJson().- Parameters:
json- the json object
-
-
Method Detail
-
toJson
public JsonObject toJson()
Builds a JSON object representing the currentEventBusOptions.- Overrides:
toJsonin classTCPSSLOptions- Returns:
- the JSON representation
-
getClientAuth
public ClientAuth getClientAuth()
- Returns:
- the configure client authentication requirement
- See Also:
NetServerOptions.getClientAuth()
-
setClientAuth
public EventBusOptions setClientAuth(ClientAuth clientAuth)
Set whether client auth is required- Parameters:
clientAuth- One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then it won't mandate the certificate to be presented, basically make it optional.- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetServerOptions.setClientAuth(ClientAuth)
-
getAcceptBacklog
public int getAcceptBacklog()
- Returns:
- the value of accept backlog.
- See Also:
NetServerOptions.getAcceptBacklog()
-
setAcceptBacklog
public EventBusOptions setAcceptBacklog(int acceptBacklog)
Set the accept back log.- Parameters:
acceptBacklog- accept backlog- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetServerOptions.setAcceptBacklog(int)
-
getHost
public String getHost()
- Returns:
- the host or
nullif the clustered eventbus should try to pick one automatically
-
setHost
public EventBusOptions setHost(String host)
Sets the host. Defaults tonull.When the clustered eventbus starts, it tries to bind to the provided
host. Ifhostisnull, then it tries to bind to the same host as the underlying cluster manager. As a last resort, an address will be picked among the available network interfaces.- Parameters:
host- the host- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetServerOptions.setHost(String)
-
getPort
public int getPort()
- Returns:
- the port, which can be configured from the
setPort(int), or using the--cluster-portcommand line option. - See Also:
NetServerOptions.getPort()
-
setPort
public EventBusOptions setPort(int port)
Sets the port.- Parameters:
port- the port- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetServerOptions.setPort(int)
-
getReconnectAttempts
public int getReconnectAttempts()
- Returns:
- the value of reconnect attempts
- See Also:
NetClientOptions.getReconnectAttempts()
-
setReconnectAttempts
public EventBusOptions setReconnectAttempts(int attempts)
Sets 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
- See Also:
NetClientOptions.setReconnectAttempts(int)
-
getReconnectInterval
public long getReconnectInterval()
- Returns:
- the value of reconnect interval
- See Also:
NetClientOptions.getReconnectInterval()
-
setReconnectInterval
public EventBusOptions 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
- See Also:
NetClientOptions.setReconnectInterval(long)
-
addCrlPath
public EventBusOptions addCrlPath(String crlPath) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL path- Overrides:
addCrlPathin classTCPSSLOptions- Parameters:
crlPath- the path- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
addCrlValue
public EventBusOptions addCrlValue(Buffer crlValue) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL value- Overrides:
addCrlValuein classTCPSSLOptions- Parameters:
crlValue- the value- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
addEnabledCipherSuite
public EventBusOptions addEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsAdd an enabled cipher suite, appended to the ordered suites.- Overrides:
addEnabledCipherSuitein classTCPSSLOptions- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
- See Also:
TCPSSLOptions.getEnabledCipherSuites()
-
removeEnabledCipherSuite
public EventBusOptions removeEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsRemoves an enabled cipher suite from the ordered suites.- Overrides:
removeEnabledCipherSuitein classTCPSSLOptions- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeout
public EventBusOptions 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 classTCPSSLOptions- Parameters:
idleTimeout- the timeout- Returns:
- a reference to this, so the API can be used fluently
-
setReadIdleTimeout
public EventBusOptions 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 classTCPSSLOptions- Parameters:
idleTimeout- the read timeout- Returns:
- a reference to this, so the API can be used fluently
-
setWriteIdleTimeout
public EventBusOptions 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 classTCPSSLOptions- Parameters:
idleTimeout- the write timeout- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeoutUnit
public EventBusOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Description copied from class:TCPSSLOptionsSet the idle timeout unit. If not specified, default is seconds.- Overrides:
setIdleTimeoutUnitin classTCPSSLOptions- Parameters:
idleTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
setKeyCertOptions
public EventBusOptions setKeyCertOptions(KeyCertOptions options)
Description copied from class:TCPSSLOptionsSet the key/cert options.- Overrides:
setKeyCertOptionsin classTCPSSLOptions- Parameters:
options- the key store options- Returns:
- a reference to this, so the API can be used fluently
-
setSoLinger
public EventBusOptions setSoLinger(int soLinger)
Description copied from class:TCPSSLOptionsSet whether SO_linger keep alive is enabled- Overrides:
setSoLingerin classTCPSSLOptions- Parameters:
soLinger- true if SO_linger is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setSsl
public EventBusOptions setSsl(boolean ssl)
Description copied from class:TCPSSLOptionsSet whether SSL/TLS is enabled- Overrides:
setSslin classTCPSSLOptions- Parameters:
ssl- true if enabled- Returns:
- a reference to this, so the API can be used fluently
-
setTcpKeepAlive
public EventBusOptions setTcpKeepAlive(boolean tcpKeepAlive)
Description copied from class:TCPSSLOptionsSet whether TCP keep alive is enabled- Overrides:
setTcpKeepAlivein classTCPSSLOptions- Parameters:
tcpKeepAlive- true if TCP keep alive is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setTcpNoDelay
public EventBusOptions setTcpNoDelay(boolean tcpNoDelay)
Description copied from class:TCPSSLOptionsSet whether TCP no delay is enabled- Overrides:
setTcpNoDelayin classTCPSSLOptions- Parameters:
tcpNoDelay- true if TCP no delay is enabled (Nagle disabled)- Returns:
- a reference to this, so the API can be used fluently
-
setTrustOptions
public EventBusOptions setTrustOptions(TrustOptions options)
Description copied from class:TCPSSLOptionsSet the trust options.- Overrides:
setTrustOptionsin classTCPSSLOptions- Parameters:
options- the trust options- Returns:
- a reference to this, so the API can be used fluently
-
setReceiveBufferSize
public EventBusOptions setReceiveBufferSize(int receiveBufferSize)
Description copied from class:NetworkOptionsSet the TCP receive buffer size- Overrides:
setReceiveBufferSizein classTCPSSLOptions- Parameters:
receiveBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReuseAddress
public EventBusOptions setReuseAddress(boolean reuseAddress)
Description copied from class:NetworkOptionsSet the value of reuse address- Overrides:
setReuseAddressin classTCPSSLOptions- Parameters:
reuseAddress- the value of reuse address- Returns:
- a reference to this, so the API can be used fluently
-
setReusePort
public EventBusOptions setReusePort(boolean reusePort)
Description copied from class:NetworkOptionsSet the value of reuse port. This is only supported by native transports.- Overrides:
setReusePortin classTCPSSLOptions- Parameters:
reusePort- the value of reuse port- Returns:
- a reference to this, so the API can be used fluently
-
setSendBufferSize
public EventBusOptions setSendBufferSize(int sendBufferSize)
Description copied from class:NetworkOptionsSet the TCP send buffer size- Overrides:
setSendBufferSizein classTCPSSLOptions- Parameters:
sendBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setTrafficClass
public EventBusOptions setTrafficClass(int trafficClass)
Description copied from class:NetworkOptionsSet the value of traffic class- Overrides:
setTrafficClassin classTCPSSLOptions- Parameters:
trafficClass- the value of traffic class- Returns:
- a reference to this, so the API can be used fluently
-
setUseAlpn
public EventBusOptions setUseAlpn(boolean useAlpn)
Description copied from class:TCPSSLOptionsSet the ALPN usage.- Overrides:
setUseAlpnin classTCPSSLOptions- Parameters:
useAlpn- true when Application-Layer Protocol Negotiation should be used
-
setSslEngineOptions
public EventBusOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Description copied from class:TCPSSLOptionsSet to use SSL engine implementation to use.- Overrides:
setSslEngineOptionsin classTCPSSLOptions- Parameters:
sslEngineOptions- the ssl engine to use- Returns:
- a reference to this, so the API can be used fluently
-
setEnabledSecureTransportProtocols
public EventBusOptions 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
-
addEnabledSecureTransportProtocol
public EventBusOptions addEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsAdd an enabled SSL/TLS protocols, appended to the ordered protocols.- Overrides:
addEnabledSecureTransportProtocolin classTCPSSLOptions- Parameters:
protocol- the SSL/TLS protocol to enable- Returns:
- a reference to this, so the API can be used fluently
-
removeEnabledSecureTransportProtocol
public EventBusOptions removeEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsRemoves an enabled SSL/TLS protocol from the ordered protocols.- Overrides:
removeEnabledSecureTransportProtocolin classTCPSSLOptions- Parameters:
protocol- the SSL/TLS protocol to disable- Returns:
- a reference to this, so the API can be used fluently
-
setTcpFastOpen
public EventBusOptions setTcpFastOpen(boolean tcpFastOpen)
Description copied from class:TCPSSLOptionsEnable theTCP_FASTOPENoption - only with linux native transport.- Overrides:
setTcpFastOpenin classTCPSSLOptions- Parameters:
tcpFastOpen- the fast open value
-
setTcpCork
public EventBusOptions setTcpCork(boolean tcpCork)
Description copied from class:TCPSSLOptionsEnable theTCP_CORKoption - only with linux native transport.- Overrides:
setTcpCorkin classTCPSSLOptions- Parameters:
tcpCork- the cork value
-
setTcpQuickAck
public EventBusOptions setTcpQuickAck(boolean tcpQuickAck)
Description copied from class:TCPSSLOptionsEnable theTCP_QUICKACKoption - only with linux native transport.- Overrides:
setTcpQuickAckin classTCPSSLOptions- Parameters:
tcpQuickAck- the quick ack value
-
setTcpUserTimeout
public EventBusOptions setTcpUserTimeout(int tcpUserTimeout)
Description copied from class:TCPSSLOptionsSets theTCP_USER_TIMEOUToption - only with linux native transport.- Overrides:
setTcpUserTimeoutin classTCPSSLOptions- Parameters:
tcpUserTimeout- the tcp user timeout value
-
setLogActivity
public EventBusOptions 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 classTCPSSLOptions- Parameters:
logEnabled- true for logging the network activity- Returns:
- a reference to this, so the API can be used fluently
-
setSslHandshakeTimeout
public EventBusOptions 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 EventBusOptions 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
-
setTrustAll
public EventBusOptions setTrustAll(boolean trustAll)
Set whether all server certificates should be trusted.- Parameters:
trustAll- true if all should be trusted- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetClientOptions.setTrustAll(boolean)
-
isTrustAll
public boolean isTrustAll()
- Returns:
- true if all server certificates should be trusted
- See Also:
ClientOptionsBase.isTrustAll()
-
getConnectTimeout
public int getConnectTimeout()
- Returns:
- the value of connect timeout
- See Also:
ClientOptionsBase.getConnectTimeout()
-
setConnectTimeout
public EventBusOptions setConnectTimeout(int connectTimeout)
Sets the connect timeout- Parameters:
connectTimeout- connect timeout, in ms- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetClientOptions.setConnectTimeout(int)
-
getClusterPingInterval
public long getClusterPingInterval()
Get the value of cluster ping reply interval, in ms. After sending a ping, if a pong is not received in this time, the node will be considered dead.- Returns:
- the value of cluster ping reply interval
-
setClusterPingInterval
public EventBusOptions setClusterPingInterval(long clusterPingInterval)
Set the value of cluster ping interval, in ms.- Parameters:
clusterPingInterval- The value of cluster ping interval, in ms.- Returns:
- a reference to this, so the API can be used fluently
-
getClusterPingReplyInterval
public long getClusterPingReplyInterval()
Get the value of cluster ping reply interval, in ms. After sending a ping, if a pong is not received in this time, the node will be considered dead.- Returns:
- the value of cluster ping reply interval
-
setClusterPingReplyInterval
public EventBusOptions setClusterPingReplyInterval(long clusterPingReplyInterval)
Set the value of cluster ping reply interval, in ms.- Parameters:
clusterPingReplyInterval- The value of cluster ping reply interval, in ms.- Returns:
- a reference to this, so the API can be used fluently
-
getClusterPublicHost
public String getClusterPublicHost()
Get the public facing host to be used when clustering.- Returns:
- the public facing port
-
setClusterPublicHost
public EventBusOptions setClusterPublicHost(String clusterPublicHost)
Set the public facing hostname to be used for clustering. Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying. If this is the case you can specify a public hostname which is different from the hostname the server listens at.The default value is null which means use the same as the cluster hostname.
- Parameters:
clusterPublicHost- the public host name to use- Returns:
- a reference to this, so the API can be used fluently
-
getClusterPublicPort
public int getClusterPublicPort()
Gets the public facing port to be used when clustering.- Returns:
- the public facing port
-
setClusterPublicPort
public EventBusOptions setClusterPublicPort(int clusterPublicPort)
SeesetClusterPublicHost(String)for an explanation.- Parameters:
clusterPublicPort- the public port to use- Returns:
- a reference to this, so the API can be used fluently
-
getClusterNodeMetadata
public JsonObject getClusterNodeMetadata()
User-supplied information about this node when Vert.x is clustered.The data may be to select a node for a given message. For example, it could be used to implement a partioning strategy.
Not used by default.
- Returns:
- user-supplied information about this node when Vert.x is clustered
-
setClusterNodeMetadata
public EventBusOptions setClusterNodeMetadata(JsonObject clusterNodeMetadata)
Set information about this node when Vert.x is clustered.The data may be used to select a node for a given message. For example, it could be used to implement a partioning strategy.
Not used by default.
- Parameters:
clusterNodeMetadata- user-supplied information about this node when Vert.x is clustered- Returns:
- a reference to this, so the API can be used fluently
-
-