Skip to content

RedisBrokerConfig

faststream.redis.configs.broker.RedisBrokerConfig dataclass #

RedisBrokerConfig(
    *,
    prefix: str = "",
    include_in_schema: bool | None = True,
    broker_middlewares: Sequence[
        BrokerMiddleware[Any]
    ] = (),
    broker_parser: Optional[CustomCallable] = None,
    broker_decoder: Optional[CustomCallable] = None,
    producer: RedisFastProducer,
    logger: LoggerState = LoggerState(),
    fd_config: FastDependsConfig = FastDependsConfig(),
    broker_dependencies: Iterable[Dependant] = (),
    graceful_timeout: float | None = None,
    extra_context: dict[str, Any] = dict(),
    connection: ConnectionState,
    message_format: type[MessageFormat],
)

Bases: BrokerConfig

producer instance-attribute #

producer: RedisFastProducer

connection instance-attribute #

connection: ConnectionState

message_format instance-attribute #

message_format: type[MessageFormat]

prefix class-attribute instance-attribute #

prefix: str = ''

include_in_schema class-attribute instance-attribute #

include_in_schema: bool | None = True

broker_middlewares class-attribute instance-attribute #

broker_middlewares: Sequence[BrokerMiddleware[Any]] = ()

broker_parser class-attribute instance-attribute #

broker_parser: Optional[CustomCallable] = None

broker_decoder class-attribute instance-attribute #

broker_decoder: Optional[CustomCallable] = None

logger class-attribute instance-attribute #

logger: LoggerState = field(default_factory=LoggerState)

fd_config class-attribute instance-attribute #

fd_config: FastDependsConfig = field(
    default_factory=FastDependsConfig
)

broker_dependencies class-attribute instance-attribute #

broker_dependencies: Iterable[Dependant] = ()

graceful_timeout class-attribute instance-attribute #

graceful_timeout: float | None = None

extra_context class-attribute instance-attribute #

extra_context: dict[str, Any] = field(default_factory=dict)

connect async #

connect() -> None
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() -> None
Source code in faststream/redis/configs/broker.py 
25
26
async def disconnect(self) -> None:
    await self.connection.disconnect()

add_middleware #

add_middleware(middleware: BrokerMiddleware[Any]) -> None
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: BrokerMiddleware[Any],
) -> None
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)