forked from FreeRTOS/coreMQTT-Agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
core_mqtt_agent_command_functions.h
269 lines (250 loc) · 10.9 KB
/
core_mqtt_agent_command_functions.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/*
* coreMQTT Agent v1.2.0
* Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/**
* @file core_mqtt_agent_command_functions.h
* @brief Functions for processing an MQTT agent command.
*/
#ifndef CORE_MQTT_AGENT_COMMAND_FUNCTIONS_H
#define CORE_MQTT_AGENT_COMMAND_FUNCTIONS_H
/* *INDENT-OFF* */
#ifdef __cplusplus
extern "C" {
#endif
/* *INDENT-ON* */
/* MQTT Agent include. */
#include "core_mqtt_agent.h"
/**
* @brief 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.
*
* <b>Default value:</b> @code{c}
* {
* [ 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
* }
* @endcode
*/
#ifndef MQTT_AGENT_FUNCTION_TABLE
/* Designated initializers are only in C99+. */
#if defined( __STDC_VERSION__ ) && ( __STDC_VERSION__ >= 199901L )
#define MQTT_AGENT_FUNCTION_TABLE \
{ \
[ 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 \
}
#else /* if defined( __STDC_VERSION__ ) && ( __STDC_VERSION__ >= 199901L ) */
/* If not using designated initializers, this must correspond
* to the order of MQTTAgentCommandType_t commands. */
#define MQTT_AGENT_FUNCTION_TABLE \
{ \
MQTTAgentCommand_ProcessLoop, \
MQTTAgentCommand_ProcessLoop, \
MQTTAgentCommand_Publish, \
MQTTAgentCommand_Subscribe, \
MQTTAgentCommand_Unsubscribe, \
MQTTAgentCommand_Ping, \
MQTTAgentCommand_Connect, \
MQTTAgentCommand_Disconnect, \
MQTTAgentCommand_Terminate \
}
#endif /* if defined( __STDC_VERSION__ ) && ( __STDC_VERSION__ >= 199901L ) */
#endif /* ifndef MQTT_AGENT_FUNCTION_TABLE */
/*-----------------------------------------------------------*/
/**
* @ingroup mqtt_agent_struct_types
* @brief A structure of values and flags expected to be returned
* by command functions.
*/
typedef struct MQTTAgentCommandFuncReturns
{
uint16_t packetId; /**< @brief Packet ID of packet sent by command. */
bool endLoop; /**< @brief Flag to indicate command loop should terminate. */
bool addAcknowledgment; /**< @brief Flag to indicate an acknowledgment should be tracked. */
bool runProcessLoop; /**< @brief Flag to indicate MQTT_ProcessLoop() should be called after this command. */
} MQTTAgentCommandFuncReturns_t;
/**
* @brief Function prototype for a command.
*
* @note These functions should only be called from within
* #MQTTAgent_CommandLoop.
*
* @param[in] pMqttAgentContext MQTT Agent context.
* @param[in] pArgs Arguments for the command.
* @param[out] pFlags Return flags set by the function.
*
* @return Return code of MQTT call.
*/
typedef MQTTStatus_t (* MQTTAgentCommandFunc_t ) ( MQTTAgentContext_t * pMqttAgentContext,
void * pArgs,
MQTTAgentCommandFuncReturns_t * pFlags );
/*-----------------------------------------------------------*/
/**
* @brief 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
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pUnusedArg Unused NULL argument.
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return #MQTTSuccess.
*/
MQTTStatus_t MQTTAgentCommand_ProcessLoop( MQTTAgentContext_t * pMqttAgentContext,
void * pUnusedArg,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief Function to execute for a PUBLISH command.
*
* This sets the following flags to `true`:
* - MQTTAgentCommandFuncReturns_t.runProcessLoop
* - MQTTAgentCommandFuncReturns_t.addAcknowledgment (for QoS > 0)
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pPublishArg Publish information for MQTT_Publish().
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return Status code of MQTT_Publish().
*/
MQTTStatus_t MQTTAgentCommand_Publish( MQTTAgentContext_t * pMqttAgentContext,
void * pPublishArg,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief Function to execute for a SUBSCRIBE command.
*
* This sets the following flags to `true`:
* - MQTTAgentCommandFuncReturns_t.runProcessLoop
* - MQTTAgentCommandFuncReturns_t.addAcknowledgment
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pVoidSubscribeArgs Arguments for MQTT_Subscribe().
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return Status code of MQTT_Subscribe().
*/
MQTTStatus_t MQTTAgentCommand_Subscribe( MQTTAgentContext_t * pMqttAgentContext,
void * pVoidSubscribeArgs,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief Function to execute for an UNSUBSCRIBE command.
*
* This sets the following flags to `true`:
* - MQTTAgentCommandFuncReturns_t.runProcessLoop
* - MQTTAgentCommandFuncReturns_t.addAcknowledgment
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pVoidSubscribeArgs Arguments for MQTT_Unsubscribe().
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return Status code of MQTT_Unsubscribe().
*/
MQTTStatus_t MQTTAgentCommand_Unsubscribe( MQTTAgentContext_t * pMqttAgentContext,
void * pVoidSubscribeArgs,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief Function to execute for a CONNECT command.
*
* This sets all return flags to `false`.
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pVoidConnectArgs Arguments for MQTT_Connect().
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return Status code of MQTT_Connect().
*/
MQTTStatus_t MQTTAgentCommand_Connect( MQTTAgentContext_t * pMqttAgentContext,
void * pVoidConnectArgs,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief Function to execute for a DISCONNECT command.
*
* This sets the following flags to `true`:
* - MQTTAgentCommandFuncReturns_t.endLoop
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pUnusedArg Unused NULL argument.
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return Status code of MQTT_Disconnect().
*/
MQTTStatus_t MQTTAgentCommand_Disconnect( MQTTAgentContext_t * pMqttAgentContext,
void * pUnusedArg,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief Function to execute for a PING command.
*
* This sets the following flags to `true`:
* - MQTTAgentCommandFuncReturns_t.runProcessLoop
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pUnusedArg Unused NULL argument.
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return Status code of MQTT_Ping().
*/
MQTTStatus_t MQTTAgentCommand_Ping( MQTTAgentContext_t * pMqttAgentContext,
void * pUnusedArg,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/**
* @brief 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
*
* @param[in] pMqttAgentContext MQTT Agent context information.
* @param[in] pUnusedArg Unused NULL argument.
* @param[out] pReturnFlags Flags set to indicate actions the MQTT agent should take.
*
* @return #MQTTSuccess.
*/
MQTTStatus_t MQTTAgentCommand_Terminate( MQTTAgentContext_t * pMqttAgentContext,
void * pUnusedArg,
MQTTAgentCommandFuncReturns_t * pReturnFlags );
/* *INDENT-OFF* */
#ifdef __cplusplus
}
#endif
/* *INDENT-ON* */
#endif /* CORE_MQTT_AGENT_COMMAND_FUNCTIONS_H */