Functions for processing an MQTT agent command. More...

#include "core_mqtt_agent.h"

Data Structures
struct	MQTTAgentCommandFuncReturns_t
	A structure of values and flags expected to be returned by command functions. More...

Macros
#define	MQTT_AGENT_FUNCTION_TABLE
	An array of function pointers mapping command types to a function to execute. Configurable to allow a linker to remove unneeded functions. More...

Typedefs
typedef MQTTStatus_t(*	MQTTAgentCommandFunc_t) (MQTTAgentContext_t pMqttAgentContext, void pArgs, MQTTAgentCommandFuncReturns_t *pFlags)
	Function prototype for a command. More...

Functions
MQTTStatus_t	MQTTAgentCommand_ProcessLoop (MQTTAgentContext_t pMqttAgentContext, void pUnusedArg, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a NONE command. This function does not call MQTT_ProcessLoop itself, but instead sets a flag to indicate it should be called. More...

MQTTStatus_t	MQTTAgentCommand_Publish (MQTTAgentContext_t pMqttAgentContext, void pPublishArg, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a PUBLISH command. More...

MQTTStatus_t	MQTTAgentCommand_Subscribe (MQTTAgentContext_t pMqttAgentContext, void pVoidSubscribeArgs, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a SUBSCRIBE command. More...

MQTTStatus_t	MQTTAgentCommand_Unsubscribe (MQTTAgentContext_t pMqttAgentContext, void pVoidSubscribeArgs, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for an UNSUBSCRIBE command. More...

MQTTStatus_t	MQTTAgentCommand_Connect (MQTTAgentContext_t pMqttAgentContext, void pVoidConnectArgs, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a CONNECT command. More...

MQTTStatus_t	MQTTAgentCommand_Disconnect (MQTTAgentContext_t pMqttAgentContext, void pUnusedArg, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a DISCONNECT command. More...

MQTTStatus_t	MQTTAgentCommand_Ping (MQTTAgentContext_t pMqttAgentContext, void pUnusedArg, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a PING command. More...

MQTTStatus_t	MQTTAgentCommand_Terminate (MQTTAgentContext_t pMqttAgentContext, void pUnusedArg, MQTTAgentCommandFuncReturns_t *pReturnFlags)
	Function to execute for a TERMINATE command. Calls MQTTAgent_CancelAll to terminate all unfinished commands with MQTTRecvFailed. More...

Detailed Description

Functions for processing an MQTT agent command.

Macro Definition Documentation

◆ MQTT_AGENT_FUNCTION_TABLE

#define MQTT_AGENT_FUNCTION_TABLE

Value:

    {                                     \
        MQTTAgentCommand_ProcessLoop,     \
        MQTTAgentCommand_ProcessLoop,     \
        MQTTAgentCommand_Publish,         \
        MQTTAgentCommand_Subscribe,       \
        MQTTAgentCommand_Unsubscribe,     \
        MQTTAgentCommand_Ping,            \
        MQTTAgentCommand_Connect,         \
        MQTTAgentCommand_Disconnect,      \
        MQTTAgentCommand_Terminate        \
    }

An array of function pointers mapping command types to a function to execute. Configurable to allow a linker to remove unneeded functions.

Note: This array controls the behavior of each command. Altering the array would allow a linker to discard unused MQTT functions if desired. The size of this array MUST equal NUM_COMMANDS and the order MUST correspond to MQTTAgentCommandType_t commands if not using C99 designated initializers. If any function is desired not to be linked, it may be set to MQTTAgentCommand_ProcessLoop or a custom function matching an MQTTAgentCommandFunc_t prototype.

Default value:

{
    [ NONE ]        = MQTTAgentCommand_ProcessLoop,
    [ PROCESSLOOP ] = MQTTAgentCommand_ProcessLoop,
    [ PUBLISH ]     = MQTTAgentCommand_Publish,
    [ SUBSCRIBE ]   = MQTTAgentCommand_Subscribe,
    [ UNSUBSCRIBE ] = MQTTAgentCommand_Unsubscribe,
    [ PING ]        = MQTTAgentCommand_Ping,
    [ CONNECT ]     = MQTTAgentCommand_Connect,
    [ DISCONNECT ]  = MQTTAgentCommand_Disconnect,
    [ TERMINATE ]   = MQTTAgentCommand_Terminate
}

Typedef Documentation

◆ MQTTAgentCommandFunc_t

typedef MQTTStatus_t(* MQTTAgentCommandFunc_t) (MQTTAgentContext_t *pMqttAgentContext, void *pArgs, MQTTAgentCommandFuncReturns_t *pFlags)

Function prototype for a command.

Note: These functions should only be called from within MQTTAgent_CommandLoop.

Parameters

[in]	pMqttAgentContext	MQTT Agent context.
[in]	pArgs	Arguments for the command.
[out]	pFlags	Return flags set by the function.

Returns: Return code of MQTT call.

Function Documentation

◆ MQTTAgentCommand_ProcessLoop()

MQTTStatus_t MQTTAgentCommand_ProcessLoop	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pUnusedArg,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a NONE command. This function does not call MQTT_ProcessLoop itself, but instead sets a flag to indicate it should be called.

This sets the following flags to true:

MQTTAgentCommandFuncReturns_t.runProcessLoop

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pUnusedArg	Unused NULL argument.
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: MQTTSuccess.

◆ MQTTAgentCommand_Publish()

MQTTStatus_t MQTTAgentCommand_Publish	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pPublishArg,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a PUBLISH command.

This sets the following flags to true:

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pPublishArg	Publish information for MQTT_Publish().
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: Status code of MQTT_Publish().

◆ MQTTAgentCommand_Subscribe()

MQTTStatus_t MQTTAgentCommand_Subscribe	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pVoidSubscribeArgs,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a SUBSCRIBE command.

This sets the following flags to true:

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pVoidSubscribeArgs	Arguments for MQTT_Subscribe().
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: Status code of MQTT_Subscribe().

◆ MQTTAgentCommand_Unsubscribe()

MQTTStatus_t MQTTAgentCommand_Unsubscribe	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pVoidSubscribeArgs,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for an UNSUBSCRIBE command.

This sets the following flags to true:

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pVoidSubscribeArgs	Arguments for MQTT_Unsubscribe().
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: Status code of MQTT_Unsubscribe().

◆ MQTTAgentCommand_Connect()

MQTTStatus_t MQTTAgentCommand_Connect	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pVoidConnectArgs,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a CONNECT command.

This sets all return flags to false.

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pVoidConnectArgs	Arguments for MQTT_Connect().
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: Status code of MQTT_Connect().

◆ MQTTAgentCommand_Disconnect()

MQTTStatus_t MQTTAgentCommand_Disconnect	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pUnusedArg,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a DISCONNECT command.

This sets the following flags to true:

MQTTAgentCommandFuncReturns_t.endLoop

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pUnusedArg	Unused NULL argument.
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: Status code of MQTT_Disconnect().

◆ MQTTAgentCommand_Ping()

MQTTStatus_t MQTTAgentCommand_Ping	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pUnusedArg,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a PING command.

This sets the following flags to true:

MQTTAgentCommandFuncReturns_t.runProcessLoop

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pUnusedArg	Unused NULL argument.
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: Status code of MQTT_Ping().

◆ MQTTAgentCommand_Terminate()

MQTTStatus_t MQTTAgentCommand_Terminate	(	MQTTAgentContext_t *	pMqttAgentContext,
		void *	pUnusedArg,
		MQTTAgentCommandFuncReturns_t *	pReturnFlags
	)

Function to execute for a TERMINATE command. Calls MQTTAgent_CancelAll to terminate all unfinished commands with MQTTRecvFailed.

This sets the following flags to true:

MQTTAgentCommandFuncReturns_t.endLoop

Parameters

[in]	pMqttAgentContext	MQTT Agent context information.
[in]	pUnusedArg	Unused NULL argument.
[out]	pReturnFlags	Flags set to indicate actions the MQTT agent should take.

Returns: MQTTSuccess.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ MQTT_AGENT_FUNCTION_TABLE

Typedef Documentation

◆ MQTTAgentCommandFunc_t

Function Documentation

◆ MQTTAgentCommand_ProcessLoop()

◆ MQTTAgentCommand_Publish()

◆ MQTTAgentCommand_Subscribe()

◆ MQTTAgentCommand_Unsubscribe()

◆ MQTTAgentCommand_Connect()

◆ MQTTAgentCommand_Disconnect()

◆ MQTTAgentCommand_Ping()

◆ MQTTAgentCommand_Terminate()