cuberite/libevent
1
0
Fork 0
mirror of https://github.com/cuberite/libevent.git synced 2025-09-15 23:35:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clean up and clarify a little more documentation

Browse Source
This commit is contained in:
Nick Mathewson 2012-11-18 19:32:41 -05:00
parent 060c409e8b
commit dc0287c473
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/event2/buffer.h
View File

@ -589,10 +589,10 @@ struct evbuffer_file_segment *evbuffer_file_segment_new(
void evbuffer_file_segment_free(struct evbuffer_file_segment *seg); void evbuffer_file_segment_free(struct evbuffer_file_segment *seg);
/** /**
Add cleanup callback and argument for the callback to an Add cleanup callback and argument for the callback to an
evbuffer_file_segment. evbuffer_file_segment.
The cleanup callback will be invoked when no more references to the The cleanup callback will be invoked when no more references to the
evbuffer_file_segment exist. evbuffer_file_segment exist.
**/ **/
void evbuffer_file_segment_add_cleanup_cb(struct evbuffer_file_segment *seg, void evbuffer_file_segment_add_cleanup_cb(struct evbuffer_file_segment *seg,

10
include/event2/event.h
View File

@ -1347,9 +1347,13 @@ typedef int (*event_base_foreach_event_cb)(const struct event_base *, const stru
Iterate over all added or active events events in an event loop, and invoke Iterate over all added or active events events in an event loop, and invoke
a given callback on each one. a given callback on each one.
The callback must not call any function that modifies the event base, or The callback must not call any function that modifies the event base, that
modifies any event in the event base. Doing so is unsupported and modifies any event in the event base, or that adds or removes any event to
will lead to undefined behavior. the event base. Doing so is unsupported and will lead to undefined
behavior -- likely, to crashes.
event_base_foreach_event() holds a lock on the event_base() for the whole
time it's running: slow callbacks are not advisable.
The callback function must return 0 to continue iteration, or some other The callback function must return 0 to continue iteration, or some other
integer to stop iterating. integer to stop iterating.