coreMQTT Agent v1.0.0
Thread safe MQTT 3.1.1 Client
Parameter Structures

Structures passed as parameters to MQTT Agent functions. More...

Data Structures

struct  MQTTAgentReturnInfo_t
 Struct holding return codes and outputs from a command. More...
 
struct  MQTTAgentCommand_t
 The commands sent from the APIs to the MQTT agent task. More...
 
struct  MQTTAgentAckInfo_t
 Information for a pending MQTT ack packet expected by the agent. More...
 
struct  MQTTAgentContext_t
 Information used by each MQTT agent. A context will be initialized by MQTTAgent_Init(), and every API function will accept a pointer to the initalized struct. More...
 
struct  MQTTAgentSubscribeArgs_t
 Struct holding arguments for a SUBSCRIBE or UNSUBSCRIBE call. More...
 
struct  MQTTAgentConnectArgs_t
 Struct holding arguments for a CONNECT call. More...
 
struct  MQTTAgentCommandInfo_t
 Struct holding arguments that are common to every command. More...
 
struct  MQTTAgentCommandFuncReturns_t
 A structure of values and flags expected to be returned by command functions. More...
 
struct  MQTTAgentMessageInterface_t
 Function pointers and contexts used for sending and receiving commands, and allocating memory for them. More...
 

Typedefs

typedef struct MQTTAgentCommandContext MQTTAgentCommandContext_t
 Struct containing context for a specific command. More...
 
typedef struct MQTTAgentMessageContext MQTTAgentMessageContext_t
 Context with which tasks may deliver messages to the agent.
 

Detailed Description

Structures passed as parameters to MQTT Agent functions.

These structures are passed as parameters to library functions. Documentation for these structures will state the functions associated with each parameter structure and the purpose of each member.

Typedef Documentation

◆ MQTTAgentCommandContext_t

typedef struct MQTTAgentCommandContext MQTTAgentCommandContext_t

Struct containing context for a specific command.

Note
An instance of this struct and any variables it points to MUST stay in scope until the associated command is processed, and its callback called.