Skip to content

Commit 196002d

Browse files
authored
Change wepoll to IOCP (#116)
* Change wepoll to ICOP * Fix other occurences that I missed
1 parent 7f4993e commit 196002d

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ rust-version = "1.48"
1010
description = "Async I/O and timers"
1111
license = "Apache-2.0 OR MIT"
1212
repository = "https://github.com/smol-rs/async-io"
13-
keywords = ["mio", "epoll", "kqueue", "iocp", "wepoll"]
13+
keywords = ["mio", "epoll", "kqueue", "iocp"]
1414
categories = ["asynchronous", "network-programming", "os"]
1515
exclude = ["/.*"]
1616

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The purpose of this thread is to wait for I/O events reported by the operating s
2929
wake appropriate futures blocked on I/O or timers when they can be resumed.
3030

3131
To wait for the next I/O event, the "async-io" thread uses [epoll] on Linux/Android/illumos,
32-
[kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [wepoll] on Windows. That
32+
[kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [IOCP] on Windows. That
3333
functionality is provided by the [`polling`] crate.
3434

3535
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.
3939
[epoll]: https://en.wikipedia.org/wiki/Epoll
4040
[kqueue]: https://en.wikipedia.org/wiki/Kqueue
4141
[event ports]: https://illumos.org/man/port_create
42-
[wepoll]: https://github.com/piscisaureus/wepoll
42+
[IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports
4343
[`polling`]: https://docs.rs/polling
4444

4545
## Examples

src/lib.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
//! wake appropriate futures blocked on I/O or timers when they can be resumed.
1919
//!
2020
//! To wait for the next I/O event, the "async-io" thread uses [epoll] on Linux/Android/illumos,
21-
//! [kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [wepoll] on Windows. That
21+
//! [kqueue] on macOS/iOS/BSD, [event ports] on illumos/Solaris, and [IOCP] on Windows. That
2222
//! functionality is provided by the [`polling`] crate.
2323
//!
2424
//! However, note that you can also process I/O events and wake futures on any thread using the
@@ -28,7 +28,7 @@
2828
//! [epoll]: https://en.wikipedia.org/wiki/Epoll
2929
//! [kqueue]: https://en.wikipedia.org/wiki/Kqueue
3030
//! [event ports]: https://illumos.org/man/port_create
31-
//! [wepoll]: https://github.com/piscisaureus/wepoll
31+
//! [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports
3232
//! [`polling`]: https://docs.rs/polling
3333
//!
3434
//! # Examples
@@ -502,12 +502,12 @@ impl Stream for Timer {
502502
/// Async adapter for I/O types.
503503
///
504504
/// This type puts an I/O handle into non-blocking mode, registers it in
505-
/// [epoll]/[kqueue]/[event ports]/[wepoll], and then provides an async interface for it.
505+
/// [epoll]/[kqueue]/[event ports]/[IOCP], and then provides an async interface for it.
506506
///
507507
/// [epoll]: https://en.wikipedia.org/wiki/Epoll
508508
/// [kqueue]: https://en.wikipedia.org/wiki/Kqueue
509509
/// [event ports]: https://illumos.org/man/port_create
510-
/// [wepoll]: https://github.com/piscisaureus/wepoll
510+
/// [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports
511511
///
512512
/// # Caveats
513513
///
@@ -606,15 +606,15 @@ impl<T: AsRawFd> Async<T> {
606606
/// Creates an async I/O handle.
607607
///
608608
/// This method will put the handle in non-blocking mode and register it in
609-
/// [epoll]/[kqueue]/[event ports]/[wepoll].
609+
/// [epoll]/[kqueue]/[event ports]/[IOCP].
610610
///
611611
/// On Unix systems, the handle must implement `AsRawFd`, while on Windows it must implement
612612
/// `AsRawSocket`.
613613
///
614614
/// [epoll]: https://en.wikipedia.org/wiki/Epoll
615615
/// [kqueue]: https://en.wikipedia.org/wiki/Kqueue
616616
/// [event ports]: https://illumos.org/man/port_create
617-
/// [wepoll]: https://github.com/piscisaureus/wepoll
617+
/// [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports
618618
///
619619
/// # Examples
620620
///
@@ -698,15 +698,15 @@ impl<T: AsRawSocket> Async<T> {
698698
/// Creates an async I/O handle.
699699
///
700700
/// This method will put the handle in non-blocking mode and register it in
701-
/// [epoll]/[kqueue]/[event ports]/[wepoll].
701+
/// [epoll]/[kqueue]/[event ports]/[IOCP].
702702
///
703703
/// On Unix systems, the handle must implement `AsRawFd`, while on Windows it must implement
704704
/// `AsRawSocket`.
705705
///
706706
/// [epoll]: https://en.wikipedia.org/wiki/Epoll
707707
/// [kqueue]: https://en.wikipedia.org/wiki/Kqueue
708708
/// [event ports]: https://illumos.org/man/port_create
709-
/// [wepoll]: https://github.com/piscisaureus/wepoll
709+
/// [IOCP]: https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports
710710
///
711711
/// # Examples
712712
///

src/reactor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const WRITE: usize = 1;
2929
///
3030
/// There is only one global instance of this type, accessible by [`Reactor::get()`].
3131
pub(crate) struct Reactor {
32-
/// Portable bindings to epoll/kqueue/event ports/wepoll.
32+
/// Portable bindings to epoll/kqueue/event ports/IOCP.
3333
///
3434
/// This is where I/O is polled, producing I/O events.
3535
poller: Poller,

0 commit comments

Comments
 (0)