TsgcWSPClient_MQTT › Properties

TsgcWSPClient_MQTT Properties

Published properties grouped by purpose, followed by the full alphabetical list.

Connection

Name	Description
Client	References the TsgcWebSocketClient that carries MQTT frames when connecting over WebSockets.
Broker	References a TsgcWSMQTTBroker component so the MQTT protocol runs over raw TCP instead of WebSockets.
MQTTVersion	Selects the MQTT protocol level advertised in the CONNECT packet (3.1.1 or 5.0).
Guid	Unique identifier that binds this subprotocol instance to its WebSocket or broker connection.

Messaging

Name	Description
QoS	Default Quality of Service level and retry/timeout behavior for outbound QoS 1 and QoS 2 messages.
LastWillTestament	Registers a Will message the broker publishes on behalf of this client if the connection is lost ungracefully.
ConnectProperties	MQTT 5.0 properties sent with the CONNECT packet: session expiry, receive maximum, packet size, topic aliases and extended authentication.

Reliability

Name	Description
HeartBeat	Sends MQTT PINGREQ packets periodically to keep the session alive and to detect silent broker drops.

Security

Name	Description
Authentication	Sends a UserName and Password in the MQTT CONNECT packet to authenticate the client against the broker.

Diagnostics

Name	Description
Version	Read-only string with the sgcWebSockets build version of the MQTT subprotocol component.

All Properties (alphabetical)

Name	Description
Authentication	Sends a UserName and Password in the MQTT CONNECT packet to authenticate the client against the broker.
Broker	References a TsgcWSMQTTBroker component so the MQTT protocol runs over raw TCP instead of WebSockets.
Client	References the TsgcWebSocketClient that carries MQTT frames when connecting over WebSockets.
ConnectProperties	MQTT 5.0 properties sent with the CONNECT packet: session expiry, receive maximum, packet size, topic aliases and extended authentication.
Guid	Unique identifier that binds this subprotocol instance to its WebSocket or broker connection.
HeartBeat	Sends MQTT PINGREQ packets periodically to keep the session alive and to detect silent broker drops.
LastWillTestament	Registers a Will message the broker publishes on behalf of this client if the connection is lost ungracefully.
MQTTVersion	Selects the MQTT protocol level advertised in the CONNECT packet (3.1.1 or 5.0).
QoS	Default Quality of Service level and retry/timeout behavior for outbound QoS 1 and QoS 2 messages.
Version	Read-only string with the sgcWebSockets build version of the MQTT subprotocol component.