wt/libuev
1
0
Fork 0
mirror of https://github.com/troglobit/libuev.git synced 2026-10-01 05:22:25 +07:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for event flags on init and callback

Browse Source 
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
Joachim Nilsson
2017-09-20 08:59:39 +02:00
parent 649f40e5d3
commit b67c62045f
3 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API.md
+5 -5
View File
@@ -29,7 +29,8 @@ the wall clock changes, either via NTP or user input.
/*
* Callback example, arg comes from the watcher's *_init() function,
* w->fd holds the file descriptor or socket, and events is set by
* libuEv to indicate status: UEV_HUP, UEV_READ and/or UEV_WRITE
* libuEv to indicate status: UEV_READ and/or UEV_WRITE with any of
* the optional UEV_HUP, UEV_RDHUP, or UEV_PRI for urgent read data.
*/
void callback (uev_t *w, void *arg, int events);
@@ -38,10 +39,9 @@ int uev_init (uev_ctx_t *ctx);
int uev_exit (uev_ctx_t *ctx);
int uev_run (uev_ctx_t *ctx, int flags); /* UEV_NONE, UEV_ONCE, and/or UEV_NONBLOCK */
/* I/O watcher: fd MUST be non-blocking
* events can be any combination of: UEV_READ, UEV_WRITE, UEV_PRI,
* UEV_HUP, UEV_RDHUP
* UEV_EDGE, UEV_ONESHOT
/* I/O watcher: fd *MUST* be non-blocking!
* events combination of the main flags: UEV_READ, UEV_WRITE,
* UEV_EDGE, UEV_ONESHOT
*/
int uev_io_init (uev_ctx_t *ctx, uev_t *w, uev_cb_t *cb, void *arg, int fd, int events);
int uev_io_set (uev_t *w, int fd, int events);