Epollout详解

一、Epollout简介

Epoll是Linux内核提供的一种IO复用机制，它可以监视多描述符I/O事件，使用一个文件描述符，可以同时检查多个描述符是否有事件发生。epoll在处理大量Socket连接上有相当的优势。而epollout是epoll中的一种事件类型，可以用于监控Socket的可写事件。当一个Socket的可写事件被触发时，epollout会在该Socket不再是不可写状态时通知应用程序。

在epoll的API中，我们可以通过epoll_ctl函数注册fd的事件，而EPOLLOUT就是其中之一，例如：

#include <sys/epoll.h>
struct epoll_event event = {0};
event.data.fd = sockfd;
event.events = EPOLLOUT | EPOLLET; // 注册可写事件
epoll_ctl(epfd, EPOLL_CTL_ADD, sockfd, &event);

二、如何使用Epollout

当Socket的可写事件被触发时，我们可以调用send函数发送数据。由于Socket的缓冲区是有限的，如果一次性发送大量数据，可能会导致Socket的缓冲区满了，send函数会返回一个EAGAIN或EWOULDBLOCK错误，表示缓冲区已满，需要等待Socket变得可写。

如何处理这个错误？我们可以在epollout事件被触发时，将待发送的数据存放到一个缓冲区中，每次调用epoll_wait检查是否有可写事件时，再根据Socket缓冲区的可用空间大小，从缓冲区中取出一定数量的数据发送，直到全部发送完毕。

char buf[MAX_BUF_SIZE];
int total_len = strlen(msg);
int sent_len = 0;
while (sent_len < total_len) {
    int left_len = total_len - sent_len;
    int data_len = MIN(left_len, MAX_BUF_SIZE);
    memcpy(buf, msg + sent_len, data_len);
    int ret = send(sockfd, buf, data_len, 0);
    if (ret <= 0) {
        if (errno == EAGAIN || errno == EWOULDBLOCK) {
            // 等待下一轮EPOLLOUT事件
            break;
        }
        else {
            // 发送失败
            return -1;
        }
    }
    sent_len += ret;
}
if (sent_len == total_len) {
    // 发送成功
    return 0;
}
else {
    // 等待下一轮EPOLLOUT事件
    return 1;
}

三、Epollout的注意事项

在使用epollout时，需要注意以下事项：

• EPOLLOUT事件只通知Socket可写，但并不保证发送数据成功，还需要调用send函数检查返回值。
• 如果Socket的缓冲区已满，为避免CPU过高占用，可以在epollout事件被触发时，等待一定时间再次检查Socket是否可写。
• 在使用EPOLLOUT事件时，需要将Socket设置为非阻塞模式。

四、完整的代码示例

以下是一个基于epollout的Socket服务器的完整代码示例：

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <sys/epoll.h>

#define PORT 8888
#define MAX_EVENTS 1024
#define MAX_BUF_SIZE 1024
#define MIN(a, b) ((a) < (b) ? (a) : (b))

int setnonblocking(int sockfd) {
    int flag = fcntl(sockfd, F_GETFL, 0);
    if (flag == -1) {
        return -1;
    }
    flag |= O_NONBLOCK;
    if (fcntl(sockfd, F_SETFL, flag) == -1) {
        return -1;
    }
    return 0;
}

int main() {
    // 创建Socket
    int listen_fd = socket(AF_INET, SOCK_STREAM, 0);
    if (listen_fd == -1) {
        perror("socket");
        exit(EXIT_FAILURE);
    }

    // 设置Socket为非阻塞模式
    if (setnonblocking(listen_fd) == -1) {
        perror("setnonblocking");
        exit(EXIT_FAILURE);
    }

    // 绑定端口
    struct sockaddr_in addr;
    addr.sin_family = AF_INET;
    addr.sin_port = htons(PORT);
    addr.sin_addr.s_addr = INADDR_ANY;
    if (bind(listen_fd, (struct sockaddr *)&addr, sizeof(addr)) == -1) {
        perror("bind");
        exit(EXIT_FAILURE);
    }

    // 监听端口
    if (listen(listen_fd, SOMAXCONN) == -1) {
        perror("listen");
        exit(EXIT_FAILURE);
    }

    // 创建epoll句柄
    int epoll_fd = epoll_create1(0);
    if (epoll_fd == -1) {
        perror("epoll_create1");
        exit(EXIT_FAILURE);
    }

    // 将监听Socket的可读事件注册到epoll中
    struct epoll_event event = {0};
    event.data.fd = listen_fd;
    event.events = EPOLLIN | EPOLLET;
    if (epoll_ctl(epoll_fd, EPOLL_CTL_ADD, listen_fd, &event) == -1) {
        perror("epoll_ctl");
        exit(EXIT_FAILURE);
    }

    // 主循环
    struct epoll_event events[MAX_EVENTS];
    char buf[MAX_BUF_SIZE];
    while (1) {
        // 等待事件
        int nevents = epoll_wait(epoll_fd, events, MAX_EVENTS, -1);
        if (nevents == -1) {
            perror("epoll_wait");
            exit(EXIT_FAILURE);
        }

        // 处理事件
        for (int i = 0; i < nevents; ++i) {
            int fd = events[i].data.fd;
            if (fd == listen_fd) {
                // 处理新连接
                while (1) {
                    struct sockaddr_in client_addr;
                    socklen_t client_addr_len = sizeof(client_addr);
                    int client_fd = accept(listen_fd, (struct sockaddr *)&client_addr, &client_addr_len);
                    if (client_fd == -1) {
                        if (errno == EAGAIN || errno == EWOULDBLOCK) {
                            // 已处理完全部连接
                            break;
                        }
                        else {
                            perror("accept");
                            break;
                        }
                    }
                    else {
                        printf("New client connected: %s:%d\n", inet_ntoa(client_addr.sin_addr), client_addr.sin_port);

                        // 设置连接Socket为非阻塞模式
                        if (setnonblocking(client_fd) == -1) {
                            perror("setnonblocking");
                            break;
                        }

                        // 将连接Socket的可写事件也注册到epoll中
                        event.data.fd = client_fd;
                        event.events = EPOLLOUT | EPOLLET;
                        if (epoll_ctl(epoll_fd, EPOLL_CTL_ADD, client_fd, &event) == -1) {
                            perror("epoll_ctl");
                            break;
                        }
                    }
                }
            }
            else {
                // 处理已连接Socket的可写事件
                int total_len = strlen(msg);
                int sent_len = 0;
                while (sent_len < total_len) {
                    int left_len = total_len - sent_len;
                    int data_len = MIN(left_len, MAX_BUF_SIZE);
                    memcpy(buf, msg + sent_len, data_len);
                    int ret = send(sockfd, buf, data_len, 0);
                    if (ret <= 0) {
                        if (errno == EAGAIN || errno == EWOULDBLOCK) {
                            // 设置EPOLLOUT事件
                            event.data.fd = fd;
                            event.events = EPOLLOUT | EPOLLET;
                            if (epoll_ctl(epoll_fd, EPOLL_CTL_MOD, fd, &event) == -1) {
                                perror("epoll_ctl");
                                break;
                            }
                            break;
                        }
                        else {
                            perror("send");
                            break;
                        }
                    }
                    sent_len += ret;
                }
                if (sent_len == total_len) {
                    printf("Send successfully\n");
                    close(fd);
                }
            }
        }
    }

    return 0;
}