doc: expand epoll_wait() documentation
This commit is contained in:
parent
d6845acd26
commit
564db33b82
18
README.md
18
README.md
@ -114,11 +114,19 @@ int epoll_wait(HANDLE ephnd,
|
|||||||
```
|
```
|
||||||
|
|
||||||
* Receive socket events from an epoll port.
|
* Receive socket events from an epoll port.
|
||||||
* Returns
|
* `events` should point to a caller-allocated array of
|
||||||
- -1 on failure
|
[`epoll_event`](#struct-epoll_event) structs, which will receive the
|
||||||
- 0 when a timeout occurs
|
reported events.
|
||||||
- ≥1 the number of evens received
|
* `maxevents` is the maximum number of events that will be written to the
|
||||||
* TODO: expand
|
`events` array, and must be greater than zero.
|
||||||
|
* `timeout` specifies whether to block when no events are immediately available.
|
||||||
|
- `<0` block indefinitely
|
||||||
|
- `0` report any events that are already waiting, but don't block
|
||||||
|
- `≥1` block for at most N milliseconds
|
||||||
|
* Return value:
|
||||||
|
- `-1` an error occurred
|
||||||
|
- `0` timed out without any events to report
|
||||||
|
- `≥1` the number of events stored in the `events` buffer
|
||||||
* [Linux man page][man epoll_wait]
|
* [Linux man page][man epoll_wait]
|
||||||
|
|
||||||
### struct epoll_event
|
### struct epoll_event
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user