Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MqttClient

Hierarchy

  • EventEmitter
    • MqttClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

clientId

clientId: string

closed

closed: boolean = false

connected

connected: boolean = false

connectedTimes

connectedTimes: number = 1

host

host: string = null

id

id: string

keepalive

keepalive: number

keepaliveTimer

keepaliveTimer: Timer = null

lastPing

lastPing: number = -1

lastPong

lastPong: number = -1

port

port: number = null

reconnectDelay

reconnectDelay: number = 0

reconnectDelayMax

reconnectDelayMax: number

reconnectId

reconnectId: Timer = null

requests

requests: object

Type declaration

socket

socket: mqtt_connection = null

timeout

timeout: number

timeoutFlag

timeoutFlag: boolean = false

timeoutId

timeoutId: Timer = null

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addTimeout

  • addTimeout(reconnectFlag?: boolean): void

checkKeepAlive

  • checkKeepAlive(): void

close

  • close(): void

connect

  • connect(host?: string, port?: number, cb?: Function): any

disconnect

  • disconnect(): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

exit

  • exit(): void

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

onSocketClose

  • onSocketClose(): void

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

reconnect

  • reconnect(): void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

  • send(topic: string, msg: any): void

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setupKeepAlive

  • setupKeepAlive(): void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number