Skip to content

Commit 6b32de3

Browse files
committed
doc(driver): add docs for mod cp
1 parent 6ee42aa commit 6b32de3

File tree

1 file changed

+14
-0
lines changed
  • compio-driver/src/iocp/cp

1 file changed

+14
-0
lines changed

compio-driver/src/iocp/cp/mod.rs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
//! Completion Port
2+
//!
3+
//! This mod contains utilities of IOCP. It provides 2 working modes:
4+
//! IOCP-per-thread, and IOCP-global.
5+
//!
6+
//! ## IOCP-per-thread
7+
//! In `mod multi`. Each driver hosts a seperate port. If the port receives
8+
//! entry that doesn't belong to the current port, it will try to repost it to
9+
//! the correct port.
10+
//!
11+
//! ## IOCP-global
12+
//! In `mod global`. A main port runs in a separate thread, and dispatches all
13+
//! entries to the correct driver.
14+
115
use std::{
216
io,
317
os::windows::io::{AsRawHandle, FromRawHandle, OwnedHandle, RawHandle},

0 commit comments

Comments
 (0)