coreMQTT-Agent/source/include/core_mqtt_agent.h at main · ronakfof/coreMQTT-Agent

History

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

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

* coreMQTT Agent v1.2.0

* 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.h

* @brief Functions for running a coreMQTT client in a dedicated thread.

#ifndef CORE_MQTT_AGENT_H

#define CORE_MQTT_AGENT_H

/* *INDENT-OFF* */

#ifdef __cplusplus

extern "C" {

#endif

/* *INDENT-ON* */

/* MQTT library includes. */

#include "core_mqtt.h"

#include "core_mqtt_state.h"

#include "core_mqtt_agent_config_defaults.h"

/* Command messaging interface include. */

#include "core_mqtt_agent_message_interface.h"

/**

* @ingroup mqtt_agent_enum_types

* @brief A type of command for interacting with the MQTT API.

typedef enum MQTTCommandType

{

NONE = 0, /**< @brief No command received. Must be zero (its memset() value). */

PROCESSLOOP, /**< @brief Call MQTT_ProcessLoop(). */

PUBLISH, /**< @brief Call MQTT_Publish(). */

SUBSCRIBE, /**< @brief Call MQTT_Subscribe(). */

UNSUBSCRIBE, /**< @brief Call MQTT_Unsubscribe(). */

PING, /**< @brief Call MQTT_Ping(). */

CONNECT, /**< @brief Call MQTT_Connect(). */

DISCONNECT, /**< @brief Call MQTT_Disconnect(). */

TERMINATE, /**< @brief Exit the command loop and stop processing commands. */

NUM_COMMANDS /**< @brief The number of command types handled by the agent. */

} MQTTAgentCommandType_t;

struct MQTTAgentContext;

struct MQTTAgentCommandContext;

/**

* @ingroup mqtt_agent_struct_types

* @brief Struct holding return codes and outputs from a command

typedef struct MQTTAgentReturnInfo

{

MQTTStatus_t returnCode; /**< Return code of the MQTT command. */

uint8_t * pSubackCodes; /**< Array of SUBACK statuses, for a SUBSCRIBE command. */

} MQTTAgentReturnInfo_t;

/**

* @ingroup mqtt_agent_struct_types

* @brief 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.

typedef struct MQTTAgentCommandContext MQTTAgentCommandContext_t;

/**

* @ingroup mqtt_agent_callback_types

* @brief Callback function called when a command completes.

* @param[in] pCmdCallbackContext The callback context passed to the original command.

* @param[in] pReturnInfo A struct of status codes and outputs from the command.

* @note A command should not be considered complete until this callback is

* called, and the arguments that the command uses MUST stay in scope until such happens.

* @note The callback MUST NOT block as it runs in the context of the MQTT agent

* task. If the callback calls any MQTT Agent API to enqueue a command, the

* blocking time (blockTimeMs member of MQTTAgentCommandInfo_t) MUST be zero. If the

* application wants to enqueue command(s) with non-zero blocking time, the

* callback can notify a different task to enqueue command(s) to the MQTT agent.

typedef void (* MQTTAgentCommandCallback_t )( MQTTAgentCommandContext_t * pCmdCallbackContext,

MQTTAgentReturnInfo_t * pReturnInfo );

/**

* @ingroup mqtt_agent_struct_types

* @brief The commands sent from the APIs to the MQTT agent task.

* @note The structure used to pass information from the public facing API into the

* agent task. */

struct MQTTAgentCommand

{

MQTTAgentCommandType_t commandType; /**< @brief Type of command. */

void * pArgs; /**< @brief Arguments of command. */

MQTTAgentCommandCallback_t pCommandCompleteCallback; /**< @brief Callback to invoke upon completion. */

MQTTAgentCommandContext_t * pCmdContext; /**< @brief Context for completion callback. */

};

/**

* @ingroup mqtt_agent_struct_types

* @brief Information for a pending MQTT ack packet expected by the agent.

typedef struct MQTTAckInfo

{

uint16_t packetId; /**< Packet ID of the pending acknowledgment. */

MQTTAgentCommand_t * pOriginalCommand; /**< Command expecting acknowledgment. */

} MQTTAgentAckInfo_t;

/**

* @ingroup mqtt_agent_callback_types

* @brief Callback function called when receiving a publish.

* @param[in] pMqttAgentContext The context of the MQTT agent.

* @param[in] packetId The packet ID of the received publish.

* @param[in] pPublishInfo Deserialized publish information.

* @note The callback MUST NOT block as it runs in the context of the MQTT agent

* task. If the callback calls any MQTT Agent API to enqueue a command, the

* blocking time (blockTimeMs member of MQTTAgentCommandInfo_t) MUST be zero. If the

* application wants to enqueue command(s) with non-zero blocking time, the

* callback can notify a different task to enqueue command(s) to the MQTT agent.

typedef void (* MQTTAgentIncomingPublishCallback_t )( struct MQTTAgentContext * pMqttAgentContext,

uint16_t packetId,

MQTTPublishInfo_t * pPublishInfo );

/**

* @ingroup mqtt_agent_struct_types

* @brief 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.

typedef struct MQTTAgentContext

{

MQTTContext_t mqttContext; /**< MQTT connection information used by coreMQTT. */

MQTTAgentMessageInterface_t agentInterface; /**< Struct of function pointers for agent messaging. */

MQTTAgentAckInfo_t pPendingAcks[ MQTT_AGENT_MAX_OUTSTANDING_ACKS ]; /**< List of pending acknowledgment packets. */

MQTTAgentIncomingPublishCallback_t pIncomingCallback; /**< Callback to invoke for incoming publishes. */

void * pIncomingCallbackContext; /**< Context for incoming publish callback. */

bool packetReceivedInLoop; /**< Whether a MQTT_ProcessLoop() call received a packet. */

} MQTTAgentContext_t;

/**

* @ingroup mqtt_agent_struct_types

* @brief Struct holding arguments for a SUBSCRIBE or UNSUBSCRIBE call.

typedef struct MQTTAgentSubscribeArgs

{

MQTTSubscribeInfo_t * pSubscribeInfo; /**< @brief List of MQTT subscriptions. */

size_t numSubscriptions; /**< @brief Number of elements in `pSubscribeInfo`. */

} MQTTAgentSubscribeArgs_t;

/**

* @ingroup mqtt_agent_struct_types

* @brief Struct holding arguments for a CONNECT call.

typedef struct MQTTAgentConnectArgs

{

MQTTConnectInfo_t * pConnectInfo; /**< @brief MQTT CONNECT packet information. */

MQTTPublishInfo_t * pWillInfo; /**< @brief Optional Last Will and Testament. */

uint32_t timeoutMs; /**< @brief Maximum timeout for a CONNACK packet. */

bool sessionPresent; /**< @brief Output flag set if a previous session was present. */

} MQTTAgentConnectArgs_t;

/**

* @ingroup mqtt_agent_struct_types

* @brief Struct holding arguments that are common to every command.

typedef struct MQTTAgentCommandInfo

{

MQTTAgentCommandCallback_t cmdCompleteCallback; /**< @brief Callback to invoke upon completion. */

MQTTAgentCommandContext_t * pCmdCompleteCallbackContext; /**< @brief Context for completion callback. */

uint32_t blockTimeMs; /**< @brief Maximum block time for enqueueing the command. */

} MQTTAgentCommandInfo_t;

/*-----------------------------------------------------------*/

/**

* @brief Perform any initialization the MQTT agent requires before it can

* be used. Must be called before any other function.

* @param[in] pMqttAgentContext Pointer to struct to initialize.

* @param[in] pMsgInterface Command interface to use for allocating and sending commands.

* @param[in] pNetworkBuffer Pointer to network buffer to use.

* @param[in] pTransportInterface Transport interface to use with the MQTT

* library. See https://www.freertos.org/network-interface.html

* @param[in] getCurrentTimeMs Pointer to a function that returns a count value

* that increments every millisecond.

* @param[in] incomingCallback The callback to execute when receiving publishes.

* @param[in] pIncomingPacketContext A pointer to a context structure defined by

* the application writer.

* @note The @p pIncomingPacketContext context provided for the incoming publish

* callback MUST remain in scope throughout the period that the agent task is running.

* @return Appropriate status code from MQTT_Init().

* Example

* @code{c}

* // Function for obtaining a timestamp.

* uint32_t getTimeStampMs();

* // Callback function for receiving packets.

* void incomingPublishCallback( MQTTAgentContext_t * pMqttAgentContext,

* uint16_t packetId,

* MQTTPublishInfo_t * pPublishInfo );

* // Platform function for network send interface.

* int32_t networkSend( NetworkContext_t * pContext, const void * pBuffer, size_t bytes );

* // Platform for network receive interface.

* int32_t networkRecv( NetworkContext_t * pContext, void * pBuffer, size_t bytes );

* // Platform function for Agent Message Send.

* bool agentSendMessage( MQTTAgentMessageContext_t * pMsgCtx,

* MQTTAgentCommand_t * const * pCommandToSend,

* uint32_t blockTimeMs );

* // Platform function for Agent Message Receive.

* bool agentReceiveMessage( MQTTAgentMessageContext_t * pMsgCtx,

* MQTTAgentCommand_t ** pCommandToSend,

* uint32_t blockTimeMs );

* // Platform function to Get Agent Command.

* MQTTAgentCommand_t * getCommand( uint32_t blockTimeMs );

* // Platform function to Release Agent Command.

* bool releaseCommand( MQTTAgentCommand_t * pCommandToRelease );

* // Variables used in this example.

* MQTTAgentMessageInterface_t messageInterface;

* MQTTAgentMessageContext_t messageContext;

* MQTTAgentContext_t agentContext;

* TransportInterface_t transport;

* // Buffer for storing outgoing and incoming MQTT packets.

* MQTTFixedBuffer_t fixedBuffer;

* uint8_t buffer[ 1024 ];

* MQTTStatus_t status;

* // Set transport interface members.

* transport.pNetworkContext = &someTransportContext;

* transport.send = networkSend;

* transport.recv = networkRecv;

* // Set agent message interface members.

* messageInterface.pMsgCtx = &messageContext;

* messageInterface.send = agentSendMessage;

* messageInterface.recv = agentReceiveMessage;

* messageInterface.getCommand = getCommand;

* messageInterface.releaseCommand = releaseCommand;

* // Set buffer members.

* fixedBuffer.pBuffer = buffer;

* fixedBuffer.size = 1024;

* status = MQTTAgent_Init( &agentContext,

* &messageInterface,

* &networkBuffer,

* &transportInterface,

* stubGetTime,

* stubPublishCallback,

* incomingPacketContext );

* if( status == MQTTSuccess )

* {

* // Do something with agentContext. The transport and message interfaces, and

* // fixedBuffer structs were copied into the context, so the original structs

* // do not need to stay in scope.

* }

* @endcode

/* @[declare_mqtt_agent_init] */

MQTTStatus_t MQTTAgent_Init( MQTTAgentContext_t * pMqttAgentContext,

const MQTTAgentMessageInterface_t * pMsgInterface,

const MQTTFixedBuffer_t * pNetworkBuffer,

const TransportInterface_t * pTransportInterface,

MQTTGetCurrentTimeFunc_t getCurrentTimeMs,

MQTTAgentIncomingPublishCallback_t incomingCallback,

void * pIncomingPacketContext );

/* @[declare_mqtt_agent_init] */

/**

* @brief Process commands from the command queue in a loop.

* @param[in] pMqttAgentContext The MQTT agent to use.

* @return appropriate error code, or #MQTTSuccess from a successful disconnect

* or termination.

* Example

* @code{c}

* // Variables used in this example.

* MQTTStatus_t status;

* MQTTAgentContext_t mqttAgentContext;

* status = MQTTAgent_CommandLoop( &mqttAgentContext );

* // The function returns on either receiving a terminate command,

* // undergoing network disconnection OR encountering an error.

* if( ( status == MQTTSuccess ) && ( mqttAgentContext.mqttContext.connectStatus == MQTTNotConnected ) )

* {

* // A terminate command was processed and MQTT connection was closed.

* // Need to close socket connection.

* Platform_DisconnectNetwork( mqttAgentContext.mqttContext.transportInterface.pNetworkContext );

* }

* else if( status == MQTTSuccess )

* {

* // Terminate command was processed but MQTT connection was not

* // closed. Thus, need to close both MQTT and socket connections.

* status = MQTT_Disconnect( &( mqttAgentContext.mqttContext ) );

* assert( status == MQTTSuccess );

* Platform_DisconnectNetwork( mqttAgentContext.mqttContext.transportInterface.pNetworkContext );

* }

* else

* {

* // Handle error.

* }

* @endcode

/* @[declare_mqtt_agent_commandloop] */

MQTTStatus_t MQTTAgent_CommandLoop( MQTTAgentContext_t * pMqttAgentContext );

/* @[declare_mqtt_agent_commandloop] */

/**

* @brief Resume a session by resending publishes if a session is present in

* the broker, or clear state information if not.

* @param[in] pMqttAgentContext The MQTT agent to use.

* @param[in] sessionPresent The session present flag from the broker.

* @note This function is NOT thread-safe and should only be called

* from the context of the task responsible for #MQTTAgent_CommandLoop.

* @return #MQTTSuccess if it succeeds in resending publishes, else an

* appropriate error code from `MQTT_Publish()`

* Example

* @code{c}

* // Variables used in this example.

* MQTTStatus_t status;

* MQTTAgentContext_t mqttAgentContext;

* MQTTConnectInfo_t connectInfo = { 0 };

* MQTTPublishInfo_t willInfo = { 0 };

* bool sessionPresent;

* // The example assumes that all variables have been filled with

* // data for the MQTT_Connect call

* // Refer to the MQTT_Connect API for a more detailed example.

* // Attempt to resume session with the broker.

* status = MQTT_Connect( &( mqttAgentContext.mqttContext ), &connectInfo, &willInfo, 100, &sessionPresent )

* if( status == MQTTSuccess )

* {

* // Process the session present status sent by the broker.

* status = MQTTAgent_ResumeSession( &mqttAgentContext, sessionPresent );

* }

* @endcode

/* @[declare_mqtt_agent_resumesession] */

MQTTStatus_t MQTTAgent_ResumeSession( MQTTAgentContext_t * pMqttAgentContext,

bool sessionPresent );

/* @[declare_mqtt_agent_resumesession] */

/**

* @brief Cancel all enqueued commands and those awaiting acknowledgment

* while the command loop is not running.

* Canceled commands will be terminated with return code #MQTTRecvFailed.

* @param[in] pMqttAgentContext The MQTT agent to use.

* @note This function is NOT thread-safe and should only be called

* from the context of the task responsible for #MQTTAgent_CommandLoop.

* @return #MQTTBadParameter if an invalid context is given, else #MQTTSuccess.

* Example

* @code{c}

* // Variables used in this example.

* MQTTStatus_t status;

* MQTTAgentContext_t mqttAgentContext;

* status = MQTTAgent_CommandLoop( &mqttAgentContext );

* //An error was returned, but reconnection is not desired. Cancel all commands

* //that are in the queue or awaiting an acknowledgment.

* if( status != MQTTSuccess )

* {

* //Cancel commands so any completion callbacks will be invoked.

* status = MQTTAgent_CancelAll( &mqttAgentContext );

* }

* Platform_DisconnectNetwork( mqttAgentContext.mqttContext.transportInterface.pNetworkContext );

* @endcode

/* @[declare_mqtt_agent_cancelall] */

MQTTStatus_t MQTTAgent_CancelAll( MQTTAgentContext_t * pMqttAgentContext );

/* @[declare_mqtt_agent_cancelall] */

/**

* @brief Add a command to call MQTT_Subscribe() for an MQTT connection.

* @param[in] pMqttAgentContext The MQTT agent to use.

* @param[in] pSubscriptionArgs Struct describing topic to subscribe to.

* @param[in] pCommandInfo The information pertaining to the command, including:

* - cmdCompleteCallback Optional callback to invoke when the command completes.

* - pCmdCompleteCallbackContext Optional completion callback context.

* - blockTimeMs The maximum amount of time in milliseconds to wait for the

* command to be posted to the MQTT agent, should the agent's event queue

* be full. Tasks wait in the Blocked state so don't use any CPU time.

* @note The context passed to the callback through pCmdContext member of

* @p pCommandInfo parameter MUST remain in scope at least until the callback

* has been executed by the agent task.

* @return #MQTTSuccess if the command was posted to the MQTT agent's event queue.

* Otherwise an enumerated error code.

* Example

* @code{c}

* // Variables used in this example.

* MQTTAgentContext_t agentContext;

* MQTTStatus_t status;

* MQTTAgentCommandInfo_t commandInfo = { 0 };

* MQTTSubscribeInfo_t subscribeInfo = { 0 };

* MQTTAgentSubscribeArgs_t subscribeArgs = { 0 };

* // Function for command complete callback.

* void subscribeCmdCompleteCb( MQTTAgentCommandContext_t * pCmdCallbackContext,

* MQTTAgentReturnInfo_t * pReturnInfo );

* // Fill the command information.

* commandInfo.CmdCompleteCallback = subscribeCmdCompleteCb;

* commandInfo.blockTimeMs = 500;

* // Fill the information for topic filters to subscribe to.

* subscribeInfo.qos = Qos1;

* subscribeInfo.pTopicFilter = "/foo/bar";

* subscribeInfo.topicFilterLength = strlen("/foo/bar");

* subscribeArgs.pSubscribeInfo = &subscribeInfo;

* subscribeArgs.numSubscriptions = 1U;

* status = MQTTAgent_Subscribe( &agentContext, &subscribeArgs, &commandInfo );

* if( status == MQTTSuccess )

* {

* // Command to send subscribe request to the server has been queued. Notification

* // about completion of the subscribe operation will be notified to application

* // through invocation of subscribeCmdCompleteCb().

* }

* @endcode

/* @[declare_mqtt_agent_subscribe] */

MQTTStatus_t MQTTAgent_Subscribe( const MQTTAgentContext_t * pMqttAgentContext,

MQTTAgentSubscribeArgs_t * pSubscriptionArgs,

const MQTTAgentCommandInfo_t * pCommandInfo );

/* @[declare_mqtt_agent_subscribe] */

/**

* @brief Add a command to call MQTT_Unsubscribe() for an MQTT connection.

* @param[in] pMqttAgentContext The MQTT agent to use.

* @param[in] pSubscriptionArgs List of topics to unsubscribe from.