Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StompClientOptions

Options used to configure a STOMP client. As a STOMP client wraps a Net client, you can also configure the underlying NET client.

Hierarchy

  • StompClientOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns StompClientOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns StompClientOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns StompClientOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): StompClientOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns StompClientOptions

getAcceptedVersions

  • getAcceptedVersions(): string
  • Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest version to the highest. By default the following list is used: 1.0, 1.1, 1.2

    Returns string

getConnectTimeout

  • getConnectTimeout(): number
  • Returns number

getCrlPaths

  • getCrlPaths(): string
  • Returns string

getCrlValues

  • getCrlValues(): Buffer
  • Returns Buffer

getEnabledCipherSuites

  • getEnabledCipherSuites(): string
  • Returns string

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string
  • Returns string

getHeartbeat

  • getHeartbeat(): {}
  • Sets the heartbeat configuration.

    Returns {}

    • [key: string]: any

getHost

  • getHost(): string
  • Sets the STOMP server host. 0.0.0.0 by default.

    Returns string

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

getLogin

  • getLogin(): string
  • Sets the login to use if the STOMP server is secured.

    Returns string

getMetricsName

  • getMetricsName(): string
  • Returns string

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPasscode

  • getPasscode(): string
  • Sets the passcode to use if the STOMP server is secured.

    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
  • Sets the STOMP server port. 61613 by default.

    Returns number

getProxyOptions

  • getProxyOptions(): ProxyOptions
  • Returns ProxyOptions

getReceiveBufferSize

  • getReceiveBufferSize(): number
  • Returns number

getReconnectAttempts

  • getReconnectAttempts(): number
  • Returns number

getReconnectInterval

  • getReconnectInterval(): number
  • Returns number

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

getTrafficClass

  • getTrafficClass(): number
  • Returns number

getTrustOptions

  • getTrustOptions(): any
  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • Returns JksOptions

getVirtualHost

  • getVirtualHost(): string
  • Sets the virtual host that will be used as "host" header value in the CONNECT frame.

    Returns string

isAutoComputeContentLength

  • isAutoComputeContentLength(): boolean
  • Sets whether or not the automatic computation of the content-length header is enabled. If enabled, the content-length header is set in all frame with a body that do not explicitly set the header. The option is enabled by default.

    Returns boolean

isBypassHostHeader

  • isBypassHostHeader(): boolean
  • Sets whether or not the host header must be dropped from the CONNECT/STOMP frame. Server may be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

    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

isTrailingLine

  • isTrailingLine(): boolean
  • Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

    Returns boolean

isTrustAll

  • isTrustAll(): boolean
  • Returns boolean

isUseAlpn

  • isUseAlpn(): boolean
  • Returns boolean

isUseStompFrame

  • isUseStompFrame(): boolean
  • Sets whether or not the connection is made using the STOMP command instead of the CONNECT command. The STOMP command has been introduced in the 1.2 version of the protocol to ease the network analysis (as CONNECT is also used by HTTP. To be compliant with server not implementing the 1.2 specification, this option should be disabled. This option is disabled by default.

    Returns boolean

setAcceptedVersions

  • Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest version to the highest. By default the following list is used: 1.0, 1.1, 1.2

    Parameters

    • acceptedVersions: string

    Returns StompClientOptions

setAutoComputeContentLength

  • Sets whether or not the automatic computation of the content-length header is enabled. If enabled, the content-length header is set in all frame with a body that do not explicitly set the header. The option is enabled by default.

    Parameters

    • autoComputeContentLength: boolean

    Returns StompClientOptions

setBypassHostHeader

  • Sets whether or not the host header must be dropped from the CONNECT/STOMP frame. Server may be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

    Parameters

    • bypassHostHeader: boolean

    Returns StompClientOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns StompClientOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): StompClientOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns StompClientOptions

setHeartbeat

  • Sets the heartbeat configuration.

    Parameters

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

    Returns StompClientOptions

setHost

  • Sets the STOMP server host. 0.0.0.0 by default.

    Parameters

    • host: string

    Returns StompClientOptions

setHostnameVerificationAlgorithm

  • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): StompClientOptions
  • Parameters

    • hostnameVerificationAlgorithm: string

    Returns StompClientOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns StompClientOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns StompClientOptions

setJdkSslEngineOptions

  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns StompClientOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns StompClientOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns StompClientOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns StompClientOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns StompClientOptions

setLogin

  • Sets the login to use if the STOMP server is secured.

    Parameters

    • login: string

    Returns StompClientOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns StompClientOptions

setOpenSslEngineOptions

  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns StompClientOptions

setPasscode

  • Sets the passcode to use if the STOMP server is secured.

    Parameters

    • passcode: string

    Returns StompClientOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns StompClientOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns StompClientOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns StompClientOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns StompClientOptions

setPort

  • Sets the STOMP server port. 61613 by default.

    Parameters

    • port: number

    Returns StompClientOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns StompClientOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns StompClientOptions

setReconnectAttempts

  • Parameters

    • reconnectAttempts: number

    Returns StompClientOptions

setReconnectInterval

  • Parameters

    • reconnectInterval: number

    Returns StompClientOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns StompClientOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns StompClientOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns StompClientOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns StompClientOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns StompClientOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns StompClientOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns StompClientOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns StompClientOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns StompClientOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns StompClientOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns StompClientOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns StompClientOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns StompClientOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns StompClientOptions

setTrailingLine

  • Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

    Parameters

    • trailingLine: boolean

    Returns StompClientOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns StompClientOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns StompClientOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns StompClientOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns StompClientOptions

setUseStompFrame

  • Sets whether or not the connection is made using the STOMP command instead of the CONNECT command. The STOMP command has been introduced in the 1.2 version of the protocol to ease the network analysis (as CONNECT is also used by HTTP. To be compliant with server not implementing the 1.2 specification, this option should be disabled. This option is disabled by default.

    Parameters

    • useStompFrame: boolean

    Returns StompClientOptions

setVirtualHost

  • Sets the virtual host that will be used as "host" header value in the CONNECT frame.

    Parameters

    • virtualHost: string

    Returns StompClientOptions

Generated using TypeDoc