Better explanation for bufferevent_pair

svn:r1153
This commit is contained in:
Nick Mathewson 2009-04-10 20:42:53 +00:00
parent 23085c9247
commit decdacfaf8

View File

@ -405,7 +405,13 @@ bufferevent_filter_new(struct bufferevent *underlying,
void (*free_context)(void *),
void *ctx);
/** Allocate a pair of linked bufferevents DOCDOC */
/**
Allocate a pair of linked bufferevents. The bufferevents behave as would
two bufferevent_sock instances connected to opposite ends of a
socketpair(), except that no internel socketpair is allocated.
@param base The event base to associate with the socketpair.
*/
int
bufferevent_pair_new(struct event_base *base, enum bufferevent_options options,
struct bufferevent *pair[2]);