base

class litestar.channels.backends.base.ChannelsBackend

Bases: ABC

abstractmethod async on_startup() → None

Called by the plugin on application startup

abstractmethod async on_shutdown() → None

Called by the plugin on application shutdown

abstractmethod async publish(data: bytes, channels: Iterable[str]) → None

Publish the message data to all channels

abstractmethod async subscribe(channels: Iterable[str]) → None

Start listening for events on channels

abstractmethod async unsubscribe(channels: Iterable[str]) → None

Stop listening for events on channels

abstractmethod stream_events() → AsyncGenerator[tuple[str, bytes], None]

Return a generator, iterating over events of subscribed channels as they become available

abstractmethod async get_history(channel: str, limit: int | None = None) → list[bytes]

Return the event history of channel, at most limit entries