Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProtonClientOptions

Options for configuring {@link ProtonClient} connect operations.

Hierarchy

  • any
    • ProtonClientOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns ProtonClientOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns ProtonClientOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns ProtonClientOptions

addEnabledSaslMechanism

  • Adds a mechanism name that the client may use during SASL negotiation.

    Parameters

    • enabledSaslMechanisms: string

    Returns ProtonClientOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): ProtonClientOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns ProtonClientOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns ProtonClientOptions

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Returns any

getApplicationLayerProtocols

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

getConnectTimeout

  • getConnectTimeout(): number
  • Returns number

getCrlPaths

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

getCrlValues

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

getEnabledCipherSuites

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

getEnabledSaslMechanisms

  • getEnabledSaslMechanisms(): string[]
  • Adds a mechanism name that the client may use during SASL negotiation.

    Returns string[]

getEnabledSecureTransportProtocols

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

getHeartbeat

  • getHeartbeat(): number
  • Set the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2*heartbeat, the connection is closed

    Returns number

getHostnameVerificationAlgorithm

  • getHostnameVerificationAlgorithm(): string
  • Returns string

getIdleTimeout

  • getIdleTimeout(): number
  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Returns any

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Returns JksOptions

getLocalAddress

  • getLocalAddress(): string
  • Returns string

getLogActivity

  • getLogActivity(): boolean
  • Returns boolean

getMaxFrameSize

  • getMaxFrameSize(): number
  • Sets the maximum frame size for the connection.

    If this property is not set explicitly, a reasonable default value is used.

    Setting this property to a negative value will result in no maximum frame size being announced at all.

    Returns number

getMetricsName

  • getMetricsName(): string
  • Returns string

getNonProxyHosts

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

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPemKeyCertOptions

  • getPemKeyCertOptions(): PemKeyCertOptions
  • Returns PemKeyCertOptions

getPemTrustOptions

  • getPemTrustOptions(): PemTrustOptions
  • Returns PemTrustOptions

getPfxKeyCertOptions

  • getPfxKeyCertOptions(): PfxOptions
  • Returns PfxOptions

getPfxTrustOptions

  • getPfxTrustOptions(): PfxOptions
  • Returns PfxOptions

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

getSendBufferSize

  • getSendBufferSize(): number
  • Returns number

getSniServerName

  • getSniServerName(): string
  • Explicitly override the hostname to use for the TLS SNI server name.

    If neither the #setVirtualHost(String) virtualhost or SNI server name is explicitly overridden, the hostname specified in {@link ProtonClient#connect} will be used, with SNI performed implicitly where a FQDN was specified.

    This method should typically only be needed to set different values for the [virtual] hostname and SNI server name.

    Returns string

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

getVirtualHost

  • getVirtualHost(): string
  • Override the hostname value used in the connection AMQP Open frame and TLS SNI server name (if TLS is in use). By default, the hostname specified in {@link ProtonClient#connect} will be used for both, with SNI performed implicit where a FQDN was specified.

    The SNI server name can also be overridden explicitly using ProtonClientOptions.

    Returns string

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • Returns number

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 ProtonClientOptions

setApplicationLayerProtocols

  • Parameters

    • applicationLayerProtocols: string[]

    Returns ProtonClientOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns ProtonClientOptions

setEnabledSecureTransportProtocols

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

    • enabledSecureTransportProtocols: string[]

    Returns ProtonClientOptions

setHeartbeat

  • Set the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2*heartbeat, the connection is closed

    Parameters

    • heartbeat: number

    Returns ProtonClientOptions

setHostnameVerificationAlgorithm

  • Parameters

    • hostnameVerificationAlgorithm: string

    Returns ProtonClientOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns ProtonClientOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns ProtonClientOptions

setJdkSslEngineOptions

  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns ProtonClientOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns ProtonClientOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns ProtonClientOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns ProtonClientOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns ProtonClientOptions

setMaxFrameSize

  • Sets the maximum frame size for the connection.

    If this property is not set explicitly, a reasonable default value is used.

    Setting this property to a negative value will result in no maximum frame size being announced at all.

    Parameters

    • maxFrameSize: number

    Returns ProtonClientOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns ProtonClientOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns ProtonClientOptions

setOpenSslEngineOptions

  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns ProtonClientOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns ProtonClientOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns ProtonClientOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns ProtonClientOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns ProtonClientOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns ProtonClientOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns ProtonClientOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns ProtonClientOptions

setReconnectAttempts

  • Parameters

    • reconnectAttempts: number

    Returns ProtonClientOptions

setReconnectInterval

  • Parameters

    • reconnectInterval: number

    Returns ProtonClientOptions

setRegisterWriteHandler

  • Parameters

    • registerWriteHandler: boolean

    Returns ProtonClientOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns ProtonClientOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns ProtonClientOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns ProtonClientOptions

setSniServerName

  • Explicitly override the hostname to use for the TLS SNI server name.

    If neither the #setVirtualHost(String) virtualhost or SNI server name is explicitly overridden, the hostname specified in {@link ProtonClient#connect} will be used, with SNI performed implicitly where a FQDN was specified.

    This method should typically only be needed to set different values for the [virtual] hostname and SNI server name.

    Parameters

    • sniServerName: string

    Returns ProtonClientOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns ProtonClientOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns ProtonClientOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns ProtonClientOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns ProtonClientOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns ProtonClientOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns ProtonClientOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns ProtonClientOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns ProtonClientOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns ProtonClientOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns ProtonClientOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns ProtonClientOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns ProtonClientOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns ProtonClientOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns ProtonClientOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns ProtonClientOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns ProtonClientOptions

setVirtualHost

  • Override the hostname value used in the connection AMQP Open frame and TLS SNI server name (if TLS is in use). By default, the hostname specified in {@link ProtonClient#connect} will be used for both, with SNI performed implicit where a FQDN was specified.

    The SNI server name can also be overridden explicitly using ProtonClientOptions.

    Parameters

    • virtualHost: string

    Returns ProtonClientOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns ProtonClientOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc