Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: 5_Dragonfly_Cayenne_Sprint_IKS01A1
Fork of Cayenne-MQTT-mbed-MTSAS by
MQTTTimer Class Reference
Timer class for use with MQTTClient. More...
#include <MQTTTimer.h>
Public Member Functions | |
| MQTTTimer () | |
| Construct a timer. | |
| MQTTTimer (int milliseconds) | |
| Construct a timer and start it. | |
| void | countdown_ms (int milliseconds) |
| Start countdown. | |
| void | countdown (int seconds) |
| Start countdown. | |
| int | left_ms () |
| Get the number of milliseconds left in countdown. | |
| bool | expired () |
| The countdown timer has expired. | |
Detailed Description
Timer class for use with MQTTClient.
Definition at line 26 of file MQTTTimer.h.
Constructor & Destructor Documentation
| MQTTTimer | ( | ) |
Construct a timer.
Definition at line 32 of file MQTTTimer.h.
| MQTTTimer | ( | int | milliseconds ) |
Construct a timer and start it.
- Parameters:
-
[in] milliseconds Number of milliseconds to count down.
Definition at line 38 of file MQTTTimer.h.
Member Function Documentation
| void countdown | ( | int | seconds ) |
Start countdown.
- Parameters:
-
[in] seconds Number of seconds to count down.
Definition at line 56 of file MQTTTimer.h.
| void countdown_ms | ( | int | milliseconds ) |
Start countdown.
- Parameters:
-
[in] milliseconds Number of milliseconds to count down.
Definition at line 46 of file MQTTTimer.h.
| bool expired | ( | ) |
The countdown timer has expired.
- Returns:
- true if countdown has expired, false otherwise.
Definition at line 72 of file MQTTTimer.h.
| int left_ms | ( | ) |
Get the number of milliseconds left in countdown.
- Returns:
- Number of milliseconds left.
Definition at line 64 of file MQTTTimer.h.
Generated on Wed Jul 13 2022 08:52:00 by
1.7.2
