Class MQTTClient

Hierarchy

  • EventTarget
    • MQTTClient

Constructors

constructor

Accessors

clientId host path port

Methods

addEventListener connect disconnect dispatchEvent getStatus getTraceLog isSubscribed mount publish removeEventListener startTrace stopTrace subscribe unmount

Events

EVENT_ERROR EVENT_FILTER EVENT_STATE

Constructors

constructor

Accessors

clientId

host

path

port

Methods

addEventListener

  • addEventListener(type, callback, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

connect

disconnect

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

getStatus

getTraceLog

isSubscribed

mount

publish

  • publish(topic, payload, qos?, retained?): boolean

  • Send a message to the consumers of the destination in the Message.

    Parameters

    • topic: string

      The name of the destination to which the message is to be sent.

    • payload: string | ArrayBuffer

      The message payload to be sent.

    • Optionalqos: Qos = 0

      The Quality of Service used to deliver the message.

    • Optionalretained: boolean = false

      If true, the message is to be retained by the server and delivered to both current and future subscriptions. If false the server only delivers the message to current subscribers, this is the default for new Messages. A received message has the retained boolean set to true if the message was published with the retained boolean set to true and the subscrption was made after the message has been published.

    Returns boolean

    If the message was sent

removeEventListener

  • removeEventListener(type, callback, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

startTrace

stopTrace

subscribe

unmount

Events

StaticEVENT_ERROR

EVENT_ERROR: string = "error"

Error Event

Example

client.addEventListener("error",(ev)=>{})

StaticEVENT_FILTER

EVENT_FILTER: string = "filter"

Filter Event

Example

client.addEventListener("filter:/topic/example",(ev)=>{})

Emited when a message from the broker is received.

StaticEVENT_STATE

EVENT_STATE: string = "state"

State Event

Example

client.addEventListener("state",(ev)=>{})

 Emited when the client changes state.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
Events