Skip to content

Commit

Permalink
Adds unregister event API
Browse files Browse the repository at this point in the history
- Added to enable users to unregister event handler.

 Closes espressif/esp-idf#9194
  • Loading branch information
euripedesrocha authored and david-cermak committed Jul 28, 2022
1 parent f14eeb9 commit a9a9fe7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
13 changes: 13 additions & 0 deletions include/mqtt_client.h
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,19 @@ esp_err_t esp_mqtt_client_register_event(esp_mqtt_client_handle_t client,
esp_event_handler_t event_handler,
void *event_handler_arg);

/**
* @brief Unregisters mqtt event
*
* @param client mqtt client handle
* @param event event ID
* @param event_handler handler to unregister
*
* @return ESP_ERR_NO_MEM if failed to allocate
* ESP_ERR_INVALID_ARG on invalid event ID
* ESP_OK on success
*/
esp_err_t esp_mqtt_client_unregister_event(esp_mqtt_client_handle_t client, esp_mqtt_event_id_t event, esp_event_handler_t event_handler);

/**
* @brief Get outbox size
*
Expand Down
17 changes: 17 additions & 0 deletions mqtt_client.c
Original file line number Diff line number Diff line change
Expand Up @@ -2056,6 +2056,23 @@ esp_err_t esp_mqtt_client_register_event(esp_mqtt_client_handle_t client, esp_mq
#endif
}

esp_err_t esp_mqtt_client_unregister_event(esp_mqtt_client_handle_t client, esp_mqtt_event_id_t event, esp_event_handler_t event_handler)
{
if (client == NULL) {
return ESP_ERR_INVALID_ARG;
}
#ifdef MQTT_SUPPORTED_FEATURE_EVENT_LOOP
if (client->config->event_handle) {
ESP_LOGW(TAG, "Unregistering event loop while event callback is not null, clearing callback");
client->config->event_handle = NULL;
}

return esp_event_handler_unregister_with(client->config->event_loop_handle, MQTT_EVENTS, event, event_handler);
#else
ESP_LOGE(TAG, "Unregistering event handler while event loop not available in IDF version %s", IDF_VER);
return ESP_FAIL;
#endif
}

static void esp_mqtt_client_dispatch_transport_error(esp_mqtt_client_handle_t client)
{
Expand Down

0 comments on commit a9a9fe7

Please sign in to comment.