Skip to content

Latest commit

 

History

History
159 lines (106 loc) · 2.68 KB

EVENTS.md

File metadata and controls

159 lines (106 loc) · 2.68 KB

Connect

Emitted after client is connected to the broker.

client.on("connect", () => {
  console.log("Client Connected !!");
});

Ready

Emitted after broker is ready to receive packets

client.on("ready", () => {
  console.log("Client Ready !!");
});

Close

Emitted after connection closed.

hadError

  • Type: boolean
  • Description: If connection closed because of an error or not.
client.on("close", (hadError) => {
  console.log("Client Connection Closed !!");
});

End

Emitted after connection ends.

client.on("end", (hadError) => {
  console.log("Client Connection Ended !!");
});

Close

Emitted after an error occured.

error

  • Type: Error
  • Description: Error argument in tcp socket.
client.on("close", (hadError) => {
  console.log("Client Connection Closed !!");
});

Timeout

Emitted after connection timedout.

client.on("timeout", (hadError) => {
  console.log("Connection Timedout !!");
});

connectionAccepted

Emitted after broker accepts client connection.

returnCode

  • Type: any
  • Description: Return code from the broker.

message

  • Type: string
  • Description: Message from the broker.
client.on("connectionAccepted", ({ returnCode, message }) => {
  console.log("Client Connection Accepted !!");
});

connectionRefused

Emitted after if broker refuses client connection

returnCode

  • Type: any
  • Description: Return code from the broker.

message

  • Type: string
  • Description: Message from the broker.
client.on("connectionRefused", ({ returnCode, message }) => {
  console.log("Client Connection Refused !!");
});

Pingresp

Emitted after ping response received by client

response

  • Type: string
  • Description: Default pingresp message
client.on("pingresp", (response) => {
  console.log("Server pinged back !!");
});

Suback

Emitted after subscribe acknowledgement packet received by client

packetID

  • Type: number[]
  • Description: Packet identifier

returnCodes

  • Type: object

  • Description: Suback information

  • Properties:

    type: string

    message: string

    returnCode: string

client.on("suback", ({ packetID, returnCodes }) => {
  console.log("Client SuBack Response", returnCodes, packetID);
});

Unsuback

Emitted after unsubscribe acknowledgement packet received by client

client.on("unsuback", ({ packetID, returnCodes }) => {});