Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MqttClientOptions

Represents options used by the MQTT client.

Hierarchy

  • any
    • MqttClientOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns MqttClientOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns MqttClientOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns MqttClientOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): MqttClientOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns MqttClientOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns MqttClientOptions

getAckTimeout

  • getAckTimeout(): number
  • Sets the time in seconds after which the client will stop waiting for a PUBACK, PUBREC or PUBCOMP packet from the server in response to a packet it has sent.

    The default value of this property is -1 which indicates that the client should wait an unlimited time for the server's acknowledgement.

    Returns number

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Returns any

getApplicationLayerProtocols

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

getClientId

  • getClientId(): string
  • Set the client identifier

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

getHostnameVerificationAlgorithm

  • getHostnameVerificationAlgorithm(): string
  • Returns string

getIdleTimeout

  • getIdleTimeout(): number
  • Do the same thing as MqttClientOptions (int)}. Use it instead.

    Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Returns any

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeepAliveInterval

  • getKeepAliveInterval(): number
  • Set the keep alive interval in seconds

    Returns number

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Returns JksOptions

getLocalAddress

  • getLocalAddress(): string
  • Returns string

getLogActivity

  • getLogActivity(): boolean
  • Returns boolean

getMaxInflightQueue

  • getMaxInflightQueue(): number
  • Set max count of unacknowledged messages

    Returns number

getMaxMessageSize

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

    Returns number

getMetricsName

  • getMetricsName(): string
  • Returns string

getNonProxyHosts

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

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPassword

  • getPassword(): string
  • Set the password

    Returns string

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

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

getUsername

  • getUsername(): string
  • Set the username

    Returns string

getWillMessage

  • getWillMessage(): string
  • Set the content of the will message

    Returns string

getWillQoS

  • getWillQoS(): number
  • Set the QoS level for the will message

    Returns number

getWillTopic

  • getWillTopic(): string
  • Set the topic on which the will message will be published

    Returns string

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • Returns number

isAutoAck

  • isAutoAck(): boolean
  • Set to false to let the application code to ack the message via . If true, the ack (PUBACK/PUBCOMP) will be sent by vertx-mqtt before execution. (default is true)

    Returns boolean

isAutoGeneratedClientId

  • isAutoGeneratedClientId(): boolean
  • Set if the MQTT client must generate clientId automatically (default is true)

    Returns boolean

isAutoKeepAlive

  • isAutoKeepAlive(): boolean
  • Set if the MQTT client must handle PINGREQ automatically (default is true)

    Returns boolean

isCleanSession

  • isCleanSession(): boolean
  • Set to start with a clean session (or not)

    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

isWillFlag

  • isWillFlag(): boolean
  • Set if will information are provided on connection

    Returns boolean

isWillRetain

  • isWillRetain(): boolean
  • Set if the will message must be retained

    Returns boolean

setAckTimeout

  • Sets the time in seconds after which the client will stop waiting for a PUBACK, PUBREC or PUBCOMP packet from the server in response to a packet it has sent.

    The default value of this property is -1 which indicates that the client should wait an unlimited time for the server's acknowledgement.

    Parameters

    • ackTimeout: number

    Returns MqttClientOptions

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns MqttClientOptions

setApplicationLayerProtocols

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

    • applicationLayerProtocols: string[]

    Returns MqttClientOptions

setAutoAck

  • Set to false to let the application code to ack the message via . If true, the ack (PUBACK/PUBCOMP) will be sent by vertx-mqtt before execution. (default is true)

    Parameters

    • autoAck: boolean

    Returns MqttClientOptions

setAutoGeneratedClientId

  • Set if the MQTT client must generate clientId automatically (default is true)

    Parameters

    • autoGeneratedClientId: boolean

    Returns MqttClientOptions

setAutoKeepAlive

  • Set if the MQTT client must handle PINGREQ automatically (default is true)

    Parameters

    • autoKeepAlive: boolean

    Returns MqttClientOptions

setCleanSession

  • Set to start with a clean session (or not)

    Parameters

    • cleanSession: boolean

    Returns MqttClientOptions

setClientId

  • Set the client identifier

    Parameters

    • clientId: string

    Returns MqttClientOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns MqttClientOptions

setEnabledSecureTransportProtocols

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

    • enabledSecureTransportProtocols: string[]

    Returns MqttClientOptions

setHostnameVerificationAlgorithm

  • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): MqttClientOptions
  • Parameters

    • hostnameVerificationAlgorithm: string

    Returns MqttClientOptions

setIdleTimeout

  • Do the same thing as MqttClientOptions (int)}. Use it instead.

    Parameters

    • idleTimeout: number

    Returns MqttClientOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns MqttClientOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): MqttClientOptions
  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns MqttClientOptions

setKeepAliveInterval

  • Set the keep alive interval in seconds

    Parameters

    • keepAliveInterval: number

    Returns MqttClientOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns MqttClientOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns MqttClientOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns MqttClientOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns MqttClientOptions

setMaxInflightQueue

  • Set max count of unacknowledged messages

    Parameters

    • maxInflightQueue: number

    Returns MqttClientOptions

setMaxMessageSize

  • Set max MQTT message size

    Parameters

    • maxMessageSize: number

    Returns MqttClientOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns MqttClientOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns MqttClientOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): MqttClientOptions
  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns MqttClientOptions

setPassword

  • Set the password

    Parameters

    • password: string

    Returns MqttClientOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns MqttClientOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns MqttClientOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns MqttClientOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns MqttClientOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns MqttClientOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns MqttClientOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns MqttClientOptions

setReconnectAttempts

  • Parameters

    • reconnectAttempts: number

    Returns MqttClientOptions

setReconnectInterval

  • Parameters

    • reconnectInterval: number

    Returns MqttClientOptions

setRegisterWriteHandler

  • Parameters

    • registerWriteHandler: boolean

    Returns MqttClientOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns MqttClientOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns MqttClientOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns MqttClientOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns MqttClientOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns MqttClientOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns MqttClientOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns MqttClientOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns MqttClientOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns MqttClientOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns MqttClientOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns MqttClientOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns MqttClientOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns MqttClientOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns MqttClientOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns MqttClientOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns MqttClientOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns MqttClientOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns MqttClientOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns MqttClientOptions

setUsername

  • Set the username

    Parameters

    • username: string

    Returns MqttClientOptions

setWillFlag

  • Set if will information are provided on connection

    Parameters

    • willFlag: boolean

    Returns MqttClientOptions

setWillMessage

  • Set the content of the will message

    Parameters

    • willMessage: string

    Returns MqttClientOptions

setWillQoS

  • Set the QoS level for the will message

    Parameters

    • willQoS: number

    Returns MqttClientOptions

setWillRetain

  • Set if the will message must be retained

    Parameters

    • willRetain: boolean

    Returns MqttClientOptions

setWillTopic

  • Set the topic on which the will message will be published

    Parameters

    • willTopic: string

    Returns MqttClientOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns MqttClientOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc