From: Ondřej Kuzník <ondra@mistotebe.net>
Date: Tue, 3 Dec 2013 22:50:51 +0000 (+0000)
Subject: Document deferred eventcb behaviour
X-Git-Tag: release-2.1.4-alpha~62^2~4
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=13a9a020e1361b34c600b7e1f0191c33a32a05c0;p=libevent

Document deferred eventcb behaviour
---

diff --git a/include/event2/bufferevent.h b/include/event2/bufferevent.h
index 513d3285..f3cf1d6e 100644
--- a/include/event2/bufferevent.h
+++ b/include/event2/bufferevent.h
@@ -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
    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 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,