Skip to content

Commit

Permalink
Added a simple README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
coot committed Mar 17, 2020
1 parent aab8e9f commit ec390db
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Win32-network/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Asynchronious IO for Windows

`Win32-network` provides low level api for doing IO / networking on Windows
using Overlapped (or asynchronous) IO. It supports:

* `File` Api
* `NamedPipes` Api
* `winsock2` - Berkeley sockets api on Windows

`NamedPipes` provide a good alternative for the lack of Unix Sockets on
Windows, and there are ways of providing abstraction for both, though this is
not present in this package.

An application which is using this package should use `-threaded` option, as
the io manager thread runs a blocking ffi call (e.g.
[GetQueuedCompletionStatus](https://docs.microsoft.com/en-us/windows/win32/api/ioapiset/nf-ioapiset-getqueuedcompletionstatus)).

0 comments on commit ec390db

Please sign in to comment.