Skip to content

RedisConnectionState

faststream.redis.configs.RedisConnectionState #

RedisConnectionState(options: dict[str, Any] | None = None)

Bases: ConnectionState['Redis[bytes]']

Source code in faststream/redis/configs/state.py 
24
25
26
27
28
29
30
def __init__(self, options: dict[str, Any] | None = None) -> None:
    self._options = options or {}

    self._connected = False
    self._client: ClientT | None = None
    self._sync_cluster: Any = None
    self._thread_pool: Any = None

client property #

client: ClientT

disconnect async #

disconnect() -> None
Source code in faststream/redis/configs/state.py 
46
47
48
49
50
51
async def disconnect(self) -> None:
    if self._client:
        await self._client.aclose()  # type: ignore[attr-defined]

    self._client = None
    self._connected = False

connect async #

connect() -> Redis[bytes]
Source code in faststream/redis/configs/state.py 
55
56
57
58
59
60
61
62
63
64
65
66
async def connect(self) -> "Redis[bytes]":
    pool = ConnectionPool(
        **self._options,
        lib_name="faststream",
        lib_version=__version__,
    )
    client: Redis[bytes] = Redis.from_pool(pool)  # type: ignore[attr-defined]

    self._client = client
    self._connected = True

    return client