GitHub/libevent
1
0
Fork 0
mirror of https://github.com/libevent/libevent.git synced 2025-01-31 09:12:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Avoid defining recommended functions in terms of deprecated ones

Browse Source
This commit is contained in:
Nick Mathewson 2012-11-18 18:59:19 -05:00
parent 3db0737ae6
commit 96584866cd
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/event2/event.h
View File

@ -39,7 +39,7 @@
to signals or regular timeouts.
Libevent is meant to replace the event loop found in event driven network
servers. An application just needs to call event_dispatch() and then add or
servers. An application just needs to call event_base_dispatch() and then add or
remove events dynamically without having to change the event loop.
@ -750,7 +750,7 @@ int event_base_loopexit(struct event_base *, const struct timeval *);
event_base_loopbreak() is typically invoked from this event's callback.
This behavior is analogous to the "break;" statement.
Subsequent invocations of event_loop() will proceed normally.
Subsequent invocations of event_base_loop() will proceed normally.
@param eb the event_base structure returned by event_init()
@return 0 if successful, or -1 if an error occurred
@ -778,7 +778,7 @@ int event_base_loopbreak(struct event_base *);
int event_base_loopcontinue(struct event_base *);
/**
Checks if the event loop was told to exit by event_loopexit().
Checks if the event loop was told to exit by event_base_loopexit().
This function will return true for an event_base at every point after
event_loopexit() is called, until the event loop is next entered.
@ -792,10 +792,10 @@ int event_base_loopcontinue(struct event_base *);
int event_base_got_exit(struct event_base *);
/**
Checks if the event loop was told to abort immediately by event_loopbreak().
Checks if the event loop was told to abort immediately by event_base_loopbreak().
This function will return true for an event_base at every point after
event_loopbreak() is called, until the event loop is next entered.
event_base_loopbreak() is called, until the event loop is next entered.
@param eb the event_base structure returned by event_init()
@return true if event_base_loopbreak() was called on this event base,
@ -1001,7 +1001,7 @@ void event_free(struct event *);
/**
Schedule a one-time event
The function event_base_once() is similar to event_set(). However, it
The function event_base_once() is similar to event_new(). However, it
schedules a callback to be called exactly once, and does not require the
caller to prepare an event structure.
@ -1039,7 +1039,7 @@ int event_base_once(struct event_base *, evutil_socket_t, short, event_callback_
If the event in the ev argument already has a scheduled timeout, calling
event_add() replaces the old timeout with the new one if tv is non-NULL.
@param ev an event struct initialized via event_set()
@param ev an event struct initialized via event_assign() or event_new()
@param timeout the maximum amount of time to wait for the event, or NULL
to wait forever
@return 0 if successful, or -1 if an error occurred