TsgcWSPClient_MQTT › Events

TsgcWSPClient_MQTT Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Lifecycle

Name	Description
OnMQTTBeforeConnect	Fires before the CONNECT packet is sent; lets the app override CleanSession and ClientIdentifier.
OnMQTTConnect	Fires after CONNACK is received; reports Session flag, ReasonCode and MQTT 5 ConnectProperties.
OnMQTTDisconnect	Fires when the broker sends a DISCONNECT or the session is closed; reports ReasonCode and MQTT 5 DisconnectProperties.
OnMQTTPing	Fires when the client receives a PINGRESP acknowledging a previously sent PINGREQ.
OnMQTTAuth	Fires during the MQTT 5 enhanced authentication exchange when the broker sends an AUTH packet.

Publish

Name	Description
OnMQTTPublish	Fires when the broker delivers an incoming PUBLISH message; exposes Topic, Text and MQTT 5 PublishProperties.
OnMQTTPublishEx	Fires on incoming PUBLISH; delivers the payload as a TsgcWSMQTTPublishData (Value, Bytes, Stream) plus the raw TsgcWSMQTTMessage.
OnMQTTPubAck	Fires when a PUBACK is received for a QoS 1 publish (PUBLISH → PUBACK).
OnMQTTPubRec	Fires on the second leg of the QoS 2 handshake (PUBLISH → PUBREC → PUBREL → PUBCOMP).
OnMQTTPubRel	Fires on the third leg of the QoS 2 handshake when a PUBREL is received.
OnMQTTPubComp	Fires on the fourth and final leg of the QoS 2 handshake when a PUBCOMP is received.

Subscribe

Name	Description
OnMQTTSubscribe	Fires when a SUBACK is received in response to Subscribe; exposes per-topic reason codes and MQTT 5 SubscribeProperties.
OnMQTTUnSubscribe	Fires when an UNSUBACK is received in response to UnSubscribe; exposes per-topic reason codes and MQTT 5 UnsubscribeProperties.

All Events (alphabetical)

Name	Description
OnMQTTAuth	Fires during the MQTT 5 enhanced authentication exchange when the broker sends an AUTH packet.
OnMQTTBeforeConnect	Fires before the CONNECT packet is sent; lets the app override CleanSession and ClientIdentifier.
OnMQTTConnect	Fires after CONNACK is received; reports Session flag, ReasonCode and MQTT 5 ConnectProperties.
OnMQTTDisconnect	Fires when the broker sends a DISCONNECT or the session is closed; reports ReasonCode and MQTT 5 DisconnectProperties.
OnMQTTPing	Fires when the client receives a PINGRESP acknowledging a previously sent PINGREQ.
OnMQTTPubAck	Fires when a PUBACK is received for a QoS 1 publish (PUBLISH → PUBACK).
OnMQTTPubComp	Fires on the fourth and final leg of the QoS 2 handshake when a PUBCOMP is received.
OnMQTTPublish	Fires when the broker delivers an incoming PUBLISH message; exposes Topic, Text and MQTT 5 PublishProperties.
OnMQTTPublishEx	Fires on incoming PUBLISH; delivers the payload as a TsgcWSMQTTPublishData (Value, Bytes, Stream) plus the raw TsgcWSMQTTMessage.
OnMQTTPubRec	Fires on the second leg of the QoS 2 handshake (PUBLISH → PUBREC → PUBREL → PUBCOMP).
OnMQTTPubRel	Fires on the third leg of the QoS 2 handshake when a PUBREL is received.
OnMQTTSubscribe	Fires when a SUBACK is received in response to Subscribe; exposes per-topic reason codes and MQTT 5 SubscribeProperties.
OnMQTTUnSubscribe	Fires when an UNSUBACK is received in response to UnSubscribe; exposes per-topic reason codes and MQTT 5 UnsubscribeProperties.