MattzoMQTTSubscriber Class Reference

Class used to publish messages to an MQTT broker. More...

#include <MattzoMQTTSubscriber.h>

Static Public Member Functions
static void	Setup (MCMQTTConfiguration *config, void(*MQTThandler)(const char *message))
	Setup the MQTT Subscriber.
static int	GetStatus ()
static void	Loop ()

Static Public Attributes
static QueueHandle_t	IncomingQueue = nullptr
static int	ReconnectDelayInMilliseconds = 1000
	Reconnect delay in milliseconds. This configures the delay between reconnect attempts.
static int	HandleMessageDelayInMilliseconds = 10
	Send message delay in milliseconds. This configures the delay between send message attempts.
static uint8_t	TaskPriority = 2
	The priority at which the task should run. Systems that include MPU support can optionally create tasks in a privileged (system) mode by setting bit portPRIVILEGE_BIT of the priority parameter. For example, to create a privileged task at priority 2 the uxPriority parameter should be set to ( 2 | portPRIVILEGE_BIT ).
static int8_t	CoreID = 0
	If the value is tskNO_AFFINITY, the created task is not pinned to any CPU, and the scheduler can run it on any core available. Values 0 or 1 indicate the index number of the CPU which the task should be pinned to. Specifying values larger than (portNUM_PROCESSORS - 1) will cause the function to fail.
static uint32_t	StackDepth = 2048
	The size of the task stack specified as the number of bytes.
static uint16_t	MaxBufferSize = 1024
	The maximum message size, including header, specified as the number of bytes. Messages larger than this are ignored!
static void(*	handler )(const char *message) = nullptr

Detailed Description

Class used to publish messages to an MQTT broker.

Member Function Documentation

GetStatus()

int MattzoMQTTSubscriber::GetStatus ( )

static

Here is the caller graph for this function:

Loop()

void MattzoMQTTSubscriber::Loop ( )

static

Here is the caller graph for this function:

Setup()

void MattzoMQTTSubscriber::Setup ( MCMQTTConfiguration * config, void(*)(const char *message) MQTThandler )

static

Setup the MQTT Subscriber.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

CoreID

int8_t MattzoMQTTSubscriber::CoreID = 0

static

If the value is tskNO_AFFINITY, the created task is not pinned to any CPU, and the scheduler can run it on any core available. Values 0 or 1 indicate the index number of the CPU which the task should be pinned to. Specifying values larger than (portNUM_PROCESSORS - 1) will cause the function to fail.

HandleMessageDelayInMilliseconds

int MattzoMQTTSubscriber::HandleMessageDelayInMilliseconds = 10

static

Send message delay in milliseconds. This configures the delay between send message attempts.

handler

void(* MattzoMQTTSubscriber::handler)(const char *message) = nullptr

static

IncomingQueue

QueueHandle_t MattzoMQTTSubscriber::IncomingQueue = nullptr

static

MaxBufferSize

uint16_t MattzoMQTTSubscriber::MaxBufferSize = 1024

static

The maximum message size, including header, specified as the number of bytes. Messages larger than this are ignored!

ReconnectDelayInMilliseconds

int MattzoMQTTSubscriber::ReconnectDelayInMilliseconds = 1000

static

Reconnect delay in milliseconds. This configures the delay between reconnect attempts.

StackDepth

uint32_t MattzoMQTTSubscriber::StackDepth = 2048

static

The size of the task stack specified as the number of bytes.

TaskPriority

uint8_t MattzoMQTTSubscriber::TaskPriority = 2

static

The priority at which the task should run. Systems that include MPU support can optionally create tasks in a privileged (system) mode by setting bit portPRIVILEGE_BIT of the priority parameter. For example, to create a privileged task at priority 2 the uxPriority parameter should be set to ( 2 | portPRIVILEGE_BIT ).

---

The documentation for this class was generated from the following files:

• /home/hilbert/src/MattzoStuff/MattzoControllers/src/lib/MCNetwork/MattzoMQTTSubscriber.h
• /home/hilbert/src/MattzoStuff/MattzoControllers/src/lib/MCNetwork/MattzoMQTTSubscriber.cpp