coffee/wepoll
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: update readme prose

Browse Source
This commit is contained in:
Bert Belder 2017-12-11 16:55:04 +01:00
parent 0b4788e2af
commit 3f24ebfa21
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -3,8 +3,8 @@
[![][ci status badge]][ci status link] [![][ci status badge]][ci status link]
This library implements the [epoll][man epoll] API for Windows This library implements the [epoll][man epoll] API for Windows
applications. It attempts to be efficient, and to match the Linux API applications. It is fast and scalable, and it closely resembles the API
as semantics as closely as possible. and behavior of Linux' epoll.
## Rationale ## Rationale
@ -21,18 +21,19 @@ to run on Linux.
## Features ## Features
* can poll 100000s of sockets efficiently * Can poll 100000s of sockets efficiently.
* fully thread safe * Fully thread-safe.
* multiple threads can poll the same epoll port * Multiple threads can poll the same epoll port.
* sockets can be added to multiple epoll sets * Sockets can be added to multiple epoll sets.
* polling for `EPOLLIN`, `EPOLLOUT`, `EPOLLPRI`, `EPOLLRDHUP`, * All epoll events (`EPOLLIN`, `EPOLLOUT`, `EPOLLPRI`, `EPOLLRDHUP`)
`EPOLLHUP`, and `EPOLLERR` events are supported.
* `EPOLLONESTHOT` flag * Level-triggered and one-shot (`EPOLLONESTHOT`) modes are supported
* Trivial to embed: you need [only two files][dist].
## Limitations ## Limitations
* only works with sockets * Only works with sockets.
* some modes not suported: `EPOLLET`, `EPOLLEXCLUSIVE` * Edge-triggered (`EPOLLET`) mode isn't supported.
## How to use ## How to use