diff --git a/Cargo.toml b/Cargo.toml index 292374e..31f073d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,7 +10,7 @@ rust-version = "1.48" description = "Async I/O and timers" license = "Apache-2.0 OR MIT" repository = "https://github.com/smol-rs/async-io" -keywords = ["mio", "epoll", "kqueue", "iocp", "wepoll"] +keywords = ["mio", "epoll", "kqueue", "iocp"] categories = ["asynchronous", "network-programming", "os"] exclude = ["/.*"] diff --git a/README.md b/README.md index 3e72ea8..2e961f6 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ The purpose of this thread is to wait for I/O events reported by the operating s wake appropriate futures blocked on I/O or timers when they can be resumed. To wait for the next I/O event, the "async-io" thread uses [epoll] on Linux/Android/illumos, -[kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [wepoll] on Windows. That +[kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [IOCP] on Windows. That functionality is provided by the [`polling`] crate. However, note that you can also process I/O events and wake futures on any thread using the @@ -39,7 +39,7 @@ processing I/O events in case no other threads are. [epoll]: https://en.wikipedia.org/wiki/Epoll [kqueue]: https://en.wikipedia.org/wiki/Kqueue [event ports]: https://illumos.org/man/port_create -[wepoll]: https://github.com/piscisaureus/wepoll +[IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports [`polling`]: https://docs.rs/polling ## Examples diff --git a/src/lib.rs b/src/lib.rs index fd2ecb1..5af8032 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,7 +18,7 @@ //! wake appropriate futures blocked on I/O or timers when they can be resumed. //! //! To wait for the next I/O event, the "async-io" thread uses [epoll] on Linux/Android/illumos, -//! [kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [wepoll] on Windows. That +//! [kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [IOCP] on Windows. That //! functionality is provided by the [`polling`] crate. //! //! However, note that you can also process I/O events and wake futures on any thread using the @@ -28,7 +28,7 @@ //! [epoll]: https://en.wikipedia.org/wiki/Epoll //! [kqueue]: https://en.wikipedia.org/wiki/Kqueue //! [event ports]: https://illumos.org/man/port_create -//! [wepoll]: https://github.com/piscisaureus/wepoll +//! [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports //! [`polling`]: https://docs.rs/polling //! //! # Examples @@ -502,12 +502,12 @@ impl Stream for Timer { /// Async adapter for I/O types. /// /// This type puts an I/O handle into non-blocking mode, registers it in -/// [epoll]/[kqueue]/[event ports]/[wepoll], and then provides an async interface for it. +/// [epoll]/[kqueue]/[event ports]/[IOCP], and then provides an async interface for it. /// /// [epoll]: https://en.wikipedia.org/wiki/Epoll /// [kqueue]: https://en.wikipedia.org/wiki/Kqueue /// [event ports]: https://illumos.org/man/port_create -/// [wepoll]: https://github.com/piscisaureus/wepoll +/// [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports /// /// # Caveats /// @@ -606,7 +606,7 @@ impl Async { /// Creates an async I/O handle. /// /// This method will put the handle in non-blocking mode and register it in - /// [epoll]/[kqueue]/[event ports]/[wepoll]. + /// [epoll]/[kqueue]/[event ports]/[IOCP]. /// /// On Unix systems, the handle must implement `AsRawFd`, while on Windows it must implement /// `AsRawSocket`. @@ -614,7 +614,7 @@ impl Async { /// [epoll]: https://en.wikipedia.org/wiki/Epoll /// [kqueue]: https://en.wikipedia.org/wiki/Kqueue /// [event ports]: https://illumos.org/man/port_create - /// [wepoll]: https://github.com/piscisaureus/wepoll + /// [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports /// /// # Examples /// @@ -682,7 +682,7 @@ impl Async { /// Creates an async I/O handle. /// /// This method will put the handle in non-blocking mode and register it in - /// [epoll]/[kqueue]/[event ports]/[wepoll]. + /// [epoll]/[kqueue]/[event ports]/[IOCP]. /// /// On Unix systems, the handle must implement `AsRawFd`, while on Windows it must implement /// `AsRawSocket`. @@ -690,7 +690,7 @@ impl Async { /// [epoll]: https://en.wikipedia.org/wiki/Epoll /// [kqueue]: https://en.wikipedia.org/wiki/Kqueue /// [event ports]: https://illumos.org/man/port_create - /// [wepoll]: https://github.com/piscisaureus/wepoll + /// [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports /// /// # Examples /// diff --git a/src/reactor.rs b/src/reactor.rs index 6b933ba..f49b345 100644 --- a/src/reactor.rs +++ b/src/reactor.rs @@ -29,7 +29,7 @@ const WRITE: usize = 1; /// /// There is only one global instance of this type, accessible by [`Reactor::get()`]. pub(crate) struct Reactor { - /// Portable bindings to epoll/kqueue/event ports/wepoll. + /// Portable bindings to epoll/kqueue/event ports/IOCP. /// /// This is where I/O is polled, producing I/O events. poller: Poller,