cuberite/libevent
1
0
Fork 0
mirror of https://github.com/cuberite/libevent.git synced 2025-09-11 05:14:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Be explicit about how long event loops run in event.h documentation

Browse Source
This commit is contained in:
Nick Mathewson 2011-02-22 00:34:49 -05:00
parent 039b9bd0e3
commit f95bafb608
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/event2/event.h
View File

@ -107,6 +107,10 @@ int event_reinit(struct event_base *base);
/** /**
Threadsafe event dispatching loop. 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() @param eb the event_base structure returned by event_init()
@see event_init(), event_dispatch() @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 *); 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 /** 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(). 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 eb the event_base structure returned by event_init()
@param flags any combination of EVLOOP_ONCE | EVLOOP_NONBLOCK @param flags any combination of EVLOOP_ONCE | EVLOOP_NONBLOCK
@return 0 if successful, -1 if an error occurred, or 1 if no events were @return 0 if successful, -1 if an error occurred, or 1 if no events were