summaryrefslogtreecommitdiffstats
path: root/tokio/src/net/tcp/incoming.rs
diff options
context:
space:
mode:
Diffstat (limited to 'tokio/src/net/tcp/incoming.rs')
-rw-r--r--tokio/src/net/tcp/incoming.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/tokio/src/net/tcp/incoming.rs b/tokio/src/net/tcp/incoming.rs
index 0abe047d..062be1e9 100644
--- a/tokio/src/net/tcp/incoming.rs
+++ b/tokio/src/net/tcp/incoming.rs
@@ -17,7 +17,11 @@ impl Incoming<'_> {
Incoming { inner: listener }
}
- #[doc(hidden)] // TODO: dox
+ /// Attempts to poll `TcpStream` by polling inner `TcpListener` to accept
+ /// connection.
+ ///
+ /// If `TcpListener` isn't ready yet, `Poll::Pending` is returned and
+ /// current task will be notified by a waker.
pub fn poll_accept(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,