Skip to content

Commit 07258d9

Browse files
committed
Update release notes
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
1 parent 7ad1cc9 commit 07258d9

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

RELEASE_NOTES.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,22 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
The main change in this release is the introduction of the `OneshotChannel` and `BroadcastChannel` classes, and the deprecation of the `Broadcast` and `Anycast` classes.
66

77
## Upgrading
88

99
- `LatestValueCache` now closes the receiver when it is stopped.
10+
1011
- Fetching values from stopped `LatestValueCache` instances is now disallowed.
1112

13+
- The old `Broadcast` class is deprecated in favour of the new auto-closing `BroadcastChannel`.
14+
15+
- The `Anycast` class is deprecated, because of the lack of use-cases and the maintenance cost.
16+
1217
## New Features
1318

14-
- There's a new `Oneshot` channel, which returns a sender and a receiver. A single message can be sent using the sender, after which it will be closed. And the receiver will close as soon as the message is received.
19+
- There's a new `OneshotChannel`, which returns a sender and a receiver. A single message can be sent using the sender, after which it will be closed. And the receiver will close as soon as the message is received.
1520

1621
- `Sender`s now have an `aclose`, which must be called, when they are no-longer needed.
1722

18-
## Bug Fixes
19-
20-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
23+
- 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.

0 commit comments

Comments
 (0)