fastx-channels

WebSocket channel abstraction for FastX -- pub/sub rooms, presence tracking, and Redis backend support.

Installation

pip install fastx-channels

# With Redis support
pip install fastx-channels[redis]

Quick Start

from starlette.websockets import WebSocket
from fastx_channels import Channel, ChannelManager, InMemoryBackend, Message

# Create a manager with an in-memory backend
backend = InMemoryBackend()
manager = ChannelManager(backend)

# In a WebSocket endpoint
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    channel = manager.get_or_create("chat:lobby")

    # Subscribe the connection
    await channel.subscribe(websocket)

    try:
        while True:
            data = await websocket.receive_json()
            msg = Message(channel="chat:lobby", event="message", data=data)
            await channel.publish(msg)
    finally:
        await channel.unsubscribe(websocket)

Presence Tracking

from fastx_channels import PresenceService, InMemoryPresenceBackend

presence = PresenceService(InMemoryPresenceBackend())

await presence.join("chat:lobby", user_id="user_1", metadata={"name": "Alice"})
members = await presence.get_members("chat:lobby")
online = await presence.is_online("chat:lobby", "user_1")
await presence.leave("chat:lobby", "user_1")

Redis Backend (multi-process)

from redis.asyncio import Redis
from fastx_channels import RedisBackend, ChannelManager

redis_client = Redis.from_url("redis://localhost:6379")
backend = RedisBackend(redis_client)
manager = ChannelManager(backend)

License

MIT