mqtt_client.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. #ifndef HV_MQTT_CLIENT_H_
  2. #define HV_MQTT_CLIENT_H_
  3. #include "mqtt_protocol.h"
  4. #include "hloop.h"
  5. #include "hssl.h"
  6. #include "hmutex.h"
  7. #define DEFAULT_MQTT_KEEPALIVE 60 // s
  8. typedef struct mqtt_client_s mqtt_client_t;
  9. // @type mqtt_type_e
  10. // @example examples/mqtt
  11. typedef void (*mqtt_client_cb)(mqtt_client_t* cli, int type);
  12. struct mqtt_client_s {
  13. // connect: host:port
  14. char host[256];
  15. int port;
  16. int connect_timeout; // ms
  17. // reconnect
  18. reconn_setting_t* reconn_setting;
  19. // login: flags + keepalive + client_id + will + username + password
  20. // flags
  21. unsigned char protocol_version; // Default MQTT_PROTOCOL_V311
  22. unsigned char clean_session: 1;
  23. unsigned char ssl: 1; // Read Only
  24. unsigned char alloced_ssl_ctx: 1; // intern
  25. unsigned char connected : 1;
  26. unsigned short keepalive;
  27. char client_id[64];
  28. // will
  29. mqtt_message_t* will;
  30. // auth
  31. char username[64];
  32. char password[64];
  33. // message
  34. mqtt_head_t head;
  35. int error; // for MQTT_TYPE_CONNACK
  36. int mid; // for MQTT_TYPE_SUBACK, MQTT_TYPE_PUBACK
  37. mqtt_message_t message; // for MQTT_TYPE_PUBLISH
  38. // callback
  39. mqtt_client_cb cb;
  40. // userdata
  41. void* userdata;
  42. // privdata
  43. hloop_t* loop;
  44. hio_t* io;
  45. htimer_t* reconn_timer;
  46. // SSL/TLS
  47. hssl_ctx_t ssl_ctx;
  48. // thread-safe
  49. hmutex_t mutex_;
  50. };
  51. BEGIN_EXTERN_C
  52. // hloop_new -> malloc(mqtt_client_t)
  53. HV_EXPORT mqtt_client_t* mqtt_client_new(hloop_t* loop DEFAULT(NULL));
  54. // @see hloop_run
  55. HV_EXPORT void mqtt_client_run (mqtt_client_t* cli);
  56. // @see hloop_stop
  57. HV_EXPORT void mqtt_client_stop(mqtt_client_t* cli);
  58. // hloop_free -> free(mqtt_client_t)
  59. HV_EXPORT void mqtt_client_free(mqtt_client_t* cli);
  60. // id
  61. HV_EXPORT void mqtt_client_set_id(mqtt_client_t* cli, const char* id);
  62. // will
  63. HV_EXPORT void mqtt_client_set_will(mqtt_client_t* cli,
  64. mqtt_message_t* will);
  65. // auth
  66. HV_EXPORT void mqtt_client_set_auth(mqtt_client_t* cli,
  67. const char* username, const char* password);
  68. // callback
  69. HV_EXPORT void mqtt_client_set_callback(mqtt_client_t* cli, mqtt_client_cb cb);
  70. // userdata
  71. HV_EXPORT void mqtt_client_set_userdata(mqtt_client_t* cli, void* userdata);
  72. HV_EXPORT void* mqtt_client_get_userdata(mqtt_client_t* cli);
  73. // error
  74. HV_EXPORT int mqtt_client_get_last_error(mqtt_client_t* cli);
  75. // SSL/TLS
  76. HV_EXPORT int mqtt_client_set_ssl_ctx(mqtt_client_t* cli, hssl_ctx_t ssl_ctx);
  77. // hssl_ctx_new(opt) -> mqtt_client_set_ssl_ctx
  78. HV_EXPORT int mqtt_client_new_ssl_ctx(mqtt_client_t* cli, hssl_ctx_opt_t* opt);
  79. // reconnect
  80. HV_EXPORT int mqtt_client_set_reconnect(mqtt_client_t* cli,
  81. reconn_setting_t* reconn);
  82. HV_EXPORT int mqtt_client_reconnect(mqtt_client_t* cli);
  83. // connect
  84. // hio_create_socket -> hio_connect ->
  85. // on_connect -> mqtt_client_login ->
  86. // on_connack
  87. HV_EXPORT void mqtt_client_set_connect_timeout(mqtt_client_t* cli, int ms);
  88. HV_EXPORT int mqtt_client_connect(mqtt_client_t* cli,
  89. const char* host,
  90. int port DEFAULT(DEFAULT_MQTT_PORT),
  91. int ssl DEFAULT(0));
  92. HV_EXPORT bool mqtt_client_is_connected(mqtt_client_t* cli);
  93. // disconnect
  94. // @see hio_close
  95. HV_EXPORT int mqtt_client_disconnect(mqtt_client_t* cli);
  96. // publish
  97. HV_EXPORT int mqtt_client_publish(mqtt_client_t* cli,
  98. mqtt_message_t* msg);
  99. // subscribe
  100. HV_EXPORT int mqtt_client_subscribe(mqtt_client_t* cli,
  101. const char* topic, int qos DEFAULT(0));
  102. // unsubscribe
  103. HV_EXPORT int mqtt_client_unsubscribe(mqtt_client_t* cli,
  104. const char* topic);
  105. END_EXTERN_C
  106. #endif // HV_MQTT_CLIENT_H_