Skip to content

RedisBrokerConfig

faststream.redis.configs.RedisBrokerConfig dataclass #

RedisBrokerConfig(
    *,
    prefix="",
    include_in_schema=True,
    broker_middlewares=(),
    broker_parser=None,
    broker_decoder=None,
    producer,
    logger=LoggerState(),
    fd_config=FastDependsConfig(),
    broker_dependencies=(),
    graceful_timeout=None,
    extra_context=dict(),
    connection,
    message_format,
)

Bases: BrokerConfig

prefix class-attribute instance-attribute #

prefix = ''

include_in_schema class-attribute instance-attribute #

include_in_schema = True

broker_middlewares class-attribute instance-attribute #

broker_middlewares = ()

broker_parser class-attribute instance-attribute #

broker_parser = None

broker_decoder class-attribute instance-attribute #

broker_decoder = None

logger class-attribute instance-attribute #

logger = field(default_factory=LoggerState)

fd_config class-attribute instance-attribute #

fd_config = field(default_factory=FastDependsConfig)

broker_dependencies class-attribute instance-attribute #

broker_dependencies = ()

graceful_timeout class-attribute instance-attribute #

graceful_timeout = None

extra_context class-attribute instance-attribute #

extra_context = field(default_factory=dict)

producer instance-attribute #

producer

connection instance-attribute #

connection

message_format instance-attribute #

message_format

add_middleware #

add_middleware(middleware)
Source code in faststream/_internal/configs/broker.py 
46
47
def add_middleware(self, middleware: "BrokerMiddleware[Any]") -> None:
    self.broker_middlewares = (*self.broker_middlewares, middleware)

insert_middleware #

insert_middleware(middleware)
Source code in faststream/_internal/configs/broker.py 
49
50
def insert_middleware(self, middleware: "BrokerMiddleware[Any]") -> None:
    self.broker_middlewares = (middleware, *self.broker_middlewares)

connect async #

connect()
Source code in faststream/redis/configs/broker.py 
21
22
23
async def connect(self) -> None:
    self.producer.connect(self.fd_config._serializer)
    await self.connection.connect()

disconnect async #

disconnect()
Source code in faststream/redis/configs/broker.py 
25
26
async def disconnect(self) -> None:
    await self.connection.disconnect()