MQTTBroker
faststream.mqtt.broker.broker.MQTTBroker #
MQTTBroker(
url: str = "mqtt://localhost:1883",
port: int = EMPTY,
*,
host: str = EMPTY,
client_id: str = "",
keepalive: int = 60,
clean_session: bool = True,
will: Will | None = None,
version: MQTTVersion = "5.0",
reconnect: ReconnectConfig | None = None,
on_connection_recovery_failed: Callable[
[], Awaitable[None]
]
| None = None,
mqtt_connect_timeout: float = 30.0,
session_expiry_interval: int = 0,
session_replay_buffer_size: int = 1000,
session_replay_timeout: float = 30.0,
stripped_prefixes: tuple[str, ...] | None = None,
graceful_timeout: float | None = 15.0,
decoder: Optional[CustomCallable] = None,
parser: Optional[CustomCallable] = None,
codec: Optional[CodecProto] = None,
dependencies: Sequence[Dependant] = (),
middlewares: Sequence[BrokerMiddleware[Any, Any]] = (),
routers: Iterable[MQTTRegistrator] = (),
ack_policy: AckPolicy = EMPTY,
id_generator: IdGenerator = gen_cor_id,
specification_url: str | None = None,
protocol: str | None = None,
protocol_version: str | None = None,
description: str | None = None,
tags: Iterable[Tag | TagDict] = (),
security: Optional[BaseSecurity] = None,
logger: Optional[LoggerProto] = EMPTY,
log_level: int = INFO,
apply_types: bool = True,
serializer: Optional[SerializerProto] = EMPTY,
provider: Optional[Provider] = None,
context: Optional[ContextRepo] = None,
)
Bases: MQTTRegistrator, BrokerUsecase[Message, MQTTClient, MQTTBrokerConfig]
MQTT broker for FastStream using the zmqtt client library.
Source code in faststream/mqtt/broker/broker.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | |
config instance-attribute #
config: ConfigComposition[BrokerConfigType_co] = (
ConfigComposition(config)
)
start async #
start() -> None
Source code in faststream/mqtt/broker/broker.py
216 217 218 219 220 221 | |
stop async #
stop(
exc_type: type[BaseException] | None = None,
exc_val: BaseException | None = None,
exc_tb: Optional[TracebackType] = None,
) -> None
Source code in faststream/mqtt/broker/broker.py
223 224 225 226 227 228 229 230 231 232 233 234 235 236 | |
ping async #
ping(timeout: float | None = None) -> bool
Source code in faststream/mqtt/broker/broker.py
238 239 240 241 242 243 244 245 246 247 | |
publish async #
publish(
message: SendableMessage = None,
topic: str = "",
*,
qos: QoS = AT_MOST_ONCE,
retain: bool = False,
headers: dict[str, str] | None = None,
correlation_id: str | None = None,
reply_to: str = "",
) -> None
Publish a message to an MQTT topic.
| PARAMETER | DESCRIPTION |
|---|---|
message | Message body to send. TYPE: |
topic | MQTT topic to publish to. TYPE: |
qos | QoS level (0, 1, or 2). TYPE: |
retain | Whether the broker should retain the message. TYPE: |
headers | Message headers (MQTT 5.0 user properties). TYPE: |
correlation_id | Correlation ID for message tracing. TYPE: |
reply_to | Response topic (MQTT 5.0 response_topic property). TYPE: |
Source code in faststream/mqtt/broker/broker.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | |
request async #
request(
message: SendableMessage = None,
topic: str = "",
/,
timeout: float = 0.5,
correlation_id: str | None = None,
headers: dict[str, str] | None = None,
qos: QoS = AT_MOST_ONCE,
reply_to: str = "",
) -> MQTTMessage
Source code in faststream/mqtt/broker/broker.py
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | |
publish_batch async #
publish_batch(
*messages: SendableMessage, queue: str
) -> Any
Source code in faststream/_internal/broker/pub_base.py
53 54 55 56 57 58 59 | |
add_middleware #
add_middleware(
middleware: BrokerMiddleware[Any, Any],
) -> None
Append BrokerMiddleware to the end of middlewares list.
Current middleware will be used as a most inner of the stack.
Source code in faststream/_internal/broker/registrator.py
56 57 58 59 60 61 | |
insert_middleware #
insert_middleware(
middleware: BrokerMiddleware[Any, Any],
) -> None
Insert BrokerMiddleware to the start of middlewares list.
Current middleware will be used as a most outer of the stack.
Source code in faststream/_internal/broker/registrator.py
63 64 65 66 67 68 | |
subscriber #
subscriber(
topic: str,
*,
qos: QoS = AT_MOST_ONCE,
shared: str | None = None,
ack_policy: AckPolicy = EMPTY,
no_reply: bool = False,
dependencies: Sequence[Dependant] = (),
parser: Optional[CustomCallable] = None,
decoder: Optional[CustomCallable] = None,
codec: Optional[CodecProto] = None,
max_workers: Literal[1] = 1,
persistent: bool = True,
title: str | None = None,
description: str | None = None,
include_in_schema: bool = True,
) -> MQTTDefaultSubscriber
subscriber(
topic: str,
*,
qos: QoS = AT_MOST_ONCE,
shared: str | None = None,
ack_policy: AckPolicy = EMPTY,
no_reply: bool = False,
dependencies: Sequence[Dependant] = (),
parser: Optional[CustomCallable] = None,
decoder: Optional[CustomCallable] = None,
codec: Optional[CodecProto] = None,
max_workers: int = ...,
persistent: bool = True,
title: str | None = None,
description: str | None = None,
include_in_schema: bool = True,
) -> MQTTConcurrentSubscriber
subscriber(
topic: str,
*,
qos: QoS = AT_MOST_ONCE,
shared: str | None = None,
ack_policy: AckPolicy = EMPTY,
no_reply: bool = False,
dependencies: Sequence[Dependant] = (),
parser: Optional[CustomCallable] = None,
decoder: Optional[CustomCallable] = None,
codec: Optional[CodecProto] = None,
max_workers: int = 1,
persistent: bool = True,
title: str | None = None,
description: str | None = None,
include_in_schema: bool = True,
) -> MQTTDefaultSubscriber | MQTTConcurrentSubscriber
Subscribe a handler to an MQTT topic.
| PARAMETER | DESCRIPTION |
|---|---|
topic | MQTT topic filter. Wildcards TYPE: |
qos | QoS level for the subscription (0, 1, or 2). TYPE: |
shared | Optional shared subscription group name. When set, subscribes as TYPE: |
ack_policy | Acknowledgement policy for message processing. TYPE: |
no_reply | Whether to disable FastStream RPC / reply-to responses. TYPE: |
dependencies | Dependencies list to apply to the subscriber. TYPE: |
parser | Custom parser to map raw messages to FastStream ones. TYPE: |
decoder | Function to decode FastStream message bytes to Python objects. TYPE: |
codec | Custom codec object. TYPE: |
max_workers | Number of workers to process messages concurrently. TYPE: |
persistent | Whether to retain the subscriber across broker restarts. TYPE: |
title | AsyncAPI subscriber object title. TYPE: |
description | AsyncAPI subscriber object description. TYPE: |
include_in_schema | Whether to include operation in AsyncAPI schema. TYPE: |
Source code in faststream/mqtt/broker/registrator.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | |
publisher #
publisher(
topic: str,
*,
qos: QoS = AT_MOST_ONCE,
retain: bool = False,
headers: dict[str, str] | None = None,
persistent: bool = True,
title: str | None = None,
description: str | None = None,
schema: Any | None = None,
include_in_schema: bool = True,
) -> MQTTPublisher
Create a persistent publisher object for the given MQTT topic.
| PARAMETER | DESCRIPTION |
|---|---|
topic | MQTT topic to publish to. Must not contain wildcards. TYPE: |
qos | QoS level for published messages (0, 1, or 2). TYPE: |
retain | Whether the broker should retain the last message. TYPE: |
headers | Default headers to include in every published message. TYPE: |
persistent | Whether to retain the publisher across broker restarts. TYPE: |
title | AsyncAPI publisher object title. TYPE: |
description | AsyncAPI publisher object description. TYPE: |
schema | AsyncAPI publishing message type. TYPE: |
include_in_schema | Whether to include operation in AsyncAPI schema. TYPE: |
Source code in faststream/mqtt/broker/registrator.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |
include_router #
include_router(
router: MQTTRegistrator,
*,
prefix: str = "",
dependencies: Sequence[Dependant] = (),
middlewares: Sequence[BrokerMiddleware[Any, Any]] = (),
include_in_schema: bool | None = None,
) -> None
Source code in faststream/mqtt/broker/registrator.py
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |
include_routers #
include_routers(
*routers: Registrator[MsgType, Any],
) -> None
Includes routers in the object.
Source code in faststream/_internal/broker/registrator.py
128 129 130 131 132 133 134 | |
connect async #
connect() -> ConnectionType
Connect to a remote server.
Source code in faststream/_internal/broker/broker.py
111 112 113 114 115 116 117 | |