Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RabbitMQOptions

RabbitMQ client options, most

Hierarchy

  • any
    • RabbitMQOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns RabbitMQOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns RabbitMQOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns RabbitMQOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): RabbitMQOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns RabbitMQOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns RabbitMQOptions

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Returns any

getAddresses

  • getAddresses(): any[]
  • Set multiple addresses for cluster mode.

    Returns any[]

getApplicationLayerProtocols

  • getApplicationLayerProtocols(): string[]
  • Returns string[]

getConnectTimeout

  • getConnectTimeout(): number
  • Returns number

getConnectionName

  • getConnectionName(): string
  • Returns string

getConnectionTimeout

  • getConnectionTimeout(): number
  • Set the TCP connection timeout, in milliseconds, zero for infinite).

    Returns number

getCredentialsProvider

  • getCredentialsProvider(): any
  • Provides a RabbitMQ credentials provider for using dynamic credentials.

    Returns any

getCredentialsRefreshService

  • getCredentialsRefreshService(): any
  • Provides a RabbitMQ credentials refresh service for refreshing dynamic credentials.

    Returns any

getCrlPaths

  • getCrlPaths(): string[]
  • Returns string[]

getCrlValues

  • getCrlValues(): Buffer[]
  • Returns Buffer[]

getEnabledCipherSuites

  • getEnabledCipherSuites(): string[]
  • Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]
  • Returns string[]

getHandshakeTimeout

  • getHandshakeTimeout(): number
  • Set the AMQP 0-9-1 protocol handshake timeout, in milliseconds

    Returns number

getHost

  • getHost(): string
  • Set the default host to use for connections.

    Returns string

getHostnameVerificationAlgorithm

  • getHostnameVerificationAlgorithm(): string
  • Returns string

getIdleTimeout

  • getIdleTimeout(): number
  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Returns any

getIncludeProperties

  • getIncludeProperties(): boolean
  • Set wether to include properties when a broker message is passed on the event bus

    Returns boolean

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Returns JksOptions

getLocalAddress

  • getLocalAddress(): string
  • Returns string

getLogActivity

  • getLogActivity(): boolean
  • Returns boolean

getMetricsCollector

  • getMetricsCollector(): any
  • Provides a metrics collector for RabbitMQ.

    Returns any

getMetricsName

  • getMetricsName(): string
  • Returns string

getNetworkRecoveryInterval

  • getNetworkRecoveryInterval(): number
  • Set how long in milliseconds will automatic recovery wait before attempting to reconnect, default is 5000

    Returns number

getNonProxyHosts

  • getNonProxyHosts(): string[]
  • Returns string[]

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPassword

  • getPassword(): string
  • Set the password to use when connecting to the broker.

    Returns string

getPemKeyCertOptions

  • getPemKeyCertOptions(): PemKeyCertOptions
  • Returns PemKeyCertOptions

getPemTrustOptions

  • getPemTrustOptions(): PemTrustOptions
  • Returns PemTrustOptions

getPfxKeyCertOptions

  • getPfxKeyCertOptions(): PfxOptions
  • Returns PfxOptions

getPfxTrustOptions

  • getPfxTrustOptions(): PfxOptions
  • Returns PfxOptions

getPort

  • getPort(): number
  • Set the default port to use for connections.

    Returns number

getProxyOptions

  • getProxyOptions(): ProxyOptions
  • Returns ProxyOptions

getReadIdleTimeout

  • getReadIdleTimeout(): number
  • Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): number
  • Returns number

getReconnectAttempts

  • getReconnectAttempts(): number
  • Returns number

getReconnectInterval

  • getReconnectInterval(): number
  • Returns number

getRequestedChannelMax

  • getRequestedChannelMax(): number
  • Set the initially requested maximum channel number, zero for unlimited.

    Returns number

getRequestedHeartbeat

  • getRequestedHeartbeat(): number
  • Set the initially requested heartbeat interval, in seconds, zero for none.

    Returns number

getSaslConfig

  • getSaslConfig(): any
  • Set the SASL mechanism for rabbitmq authentication

    Returns any

getSendBufferSize

  • getSendBufferSize(): number
  • Returns number

getSoLinger

  • getSoLinger(): number
  • Returns number

getSslEngineOptions

  • getSslEngineOptions(): any
  • Returns any

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number
  • Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any
  • Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number
  • Returns number

getTrafficClass

  • getTrafficClass(): number
  • Returns number

getTrustOptions

  • getTrustOptions(): any
  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • Returns JksOptions

getUri

  • getUri(): string
  • Returns string

getUser

  • getUser(): string
  • Set the AMQP user name to use when connecting to the broker.

    Returns string

getVirtualHost

  • getVirtualHost(): string
  • Set the virtual host to use when connecting to the broker.

    Returns string

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • Returns number

isAutomaticRecoveryEnabled

  • isAutomaticRecoveryEnabled(): boolean
  • Enables or disables automatic connection recovery.

    Returns boolean

isAutomaticRecoveryOnInitialConnection

  • isAutomaticRecoveryOnInitialConnection(): boolean
  • Enable or disable automatic recovery on initial connections.

    If automatic recovery is enabled it will, by default, make multiple attempts to connect on startup. This can cause problems with the configuration is wrong, and it is this bad configuration that is preventing connection. To work around this automaticRecoveryOnInitialConnection can be set to false (it default to true). When automaticRecoveryOnInitialConnection is false (and automaticRecoveryEnabled is true) reconnection attempts will not be made until after the first connection has been successful.

    Returns boolean

isNioEnabled

  • isNioEnabled(): boolean
  • Returns boolean

isRegisterWriteHandler

  • isRegisterWriteHandler(): boolean
  • Returns boolean

isReuseAddress

  • isReuseAddress(): boolean
  • Returns boolean

isReusePort

  • isReusePort(): boolean
  • Returns boolean

isSsl

  • isSsl(): boolean
  • Returns boolean

isTcpCork

  • isTcpCork(): boolean
  • Returns boolean

isTcpFastOpen

  • isTcpFastOpen(): boolean
  • Returns boolean

isTcpKeepAlive

  • isTcpKeepAlive(): boolean
  • Returns boolean

isTcpNoDelay

  • isTcpNoDelay(): boolean
  • Returns boolean

isTcpQuickAck

  • isTcpQuickAck(): boolean
  • Returns boolean

isTrustAll

  • isTrustAll(): boolean
  • Returns boolean

isUseAlpn

  • isUseAlpn(): boolean
  • Returns boolean

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns RabbitMQOptions

setAddresses

  • Set multiple addresses for cluster mode.

    Parameters

    • addresses: any[]

    Returns RabbitMQOptions

setApplicationLayerProtocols

  • setApplicationLayerProtocols(applicationLayerProtocols: string[]): RabbitMQOptions
  • Parameters

    • applicationLayerProtocols: string[]

    Returns RabbitMQOptions

setAutomaticRecoveryEnabled

  • setAutomaticRecoveryEnabled(automaticRecoveryEnabled: boolean): RabbitMQOptions
  • Enables or disables automatic connection recovery.

    Parameters

    • automaticRecoveryEnabled: boolean

    Returns RabbitMQOptions

setAutomaticRecoveryOnInitialConnection

  • setAutomaticRecoveryOnInitialConnection(automaticRecoveryOnInitialConnection: boolean): RabbitMQOptions
  • Enable or disable automatic recovery on initial connections.

    If automatic recovery is enabled it will, by default, make multiple attempts to connect on startup. This can cause problems with the configuration is wrong, and it is this bad configuration that is preventing connection. To work around this automaticRecoveryOnInitialConnection can be set to false (it default to true). When automaticRecoveryOnInitialConnection is false (and automaticRecoveryEnabled is true) reconnection attempts will not be made until after the first connection has been successful.

    Parameters

    • automaticRecoveryOnInitialConnection: boolean

    Returns RabbitMQOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns RabbitMQOptions

setConnectionName

  • Parameters

    • connectionName: string

    Returns RabbitMQOptions

setConnectionTimeout

  • Set the TCP connection timeout, in milliseconds, zero for infinite).

    Parameters

    • connectionTimeout: number

    Returns RabbitMQOptions

setCredentialsProvider

  • Provides a RabbitMQ credentials provider for using dynamic credentials.

    Parameters

    • credentialsProvider: any

    Returns RabbitMQOptions

setCredentialsRefreshService

  • setCredentialsRefreshService(credentialsRefreshService: any): RabbitMQOptions
  • Provides a RabbitMQ credentials refresh service for refreshing dynamic credentials.

    Parameters

    • credentialsRefreshService: any

    Returns RabbitMQOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): RabbitMQOptions
  • Parameters

    • enabledSecureTransportProtocols: string[]

    Returns RabbitMQOptions

setHandshakeTimeout

  • Set the AMQP 0-9-1 protocol handshake timeout, in milliseconds

    Parameters

    • handshakeTimeout: number

    Returns RabbitMQOptions

setHost

  • Set the default host to use for connections.

    Parameters

    • host: string

    Returns RabbitMQOptions

setHostnameVerificationAlgorithm

  • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): RabbitMQOptions
  • Parameters

    • hostnameVerificationAlgorithm: string

    Returns RabbitMQOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns RabbitMQOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns RabbitMQOptions

setIncludeProperties

  • Set wether to include properties when a broker message is passed on the event bus

    Parameters

    • includeProperties: boolean

    Returns RabbitMQOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): RabbitMQOptions
  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns RabbitMQOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns RabbitMQOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns RabbitMQOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns RabbitMQOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns RabbitMQOptions

setMetricsCollector

  • Provides a metrics collector for RabbitMQ.

    Parameters

    • metricsCollector: any

    Returns RabbitMQOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns RabbitMQOptions

setNetworkRecoveryInterval

  • setNetworkRecoveryInterval(networkRecoveryInterval: number): RabbitMQOptions
  • Set how long in milliseconds will automatic recovery wait before attempting to reconnect, default is 5000

    Parameters

    • networkRecoveryInterval: number

    Returns RabbitMQOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns RabbitMQOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): RabbitMQOptions
  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns RabbitMQOptions

setPassword

  • Set the password to use when connecting to the broker.

    Parameters

    • password: string

    Returns RabbitMQOptions

setPemKeyCertOptions

  • setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): RabbitMQOptions
  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns RabbitMQOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns RabbitMQOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns RabbitMQOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns RabbitMQOptions

setPort

  • Set the default port to use for connections.

    Parameters

    • port: number

    Returns RabbitMQOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns RabbitMQOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns RabbitMQOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns RabbitMQOptions

setReconnectAttempts

  • Parameters

    • reconnectAttempts: number

    Returns RabbitMQOptions

setReconnectInterval

  • Parameters

    • reconnectInterval: number

    Returns RabbitMQOptions

setRegisterWriteHandler

  • Parameters

    • registerWriteHandler: boolean

    Returns RabbitMQOptions

setRequestedChannelMax

  • Set the initially requested maximum channel number, zero for unlimited.

    Parameters

    • requestedChannelMax: number

    Returns RabbitMQOptions

setRequestedHeartbeat

  • Set the initially requested heartbeat interval, in seconds, zero for none.

    Parameters

    • requestedHeartbeat: number

    Returns RabbitMQOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns RabbitMQOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns RabbitMQOptions

setSaslConfig

  • Set the SASL mechanism for rabbitmq authentication

    Parameters

    • saslConfig: any

    Returns RabbitMQOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns RabbitMQOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns RabbitMQOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns RabbitMQOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns RabbitMQOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns RabbitMQOptions

setSslHandshakeTimeoutUnit

  • setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): RabbitMQOptions
  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns RabbitMQOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns RabbitMQOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns RabbitMQOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns RabbitMQOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns RabbitMQOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns RabbitMQOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns RabbitMQOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns RabbitMQOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns RabbitMQOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns RabbitMQOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns RabbitMQOptions

setUri

  • Parameters

    • uri: string

    Returns RabbitMQOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns RabbitMQOptions

setUseNio

  • Enables or disables usage of NIO Sockets.

    Parameters

    • useNio: boolean

    Returns RabbitMQOptions

setUser

  • Set the AMQP user name to use when connecting to the broker.

    Parameters

    • user: string

    Returns RabbitMQOptions

setVirtualHost

  • Set the virtual host to use when connecting to the broker.

    Parameters

    • virtualHost: string

    Returns RabbitMQOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns RabbitMQOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc