libevent的基本操作单元是事件。每个事件代表一组条件的集合，这些条件包括：

文件描述符已经就绪，可以读取或者写入
文件描述符变为就绪状态，可以读取或者写入（仅对于边沿触发IO）
超时事件
发生某信号
用户触发事件所有事件具有相似的生命周期。调用libevent函数设置事件并且关联到event_base之后，事件进入“已初始化（initialized）”状态。此时可以将事件添加到event_base中，这使之进入“未决（pending）”状态。在未决状态下，如果触发事件的条件发生（比如说，文件描述符的状态改变，或者超时时间到达），则事件进入“激活（active）”状态，（用户提供的）事件回调函数将被执行。如果配置为“持久的（persistent）”，事件将保持为未决状态

Create event

使用event_new（）接口创建事件。 event support 相关宏见：Macro definition

typedef void (*event_callback_fn)(evutil_socket_t, short, void *);
void event_free(struct event *ev)

source code

event_new()

struct event * event_new(struct event_base *base, evutil_socket_t fd, short events, void (*cb)(evutil_socket_t, short, void *), void *arg)

{

    struct event *ev;

    ev = mm_malloc(sizeof(struct event));

    if (ev == NULL)

        return (NULL);

    if (event_assign(ev, base, fd, events, cb, arg) < 0) {

        mm_free(ev);

        return (NULL);

    }

  

    return (ev);

}

  

void event_free(struct event *ev)

{

    /* This is disabled, so that events which have been finalized be a

     * valid target for event_free(). That's */

    // event_debug_assert_is_setup_(ev);
  
    /* make sure that this event won't be coming back to haunt us. */

    event_del(ev);

    event_debug_note_teardown_(ev);

    mm_free(ev);

  

}

event_new()试图分配和构造一个用于base的新的事件。what参数是上述标志的集合。如果fd非负，则它是将被观察其读写事件的文件。事件被激活时，libevent将调用cb函数，传递这些参数：文件描述符fd，表示所有被触发事件的位字段，以及构造事件时的arg参数。

发生内部错误，或者传入无效参数时，event_new（）将返回NULL。

所有新创建的事件都处于已初始化和非未决状态，调用event_add（）可以使其成为未决的。

要释放事件，调用event_free（）。对未决或者激活状态的事件调用event_free（）是安全的：在释放事件之前，函数将会使事件成为非激活和非未决的。

参数名	数据结构	说明
base	struct event_base	event_base上下文
fd	evutil_socket_t	IO事件对应的套接字
events	short	IO触发的事件； \|EV_READ\|读事件\| \|EV_WRITE\|写事件\|
cb	void ()(evutil_socket_t, short, void )	IO事件触发的回调函数，最终处理事件函数。
arg	void *	需要传给回调函数的信息。

example

上述函数定义在<event2/event.h>中，首次出现在libevent 2.0.1-alpha版本中。event_callback_fn类型首次在2.0.4-alpha版本中作为typedef出现。

Event flag

事件标志见：Macro definition

Only timeout events

为使用方便，libevent提供了一些以evtimer_开头的宏，用于替代event_*调用来操作纯超时事件。使用这些宏能改进代码的清晰性。

![[Pasted image 20240904092035.png]]

event_assign()

 /**
 * @brief  Assigns a file descriptor to an event structure and sets its properties.
 *
 * This function initializes an `event` structure to be used with the given `event_base`.
 * It sets up the event with a file descriptor, event types, and a callback function.
 *
 * @param ev         Pointer to the `event` structure to be initialized.
 * @param base       Pointer to the `event_base` to which this event will be assigned.
 *                   If NULL, the global or current event base is used.
 * @param fd         File descriptor associated with the event. This can be a socket,
 *                   pipe, or any other file descriptor used for I/O operations.
 * @param events     Bitmask of event types. This can include flags such as `EV_READ`,
 *                   `EV_WRITE`, `EV_SIGNAL`, `EV_PERSIST`, etc.
 * @param callback   Pointer to the function that will be called when the event is triggered.
 *                   This function should match the signature: `void callback(evutil_socket_t fd, short events, void *arg)`.
 * @param arg        Pointer to user-defined data that will be passed to the callback function.
 *                   This can be NULL or any pointer to additional context or state information.
 *
 * @return  0 on success, or -1 if there is an error (e.g., incompatible event types).
 */
int event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd, short events, void (*callback)(evutil_socket_t, short, void *), void *arg)
{
    // If no event base is provided, use the current base.
    if (!base)
        base = current_base;

    // If the argument is a special value, use the event structure itself.
    if (arg == &event_self_cbarg_ptr_)
        arg = ev;

    // Ensure the event is not already added to an event base.
    if (!(events & EV_SIGNAL))
        event_debug_assert_socket_nonblocking_(fd);

    // Ensure the event structure is in an initial state.
    event_debug_assert_not_added_(ev);

    // Initialize the event structure with provided parameters.
    ev->ev_base = base;  
    ev->ev_callback = callback;
    ev->ev_arg = arg;
    ev->ev_fd = fd;
    ev->ev_events = events;
    ev->ev_res = 0;
    ev->ev_flags = EVLIST_INIT;
    ev->ev_ncalls = 0;
    ev->ev_pncalls = NULL;

    // Special handling for signal events.
    if (events & EV_SIGNAL) {
        // EV_SIGNAL should not be combined with EV_READ, EV_WRITE, or EV_CLOSED.
        if ((events & (EV_READ|EV_WRITE|EV_CLOSED)) != 0) {
            event_warnx("%s: EV_SIGNAL is not compatible with "
                "EV_READ, EV_WRITE or EV_CLOSED", __func__);
            return -1;
        }
        ev->ev_closure = EV_CLOSURE_EVENT_SIGNAL;
    } else {
        // Handle persistent and one-time events.
        if (events & EV_PERSIST) {
            evutil_timerclear(&ev->ev_io_timeout);
            ev->ev_closure = EV_CLOSURE_EVENT_PERSIST;
        } else {
            ev->ev_closure = EV_CLOSURE_EVENT;
        }
    }

    // Initialize priority and other internal structures.
    min_heap_elem_init_(ev);

    // Set event priority if the event base is not NULL.
    if (base != NULL) {
        ev->ev_pri = base->nactivequeues / 2;
    }

    // Debug note for setting up the event.
    event_debug_note_setup_(ev);

    return 0;
}

参数说明：

ev: 要初始化的事件结构体的指针。
base: 事件基底的指针。如果传递 NULL，则使用当前全局事件基底。
fd: 关联的文件描述符。
events: 事件类型的位掩码，例如 EV_READ 表示读事件，EV_WRITE 表示写事件等。
callback: 事件触发时调用的回调函数。
arg: 传递给回调函数的用户数据。

功能说明：

检查并设置事件基底。
设置事件的回调函数、参数、文件描述符和事件类型。
特殊处理信号事件和持久事件。
初始化事件的内部状态。
设置事件优先级（如果事件基底不为 NULL）。
执行调试相关的初始化操作。

event_add()

int event_add(struct event *ev, const struct timeval *tv)

{

    int res;

  

    if (EVUTIL_FAILURE_CHECK(!ev->ev_base)) {

        event_warnx("%s: event has no event_base set.", __func__);

        return -1;

    }

  

    EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);

  

    res = event_add_nolock_(ev, tv, 0);

  

    EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);

  

    return (res);

}

event_del()

int event_del(struct event *ev)

{

    return event_del_(ev, EVENT_DEL_AUTOBLOCK);

}

![[Pasted image 20240904092708.png]]

event_del_()

static int event_del_(struct event *ev, int blocking)

{

    int res;

    struct event_base *base = ev->ev_base;

  

    if (EVUTIL_FAILURE_CHECK(!base)) {

        event_warnx("%s: event has no event_base set.", __func__);

        return -1;

    }

  

    EVBASE_ACQUIRE_LOCK(base, th_base_lock);

    res = event_del_nolock_(ev, blocking);

    EVBASE_RELEASE_LOCK(base, th_base_lock);

  

    return (res);

}

event_pending()

int event_pending(const struct event *ev, short event, struct timeval *tv)

{

    int flags = 0;

  

    if (EVUTIL_FAILURE_CHECK(ev->ev_base == NULL)) {

        event_warnx("%s: event has no event_base set.", __func__);

        return 0;

    }

  

    EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);

    event_debug_assert_is_setup_(ev);

  

    if (ev->ev_flags & EVLIST_INSERTED)

        flags |= (ev->ev_events & (EV_READ|EV_WRITE|EV_CLOSED|EV_SIGNAL));

    if (ev->ev_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER))

        flags |= ev->ev_res;

    if (ev->ev_flags & EVLIST_TIMEOUT)

        flags |= EV_TIMEOUT;

  

    event &= (EV_TIMEOUT|EV_READ|EV_WRITE|EV_CLOSED|EV_SIGNAL);

  

    /* See if there is a timeout that we should report */

    if (tv != NULL && (flags & event & EV_TIMEOUT)) {

        struct timeval tmp = ev->ev_timeout;

        tmp.tv_usec &= MICROSECONDS_MASK;

        /* correctly remamp to real time */

        evutil_timeradd(&ev->ev_base->tv_clock_diff, &tmp, tv);

    }

  

    EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);

  

    return (flags & event);

}

event_initialized()

int event_initialized(const struct event *ev)
{

    if (!(ev->ev_flags & EVLIST_INIT))
        return 0;          
    return 1;

}

Build singal event

libevent也可以监测POSIX风格的信号。要构造信号处理器，使用：

struct event *

event_new(struct event_base *base, evutil_socket_t fd, short events, void (*cb)(evutil_socket_t, short, void *), void *arg)

#define evsignal_new(b, x, cb, arg)          \

event_new((b), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))

除了提供一个信号编号代替文件描述符之外，各个参数与event_new（）相同。

注意：信号回调是信号发生后在事件循环中被执行的，所以可以安全地调用通常不能在POSIX风格信号处理器中使用的函数。

libevent也提供了一组方便使用的宏用于处理信号事件：

evsignal_*宏从2.0.1-alpha版本开始存在。先前版本中这些宏叫做signal_add（）、signal_del（）等等。

Warning about signals

在当前版本的libevent和大多数后端中，每个进程任何时刻只能有一个event_base可以监听信号。如果同时向两个event_base添加信号事件，即使是不同的信号，也只有一个event_base可以取得信号。

kqueue后端没有这个限制

Memory management Settings do not use heap-allocated events

出于性能考虑或者其他原因，有时需要将事件作为一个大结构体的一部分。对于每个事件的使用，这可以节省：

内存分配器在堆上分配小对象的开销
对event结构体指针取值的时间开销
如果事件不在缓存中，因为可能的额外缓存丢失而导致的时间开销对于大多数应用来说，这些开销是非常小的。所以，除非确定在堆上分配事件导致了严重的性能问题，应该坚持使用event_new（）。如果将来版本中的event结构体更大，不使用event_new（）可能会导致难以诊断的错误。

不在堆上分配event具有破坏与其他版本libevent二进制兼容性的风险：其他版本中的event结构体大小可能不同。

event_assign()

int event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd, short events, 
				 void (*callback)(evutil_socket_t, short, void *), void *arg)

除了event参数必须指向一个未初始化的事件之外，event_assign（）的参数与event_new（）的参数相同。成功时函数返回0，如果发生内部错误或者使用错误的参数，函数返回-1。

source code

int event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd, short events, void (*callback)(evutil_socket_t, short, void *), void *arg)

{

    if (!base)

        base = current_base;

    if (arg == &event_self_cbarg_ptr_)

        arg = ev;

  

    if (!(events & EV_SIGNAL))

        event_debug_assert_socket_nonblocking_(fd);

    event_debug_assert_not_added_(ev);

  

    ev->ev_base = base;

  

    ev->ev_callback = callback;

    ev->ev_arg = arg;

    ev->ev_fd = fd;

    ev->ev_events = events;

    ev->ev_res = 0;

    ev->ev_flags = EVLIST_INIT;

    ev->ev_ncalls = 0;

    ev->ev_pncalls = NULL;

  

    if (events & EV_SIGNAL) {

        if ((events & (EV_READ|EV_WRITE|EV_CLOSED)) != 0) {

            event_warnx("%s: EV_SIGNAL is not compatible with "

                "EV_READ, EV_WRITE or EV_CLOSED", __func__);

            return -1;

        }

        ev->ev_closure = EV_CLOSURE_EVENT_SIGNAL;

    } else {

        if (events & EV_PERSIST) {

            evutil_timerclear(&ev->ev_io_timeout);

            ev->ev_closure = EV_CLOSURE_EVENT_PERSIST;

        } else {

            ev->ev_closure = EV_CLOSURE_EVENT;

        }

    }

  

    min_heap_elem_init_(ev);

  

    if (base != NULL) {

        /* by default, we put new events into the middle priority */

        ev->ev_pri = base->nactivequeues / 2;

    }

  

    event_debug_note_setup_(ev);

  

    return 0;

}

example

#include <event2/event.h>

#include <event2/event_struct.h>

#include <stdlib.h>

  

struct event_pair{

    evutil_socket_t fd;

    struct event read_event;

    struct event write_event;

};

  

void readcb(evutil_socket_t fd, short , void *);

void writecb(evutil_socket_t fd, short , void *);

  

struct event_pair * event_pair_new(struct event_base *base, evutil_socket_t fd){

    struct event_pair *pair = (struct event_pair *)malloc(sizeof(struct event_pair));

    if(!pair) return NULL;

    pair->fd = fd;

    event_assign(&pair->read_event, base, fd, EV_READ|EV_PERSIST, readcb, pair);

    event_assign(&pair->write_event, base, fd, EV_WRITE|EV_PERSIST, writecb, pair);

    return pair;

}

q也可以用event_assign（）初始化栈上分配的，或者静态分配的事件。

Warning

不要对已经在event_base中未决的事件调用event_assign（），这可能会导致难以诊断的错误。如果已经初始化和成为未决的，调用event_assign（）之前需要调用event_del（）。

libevent提供了方便的宏将event_assign（）用于仅超时事件或者信号事件。

#define evtimer_assign(ev, b, cb, arg) \

   event_assign((ev), (b), -1, 0, (cb), (arg))
#define evsignal_assign(ev, b, x, cb, arg)         \

   event_assign((ev), (b), (x), EV_SIGNAL|EV_PERSIST, cb, (arg))

如果需要使用event_assign（），又要保持与将来版本libevent的二进制兼容性，可以请求libevent告知struct event在运行时应该有多大：

size_t event_get_struct_event_size(void)

{

    return sizeof(struct event);

}

这个函数返回需要为event结构体保留的字节数。再次强调，只有在确信堆分配是一个严重的性能问题时才应该使用这个函数，因为这个函数让代码难以阅读和编写。

注意，将来版本的event_get_struct_event_size()的返回值可能比sizeof(struct event)小，这表示event结构体末尾的额外字节仅仅是保留用于将来版本libevent的填充字节。

下面这个例子跟上面的那个相同，但是不依赖于event_struct.h中的event结构体的大小，而是使用event_get_struct_size（）来获取运行时的正确大小。

Make events unresolved and non-unresolved

event_add

构造事件之后，在将其添加到event_base之前实际上是不能对其做任何操作的。使用event_add（）将事件添加到event_base。

在非未决的事件上调用event_add（）将使其在配置的event_base中成为未决的。成功时函数返回0，失败时返回-1。如果tv为NULL，添加的事件不会超时。否则，tv以秒和微秒指定超时值。

如果对已经未决的事件调用event_add（），事件将保持未决状态，并在指定的超时时间被重新调度。

注意：不要设置tv为希望超时事件执行的时间。如果在2010年1月1日设置“tv->tv_sec=time(NULL)+10;”，超时事件将会等待40年，而不是10秒。

event_del()

见上文 Only timeouts events 部分。对已经初始化的事件调用event_del（）将使其成为非未决和非激活的。如果事件不是未决的或者激活的，调用将没有效果。成功时函数返回0，失败时返回-1。

注意：如果在事件激活后，其回调被执行前删除事件，回调将不会执行。

这些函数定义在<event2/event.h>中，从0.1版本就存在了。

Events with priority

多个事件同时触发时，libevent没有定义各个回调的执行次序。可以使用优先级来定义某些事件比其他事件更重要。

在前一章讨论过，每个event_base有与之相关的一个或者多个优先级。在初始化事件之后，但是在添加到event_base之前，可以为其设置优先级。

event_priority_set()

int event_priority_set(struct event *ev, int pri)

{

    event_debug_assert_is_setup_(ev);
  

    if (ev->ev_flags & EVLIST_ACTIVE)

        return (-1);

    if (pri < 0 || pri >= ev->ev_base->nactivequeues)

        return (-1);

    ev->ev_pri = pri;

    return (0);

}

事件的优先级是一个在0和event_base的优先级减去1之间的数值。成功时函数返回0，失败时返回-1。

多个不同优先级的事件同时成为激活的时候，低优先级的事件不会运行。libevent会执行高优先级的事件，然后重新检查各个事件。只有在没有高优先级的事件是激活的时候，低优先级的事件才会运行。

#include <event2/event.h>

#include <event2/event_struct.h>

void readcb(evutil_socket_t fd, short event, void *arg) ;

void writecb(evutil_socket_t fd, short event, void *arg) ;



void main_loop(evutil_socket_t fd)

{

  

    struct event * important_event ,*unimportant_event;

    struct event_base *base = event_base_new();

    event_base_priority_init(base, 2);

    /* Now base has priority0 and priority 1*/

    important_event = event_new(base, fd, EV_READ|EV_WRITE, readcb, NULL);

    unimportant_event = event_new(base, fd, EV_READ|EV_WRITE, writecb, NULL);

    event_priority_set(important_event, 0);

    event_priority_set(unimportant_event, 1);

    /** Now,whenever the fd is ready for  writing,the write callback will happen

     * before the read callback ,The read callback won't happen at

     * all until the  write callback is no longer active.

       */

  

}

如果不为事件设置优先级，则默认的优先级将会是event_base的优先级数目除以2。

Check event status

有时候需要了解事件是否已经添加，检查事件代表什么。

API

#define event_get_signal(ev) ((int)event_get_fd(ev))
int event_pending(const struct event *ev, short event, struct timeval *tv)
short event_get_events(const struct event *ev);
evutil_socket_t event_get_fd(const struct event *ev);
event_callback_fn event_get_callback(const struct event *ev);
void *event_get_callback_arg(const struct event *ev);
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)

event_pending（）函数确定给定的事件是否是未决的或者激活的。如果是，而且what参数设置了EV_READ、EV_WRITE、EV_SIGNAL或者EV_TIMEOUT等标志，则函数会返回事件当前为之未决或者激活的所有标志。如果提供了tv_out参数，并且what参数中设置了EV_TIMEOUT标志，而事件当前正因超时事件而未决或者激活，则tv_out会返回事件的超时值。

#include <cstddef>

#include <event2/event.h>

#include <stdio.h>

  

int repplace_callback(struct event *ev,event_callback_fn new_callback,

    void *new_callback_arg)  
{

    struct event_base *base;
    evutil_socket_t fd;
    short events;  
    int pengding;

    pengding = event_pending(ev,EV_READ|EV_WRITE|EV_SIGNAL|EV_TIMEOUT,NULL);  
    if(pengding){
        fprintf(stderr,"Error! replace_callback() called on a pending event!\n");
        return -1;
    }
    event_get_assignment(ev,&base,&fd,&events,NULL,NULL);
    event_assign(ev,base,fd,events,new_callback,new_callback_arg);
    return 0;  
}

event_get_fd（）和event_get_signal（）返回为事件配置的文件描述符或者信号值。event_get_base（）返回为事件配置的event_base。event_get_events（）返回事件的标志（EV_READ、EV_WRITE等）。event_get_callback（）和event_get_callback_arg（）返回事件的回调函数及其参数指针。

event_get_assignment（）复制所有为事件分配的字段到提供的指针中。任何为NULL的参数会被忽略。

source code

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)
{

    event_debug_assert_is_setup_(event);  
    if (base_out)
        *base_out = event->ev_base;
    if (fd_out)
        *fd_out = event->ev_fd;
    if (events_out)
        *events_out = event->ev_events;
    if (callback_out)
        *callback_out = event->ev_callback;
    if (arg_out)
        *arg_out = event->ev_arg;
}

  
//获取配置的文件描述符
evutil_socket_t

event_get_fd(const struct event *ev)

{

    event_debug_assert_is_setup_(ev);

    return ev->ev_fd;

}

  
//获取操作后端
struct event_base *

event_get_base(const struct event *ev)

{

    event_debug_assert_is_setup_(ev);

    return ev->ev_base;

}

  
//返回事件
short

event_get_events(const struct event *ev)

{

    event_debug_assert_is_setup_(ev);

    return ev->ev_events;

}

  
//返回事件的回调函数
event_callback_fn

event_get_callback(const struct event *ev)

{

    event_debug_assert_is_setup_(ev);

    return ev->ev_callback;

}

  
//返回回调函数的参数
void *

event_get_callback_arg(const struct event *ev)

{

    event_debug_assert_is_setup_(ev);

    return ev->ev_arg;

}

  
//返回事件的优先级
int

event_get_priority(const struct event *ev)

{

    event_debug_assert_is_setup_(ev);

    return ev->ev_pri;

}

event_get_fd（）和event_get_signal（）返回为事件配置的文件描述符或者信号值。 event_get_base（）返回为事件配置的event_base。 event_get_events（）返回事件的标志（EV_READ、EV_WRITE等）。 event_get_callback（）和event_get_callback_arg（）返回事件的回调函数及其参数指针。

Configure a trigger event

如果不需要多次添加一个事件，或者要在添加后立即删除事件，而事件又不需要是持久的，则可以使用event_base_once（）。

event_base_once()

int

event_base_once(struct event_base *base, evutil_socket_t fd, short events,

    void (*callback)(evutil_socket_t, short, void *),

    void *arg, const struct timeval *tv)

除了不支持EV_SIGNAL或者EV_PERSIST之外，这个函数的接口与event_new（）相同。安排的事件将以默认的优先级加入到event_base并执行。回调被执行后，libevent内部将会释放event结构。成功时函数返回0，失败时返回-1。

不能删除或者手动激活使用event_base_once（）插入的事件：如果希望能够取消事件，应该使用event_new（）或者event_assign（）。

source code

/* Schedules an event once */

int

event_base_once(struct event_base *base, evutil_socket_t fd, short events,

    void (*callback)(evutil_socket_t, short, void *),

    void *arg, const struct timeval *tv)

{

    struct event_once *eonce;

    int res = 0;

    int activate = 0;

  

    if (!base)

        return (-1);

  

    /* We cannot support signals that just fire once, or persistent

     * events. */

    if (events & (EV_SIGNAL|EV_PERSIST))

        return (-1);

  

    if ((eonce = mm_calloc(1, sizeof(struct event_once))) == NULL)

        return (-1);

  

    eonce->cb = callback;

    eonce->arg = arg;

  

    if ((events & (EV_TIMEOUT|EV_SIGNAL|EV_READ|EV_WRITE|EV_CLOSED)) == EV_TIMEOUT) {

        evtimer_assign(&eonce->ev, base, event_once_cb, eonce);

  

        if (tv == NULL || ! evutil_timerisset(tv)) {

            /* If the event is going to become active immediately,

             * don't put it on the timeout queue.  This is one

             * idiom for scheduling a callback, so let's make

             * it fast (and order-preserving). */

            activate = 1;

        }

    } else if (events & (EV_READ|EV_WRITE|EV_CLOSED)) {

        events &= EV_READ|EV_WRITE|EV_CLOSED;

  

        event_assign(&eonce->ev, base, fd, events, event_once_cb, eonce);

    } else {

        /* Bad event combination */

        mm_free(eonce);

        return (-1);

    }

  

    if (res == 0) {

        EVBASE_ACQUIRE_LOCK(base, th_base_lock);

        if (activate)

            event_active_nolock_(&eonce->ev, EV_TIMEOUT, 1);

        else

            res = event_add_nolock_(&eonce->ev, tv, 0);

  

        if (res != 0) {

            mm_free(eonce);

            return (res);

        } else {

            LIST_INSERT_HEAD(&base->once_events, eonce, next_once);

        }

        EVBASE_RELEASE_LOCK(base, th_base_lock);

    }

  

    return (0);

}

Manual Activation Events

极少数情况下，需要在事件的条件没有触发的时候让事件成为激活的。

event_active()

void

event_active(struct event *ev, int res, short ncalls)

这个函数让事件ev带有标志what（EV_READ、EV_WRITE和EV_TIMEOUT的组合）成为激活的。事件不需要已经处于未决状态，激活事件也不会让它成为未决的。

source code

/*
- `struct event *ev`：指向 `event` 结构体的指针，表示需要激活的事件。
- `int res`：事件激活的结果状态（具体含义取决于事件的类型）。EV_READ等宏
- `short ncalls`：调用的次数或其它相关的信息。
*/
void

event_active(struct event *ev, int res, short ncalls)

{

    if (EVUTIL_FAILURE_CHECK(!ev->ev_base)) {

        event_warnx("%s: event has no event_base set.", __func__);

        return;

    }

  

    EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);

  

    event_debug_assert_is_setup_(ev);

  

    event_active_nolock_(ev, res, ncalls);

  

    EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);

}

Optimizing common timeouts

当前版本的libevent使用二进制堆算法跟踪未决事件的超时值，这让添加和删除事件超时值具有O(logN)性能。对于随机分布的超时值集合，这是优化的，但对于大量具有相同超时值的事件集合，则不是。

比如说，假定有10000个事件，每个都需要在添加后5秒触发超时事件。这种情况下，使用双链队列实现才可以取得O（1）性能。

自然地，不希望为所有超时值使用队列，因为队列仅对常量超时值更快。如果超时值或多或少地随机分布，则向队列添加超时值的性能将是O（n），这显然比使用二进制堆糟糕得多。

libevent通过放置一些超时值到队列中，另一些到二进制堆中来解决这个问题。要使用这个机制，需要向libevent请求一个“公用超时(common timeout)”值，然后使用它来添加事件。如果有大量具有单个公用超时值的事件，使用这个优化应该可以改进超时处理性能。

const struct timeval *

event_base_init_common_timeout(struct event_base *base,

    const struct timeval *duration)

这个函数需要event_base和要初始化的公用超时值作为参数。函数返回一个到特别的timeval结构体的指针，可以使用这个指针指示事件应该被添加到O（1）队列，而不是O（logN）堆。可以在代码中自由地复制这个特别的timeval或者进行赋值，但它仅对用于构造它的特定event_base有效。不能依赖于其实际内容：libevent使用这个内容来告知自身使用哪个队列。

example

#include <bits/types/struct_timeval.h>

#include <cstring>

#include <event2/event.h>

#include <cstring>

#include <memory.h>

  

struct timeval ten_s = {10,0};

  

void initialise_time_out(struct event_base *base){

    struct timeval tv_in = {10,0};

    const struct timeval *tv_out ;

    tv_out = event_base_init_common_timeout(base, &tv_in);

    memcpy(&ten_s, tv_out, sizeof(struct timeval));

}

a

int my_event_add(struct event* ev,const struct timeval *tv){

    if(tv && tv->tv_sec == ten_s.tv_sec && tv->tv_usec == ten_s.tv_usec){

        return event_add(ev, &ten_s);

    }

    return event_add(ev, tv);

}

source code

  

#define MAX_COMMON_TIMEOUTS 256

  

const struct timeval *

event_base_init_common_timeout(struct event_base *base,

    const struct timeval *duration)

{

    int i;

    struct timeval tv;

    const struct timeval *result=NULL;

    struct common_timeout_list *new_ctl;

  

    EVBASE_ACQUIRE_LOCK(base, th_base_lock);

    if (duration->tv_usec > 1000000) {

        memcpy(&tv, duration, sizeof(struct timeval));

        if (is_common_timeout(duration, base))

            tv.tv_usec &= MICROSECONDS_MASK;

        tv.tv_sec += tv.tv_usec / 1000000;

        tv.tv_usec %= 1000000;

        duration = &tv;

    }

    for (i = 0; i < base->n_common_timeouts; ++i) {

        const struct common_timeout_list *ctl =

            base->common_timeout_queues[i];

        if (duration->tv_sec == ctl->duration.tv_sec &&

            duration->tv_usec ==

            (ctl->duration.tv_usec & MICROSECONDS_MASK)) {

            EVUTIL_ASSERT(is_common_timeout(&ctl->duration, base));

            result = &ctl->duration;

            goto done;

        }

    }

    if (base->n_common_timeouts == MAX_COMMON_TIMEOUTS) {

        event_warnx("%s: Too many common timeouts already in use; "

            "we only support %d per event_base", __func__,

            MAX_COMMON_TIMEOUTS);

        goto done;

    }

    if (base->n_common_timeouts_allocated == base->n_common_timeouts) {

        int n = base->n_common_timeouts < 16 ? 16 :

            base->n_common_timeouts*2;

        struct common_timeout_list **newqueues =

            mm_realloc(base->common_timeout_queues,

            n*sizeof(struct common_timeout_queue *));

        if (!newqueues) {

            event_warn("%s: realloc",__func__);

            goto done;

        }

        base->n_common_timeouts_allocated = n;

        base->common_timeout_queues = newqueues;

    }

    new_ctl = mm_calloc(1, sizeof(struct common_timeout_list));

    if (!new_ctl) {

        event_warn("%s: calloc",__func__);

        goto done;

    }

    TAILQ_INIT(&new_ctl->events);

    new_ctl->duration.tv_sec = duration->tv_sec;

    new_ctl->duration.tv_usec =

        duration->tv_usec | COMMON_TIMEOUT_MAGIC |

        (base->n_common_timeouts << COMMON_TIMEOUT_IDX_SHIFT);

    evtimer_assign(&new_ctl->timeout_event, base,

        common_timeout_callback, new_ctl);

    new_ctl->timeout_event.ev_flags |= EVLIST_INTERNAL;

    event_priority_set(&new_ctl->timeout_event, 0);

    new_ctl->base = base;

    base->common_timeout_queues[base->n_common_timeouts++] = new_ctl;

    result = &new_ctl->duration;  

done:
    if (result)
        EVUTIL_ASSERT(is_common_timeout(result, base));  

    EVBASE_RELEASE_LOCK(base, th_base_lock);

    return result;

}

Identifying events from cleared memory

libevent提供了函数，可以从已经通过设置为0（比如说，通过calloc（）分配的，或者使用memset（）或者bzero（）清除了的）而清除的内存识别出已初始化的事件。

int event_initialized(const struct event *ev)

source code

int event_initialized(const struct event *ev)
{
    if (!(ev->ev_flags & EVLIST_INIT))
        return 0;  
    return 1;

}

#define evsignal_initialized(ev) event_initialized(ev)
#define evtimer_initialized(ev)     event_initialized(ev)

警告这个函数不能可靠地从没有初始化的内存块中识别出已经初始化的事件。除非知道被查询的内存要么是已清除的，要么是已经初始化为事件的，才能使用这个函数。

除非编写一个非常特别的应用，通常不需要使用这个函数。event_new（）返回的事件总是已经初始化的。

example

#include <event2/event.h>

#include <stdlib.h>
  
struct reader{

    evutil_socket_t fd;

};

  

#define READER_ACTUAL_SIZE \

    (sizeof(struct reader) + sizeof(evutil_socket_t))

  

#define READER_EVENT_PTR(r) \

    ((struct event *)((char *)(r) + sizeof(struct reader)))

  

struct reader* allocate_reader(evutil_socket_t fd){

  

    struct reader *r = (reader*)calloc(1, READER_ACTUAL_SIZE);

    if(r)

        r->fd = fd;

    return r;

};

void readcb(evutil_socket_t fd, short event, void *arg);

  

int add_reader(struct reader*r ,struct event_base *base)

{

    struct event* ev = READER_EVENT_PTR(r);

    if(!event_initialized(ev))

        event_assign(ev,base,r->fd,EV_READ,readcb,r);

    return event_add(ev,NULL);  

}

event_initialized（）函数从0.3版本就存在了。

Deprecated event handling functions

2.0版本之前的libevent没有event_assign（）或者event_new（）。替代的是将事件关联到“当前”event_base的event_set（）。如果有多个event_base，需要记得调用event_base_set（）来确定事件确实是关联到当前使用的event_base的。

int event_base_set(struct event_base *base, struct event *ev)
void event_set(struct event *ev, evutil_socket_t fd, short events,
      void (*callback)(evutil_socket_t, short, void *), void *arg)

除了使用当前event_base之外，event_set（）跟event_assign（）是相似的。event_base_set（）用于修改事件所关联到的event_base。

event_set（）具有一些用于更方便地处理定时器和信号的变体：evtimer_set（）大致对应evtimer_assign（）；evsignal_set（）大致对应evsignal_assign（）。

2.0版本之前的libevent使用“signal_”作为用于信号的event_set（）等函数变体的前缀，而不是“evsignal_”（也就是说，有signal_set()、signal_add()、signal_del()、signal_pending()和signal_initialized()）。远古版本(0.6版之前)的libevent使用“timeout_”而不是“evtimer_”。因此，做代码考古（code archeology）（注：这个翻译似乎不正确，是否有更专业的术语？比如说，“代码复审”）时可能会看到timeout_add()、timeout_del()、timeout_initialized()、timeout_set()和timeout_pending()等等。

较老版本（2.0版之前）的libevent用宏EVENT_FD()和EVENT_SIGNAL()代表现在的event_get_fd()和event_get_signal()函数。这两个宏直接检查event结构体的内容，所以会妨碍不同版本之间的二进制兼容性。在2.0以及后续版本中，这两个宏仅仅是event_get_fd()和event_get_signal()的别名。

因为2.0之前的版本不支持锁，所以在运行event_base的线程之外的任何线程调用修改事件状态的函数都是不安全的。这些函数包括event_add()、event_del()、event_active()和event_base_once()。

有一个event_once()与event_base_once()相似，只是用于当前event_base。

2.0版本之前EV_PERSIST标志不能正确地操作超时。标志不会在事件激活时复位超时值，而是没有任何操作。

2.0之前的版本不支持同时添加多个带有相同fd和READ/WRITE标志的事件。也就是说，在每个fd上，某时刻只能有一个事件等待读取，也只能有一个事件等待写入。 43 Things： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件 BuzzNet： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件
del.icio.us： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件
Flickr： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件
IceRocket： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件
LiveJournal： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件
Technorati： IT, libevent, 非阻塞IO, 公用超时, 激活, 网络编程, 未决, 信号事件

source code

int

event_base_set(struct event_base *base, struct event *ev)

{

    /* Only innocent events may be assigned to a different base */

    if (ev->ev_flags != EVLIST_INIT)

        return (-1);

  

    event_debug_assert_is_setup_(ev);

  

    ev->ev_base = base;

    ev->ev_pri = base->nactivequeues/2;

  

    return (0);

}

  

void

event_set(struct event *ev, evutil_socket_t fd, short events,

      void (*callback)(evutil_socket_t, short, void *), void *arg)

{

    int r;

    r = event_assign(ev, current_base, fd, events, callback, arg);

    EVUTIL_ASSERT(r == 0);

}

Files

Create event.md

Latest commit

History

Create event.md

File metadata and controls

Create event

source code

event_new()

example

Event flag

Only timeout events

event_assign()

event_add()

event_del()

event_del_()

event_pending()

event_initialized()

Build singal event

Warning about signals

Memory management Settings do not use heap-allocated events

event_assign()

source code

example

Warning

Make events unresolved and non-unresolved

event_add

event_del()

Events with priority

event_priority_set()

Check event status

API

source code

Configure a trigger event

event_base_once()

source code

Manual Activation Events

event_active()

source code

Optimizing common timeouts

example

source code

Identifying events from cleared memory

source code

example

Deprecated event handling functions

source code