libevent之evconnlistener

Philosophy發表於2024-06-26

目錄
  • 連線偵聽器：接受 TCP 連線
    • 建立或釋放 evconnlistener
      • 識別的標誌
      • 連線偵聽器回撥
    • 啟用和禁用 evconnlistener
    • 調整 evconnlistener 的回撥
    • 檢查 evconnlistener
    • 檢測錯誤
    • 示例程式碼：echo 伺服器。

連線偵聽器：接受 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

相關文章