amqtt/docs/references/broker.md

# Broker API reference

The `amqtt.broker.Broker` class provides a complete MQTT 3.1.1 broker implementation. This class allows Python developers to embed a MQTT broker in their own applications.

## Usage example

The following example shows how to start a broker using the default configuration:

```python
--8<-- "samples/broker_simple.py"
```

This will start the broker and let it run until it is shutdown by `^c`.

## Reference

### Broker API

The `amqtt.broker` module provides the following key methods in the `Broker` class:

- `start()`: Starts the broker and begins serving
- `shutdown()`: Gracefully shuts down the broker


::: amqtt.broker.Broker
convert rst files to md 2025-05-21 13:53:46 +00:00			`# Broker API reference`
Fix toc and add missing documents 2015-11-06 22:02:19 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			The `amqtt.broker.Broker` class provides a complete MQTT 3.1.1 broker implementation. This class allows Python developers to embed a MQTT broker in their own applications.
Improve documentation 2015-11-13 21:07:58 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			`## Usage example`
Improve documentation 2015-11-13 21:07:58 +00:00
			`The following example shows how to start a broker using the default configuration:`

convert rst files to md 2025-05-21 13:53:46 +00:00			```python
separating docker build into two phases to minimize image size. add documentation for docker launch / configure 2025-06-09 18:32:55 +00:00			`--8<-- "samples/broker_simple.py"`
convert rst files to md 2025-05-21 13:53:46 +00:00			```

consolidating configuration documentation for both broker and client. including making sure there's consistency in default configuration 2025-05-28 11:45:12 +00:00			This will start the broker and let it run until it is shutdown by `^c`.
convert rst files to md 2025-05-21 13:53:46 +00:00
			`## Reference`

			`### Broker API`

			The `amqtt.broker` module provides the following key methods in the `Broker` class:

			- `start()`: Starts the broker and begins serving
			- `shutdown()`: Gracefully shuts down the broker

updating client documentation by converting rst format into google docstring params, including examples from reference file 2025-05-22 01:59:12 +00:00
			`::: amqtt.broker.Broker`