aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/client.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/client.rs b/src/client.rs
index 1b3bd15..ab8fc2a 100644
--- a/src/client.rs
+++ b/src/client.rs
@@ -314,6 +314,9 @@ impl Connection {
/// Immediately prevents new messages from being sent on the channel and signal the channel to closes all its background tasks.
/// Before trully closing, the channel will wait for all buffered messages to be properly sent according to the channel type.
+ ///
+ /// If called on the default channel, set default channel to None.
+ ///
/// Can fail if the [ChannelId] is unknown, or if the channel is already closed.
pub fn close_channel(&mut self, channel_id: ChannelId) -> Result<(), QuinnetError> {
match self.channels.remove(&channel_id) {