Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventBusOptions

Options to configure the event bus.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

addCrlValue

addEnabledCipherSuite

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): EventBusOptions

getAcceptBacklog

  • getAcceptBacklog(): number
  • Set the accept back log.

    Returns number

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

    Returns any

getClientAuth

  • Set whether client auth is required

    Returns ClientAuth

getClusterNodeMetadata

  • getClusterNodeMetadata(): {}
  • Set information about this node when Vert.x is clustered.

    The data may be used by the {@link NodeSelector} to select a node for a given message. For example, it could be used to implement a partioning strategy.

    The default {@link NodeSelector} does not use the node metadata.

    Returns {}

    • [key: string]: any

getClusterPingInterval

  • getClusterPingInterval(): number
  • Set the value of cluster ping interval, in ms.

    Returns number

getClusterPingReplyInterval

  • getClusterPingReplyInterval(): number
  • Set the value of cluster ping reply interval, in ms.

    Returns number

getClusterPublicHost

  • getClusterPublicHost(): string
  • 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.

    Returns string

getClusterPublicPort

  • getClusterPublicPort(): number
  • See EventBusOptions for an explanation.

    Returns number

getConnectTimeout

  • getConnectTimeout(): number
  • Sets the connect timeout

    Returns number

getCrlPaths

  • getCrlPaths(): string[]
  • Add a CRL path

    Returns string[]

getCrlValues

getEnabledCipherSuites

  • getEnabledCipherSuites(): string[]
  • Add an enabled cipher suite, appended to the ordered suites.

    Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]

getHost

  • getHost(): string
  • Sets the host. Defaults to null.

    When the clustered eventbus starts, it tries to bind to the provided host. If host is null, 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.

    Returns string

getIdleTimeout

  • getIdleTimeout(): number
  • 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 EventBusOptions

    Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Set the idle timeout unit. If not specified, default is seconds.

    Returns any

getJdkSslEngineOptions

getKeyStoreOptions

getLogActivity

  • getLogActivity(): boolean
  • Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Returns boolean

getOpenSslEngineOptions

getPemKeyCertOptions

getPemTrustOptions

getPfxKeyCertOptions

getPfxTrustOptions

getPort

  • getPort(): number
  • Sets the port.

    Returns number

getReadIdleTimeout

  • getReadIdleTimeout(): number
  • 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 EventBusOptions

    Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): number

getReconnectAttempts

  • getReconnectAttempts(): number
  • Sets the value of reconnect attempts.

    Returns number

getReconnectInterval

  • getReconnectInterval(): number
  • Set the reconnect interval.

    Returns number

getSendBufferSize

  • getSendBufferSize(): number
  • Set the TCP send buffer size

    Returns number

getSoLinger

  • getSoLinger(): number
  • Set whether SO_linger keep alive is enabled

    Returns number

getSslEngineOptions

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number
  • Set the SSL handshake timeout, default time unit is seconds.

    Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any
  • Set the SSL handshake timeout unit. If not specified, default is seconds.

    Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number
  • Sets the TCP_USER_TIMEOUT option - only with linux native transport.

    Returns number

getTrafficClass

  • getTrafficClass(): number
  • Set the value of traffic class

    Returns number

getTrustOptions

getTrustStoreOptions

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • 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 EventBusOptions

    Returns number

isReuseAddress

  • isReuseAddress(): boolean
  • Set the value of reuse address

    Returns boolean

isReusePort

  • isReusePort(): boolean
  • Set the value of reuse port.

    This is only supported by native transports.

    Returns boolean

isSsl

  • isSsl(): boolean
  • Set whether SSL/TLS is enabled

    Returns boolean

isTcpCork

  • isTcpCork(): boolean
  • Enable the TCP_CORK option - only with linux native transport.

    Returns boolean

isTcpFastOpen

  • isTcpFastOpen(): boolean
  • Enable the TCP_FASTOPEN option - only with linux native transport.

    Returns boolean

isTcpKeepAlive

  • isTcpKeepAlive(): boolean
  • Set whether TCP keep alive is enabled

    Returns boolean

isTcpNoDelay

  • isTcpNoDelay(): boolean
  • Set whether TCP no delay is enabled

    Returns boolean

isTcpQuickAck

  • isTcpQuickAck(): boolean
  • Enable the TCP_QUICKACK option - only with linux native transport.

    Returns boolean

isTrustAll

  • isTrustAll(): boolean
  • Set whether all server certificates should be trusted.

    Returns boolean

isUseAlpn

  • isUseAlpn(): boolean
  • Set the ALPN usage.

    Returns boolean

setAcceptBacklog

  • Set the accept back log.

    Parameters

    • acceptBacklog: number

    Returns EventBusOptions

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: any

    Returns EventBusOptions

setClientAuth

  • Set whether client auth is required

    Parameters

    Returns EventBusOptions

setClusterNodeMetadata

  • Set information about this node when Vert.x is clustered.

    The data may be used by the {@link NodeSelector} to select a node for a given message. For example, it could be used to implement a partioning strategy.

    The default {@link NodeSelector} does not use the node metadata.

    Parameters

    • clusterNodeMetadata: {}
      • [key: string]: any

    Returns EventBusOptions

setClusterPingInterval

  • Set the value of cluster ping interval, in ms.

    Parameters

    • clusterPingInterval: number

    Returns EventBusOptions

setClusterPingReplyInterval

  • setClusterPingReplyInterval(clusterPingReplyInterval: number): EventBusOptions
  • Set the value of cluster ping reply interval, in ms.

    Parameters

    • clusterPingReplyInterval: number

    Returns EventBusOptions

setClusterPublicHost

  • 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: string

    Returns EventBusOptions

setClusterPublicPort

  • See EventBusOptions for an explanation.

    Parameters

    • clusterPublicPort: number

    Returns EventBusOptions

setConnectTimeout

  • Sets the connect timeout

    Parameters

    • connectTimeout: number

    Returns EventBusOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): EventBusOptions

setHost

  • Sets the host. Defaults to null.

    When the clustered eventbus starts, it tries to bind to the provided host. If host is null, 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: string

    Returns EventBusOptions

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 EventBusOptions

    Parameters

    • idleTimeout: number

    Returns EventBusOptions

setIdleTimeoutUnit

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

    Parameters

    • idleTimeoutUnit: any

    Returns EventBusOptions

setJdkSslEngineOptions

setKeyStoreOptions

setLogActivity

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

    Parameters

    • logActivity: boolean

    Returns EventBusOptions

setOpenSslEngineOptions

setPemKeyCertOptions

setPemTrustOptions

setPfxKeyCertOptions

setPfxTrustOptions

setPort

  • Sets the port.

    Parameters

    • port: number

    Returns EventBusOptions

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 EventBusOptions

    Parameters

    • readIdleTimeout: number

    Returns EventBusOptions

setReceiveBufferSize

setReconnectAttempts

  • Sets the value of reconnect attempts.

    Parameters

    • reconnectAttempts: number

    Returns EventBusOptions

setReconnectInterval

  • Set the reconnect interval.

    Parameters

    • reconnectInterval: number

    Returns EventBusOptions

setReuseAddress

setReusePort

  • Set the value of reuse port.

    This is only supported by native transports.

    Parameters

    • reusePort: boolean

    Returns EventBusOptions

setSendBufferSize

setSoLinger

  • Set whether SO_linger keep alive is enabled

    Parameters

    • soLinger: number

    Returns EventBusOptions

setSsl

  • Set whether SSL/TLS is enabled

    Parameters

    • ssl: boolean

    Returns EventBusOptions

setSslEngineOptions

setSslHandshakeTimeout

setSslHandshakeTimeoutUnit

  • setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): EventBusOptions

setTcpCork

  • Enable the TCP_CORK option - only with linux native transport.

    Parameters

    • tcpCork: boolean

    Returns EventBusOptions

setTcpFastOpen

  • Enable the TCP_FASTOPEN option - only with linux native transport.

    Parameters

    • tcpFastOpen: boolean

    Returns EventBusOptions

setTcpKeepAlive

setTcpNoDelay

setTcpQuickAck

  • Enable the TCP_QUICKACK option - only with linux native transport.

    Parameters

    • tcpQuickAck: boolean

    Returns EventBusOptions

setTcpUserTimeout

  • Sets the TCP_USER_TIMEOUT option - only with linux native transport.

    Parameters

    • tcpUserTimeout: number

    Returns EventBusOptions

setTrafficClass

setTrustAll

  • Set whether all server certificates should be trusted.

    Parameters

    • trustAll: boolean

    Returns EventBusOptions

setTrustOptions

setTrustStoreOptions

setUseAlpn

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 EventBusOptions

    Parameters

    • writeIdleTimeout: number

    Returns EventBusOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc