From decdacfaf8265cf9520eabcf4215501566376d84 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Fri, 10 Apr 2009 20:42:53 +0000 Subject: [PATCH] Better explanation for bufferevent_pair svn:r1153 --- include/event2/bufferevent.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/include/event2/bufferevent.h b/include/event2/bufferevent.h index 0da1fb7a..bbb70ad8 100644 --- a/include/event2/bufferevent.h +++ b/include/event2/bufferevent.h @@ -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]);