mirror of https://github.com/espressif/esp-protocols.git synced 2025-10-29 13:41:39 +01:00

Files

David Cermak ac1b2b7573 bump(mosq): 2.0.20~2 -> 2.0.20~3

2.0.20~3
Bug Fixes
- Support build on older IDF branches (13b90ad1)
- Fix misleading error when accepting connection (fd410061, #807)
- Make mosquitto component c++ compatible (c4169765, #817)
- include config.h before any system header (1b1ede43)

2025-07-01 12:20:45 +02:00

2.1 KiB

Raw Blame History

API Reference

Header files

mosq_broker.h

File mosq_broker.h

Structures and Types

Type	Name
struct	mosq_broker_config Mosquitto configuration structure.
typedef void(*	mosq_message_cb_t

Functions

Type	Name
int	mosq_broker_run (struct mosq_broker_config config) Start mosquitto broker.*
void	mosq_broker_stop (void) Stops running broker.

Structures and Types Documentation

struct `mosq_broker_config`

Mosquitto configuration structure.

ESP port of mosquittto supports only the options in this configuration structure.

Variables:

void(* handle_message_cb
On message callback. If configured, user function is called whenever mosquitto processes a message.
const char * host
Address on which the broker is listening for connections
int port
Port number of the broker to listen to
esp_tls_cfg_server_t * tls_cfg
ESP-TLS configuration (if TLS transport used) Please refer to the ESP-TLS official documentation for more details on configuring the TLS options. You can open the respective docs with this idf.py command: idf.py docs -sp api-reference/protocols/esp_tls.html

typedef `mosq_message_cb_t`

typedef void(* mosq_message_cb_t) (char *client, char *topic, char *data, int len, int qos, int retain);

Functions Documentation

function `mosq_broker_run`

Start mosquitto broker.

int mosq_broker_run (
    struct mosq_broker_config *config
)

This API runs the broker in the calling thread and blocks until the mosquitto exits.

Parameters:

config Mosquitto configuration structure

Returns:

int Exit code (0 on success)

function `mosq_broker_stop`

Stops running broker.

void mosq_broker_stop (
    void
)

Note:

After calling this API, function mosq_broker_run() unblocks and returns.

2.1 KiB Raw Blame History