Skip to content

Commit 1257c03

Browse files
author
Ariel Ben-Yehuda
committed
docs: add docs about pollcatch performance impact
1 parent a66c64a commit 1257c03

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/pollcatch/mod.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@
1717
//! let rt = rt.build().unwrap();
1818
//! rt.block_on(your_main())
1919
//! ```
20+
//!
21+
//! Except on a poll that is involved in a profiling sample, the poll hook overhead
22+
//! is limited to a few thread-local accesses and should be very very fast.
23+
//!
24+
//! When a profiling sample is taken (normally around 1 / second), it adds slightly
25+
//! more overhead to report the sample, but that is a matter of microseconds
26+
//! and therefore should not worsen tail latency problems.
2027
2128
use std::{
2229
cell::Cell,

0 commit comments

Comments
 (0)