Skip to content

Commit

Permalink
Document the current Poll::poll timeout behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomasdezeeuw committed Aug 11, 2022
1 parent 3340f6d commit c6b5f13
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/poll.rs
Expand Up @@ -349,6 +349,10 @@ impl Poll {
/// of Mio would automatically retry the poll call if it was interrupted
/// (if `EINTR` was returned).
///
/// Currently if the `timeout` elapses without any readiness events
/// triggering this will return `Ok(())`. However we're not guaranteeing
/// this behaviour as this depends on the OS.
///
/// # Examples
///
/// A basic example -- establishing a `TcpStream` connection.
Expand Down

0 comments on commit c6b5f13

Please sign in to comment.