Document deferred eventcb behaviour

This commit is contained in:
Ondřej Kuzník 2013-12-03 22:50:51 +00:00
parent be7bf2c768
commit 13a9a020e1

View File

@ -138,6 +138,9 @@ typedef void (*bufferevent_data_cb)(struct bufferevent *bev, void *ctx);
The event callback is triggered if either an EOF condition or another The event callback is triggered if either an EOF condition or another
unrecoverable error was encountered. unrecoverable error was encountered.
For bufferevents with deferred callbacks, this is a bitwise OR of all errors
that have happened on the bufferevent since the last callback invocation.
@param bev the bufferevent for which the error condition was reached @param bev the bufferevent for which the error condition was reached
@param what a conjunction of flags: BEV_EVENT_READING or BEV_EVENT_WRITING @param what a conjunction of flags: BEV_EVENT_READING or BEV_EVENT_WRITING
to indicate if the error was encountered on the read or write path, to indicate if the error was encountered on the read or write path,