esp_mqtt_client_subscribe macro

Convenience macro to select subscribe function to use. Notes: - Usage of `esp_mqtt_client_subscribe_single` is the same as previous esp_mqtt_client_subscribe, refer to it for details.

Syntax

Show:

Summary

Declaration

from mqtt_client.h:464

#define esp_mqtt_client_subscribe(client_handle, topic_type, qos_or_size) _Generic((topic_type), \ char *: esp_mqtt_client_subscribe_single, \ const char *: esp_mqtt_client_subscribe_single, \ esp_mqtt_topic_t*: esp_mqtt_client_subscribe_multiple \ )(client_handle, topic_type, qos_or_size)

Arguments

Argument

Description

client_handle

*MQTT* client handle

topic_type

Needs to be char* for single subscription or `esp_mqtt_topic_t` for multiple topics

qos_or_size

It's either a qos when subscribing to a single topic or the size of the subscription array when subscribing to multiple topics.

Return value

message_id of the subscribe message on success -1 on failure -2 in case of full outbox.

Examples

esp_mqtt_client_subscribe is referenced by 10 libraries and example projects:

References

from examples

esp_mqtt_client_subscribe macro

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle