Skip to content

Auto closing broadcast #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shsms wants to merge 12 commits into
base: v1.x.x
Choose a base branch
from
Open

Auto closing broadcast #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9a0c053
Make broadcast sender clonable and subscribable
shsms Feb 9, 2026
e696143
Track sender count on sender create and close
shsms Feb 9, 2026
31426a3
Expose strongly-typed Senders and Receivers from Broadcast
shsms Mar 9, 2026
389574c
Implement auto-close support for Broadcast channels
shsms Feb 9, 2026
ddfab00
Add `BroadcastChannel` and deprecate `Broadcast` class
shsms Feb 9, 2026
7a35af5
Test the auto-close feature of broadcast channels
shsms Feb 9, 2026
90c10db
Deprecate Anycast channels
shsms Mar 30, 2026
af8723f
Rename `BroadcastReceiver.enqueue` → `_enqueue`
shsms Mar 30, 2026
417f55e
Update release notes
shsms Mar 30, 2026
8559a81
Check for empty receivers after expired weakrefs are pruned
shsms Mar 30, 2026
5351d41
Rename `Clonable*Sender` → `Cloneable*Sender`
shsms Mar 30, 2026
3843e3f
Close underlying channel when all receivers are gone
shsms Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
- The old `Broadcast` class is deprecated in favour of the new auto-closing `BroadcastChannel`.

- The `Anycast` class is deprecated, because of the lack of use-cases and the maintenance cost.

## New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->
- There's a new `BroadcastChannel`, which returns a broadcast sender and a broadcast receiver. The channel is auto-closing, meaning when all the senders or all the receivers are closed, the channel is closed.

## Bug Fixes

Expand Down
17 changes: 15 additions & 2 deletions src/frequenz/channels/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"""

from ._anycast import Anycast
from ._broadcast import Broadcast
from ._broadcast import Broadcast, BroadcastChannel, BroadcastReceiver, BroadcastSender
from ._exceptions import ChannelClosedError, ChannelError, Error
from ._generic import (
ChannelMessageT,
Expand All @@ -101,14 +101,26 @@
select,
selected_from,
)
from ._sender import Sender, SenderClosedError, SenderError
from ._sender import (
CloneableSender,
CloneableSubscribableSender,
Sender,
SenderClosedError,
SenderError,
SubscribableSender,
)

__all__ = [
"Anycast",
"Broadcast",
"BroadcastChannel",
"BroadcastReceiver",
"BroadcastSender",
"ChannelClosedError",
"ChannelError",
"ChannelMessageT",
"CloneableSender",
"CloneableSubscribableSender",
"Error",
"ErroredChannelT_co",
"LatestValueCache",
Expand All @@ -128,6 +140,7 @@
"SenderError",
"SenderMessageT_co",
"SenderMessageT_contra",
"SubscribableSender",
"UnhandledSelectedError",
"merge",
"select",
Expand Down
6 changes: 6 additions & 0 deletions src/frequenz/channels/_anycast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
_logger = logging.getLogger(__name__)


@deprecated(
"Anycast channels are deprecated, because of the high cost of maintaining "
"something for which we don't have a use case. The implementation will "
"remain in the codebase in its current form at least until the next major "
"version."
)
class Anycast(Generic[ChannelMessageT]):
"""A channel that delivers each message to exactly one receiver.

Expand Down
Loading
Loading