This package includes the SharkSSL lite library and header files.

Dependents:   WebSocket-Client-Example SharkMQ-LED-Demo

Embed: (wiki syntax)

« Back to documentation index

SharkMQTT Struct Reference

SharkMQTT Struct Reference
[MQTTLib]

SharkMQTT structure. More...

#include <SharkMQTT.h>

Data Fields

S32 pingTmo
 Time interval in seconds for MQTT PING messages sent to the server.
U32 packetLen
 MQTT packet length.
U32 bytesRead
 Read packet data using SharkMQTT_getMessage until: packetLen-bytesRead == 0.
U32 msgLen
 MQTT message length.
U32 timeout
 Timeout in milliseconds to wait in functions waiting for server data.

Detailed Description

SharkMQTT structure.

See [SharkMQ library](MQTTLib) for details.

Definition at line 177 of file SharkMQTT.h.


Field Documentation

U32 bytesRead

Read packet data using SharkMQTT_getMessage until: packetLen-bytesRead == 0.

See also:
SharkMQTT_msgConsumed

Definition at line 208 of file SharkMQTT.h.

U32 msgLen

MQTT message length.

Definition at line 212 of file SharkMQTT.h.

U32 packetLen

MQTT packet length.

Definition at line 202 of file SharkMQTT.h.

S32 pingTmo

Time interval in seconds for MQTT PING messages sent to the server.

The default value is 20 minutes (1200 seconds). Note: the variable must be set before calling SharkMQTT_connect.

Definition at line 190 of file SharkMQTT.h.

U32 timeout

Timeout in milliseconds to wait in functions waiting for server data.

Definition at line 221 of file SharkMQTT.h.