Skip to content

Commit 24de819

Browse files
committed
Document unsupported cfg flags
1 parent 5188a36 commit 24de819

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,27 @@ This uses the Windows AFD system to access socket readiness events.
160160
[issue #1152]: https://github.com/tokio-rs/mio/issues/1152
161161
[issue #1444]: https://github.com/tokio-rs/mio/issues/1444
162162

163+
## Unsupported flags
164+
165+
Mio uses different implementations to support the same functionality dependening
166+
on the platform. Mio generally uses the "best" implementation possible, where
167+
"best" usually means most efficient for Mio's use case. However this means that
168+
the implementation is often specific to a limited number of platforms, meaning
169+
we often have multiple implemetations for the same functionality. In some cases
170+
it might be required to not use the "best" implementation, but another
171+
implementation Mio supports (on other platforms). **Mio does not officially
172+
support secondary implementations on platforms**, however we do have various cfg
173+
flags to force another implementation for these situations.
174+
175+
Current flags:
176+
* `mio_unsupported_force_poll_poll`, uses an implementation based on `poll(2)`
177+
for `mio::Poll`.
178+
* `mio_unsupported_force_waker_pipe`, uses an implementation based on `pipe(2)`
179+
for `mio::Waker`.
180+
181+
**Again, Mio does not officially supports this**. Furthermore these flags may
182+
disappear in the future.
183+
163184
## Community
164185

165186
A group of Mio users hang out on [Discord], this can be a good place to go for

0 commit comments

Comments
 (0)