libevent之evconnlistener

连接侦听器：接受 TCP 连接

连接侦听器：接受 TCP 连接

evconnlistener 机制为您提供了一种监听和接受的方法传入的 TCP 连接。

本节中的所有函数和类型都在 event2/listener.h。它们首次出现在 Libevent 2.0.2-alpha 中，除非另有说明。

创建或释放 evconnlistener

接口

struct evconnlistener *evconnlistener_new(struct event_base *base,
    evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
    evutil_socket_t fd);
struct evconnlistener *evconnlistener_new_bind(struct event_base *base,
    evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
    const struct sockaddr *sa, int socklen);
void evconnlistener_free(struct evconnlistener *lev);

两个 evconnlistener_new*（）函数都分配并返回一个新的连接侦听器对象。连接侦听器使用event_base 请注意，当给定侦听器套接字上有新的 TCP 连接时。当新连接到达时，它会调用您为其提供的回调函数。

在这两个函数中，基参数event_base都是侦听器应该用于侦听连接。cb 函数是对在收到新连接时调用;如果 cb 为 NULL，则侦听器为在设置回调之前，将其视为禁用。将传递 ptr 指针到回调。flags 参数控制侦听器的行为 — 下面将详细介绍。积压工作（backlog）参数控制最大数量网络堆栈应允许在任何时候都处于尚未接受的状态;请参阅系统文档 listen（）函数以获取更多详细信息。如果积压工作为负数，则 Libevent 会尝试为积压工作选择一个好的价值;如果它为零，则 Libevent 假设您已经在提供它的套接字上调用了 listen（）。

这些函数在设置侦听套接字的方式上有所不同。这 evconnlistener_new（）函数假定您已经将套接字绑定到要侦听的端口，并且要将套接字作为 FD 传入。如果希望 Libevent 自行分配并绑定到套接字，调用 evconnlistener_new_bind（），并传入要绑定的 sockaddr，及其长度。

提示	[使用 evconnlistener_new 时，请确保您的收听插座在使用evutil_make_socket_nonblocking或手动的非阻塞模式设置正确的套接字选项。当侦听套接字留在阻塞模式下，可能会发生未定义的行为。

若要释放连接侦听器，请将其传递给 evconnlistener_free（）。

识别的标志

这些是可以传递给 flags 参数的标志 evconnlistener_new（）函数。你可以给出任意数量的这些，或者一起。

LEV_OPT_LEAVE_SOCKETS_BLOCKING

默认情况下，当连接侦听器接受新的传入 socket，它将其设置为非阻塞，以便您可以使用它与 Libevent 的其余部分。如果您不想要此标志，请设置此标志行为。
LEV_OPT_CLOSE_ON_FREE

如果设置了此选项，则连接侦听器将关闭其底层套接字。
LEV_OPT_CLOSE_ON_EXEC

如果设置了此选项，则连接侦听器将设置基础侦听器套接字上的 close-on-exec 标志。查看您的 FCNTL 的平台文档和FD_CLOEXEC了解更多信息信息。
LEV_OPT_REUSEABLE

默认情况下，在某些平台上，一旦侦听器套接字关闭，没有其他套接字可以绑定到同一个端口，直到一段时间通过。设置此选项会使 Libevent 将套接字标记为可重复使用，因此一旦关闭，另一个插座就可以打开以在同一端口上收听。
LEV_OPT_THREADSAFE

为侦听器分配锁，以便可以安全地从多个线程。Libevent 2.0.8-rc 中的新功能。
LEV_OPT_DISABLED

初始化要禁用的侦听器，而不是启用侦听器。您可以使用 evconnlistener_enable（）手动打开它。Libevent 的新功能 2.1.1-阿尔法。
LEV_OPT_DEFERRED_ACCEPT

如果可能，告诉内核不要宣布套接字已经接受，直到收到有关它们的一些数据，并且它们已准备就绪供阅读。如果您的协议不是从客户端传输数据开始的，请不要使用此选项，因为在这种情况下此选项有时会导致内核永远不会告诉您连接。并非所有操作系统都支持此选项：在以下操作系统上不要，此选项不起作用。Libevent 2.1.1-alpha 的新功能。

连接侦听器回调

接口

typedef void (*evconnlistener_cb)(struct evconnlistener *listener,
    evutil_socket_t sock, struct sockaddr *addr, int len, void *ptr);

当收到新连接时，提供的回调函数是调用。listener 参数是连接侦听器收到连接。sock 参数是新的套接字本身。addr 和 len 参数是已接收连接以及该地址的长度分别。ptr 参数是用户提供的指针，传递给 evconnlistener_new（）。

启用和禁用 evconnlistener

接口

int evconnlistener_disable(struct evconnlistener *lev);
int evconnlistener_enable(struct evconnlistener *lev);

这些功能会暂时禁用或重新启用侦听新连接。

调整 evconnlistener 的回调

接口

void evconnlistener_set_cb(struct evconnlistener *lev,
    evconnlistener_cb cb, void *arg);

此函数调整现有 evconnlistener。它是在 2.0.9-rc 中引入的。

检查 evconnlistener

接口

evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev);
struct event_base *evconnlistener_get_base(struct evconnlistener *lev);

这些函数返回侦听器的关联套接字和event_base 分别。

evconnlistener_get_fd（）函数首次出现在 Libevent 2.0.3-alpha 中。

检测错误

您可以设置一个错误回调，每当 accept（）调用时都会收到通知侦听器失败。如果您遇到错误，这可能很重要除非您解决该问题，否则该条件将锁定该进程。

接口

typedef void (*evconnlistener_errorcb)(struct evconnlistener *lis, void *ptr);
void evconnlistener_set_error_cb(struct evconnlistener *lev,
    evconnlistener_errorcb errorcb);

如果使用 evconnlistener_set_error_cb（）在侦听器，每次在听者。它将接收侦听器作为其第一个参数，并且参数作为 ptr 传递给 evconnlistener_new（）作为其第二个参数。

此函数是在 Libevent 2.0.8-rc 中引入的。

示例代码：echo 服务器。

例

#include <event2/listener.h>
#include <event2/bufferevent.h>
#include <event2/buffer.h>

#include <arpa/inet.h>

#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>

static void
echo_read_cb(struct bufferevent *bev, void *ctx)
{
        /* This callback is invoked when there is data to read on bev. */
        struct evbuffer *input = bufferevent_get_input(bev);
        struct evbuffer *output = bufferevent_get_output(bev);

        /* Copy all the data from the input buffer to the output buffer. */
        evbuffer_add_buffer(output, input);
}

static void
echo_event_cb(struct bufferevent *bev, short events, void *ctx)
{
        if (events & BEV_EVENT_ERROR)
                perror("Error from bufferevent");
        if (events & (BEV_EVENT_EOF | BEV_EVENT_ERROR)) {
                bufferevent_free(bev);
        }
}

static void
accept_conn_cb(struct evconnlistener *listener,
    evutil_socket_t fd, struct sockaddr *address, int socklen,
    void *ctx)
{
        /* We got a new connection! Set up a bufferevent for it. */
        struct event_base *base = evconnlistener_get_base(listener);
        struct bufferevent *bev = bufferevent_socket_new(
                base, fd, BEV_OPT_CLOSE_ON_FREE);

        bufferevent_setcb(bev, echo_read_cb, NULL, echo_event_cb, NULL);

        bufferevent_enable(bev, EV_READ|EV_WRITE);
}

static void
accept_error_cb(struct evconnlistener *listener, void *ctx)
{
        struct event_base *base = evconnlistener_get_base(listener);
        int err = EVUTIL_SOCKET_ERROR();
        fprintf(stderr, "Got an error %d (%s) on the listener. "
                "Shutting down.\n", err, evutil_socket_error_to_string(err));

        event_base_loopexit(base, NULL);
}

int
main(int argc, char **argv)
{
        struct event_base *base;
        struct evconnlistener *listener;
        struct sockaddr_in sin;

        int port = 9876;

        if (argc > 1) {
                port = atoi(argv[1]);
        }
        if (port<=0 || port>65535) {
                puts("Invalid port");
                return 1;
        }

        base = event_base_new();
        if (!base) {
                puts("Couldn't open event base");
                return 1;
        }

        /* Clear the sockaddr before using it, in case there are extra
         * platform-specific fields that can mess us up. */
        memset(&sin, 0, sizeof(sin));
        /* This is an INET address */
        sin.sin_family = AF_INET;
        /* Listen on 0.0.0.0 */
        sin.sin_addr.s_addr = htonl(0);
        /* Listen on the given port. */
        sin.sin_port = htons(port);

        listener = evconnlistener_new_bind(base, accept_conn_cb, NULL,
            LEV_OPT_CLOSE_ON_FREE|LEV_OPT_REUSEABLE, -1,
            (struct sockaddr*)&sin, sizeof(sin));
        if (!listener) {
                perror("Couldn't create listener");
                return 1;
        }
        evconnlistener_set_error_cb(listener, accept_error_cb);

        event_base_dispatch(base);
        return 0;
}

原文档地址：https://libevent.org/libevent-book/Ref8_listener.html

posted @ 2024-06-26 14:25 Philosophy 阅读(109) 评论(0) 编辑收藏举报

刷新页面返回顶部

Loading

Philosophy