Skip to content

create_subscriber

faststream.mqtt.subscriber.factory.create_subscriber #

create_subscriber(
    *,
    topic: str,
    qos: QoS,
    shared: str | None,
    ack_policy: AckPolicy,
    no_reply: bool,
    config: MQTTBrokerConfig,
    max_workers: int = 1,
    title_: str | None = None,
    description_: str | None = None,
    include_in_schema: bool = True,
) -> SubscriberType
Source code in faststream/mqtt/subscriber/factory.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def create_subscriber(
    *,
    topic: str,
    qos: QoS,
    shared: str | None,
    # Subscriber args
    ack_policy: "AckPolicy",
    no_reply: bool,
    config: "MQTTBrokerConfig",
    max_workers: int = 1,
    # AsyncAPI args
    title_: str | None = None,
    description_: str | None = None,
    include_in_schema: bool = True,
) -> SubscriberType:
    subscriber_config = MQTTSubscriberConfig(
        topic=topic,
        qos=qos,
        shared=shared,
        no_reply=no_reply,
        _outer_config=config,
        _ack_policy=ack_policy,
    )

    specification_config = MQTTSubscriberSpecificationConfig(
        topic=topic,
        qos=qos,
        shared=shared,
        title_=title_,
        description_=description_,
        include_in_schema=include_in_schema,
    )

    calls = CallsCollection[Any]()

    specification = MQTTSubscriberSpecification(
        config,
        specification_config,
        calls,
    )

    if max_workers > 1:
        return MQTTConcurrentSubscriber(
            subscriber_config,
            specification,
            calls,
            max_workers=max_workers,
        )

    return MQTTDefaultSubscriber(subscriber_config, specification, calls)