Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StompServerOptions

STOMP Server options. You can also configure the Net Server used by the STOMP server from these options.

Hierarchy

  • StompServerOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns StompServerOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns StompServerOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns StompServerOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): StompServerOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns StompServerOptions

getAcceptBacklog

  • getAcceptBacklog(): number
  • Returns number

getClientAuth

  • getClientAuth(): ClientAuth
  • Returns ClientAuth

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

getIdleTimeout

  • getIdleTimeout(): number
  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Returns any

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Returns JksOptions

getLogActivity

  • getLogActivity(): boolean
  • Returns boolean

getMaxBodyLength

  • getMaxBodyLength(): number
  • Sets the max body length accepted by the server. 10 Mb by default.

    Returns number

getMaxFrameInTransaction

  • getMaxFrameInTransaction(): number
  • Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a transaction exceeds this threshold, the client receives an ERROR frame and is disconnected. The default is 1000.

    Returns number

getMaxHeaderLength

  • getMaxHeaderLength(): number
  • Sets the max header length.

    Returns number

getMaxHeaders

  • getMaxHeaders(): number
  • Sets the maximum number of headers. 1000 by default.

    Returns number

getMaxSubscriptionsByClient

  • getMaxSubscriptionsByClient(): number
  • Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives an error and the connection is closed.

    Returns number

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

getPort

  • getPort(): number
  • Sets the port on which the server is going to listen for TCP connection.

    Returns number

getProxyProtocolTimeout

  • getProxyProtocolTimeout(): number
  • Returns number

getProxyProtocolTimeoutUnit

  • getProxyProtocolTimeoutUnit(): any
  • Returns any

getReceiveBufferSize

  • getReceiveBufferSize(): 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

getSupportedVersions

  • getSupportedVersions(): string
  • Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

    Returns string

getTimeFactor

  • getTimeFactor(): number
  • Sets the time factor.

    Returns number

getTrafficClass

  • getTrafficClass(): number
  • Returns number

getTransactionChunkSize

  • getTransactionChunkSize(): number
  • Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large transactions are split into chunks, replayed one by one. This settings sets the chunk size.

    Returns number

getTrustOptions

  • getTrustOptions(): any
  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • Returns JksOptions

getWebsocketPath

  • getWebsocketPath(): string
  • Sets the websocket path. Only frames received on this path would be considered as STOMP frame.

    Returns string

isReuseAddress

  • isReuseAddress(): boolean
  • Returns boolean

isReusePort

  • isReusePort(): boolean
  • Returns boolean

isSecured

  • isSecured(): boolean
  • Enables or disables the server security feature. It requires an {@link AuthenticationProvider} handler.

    Returns boolean

isSendErrorOnNoSubscriptions

  • isSendErrorOnNoSubscriptions(): boolean
  • Sets whether or not an error is sent to the client when this client sends a message to an not subscribed destinations (no subscriptions on this destination).

    Returns boolean

isSni

  • isSni(): 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

isUseAlpn

  • isUseAlpn(): boolean
  • Returns boolean

isUseProxyProtocol

  • isUseProxyProtocol(): boolean
  • Returns boolean

isWebsocketBridge

  • isWebsocketBridge(): boolean
  • Enables or disables the web socket bridge.

    Returns boolean

setAcceptBacklog

  • Parameters

    • acceptBacklog: number

    Returns StompServerOptions

setClientAuth

  • Parameters

    • clientAuth: ClientAuth

    Returns StompServerOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): StompServerOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns StompServerOptions

setHeartbeat

  • Sets the heartbeat configuration.

    Parameters

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

    Returns StompServerOptions

setHost

  • Parameters

    • host: string

    Returns StompServerOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns StompServerOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns StompServerOptions

setJdkSslEngineOptions

  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns StompServerOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns StompServerOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns StompServerOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns StompServerOptions

setMaxBodyLength

  • Sets the max body length accepted by the server. 10 Mb by default.

    Parameters

    • maxBodyLength: number

    Returns StompServerOptions

setMaxFrameInTransaction

  • Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a transaction exceeds this threshold, the client receives an ERROR frame and is disconnected. The default is 1000.

    Parameters

    • maxFrameInTransaction: number

    Returns StompServerOptions

setMaxHeaderLength

  • Sets the max header length.

    Parameters

    • maxHeaderLength: number

    Returns StompServerOptions

setMaxHeaders

  • Sets the maximum number of headers. 1000 by default.

    Parameters

    • maxHeaders: number

    Returns StompServerOptions

setMaxSubscriptionsByClient

  • Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives an error and the connection is closed.

    Parameters

    • maxSubscriptionsByClient: number

    Returns StompServerOptions

setOpenSslEngineOptions

  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns StompServerOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns StompServerOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns StompServerOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns StompServerOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns StompServerOptions

setPort

  • Sets the port on which the server is going to listen for TCP connection.

    Parameters

    • port: number

    Returns StompServerOptions

setProxyProtocolTimeout

  • Parameters

    • proxyProtocolTimeout: number

    Returns StompServerOptions

setProxyProtocolTimeoutUnit

  • Parameters

    • proxyProtocolTimeoutUnit: any

    Returns StompServerOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns StompServerOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns StompServerOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns StompServerOptions

setSecured

  • Enables or disables the server security feature. It requires an {@link AuthenticationProvider} handler.

    Parameters

    • secured: boolean

    Returns StompServerOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns StompServerOptions

setSendErrorOnNoSubscriptions

  • Sets whether or not an error is sent to the client when this client sends a message to an not subscribed destinations (no subscriptions on this destination).

    Parameters

    • sendErrorOnNoSubscriptions: boolean

    Returns StompServerOptions

setSni

  • Parameters

    • sni: boolean

    Returns StompServerOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns StompServerOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns StompServerOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns StompServerOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns StompServerOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns StompServerOptions

setSupportedVersions

  • Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

    Parameters

    • supportedVersions: string

    Returns StompServerOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns StompServerOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns StompServerOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns StompServerOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns StompServerOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns StompServerOptions

setTimeFactor

  • Sets the time factor.

    Parameters

    • timeFactor: number

    Returns StompServerOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns StompServerOptions

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 StompServerOptions

setTransactionChunkSize

  • Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large transactions are split into chunks, replayed one by one. This settings sets the chunk size.

    Parameters

    • transactionChunkSize: number

    Returns StompServerOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns StompServerOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns StompServerOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns StompServerOptions

setUseProxyProtocol

  • Parameters

    • useProxyProtocol: boolean

    Returns StompServerOptions

setWebsocketBridge

  • Enables or disables the web socket bridge.

    Parameters

    • websocketBridge: boolean

    Returns StompServerOptions

setWebsocketPath

  • Sets the websocket path. Only frames received on this path would be considered as STOMP frame.

    Parameters

    • websocketPath: string

    Returns StompServerOptions

Generated using TypeDoc