myDevicesIoT / Cayenne-MQTT-mbed

The Cayenne MQTT mbed Library provides functions to easily connect to the Cayenne IoT project builder.

Dependents:   Cayenne-ESP8266Interface Cayenne-WIZnet_Library Cayenne-WIZnetInterface Cayenne-X-NUCLEO-IDW01M1 ... more

Embed: (wiki syntax)

« Back to documentation index

MQTTTimer Class Reference
Public Member Functions

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]millisecondsNumber of milliseconds to count down.

Definition at line 38 of file MQTTTimer.h.

Member Function Documentation

void countdown ( int  seconds )

Start countdown.

Parameters:
[in]secondsNumber of seconds to count down.

Definition at line 56 of file MQTTTimer.h.

void countdown_ms ( int  milliseconds )

Start countdown.

Parameters:
[in]millisecondsNumber 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 15:49:29 by  doxygen 1.7.2