1.1 KiB

Czysty Wina Historia

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:

--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

Broker configuration

The Broker class's __init__ method accepts a config parameter which allows setup of default and custom behaviors.

Details on the config parameter structure is a dictionary whose structure is identical to yaml formatted file¹ used by the included broker script: broker configuration

::: amqtt.broker.Broker

See PyYAML for loading YAML files as Python dict. ↩︎

1.1 KiB Czysty Wina Historia