This represents the default values for the configuration macros for the MQTT-Agent library. More...

#include "core_mqtt_agent_config.h"

Macros
#define	MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG
	Define this macro to build the MQTT library without the custom config file core_mqtt_agent_config.h. More...

#define	MQTT_AGENT_MAX_OUTSTANDING_ACKS ( 20U )
	The maximum number of pending acknowledgments to track for a single connection. More...

#define	MQTT_AGENT_MAX_EVENT_QUEUE_WAIT_TIME ( 1000U )
	Time in milliseconds that the MQTT agent task will wait in the Blocked state (so not using any CPU time) for a command to arrive in its command queue before exiting the blocked state so it can call MQTT_ProcessLoop(). More...

#define	MQTT_AGENT_USE_QOS_1_2_PUBLISH ( 1 )
	Whether the agent should configure the coreMQTT library to be used with publishes greater than QoS0. Setting this to 0 will disallow the coreMQTT library to send publishes with QoS > 0. More...

Detailed Description

This represents the default values for the configuration macros for the MQTT-Agent library.

Note: This file SHOULD NOT be modified. If custom values are needed for any configuration macro, a core_mqtt_agent_config.h file should be provided to the MQTT-Agent library to override the default values defined in this file. To use the custom config file, the MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG preprocessor macro SHOULD NOT be set.

Macro Definition Documentation

◆ MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG

#define MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG

Define this macro to build the MQTT library without the custom config file core_mqtt_agent_config.h.

Without the custom config, the MQTT library builds with default values of config macros defined in core_mqtt_agent_config_defaults.h file.

If a custom config is provided, then MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG should be defined.

◆ MQTT_AGENT_MAX_OUTSTANDING_ACKS

#define MQTT_AGENT_MAX_OUTSTANDING_ACKS ( 20U )

The maximum number of pending acknowledgments to track for a single connection.

Note: The MQTT agent tracks MQTT commands (such as PUBLISH and SUBSCRIBE) th at are still waiting to be acknowledged. MQTT_AGENT_MAX_OUTSTANDING_ACKS set the maximum number of acknowledgments that can be outstanding at any one time. The higher this number is the greater the agent's RAM consumption will be.

Possible values: Any positive integer up to SIZE_MAX.
Default value: 20

◆ MQTT_AGENT_MAX_EVENT_QUEUE_WAIT_TIME

#define MQTT_AGENT_MAX_EVENT_QUEUE_WAIT_TIME ( 1000U )

Time in milliseconds that the MQTT agent task will wait in the Blocked state (so not using any CPU time) for a command to arrive in its command queue before exiting the blocked state so it can call MQTT_ProcessLoop().

Note: It is important MQTT_ProcessLoop() is called often if there is known MQTT traffic, but calling it too often can take processing time away from lower priority tasks and waste CPU time and power.

Possible values: Any positive 32 bit integer.
Default value: 1000

◆ MQTT_AGENT_USE_QOS_1_2_PUBLISH

#define MQTT_AGENT_USE_QOS_1_2_PUBLISH ( 1 )

Whether the agent should configure the coreMQTT library to be used with publishes greater than QoS0. Setting this to 0 will disallow the coreMQTT library to send publishes with QoS > 0.