cuberite/libevent
1
0
Fork 0
mirror of https://github.com/cuberite/libevent.git synced 2025-08-04 01:36:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

Expand EV_CLOSED documentation a bit

Browse Source
This commit is contained in:
Nick Mathewson 2014-01-21 15:44:05 -05:00
parent 5c142a7ee9
commit 53d279389a
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/event2/event.h
View File

@ -489,8 +489,12 @@ enum event_method_feature {
/** Require an event method that allows file descriptors as well as /** Require an event method that allows file descriptors as well as
* sockets. */ * sockets. */
EV_FEATURE_FDS = 0x04, EV_FEATURE_FDS = 0x04,
/** Require an event method that detects premature connection close by /** Require an event method that allows you to use EV_CLOSED to detect
* clients without the necessity of reading all the pending data. */ * connection close without the necessity of reading all the pending data.
*
* Methods that do support EV_CLOSED may not be able to provide support on
* all kernel versions.
**/
EV_FEATURE_EARLY_CLOSE = 0x08 EV_FEATURE_EARLY_CLOSE = 0x08
}; };
@ -908,8 +912,12 @@ int event_base_got_break(struct event_base *);
**/ **/
#define EV_FINALIZE 0x40 #define EV_FINALIZE 0x40
/** /**
* Detects premature connection close by clients without the necessity of * Detects connection close events. You can use this to detect when a
* reading all the pending data, if supported by the backend. * connection has been closed, without having to read all the pending data
* from a connection.
*
* Not all backends support EV_CLOSED. To detect or require it, use the
* feature flag EV_FEATURE_EARLY_CLOSE.
**/ **/
#define EV_CLOSED 0x80 #define EV_CLOSED 0x80
/**@}*/ /**@}*/