SharkMQTT.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 ****************************************************************************
 *            HEADER
 *
 *   This file is part of SharkMQTT:
 *             https://realtimelogic.com/products/sharkmqtt/
 *
 *   $Id: SharkMQTT.h 6677 2026-10-29 19:41:17Z wini $
 *
 *   COPYRIGHT:  Real Time Logic, 2015 - 2026
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://www.realtimelogic.com
 */
 
#ifndef _SharkMQTT_h
#define _SharkMQTT_h
 
#include <selib.h>
#include <DoubleList.h>
 
 
 
typedef enum
{
   MqttState_Invalid,
   MqttState_Pub,
   MqttState_PubRel,
   MqttState_PubRec,
   MqttState_SubOrUnsub
} MqttState;
 
 
typedef struct
{
   DoubleLink super;
   U32 timeStamp;
   U16 packetId; /* [MQTT-2.3.1] Packet Identifier */
   U8 state; /* type MqttState */
} MqttInFlightMsg;
 
 
 
#define SMQTTE_SOCKET        -1
 
#define SMQTTE_ERRORBASE        -10000
 
#define SMQTTE_TIMEOUT          -10001
 
#define SMQTTE_PONGTIMEOUT      -10002
 
#define SMQTTE_PROTOCOL_ERROR   -10003
 
#define SMQTTE_OVERFLOW         -10005
 
#define SMQTTE_ALREADYCON       -10006
 
#define SMQTTE_CONREFUSED       -10007
 
#define SMQTTE_SERVERNOTTRUSTED -10008
 
#define SMQTTE_NOMEM            -10009
 
 /* end SharkMQTTErrorCodes */
 
 
#define SMQTT_TIMEOUT -20000
 
#define SMQTT_SUBACK -20001
 
#define SMQTT_UNSUBACK -20002
 /* end SharkMQTTRespCodes */
 
 
typedef struct
{
   const char* topic;  
   const U8* message;  
   U16 msgLen;         
   U8 qos;  
   BaBool retain;
} MqttWillMsg;
 
 
typedef struct
{
   const char* username;
   const U8* password;
   U16 pwdlen;
} MqttCredentials;
 
 
typedef struct
{
   SOCKET sock;
 
   DoubleList recQueue; /* type MqttInFlightMsg: for QOS > 0 */
   DoubleList sendQueue; /* type MqttInFlightMsg: for QOS > 0 */
 
   SharkSslCon* scon;
 
   S32 pingTmo;
 
   S32 pongTmoCounter;
   U32 pingTickTime;
 
   U8* recPackHeader;    /* from constructor: buf */
   U16 recPackHeaderLen; /* from constructor: bufLen */
   
   U16 packetId; /* send packet ID counter */
 
   U32 packetLen; 
 
   U32 bytesRead;
 
   U32 msgLen;
 
   U8* overflowPtr; /* Set if: consumed more data from stream than frame len */ 
   int overflowLen; /* overflowPtr len is used internally in wsRawRead */
   int messageHeaderIx; /* Cursor used when reading recPackHeader from socket */
   int packetHeaderLen; /* Fixed header length while collecting packet fields */
   U8 packetFieldsPending; /* Header fields retained across receive timeouts */
 
   U32 timeout;
 
   U16 recPacketId; /* For received packets with QOS 1 or 2 */
   U8  recQOS; /* For received packets with QOS 1 or 2 */
} SharkMQTT;
 
 
void SharkMQTT_constructor(SharkMQTT* o, U8* buf, U16 bufLen);
 
#define SharkMQTT_setCtx(o, ctx) SOCKET_constructor(&(o)->sock, ctx)
 
 
void SharkMQTT_destructor(SharkMQTT* o);
 
 
#define SharkMQTT_msgConsumed(o) (((o)->packetLen - (o)->bytesRead) == 0)
 
 
#define SharkMQTT_connackCode(o) (o)->recPackHeader[3]
 
 
#define SharkMQTT_sessionPresent(o) ((o)->recPackHeader[2] & 1)
 
#define SharkMQTT_trustInfo(o) ((SharkSslConTrust)(o)->packetLen)
 
 
int SharkMQTT_connect(SharkMQTT* o, SharkSslCon* scon,
                      const char* address, U16 port,
                      const char* clientId, MqttCredentials* cred,
                      BaBool cleanSession, MqttWillMsg* wm);
 
 
int SharkMQTT_subscribe(SharkMQTT* o, const char* topic, U8 qos, U16* packetId);
 
 
int SharkMQTT_unsubscribe(SharkMQTT* o, const char* topic, U16* packetId);
 
 
U8* SharkMQTT_zeroCopyPub(
   SharkMQTT* o, const char* topic, U8 qos, int* maxMsgLen);
 
 
#define SharkMQTT_pub0(o, topic, msg, msgLen)        \
   SharkMQTT_publish(o, topic, msg, msgLen, FALSE, 0)
 
 
int SharkMQTT_publish(SharkMQTT* o, const char* topic,
                      const void* msg, int msgLen, U8 retain, U8 qos);
 
 
#define SharkMQTT_packetId(o) (o)->recPacketId
 
#define SharkMQTT_subAckCode(o) ((U16)(o)->recPackHeader[4])
 
 
#define SharkMQTT_dup(o) (((o)->recPackHeader[0] & 8) ? TRUE : FALSE)
 
#define SharkMQTT_QOS(o) (((o)->recPackHeader[0] >> 1) & 3)
 
#define SharkMQTT_retain(o) ((o)->recPackHeader[0] & 1)
 
#define SharkMQTT_topic(o) ((const char*)((o)->recPackHeader+1))
 
int SharkMQTT_getMessage(SharkMQTT* o, U8** msg);
 
 
void SharkMQTT_disconnect(SharkMQTT* o);
 /* end group MQTTLib */
 
#endif