Skip to content

docs: deprecate releasing a realtime channel that isn't detached (RTS4b) #609

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SimonWoolf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: deprecate releasing a realtime channel that isn't detached (RTS4b) #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions lib/src/common/src/channels.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@ abstract class Channels<ChannelType> extends Iterable<ChannelType> {
/// Releases a [RestChannel] or [RealtimeChannel] object with a specified
/// [name], deleting it.
///
/// It also removes any listeners associated with the channel. To release a
/// channel, the [ChannelState] must be `INITIALIZED`, `DETACHED`, or
/// `FAILED`.
/// It also removes any listeners associated with the channel. A realtime
/// channel should only be released when it is in the `INITIALIZED`,
/// `DETACHED`, or `FAILED` state; releasing a realtime channel in any other
/// state is deprecated and will throw an error in the next major version.
void release(String name) {
_channels.remove(name);
}
Expand Down
7 changes: 4 additions & 3 deletions lib/src/platform/src/realtime/realtime_channels.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ class RealtimeChannels extends Channels<RealtimeChannel> {

/// Releases a [RealtimeChannel] object with a specified [name], deleting it.
///
/// It also removes any listeners associated with the channel. To release a
/// channel, the [ChannelState] must be `INITIALIZED`, `DETACHED`, or
/// `FAILED`.
/// It also removes any listeners associated with the channel. A realtime
/// channel should only be released when it is in the `INITIALIZED`,
/// `DETACHED`, or `FAILED` state; releasing a realtime channel in any other
/// state is deprecated and will throw an error in the next major version.
@override
void release(String name) {
realtime.invoke<void>(PlatformMethod.releaseRealtimeChannel, {
Expand Down
Loading