Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MqttServerOptions

Represents options used by the MQTT server

Hierarchy

  • any
    • MqttServerOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns MqttServerOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns MqttServerOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns MqttServerOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): MqttServerOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns MqttServerOptions

getAcceptBacklog

  • getAcceptBacklog(): number
  • Returns number

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Returns any

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[]

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

getMaxClientIdLength

  • getMaxClientIdLength(): number
  • Set the max client id length.

    Returns number

getMaxMessageSize

  • getMaxMessageSize(): number
  • Set max MQTT message size

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

getProxyProtocolTimeout

  • getProxyProtocolTimeout(): number
  • Returns number

getProxyProtocolTimeoutUnit

  • getProxyProtocolTimeoutUnit(): any
  • Returns any

getReadIdleTimeout

  • getReadIdleTimeout(): number
  • Returns number

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

getTcpUserTimeout

  • getTcpUserTimeout(): number
  • Returns number

getTrafficClass

  • getTrafficClass(): number
  • Returns number

getTrustOptions

  • getTrustOptions(): any
  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • Returns JksOptions

getWebSocketCompressionLevel

  • getWebSocketCompressionLevel(): number
  • Set the WebSocket compression level.

    Returns number

getWebSocketMaxFrameSize

  • getWebSocketMaxFrameSize(): number
  • Set the WebSocket max frame size.

    This should be used when WebSocket transport is used and MqttServerOptions is larger than the WebSocket frame size

    Returns number

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • Returns number

isAutoClientId

  • isAutoClientId(): boolean
  • Set if clientid should be auto-generated when it's "zero-bytes"

    Returns boolean

isPerFrameWebSocketCompressionSupported

  • isPerFrameWebSocketCompressionSupported(): boolean
  • Enable or disable support for the WebSocket per-frame deflate compression extension.

    Returns boolean

isPerMessageWebSocketCompressionSupported

  • isPerMessageWebSocketCompressionSupported(): boolean
  • Enable or disable support for WebSocket per-message deflate compression extension.

    Returns boolean

isRegisterWriteHandler

  • isRegisterWriteHandler(): boolean
  • Returns boolean

isReuseAddress

  • isReuseAddress(): boolean
  • Returns boolean

isReusePort

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

isUseAlpn

  • isUseAlpn(): boolean
  • Returns boolean

isUseProxyProtocol

  • isUseProxyProtocol(): boolean
  • Returns boolean

isUseWebSocket

  • isUseWebSocket(): boolean
  • enable mqtt over websocket

    Returns boolean

isWebSocketAllowServerNoContext

  • isWebSocketAllowServerNoContext(): boolean
  • Set whether the WebSocket server will accept the server_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

    Returns boolean

isWebSocketPreferredClientNoContext

  • isWebSocketPreferredClientNoContext(): boolean
  • Set whether the WebSocket server will accept the client_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

    Returns boolean

setAcceptBacklog

  • Parameters

    • acceptBacklog: number

    Returns MqttServerOptions

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns MqttServerOptions

setAutoClientId

  • Set if clientid should be auto-generated when it's "zero-bytes"

    Parameters

    • autoClientId: boolean

    Returns MqttServerOptions

setClientAuth

  • Parameters

    • clientAuth: ClientAuth

    Returns MqttServerOptions

setEnabledSecureTransportProtocols

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

    • enabledSecureTransportProtocols: string[]

    Returns MqttServerOptions

setHost

  • Parameters

    • host: string

    Returns MqttServerOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns MqttServerOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns MqttServerOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): MqttServerOptions
  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns MqttServerOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns MqttServerOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns MqttServerOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns MqttServerOptions

setMaxClientIdLength

  • Set the max client id length.

    Parameters

    • maxClientIdLength: number

    Returns MqttServerOptions

setMaxMessageSize

  • Set max MQTT message size

    Parameters

    • maxMessageSize: number

    Returns MqttServerOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): MqttServerOptions
  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns MqttServerOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns MqttServerOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns MqttServerOptions

setPerFrameWebSocketCompressionSupported

  • setPerFrameWebSocketCompressionSupported(perFrameWebSocketCompressionSupported: boolean): MqttServerOptions
  • Enable or disable support for the WebSocket per-frame deflate compression extension.

    Parameters

    • perFrameWebSocketCompressionSupported: boolean

    Returns MqttServerOptions

setPerMessageWebSocketCompressionSupported

  • setPerMessageWebSocketCompressionSupported(perMessageWebSocketCompressionSupported: boolean): MqttServerOptions
  • Enable or disable support for WebSocket per-message deflate compression extension.

    Parameters

    • perMessageWebSocketCompressionSupported: boolean

    Returns MqttServerOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns MqttServerOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns MqttServerOptions

setPort

  • Parameters

    • port: number

    Returns MqttServerOptions

setProxyProtocolTimeout

  • Parameters

    • proxyProtocolTimeout: number

    Returns MqttServerOptions

setProxyProtocolTimeoutUnit

  • Parameters

    • proxyProtocolTimeoutUnit: any

    Returns MqttServerOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns MqttServerOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns MqttServerOptions

setRegisterWriteHandler

  • Parameters

    • registerWriteHandler: boolean

    Returns MqttServerOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns MqttServerOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns MqttServerOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns MqttServerOptions

setSni

  • Parameters

    • sni: boolean

    Returns MqttServerOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns MqttServerOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns MqttServerOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns MqttServerOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns MqttServerOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns MqttServerOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns MqttServerOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns MqttServerOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns MqttServerOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns MqttServerOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns MqttServerOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns MqttServerOptions

setTimeoutOnConnect

  • Set the timeout on CONNECT packet

    Parameters

    • timeoutOnConnect: number

    Returns MqttServerOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns MqttServerOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns MqttServerOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns MqttServerOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns MqttServerOptions

setUseProxyProtocol

  • Parameters

    • useProxyProtocol: boolean

    Returns MqttServerOptions

setUseWebSocket

  • enable mqtt over websocket

    Parameters

    • useWebSocket: boolean

    Returns MqttServerOptions

setWebSocketAllowServerNoContext

  • setWebSocketAllowServerNoContext(webSocketAllowServerNoContext: boolean): MqttServerOptions
  • Set whether the WebSocket server will accept the server_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

    Parameters

    • webSocketAllowServerNoContext: boolean

    Returns MqttServerOptions

setWebSocketCompressionLevel

  • Set the WebSocket compression level.

    Parameters

    • webSocketCompressionLevel: number

    Returns MqttServerOptions

setWebSocketMaxFrameSize

  • Set the WebSocket max frame size.

    This should be used when WebSocket transport is used and MqttServerOptions is larger than the WebSocket frame size

    Parameters

    • webSocketMaxFrameSize: number

    Returns MqttServerOptions

setWebSocketPreferredClientNoContext

  • setWebSocketPreferredClientNoContext(webSocketPreferredClientNoContext: boolean): MqttServerOptions
  • Set whether the WebSocket server will accept the client_no_context_takeover parameter of the per-message deflate compression extension offered by the client.

    Parameters

    • webSocketPreferredClientNoContext: boolean

    Returns MqttServerOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns MqttServerOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc