From f95bafb60854d07dd8af5033d55656bc371c43f7 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Tue, 22 Feb 2011 00:34:49 -0500 Subject: [PATCH] Be explicit about how long event loops run in event.h documentation --- include/event2/event.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/include/event2/event.h b/include/event2/event.h index 5a3bbf32..09502fd6 100644 --- a/include/event2/event.h +++ b/include/event2/event.h @@ -107,6 +107,10 @@ int event_reinit(struct event_base *base); /** Threadsafe event dispatching loop. + This loop will run the event base until either there are no more added + events, or until something calls event_base_loopbreak() or + evenet_base_loopexit(). + @param eb the event_base structure returned by event_init() @see event_init(), event_dispatch() */ @@ -322,7 +326,7 @@ void event_set_fatal_callback(event_fatal_cb cb); int event_base_set(struct event_base *, struct event *); /** - event_loop() flags + event_base_loop() flags */ /*@{*/ /** Block until we have an active event, then exit once all active events @@ -338,6 +342,11 @@ int event_base_set(struct event_base *, struct event *); This is a more flexible version of event_base_dispatch(). + By default, this loop will run the event base until either there are no more + added events, or until something calls event_base_loopbreak() or + evenet_base_loopexit(). You can override this behavior with the 'flags' + argument. + @param eb the event_base structure returned by event_init() @param flags any combination of EVLOOP_ONCE | EVLOOP_NONBLOCK @return 0 if successful, -1 if an error occurred, or 1 if no events were -- 2.40.0