Clients.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2009, 2020 IBM Corp.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * and Eclipse Distribution License v1.0 which accompany this distribution. 
 *
 * The Eclipse Public License is available at 
 *    https://www.eclipse.org/legal/epl-2.0/
 * and the Eclipse Distribution License is available at 
 *   http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *    Ian Craggs - initial API and implementation and/or initial documentation
 *    Ian Craggs - add SSL support
 *    Ian Craggs - fix for bug 413429 - connectionLost not called
 *    Ian Craggs - change will payload to binary
 *    Ian Craggs - password to binary
 *    Ian Craggs - MQTT 5 support
 *******************************************************************************/

#if !defined(CLIENTS_H)
#define CLIENTS_H

#include <stdint.h>
#include "MQTTTime.h"
#if defined(OPENSSL)
#if defined(_WIN32) || defined(_WIN64)
#include <winsock2.h>
#endif
#include <openssl/ssl.h>
#endif
#include "MQTTClient.h"
#include "LinkedList.h"
#include "MQTTClientPersistence.h"

typedef struct
{
        char *topic;
        int topiclen;
        char* payload;
        int payloadlen;
        int refcount;
        uint8_t mask[4];
} Publications;

typedef struct
{
        int qos;
        int retain;
        int msgid;
        int MQTTVersion;
        MQTTProperties properties;
        Publications *publish;
        START_TIME_TYPE lastTouch;                  
        char nextMessageType;   
        int len;                                
} Messages;

typedef struct
{
        char *topic;
        int payloadlen;
        void *payload;
        int retained;
        int qos;
} willMessages;

typedef struct
{
        int socket;
        START_TIME_TYPE lastSent;
        START_TIME_TYPE lastReceived;
        START_TIME_TYPE lastPing;
#if defined(OPENSSL)
        SSL* ssl;
        SSL_CTX* ctx;
        char *https_proxy;
        char *https_proxy_auth;
#endif
        char *http_proxy;
        char *http_proxy_auth;
        int websocket; 
        char *websocket_key;
        const MQTTClient_nameValue* httpHeaders;
} networkHandles;


/* connection states */
#define NOT_IN_PROGRESS  0x0

#define TCP_IN_PROGRESS  0x1

#define SSL_IN_PROGRESS  0x2

#define WEBSOCKET_IN_PROGRESS   0x3

#define WAIT_FOR_CONNACK 0x4

#define PROXY_CONNECT_IN_PROGRESS 0x5

#define DISCONNECTING    -2

typedef struct
{
        char* clientID;                                       
        const char* username;                                   
        int passwordlen;              
        const void* password;                                   
        unsigned int cleansession : 1;  
        unsigned int cleanstart : 1;            
        unsigned int connected : 1;             
        unsigned int good : 1;                    
        unsigned int ping_outstanding : 1;
        signed int connect_state : 4;
        networkHandles net;             
        int msgID;                      
        int keepAliveInterval;          
        int retryInterval;
        int maxInflightMessages;        
        willMessages* will;             
        List* inboundMsgs;              
        List* outboundMsgs;                             
        List* messageQueue;             
        unsigned int qentry_seqno;
        void* phandle;                  
        MQTTClient_persistence* persistence; 
    MQTTPersistence_beforeWrite* beforeWrite; 
    MQTTPersistence_afterRead* afterRead; 
    void* beforeWrite_context;      
    void* afterRead_context;        
        void* context;                  
        int MQTTVersion;                
        int sessionExpiry;              
#if defined(OPENSSL)
        MQTTClient_SSLOptions *sslopts; 
        SSL_SESSION* session;           
#endif
} Clients;

int clientIDCompare(void* a, void* b);
int clientSocketCompare(void* a, void* b);

typedef struct
{
        const char* version;
        List* clients;
} ClientStates;

#endif