27#ifndef EVENT2_EVENT_H_INCLUDED_
28#define EVENT2_EVENT_H_INCLUDED_
187#include <event2/visibility.h>
193#include <event2/event-config.h>
194#ifdef EVENT__HAVE_SYS_TYPES_H
195#include <sys/types.h>
197#ifdef EVENT__HAVE_SYS_TIME_H
220#ifdef EVENT_IN_DOXYGEN_
277#ifdef EVENT_IN_DOXYGEN_
296#ifdef EVENT_IN_DOXYGEN_
425#define EVENT_BASE_COUNT_ACTIVE 1U
428#define EVENT_BASE_COUNT_VIRTUAL 2U
431#define EVENT_BASE_COUNT_ADDED 4U
695 const struct timeval *max_interval,
int max_callbacks,
736#define EVENT_LOG_DEBUG 0
737#define EVENT_LOG_MSG 1
738#define EVENT_LOG_WARN 2
739#define EVENT_LOG_ERR 3
744#define _EVENT_LOG_DEBUG EVENT_LOG_DEBUG
745#define _EVENT_LOG_MSG EVENT_LOG_MSG
746#define _EVENT_LOG_WARN EVENT_LOG_WARN
747#define _EVENT_LOG_ERR EVENT_LOG_ERR
790#define EVENT_DBG_ALL 0xffffffffu
791#define EVENT_DBG_NONE 0
829#define EVLOOP_ONCE 0x01
832#define EVLOOP_NONBLOCK 0x02
837#define EVLOOP_NO_EXIT_ON_EMPTY 0x04
955#define EV_TIMEOUT 0x01
961#define EV_SIGNAL 0x08
968#define EV_PERSIST 0x10
979#define EV_FINALIZE 0x40
988#define EV_CLOSED 0x80
998#define evtimer_assign(ev, b, cb, arg) \
999 event_assign((ev), (b), -1, 0, (cb), (arg))
1000#define evtimer_new(b, cb, arg) event_new((b), -1, 0, (cb), (arg))
1001#define evtimer_add(ev, tv) event_add((ev), (tv))
1002#define evtimer_del(ev) event_del(ev)
1003#define evtimer_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv))
1004#define evtimer_initialized(ev) event_initialized(ev)
1013#define evsignal_add(ev, tv) event_add((ev), (tv))
1014#define evsignal_assign(ev, b, x, cb, arg) \
1015 event_assign((ev), (b), (x), EV_SIGNAL|EV_PERSIST, cb, (arg))
1016#define evsignal_new(b, x, cb, arg) \
1017 event_new((b), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
1018#define evsignal_del(ev) event_del(ev)
1019#define evsignal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv))
1020#define evsignal_initialized(ev) event_initialized(ev)
1030#define evuser_new(b, cb, arg) event_new((b), -1, 0, (cb), (arg))
1031#define evuser_del(ev) event_del(ev)
1032#define evuser_pending(ev, tv) event_pending((ev), 0, (tv))
1033#define evuser_initialized(ev) event_initialized(ev)
1034#define evuser_trigger(ev) event_active((ev), 0, 0)
1376#define event_get_signal(ev) ((int)event_get_fd(ev))
1471#define LIBEVENT_VERSION EVENT__VERSION
1474#define LIBEVENT_VERSION_NUMBER EVENT__NUMERIC_VERSION
1477#define EVENT_MAX_PRIORITIES 256
1550 const struct timeval *duration);
1552#if !defined(EVENT__DISABLE_MM_REPLACEMENT) || defined(EVENT_IN_DOXYGEN_)
1577 void *(*malloc_fn)(
size_t sz),
1578 void *(*realloc_fn)(
void *ptr,
size_t sz),
1579 void (*free_fn)(
void *ptr));
1582#define EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED
1671 struct timeval *tv);
EVENT2_EXPORT_SYMBOL struct event * event_new(struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *callback_arg)
Allocate and assign a new event structure, ready to be added.
EVENT2_EXPORT_SYMBOL void event_base_active_by_fd(struct event_base *base, evutil_socket_t fd, short events)
Activates all pending events for the given fd and event mask.
EVENT2_EXPORT_SYMBOL int event_gettime_monotonic(struct event_base *base, struct timeval *tp)
Query the current monotonic time from the timer for a struct event_base.
EVENT2_EXPORT_SYMBOL size_t event_get_struct_event_size(void)
Return the size of struct event that the Libevent library was compiled with.
EVENT2_EXPORT_SYMBOL int event_base_gettimeofday_cached(struct event_base *base, struct timeval *tv)
Sets 'tv' to the current time (as returned by gettimeofday()), looking at the cached value in 'base' ...
EVENT2_EXPORT_SYMBOL int event_priority_set(struct event *ev, int priority)
Assign a priority to an event.
EVENT2_EXPORT_SYMBOL void event_debug_unassign(struct event *)
When debugging mode is enabled, informs Libevent that an event should no longer be considered as assi...
void(* event_log_cb)(int severity, const char *msg)
A callback function used to intercept Libevent's log messages.
Definition event.h:754
EVENT2_EXPORT_SYMBOL int event_base_dispatch(struct event_base *base)
Event dispatching loop.
EVENT2_EXPORT_SYMBOL void event_set_fatal_callback(event_fatal_cb cb)
Override Libevent's behavior in the event of a fatal internal error.
EVENT2_EXPORT_SYMBOL void event_free(struct event *)
Deallocate a struct event * returned by event_new().
EVENT2_EXPORT_SYMBOL int event_base_set(struct event_base *eb, struct event *ev)
Associate a different event base with an event.
EVENT2_EXPORT_SYMBOL int event_base_priority_init(struct event_base *eb, int npriorities)
Set the number of different event priorities.
EVENT2_EXPORT_SYMBOL int event_base_loopbreak(struct event_base *eb)
Abort the active event_base_loop() immediately.
EVENT2_EXPORT_SYMBOL void * event_self_cbarg(void)
Return a value used to specify that the event itself must be used as the callback argument.
EVENT2_EXPORT_SYMBOL struct event_config * event_config_new(void)
Allocates a new event configuration object.
EVENT2_EXPORT_SYMBOL void event_set_log_callback(event_log_cb cb)
Redirect Libevent's log messages.
EVENT2_EXPORT_SYMBOL int event_del(struct event *ev)
Remove an event from the set of monitored events.
EVENT2_EXPORT_SYMBOL void event_active(struct event *ev, int res, short ncalls)
Make an event active.
EVENT2_EXPORT_SYMBOL int event_base_loopcontinue(struct event_base *eb)
Tell the active event_base_loop() to scan for new events immediately.
EVENT2_EXPORT_SYMBOL void event_enable_debug_mode(void)
Enable some relatively expensive debugging checks in Libevent that would normally be turned off.
EVENT2_EXPORT_SYMBOL void event_base_free_nofinalize(struct event_base *)
As event_base_free, but do not run finalizers.
EVENT2_EXPORT_SYMBOL int event_base_get_npriorities(struct event_base *eb)
Get the number of different event priorities.
EVENT2_EXPORT_SYMBOL int event_base_get_num_events(struct event_base *eb, unsigned int flags)
Gets the number of events in event_base, as specified in the flags.
EVENT2_EXPORT_SYMBOL int event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *callback_arg)
Prepare a new, already-allocated event structure to be added.
EVENT2_EXPORT_SYMBOL int event_config_set_num_cpus_hint(struct event_config *cfg, int cpus)
Records a hint for the number of CPUs in the system.
EVENT2_EXPORT_SYMBOL void event_base_active_by_signal(struct event_base *base, int sig)
Activates all pending signals with a given signal number.
EVENT2_EXPORT_SYMBOL evutil_socket_t event_get_fd(const struct event *ev)
Get the socket or signal assigned to an event, or -1 if the event has no socket.
EVENT2_EXPORT_SYMBOL int event_del_noblock(struct event *ev)
As event_del(), but never blocks while the event's callback is running in another thread,...
EVENT2_EXPORT_SYMBOL ev_uint32_t event_get_version_number(void)
Return a numeric representation of Libevent's version.
int(* event_base_foreach_event_cb)(const struct event_base *, const struct event *, void *)
Callback for iterating events in an event base via event_base_foreach_event.
Definition event.h:1627
EVENT2_EXPORT_SYMBOL int event_base_got_exit(struct event_base *eb)
Checks if the event loop was told to exit by event_base_loopexit().
EVENT2_EXPORT_SYMBOL int event_base_loopexit(struct event_base *eb, const struct timeval *tv)
Exit the event loop after the specified time.
EVENT2_EXPORT_SYMBOL const char * event_base_get_signal_method(const struct event_base *eb)
Get the kernel signal handling mechanism used by Libevent.
EVENT2_EXPORT_SYMBOL int event_remove_timer(struct event *ev)
Remove a timer from a pending event without removing the event itself.
EVENT2_EXPORT_SYMBOL void event_get_assignment(const struct event *event, struct event_base **base_out, evutil_socket_t *fd_out, short *events_out, event_callback_fn *callback_out, void **arg_out)
Extract all of arguments given to construct a given event.
EVENT2_EXPORT_SYMBOL event_callback_fn event_get_callback(const struct event *ev)
Return the callback assigned to an event.
void(* event_finalize_callback_fn)(struct event *, void *)
Callback type for event_finalize and event_free_finalize().
Definition event.h:1180
EVENT2_EXPORT_SYMBOL short event_get_events(const struct event *ev)
Return the events (EV_READ, EV_WRITE, etc) assigned to an event.
EVENT2_EXPORT_SYMBOL const char * event_base_get_method(const struct event_base *eb)
Get the kernel event notification mechanism used by Libevent.
EVENT2_EXPORT_SYMBOL struct event_base * event_base_new_with_config(const struct event_config *cfg)
Initialize the event API.
EVENT2_EXPORT_SYMBOL int event_base_foreach_event(struct event_base *base, event_base_foreach_event_cb fn, void *arg)
Iterate over all added or active events events in an event loop, and invoke a given callback on each ...
EVENT2_EXPORT_SYMBOL int event_reinit(struct event_base *base)
Reinitialize the event base after a fork.
EVENT2_EXPORT_SYMBOL struct event_base * event_get_base(const struct event *ev)
Get the event_base associated with an event.
EVENT2_EXPORT_SYMBOL int event_del_block(struct event *ev)
As event_del(), but always blocks while the event's callback is running in another thread,...
EVENT2_EXPORT_SYMBOL int event_initialized(const struct event *ev)
Test if an event structure might be initialized.
EVENT2_EXPORT_SYMBOL struct event_base * event_base_new(void)
Create and return a new event_base to use with the rest of Libevent.
EVENT2_EXPORT_SYMBOL void event_base_free(struct event_base *eb)
Deallocate all memory associated with an event_base, and free the base.
EVENT2_EXPORT_SYMBOL int event_pending(const struct event *ev, short events, struct timeval *tv)
Checks if a specific event is pending or scheduled.
EVENT2_EXPORT_SYMBOL void event_set_mem_functions(void *(*malloc_fn)(size_t sz), void *(*realloc_fn)(void *ptr, size_t sz), void(*free_fn)(void *ptr))
Override the functions that Libevent uses for memory management.
EVENT2_EXPORT_SYMBOL int event_base_get_max_events(struct event_base *eb, unsigned int flags, int clear)
Get the maximum number of events in a given event_base as specified in the flags.
EVENT2_EXPORT_SYMBOL struct event * event_base_get_running_event(struct event_base *base)
If called from within the callback for an event, returns that event.
EVENT2_EXPORT_SYMBOL void libevent_global_shutdown(void)
Release up all globally-allocated resources allocated by Libevent.
EVENT2_EXPORT_SYMBOL int event_add(struct event *ev, const struct timeval *timeout)
Add an event to the set of pending events.
EVENT2_EXPORT_SYMBOL int event_config_require_features(struct event_config *cfg, int feature)
Enters a required event method feature that the application demands.
void(* event_fatal_cb)(int err)
A function to be called if Libevent encounters a fatal internal error.
Definition event.h:773
EVENT2_EXPORT_SYMBOL int event_get_priority(const struct event *ev)
Return the priority of an event.
EVENT2_EXPORT_SYMBOL void event_enable_debug_logging(ev_uint32_t which)
Turn on debugging logs and have them sent to the default log handler.
EVENT2_EXPORT_SYMBOL void * event_get_callback_arg(const struct event *ev)
Return the callback argument assigned to an event.
EVENT2_EXPORT_SYMBOL int event_config_avoid_method(struct event_config *cfg, const char *method)
Enters an event method that should be avoided into the configuration.
EVENT2_EXPORT_SYMBOL int event_base_loop(struct event_base *eb, int flags)
Wait for events to become active, and run their callbacks.
EVENT2_EXPORT_SYMBOL int event_base_get_features(const struct event_base *base)
Return a bitmask of the features implemented by an event base.
event_base_config_flag
A flag passed to event_config_set_flag().
Definition event.h:541
@ EVENT_BASE_FLAG_NO_CACHE_TIME
Instead of checking the current time every time the event loop is ready to run timeout callbacks,...
Definition event.h:564
@ EVENT_BASE_FLAG_IGNORE_ENV
Do not check the EVENT_* environment variables when configuring an event_base.
Definition event.h:551
@ EVENT_BASE_FLAG_STARTUP_IOCP
Windows only: enable the IOCP dispatcher at startup.
Definition event.h:560
@ EVENT_BASE_FLAG_USE_SIGNALFD
Use signalfd(2) to handle signals over sigaction/signal.
Definition event.h:606
@ EVENT_BASE_FLAG_EPOLL_DISALLOW_TIMERFD
With EVENT_BASE_FLAG_PRECISE_TIMER, epoll backend will use timerfd for more accurate timers,...
Definition event.h:600
@ EVENT_BASE_FLAG_NOLOCK
Do not allocate a lock for the event base, even if we have locking set up.
Definition event.h:548
@ EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST
If we are using the epoll backend, this flag says that it is safe to use Libevent's internal change-l...
Definition event.h:580
@ EVENT_BASE_FLAG_PRECISE_TIMER
Ordinarily, Libevent implements its time and timeout code using the fastest monotonic timer that we h...
Definition event.h:587
EVENT2_EXPORT_SYMBOL const struct timeval * event_base_init_common_timeout(struct event_base *base, const struct timeval *duration)
Prepare an event_base to use a large number of timeouts with the same duration.
EVENT2_EXPORT_SYMBOL void event_config_free(struct event_config *cfg)
Deallocates all memory associated with an event configuration object.
EVENT2_EXPORT_SYMBOL const char * event_get_version(void)
Get the Libevent version.
EVENT2_EXPORT_SYMBOL int event_base_got_break(struct event_base *eb)
Checks if the event loop was told to abort immediately by event_base_loopbreak().
EVENT2_EXPORT_SYMBOL void event_base_dump_events(struct event_base *base, FILE *output)
Writes a human-readable description of all inserted and/or active events to a provided stdio stream.
EVENT2_EXPORT_SYMBOL int event_base_once(struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *arg, const struct timeval *timeout)
Schedule a one-time event.
event_method_feature
A flag used to describe which features an event_base (must) provide.
Definition event.h:513
@ EV_FEATURE_FDS
Require an event method that allows file descriptors as well as sockets.
Definition event.h:523
@ EV_FEATURE_O1
Require an event method where having one event triggered among many is [approximately] an O(1) operat...
Definition event.h:520
@ EV_FEATURE_ET
Require an event method that allows edge-triggered events with EV_ET.
Definition event.h:515
@ EV_FEATURE_EARLY_CLOSE
Require an event method that allows you to use EV_CLOSED to detect connection close without the neces...
Definition event.h:530
EVENT2_EXPORT_SYMBOL int event_base_update_cache_time(struct event_base *base)
Update cached_tv in the 'base' to the current time.
EVENT2_EXPORT_SYMBOL int event_config_set_flag(struct event_config *cfg, int flag)
Sets one or more flags to configure what parts of the eventual event_base will be initialized,...
EVENT2_EXPORT_SYMBOL int event_config_set_max_dispatch_interval(struct event_config *cfg, const struct timeval *max_interval, int max_callbacks, int min_priority)
Record an interval and/or a number of callbacks after which the event base should check for new event...
EVENT2_EXPORT_SYMBOL const char ** event_get_supported_methods(void)
Gets all event notification mechanisms supported by Libevent.
void(* event_callback_fn)(evutil_socket_t, short, void *)
A callback function for an event.
Definition event.h:1048
Structure to hold information and state for a Libevent dispatch loop.
Definition event.h:221
Configuration for an event_base.
Definition event.h:297
Structure to represent a single event.
Definition event.h:278
Common convenience functions for cross-platform portability and related socket manipulations.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition util.h:325
1.16.1