mqtt_client.h 3.4 KB

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