fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-28 01:01:34 +00:00
Code Issues Projects Releases Wiki Activity

Tweak docs of StreamMuxer::poll_event

Browse Source
This commit is contained in:
Roman S. Borschel
2020-11-24 17:36:44 +01:00
parent e3af8b7d03
commit 86d2281222
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
core/src/muxing.rs
View File

@ -91,6 +91,9 @@ pub trait StreamMuxer {
/// is ready to be polled, similar to the API of `Stream::poll()`. /// is ready to be polled, similar to the API of `Stream::poll()`.
/// Only the latest task that was used to call this method may be notified. /// Only the latest task that was used to call this method may be notified.
/// ///
/// It is permissible and common to use this method to perform background
/// work, such as processing incoming packets and polling timers.
///
/// An error can be generated if the connection has been closed. /// An error can be generated if the connection has been closed.
fn poll_event(&self, cx: &mut Context<'_>) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Self::Error>>; fn poll_event(&self, cx: &mut Context<'_>) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Self::Error>>;