定时器处理非活动连接

服务器编程中使用定时器处理非活动连接

主要结构：
client_data结构体：记录客户端链接信息，以及每个客户端连接时的时间参数，主要记录超时时间等
util_timer类：记录timer里的一些数据，如回调函数，超时时间以及文件描述符等
sort_timer_lst类：有序链表，记录timer位置，按照超时时间（记录的绝对时间）从小到大，这样在处理的时候，只要遇到不超时的就可以结束循环，不用全部遍历。

执行流程：
首先是直接使用alarm(5);在5秒钟之后触发SIGALRM信号

该信号会调用与其绑定的信号处理函数sig_handle()

sig_handle()函数会将信号类型写入pipefd[1]，另一端在epoll树上被监听

监听到该信号的主循环判断sig类型，若为SIGALRM，则执行timer_handle()函数

timer_handle()：先调用sort_timer_lst::tick()函数，遍历有序链表，将超时的timer找出来，并执行他们的回调函数cb_func()传输参数为当前user_data因为user_data中保存着链接的文件描述符，cb_func()函数将此文件描述符下树，不再监听，并close掉

之后定时五秒触发一次SIGALRM信号，之后有被监听不断循环。

代码如下：

#ifndef LST_TIMER
#define LST_TIMER

#include<time.h>

#define BUFFER_SIZE 64

class util_timer;//向前声明

struct client_data
{
    sockaddr_in address;
    int sockfd;
    char buf[BUFFER_SIZE];
    util_timer * timer;

};

//定时器类
class util_timer
{
public:
    util_timer():prev(NULL),next(NULL){}

public:
    time_t expire;//任务的超时时间，这里使用绝对时间
    void (*cb_func)(client_data*);//任务回调函数，回调函数处理的客户数据，由定时器的执行者传递给回调函数
    client_data * user_data;
    util_timer* prev;//指向前一个定时器
    util_timer* next;//指向后一个定时器    

};

//定时器链表。他是一个升序、双向链表，且带有头节点和尾节点
class sort_timer_lst
{
public:
    sort_timer_lst():head(NULL),tail(NULL) {}
    //链表被销毁时，删除其中所有节点
    ~sort_timer_lst()
    {
        util_timer* temp = head;
        while(temp)
        {
            head = head->next;
            delete temp;
            temp = head;
        }
    }

    void add_timer(util_timer * timer)
    {
        if(!timer)
        {
            return;
        }
        if(!head)
        {
            head = tail = timer;
            return;
        }
        //为了链表的有序性；我们根据目标定时器的超过时间来排序，（按照超时时间从小到大排序）如果超时时间小于head，成为head，负责根据顺序插入
        if(timer->expire < head->expire)
        {
            timer->next = head;
            head->prev = timer;
            head = timer;
            return ;
        }
        add_timer(timer,head);//将timer插入head中,这是一个重载函数，注意参数！
    }

    //当某一个任务发生变换时，应该调整对应的定时器在链表中的位置。这个函数只考虑被调整的定时器的超过时间延长的情况，即该定时器需要往尾部移动
    void adjust_timer(util_timer * timer)
    {
        if(!timer)
        {
            return;
        }
        util_timer * temp = timer->next;
        //不用调整的情况：1.处于尾部。2.虽有变化，但不影响排位
        if(!temp || timer->expire < temp->expire)
        {
            return;
        }
        //如果为头部节点，最好的时间复杂度是取出来重新插入
        if(timer == head)
        {
            head = head->next;
            head-prev = NULL;
            timer->next = NULL;
            add_timer(timer,head);
        }
        else//不为头部，也可以取出来插入！
        {
            timer->prev->next = timer->next;
            timer->next->prev = timer->prev;
            add_timer(timer,head);

        }
    }

    //将目标定时器timer从链表中删除
    void del_timer(util_timer* timer)
    {
        if(!timer)
        {
            return;
        }
        //下面这个条件成立表示链表中只有一个定时器，即目标定时器
        if((timer == head) && (timer == tail))
        {
            delete timer;
            head = NULL;
            tail = NULL;
            return;
        }
        //如果链表中至少有两个定时器，且目标定时器是链表的头结点，则将链表的头结点重置为源节点的下一个节点
        if(timer == head)
        {
            head = head->next;
            head->perv = NULL;
            delete timer;
            return;
        }
        //如果链表中至少有两个定时器，且目标节点是链表的尾节点
        if(timer == tail)
        {
            tail = tail->perv;
            tail->next = NULL;
            delete timer;
            return;
        }
        //如果链表至少有三个定时器，并且目标节点是在链表的中间位置
        else
        {
            timer->prev->next = timer->next;
            timer->next->prev = timer->prev;
            delete timer;
            return;
        }
        
    }

    //SIGALRM信号每次被触发就在其信号处理函数（如果使用统一事件源，那就是主函数）中执行一次tick函数，已处理链表上到期的任务
    void tick()
    {
        if(!head)
        {
            return;
        }
        printf("timer tick !\n");
        timer_t cur = time(NULL);//获取系统当前时间
        util_timer* temp = head;
        //从头节点开始一次处理每一个定时器，直到遇到一个尚未到期的定时器，这就是定时器的核心逻辑
        //说白了就是遍历
        while(temp)
        {
            //因为每个定时器都是用绝对时间作为超时值，所以我们可以吧定时器的超时值和系统当前时间，比较一判断定时器是否到期
            if(cur < temp->expire)
            {
                break;
            }
            //调用定时器的回调函数，已执行定时任务
            temp->cb_func(temp->user_data);
            //执行完定时任务以后，就将它从链表中删除，并且重置链表头节点
            head = temp->next;
            //链表操作的时候一定一定要注意！先检查是否为空
            if(head)
            {
                head->perv = NULL;
            }
            delete temp;
            temp = head;
        }

    }

private:
    //一个重载的辅助函数
    void add_timer(util_timer* timer, util_timer* lst_head)
    {
        util_timer* prev = lst_head;
        util_timer* temp = prev->next;
        //遍历head之后的所有节点，知道找到一个节点的值大于timer的位置插入
        while (temp)
        {
            if(timer->expire < temp->expire)
            {
                prev->next = timer;
                timer->next = temp;
                temp->prev = timer;
                timer->prev = prev;
                break;
            }
            prev = temp;
            temp = temp->next;
        }
        //如果遍历完还没有找到，就直接插到尾节点
        if(!temp)
        {
            prev->next = timer;
            timer->prev = prev;
            timer->next = NULL;
            tail = timer;
        }
        
    }

private:
    util_timer* head;
    util_timer* tail;

};



#endif

//处理非活动链接

#include"lst_time.h"

#define FD_LIMIT 65535
#define MAX_EVENT_NUMBER 1024
#define TIMESLOT 5

static int pipefd[2];
//利用lst_time.h中的升序链表来管理定时器
static sort_timer_lst timer_list;
static int epollfd = 0;

//设置非阻塞IO
int setnonblocking(int fd)
{
    int old_option = fcntl(fd, F_GETFL);
    int new_option = old_option | O_NONBLOCK;
    fcntl(fd, F_SETFL, new_option);
    return old_option;
}

//添加需要监听的文件描述符到树上
//并且设置非阻塞IO和ET触发模式
void addfd(int int epollfd, int fd)
{
    epoll_event event;
    event.data.fd = fd;
    event.events = EPOLLIN | EPOLLET;
    epoll_ctl(epollfd, EPOLL_CTL_ADD, fd, &event);
    setnonblocking(fd);

}


//信号处理函数
void sig_handler(int sig)
{
    int save_errno = errno;
    int msg = sig;
    send(pipefd[1], (char*)&msg, 1, 0);
    errno = save_errno;
}


//把信号与信号处理函数绑定
void addsig(int sig)
{
    struct sigaction sa;
    memset(&sa,'\0',sizeof(sa));
    sa.sa_handler = sig_handler;
    //因为信号会中断当前系统调用，该flag表示会重新调用被信号终止的系统调用
    sa.sa_flags |= SA_RESTART;
    sigfillset(&sa.sa_mask);
    assert(sigaction(sig, &sa, NULL) != 0);

}

void timer_handler()
{
    //定时处理任务，实际上就是调用tick函数
    timer_list.tick();
    //因为一次alarm调用只会引起一次SIGALRM信号，所以我们要重新定时，以不断触发SIGALRM信号
    alarm(TIMESLOT);
}

//定时器回调函数，他删除非活动链接socket上的注册事件
void cb_func(client_data* user_data)
{
    epoll_ctl(epollfd, EPOLL_CTL_DEL, user_data->sockfd, 0);
    assert(user_data);
    close(user_data->sockfd);
    printf("close fd %d \n",user_data->sockfd);

}

int main(int argc, char* argv[])
{   
    if(argc <=  2)
    {
        printf("命令行参数太少！");
        return -1;
    }
    const char* ip = argv[1];
    int port = atoi(argc[2]);

    int ret = 0;
    struct sockaddr_in address;
    bzero(address,sizeof(address));
    address.sin_family = AF_INET;
    inet_pton(AF_INET, ip, &address.sin_addr);
    address.sin_port = htons(port);

    int listenfd = socket(AF_INET, SOCK_STREAM, 0);
    assert(listenfd >= 0);

    ret = bind(listenfd, (struct sockaddr*)&address, sizeof(address));
    assert(ret != -1);

    ret = listen(listenfd, 128);
    assert(ret != -1);

    epoll_event events[MAX_EVENT_NUMBER];
    int epollfd = epoll_create(5);
    assert(epollfd != -1);
    addfd(epollfd,listenfd);

    ret = socketpair(PF_UNIX, SOCK_STREAM, 0, pipefd);//创建一对sock套接字，分别为pipefd[2]
    assert(ert != -1);
    setnonblocking(pipefd[1]);
    addfd(epollfd, pipefd[0]);

    //设置信号处理函数
    addsig(SIGALRM);
    addsig(SIGTERM);
    bool stop_server = false;

    client_data* users = new client_data[FD_LIMIT];
    bool timeout = false;
    alarm(TIMESLOT);

    while(!stop_server)
    {
        int number = epoll_wait(epollfd, events, MAX_EVENT_NUMBER, -1);
        if((number < 0) && (errno != EINTR))//不是被信号中断的错误
        {
            printf("epoll wait failure!\n");
            break;
        } 
        for(int i = 0; i < number; ++i)
        {
            int sockfd = events[i].data.fd;
            if( i == listenfd)
            {
                struct sockaddr_in client_address;
                socklen_t client_addrlength = sizeof(client_address);
                int connfd = accept(listenfd, (struct sockaddr*)&client_address, client_addrlength);
                addfd(epollfd, connfd);
                users[connfd].address = client_address;
                users[connfd].sockfd = connfd;


                //创建定时器，设置其回调函数与超时时间，然后绑定定时器与用户数据，最后将定时器添加到链表timer_list中
                util_timer * timer = new util_timer;
                timer->user_data = &users[connfd];
                timer->cb_func = cb_func;
                time_t cur = time(NULL);
                timer->expire = cur + 5*TIMESLOT;//超时时间为15s，15无连接则关闭链接
                users[connfd].timer = timer;
                timer_list.add_timer(timer);
            }
            //处理信号,因为之前定义了send(pipefd[1], (char*)&msg, 1, 0);一旦触发信号，pipefd中就会有数据，就可以读
            else if((sockfd == pipefd[0]) && (events[i].events & EPOLLIN))
            {
                int sig;
                char signals[1024];
                ret = recv(pipefd[0], signal, sizeof(signals), 0);
                if(-1 == ret)
                {
                    //handle the error
                    continue;
                }
                else if(ret == 0)
                {
                    continue;
                }
                else 
                {
                    for(int i = 0; i < ret; ++i)
                    {
                        switch (signals[i])
                        {
                        case SIGALRM:
                        {
                            //用timeout变量标记有定时任务需要处理，但不立即处理定时任务，这是因为定时任务的优先级不是很高，我们优先处理其他更重要的任务
                            timeout = true;
                            break;
                        }
                            
                        
                        case SIGTERM:
                        {
                            stop_server = true;
                        }
                            
                        }
                    }
                }
            }
            else if(events[i].events & EPOLLIN)
            {
                memset(users[sockfd].buf, '\0', BUFFER_SIZE);
                ret = recv(sockfd, users[sockfd].buf, BUFFER_SIZE - 1, 0);
                printf("get %d bytes of client data %s from %d\n", ret, users[sockfd].buf, sockfd);
                util_timer* timer = users[sockfd].timer;
                if(ret < 0)
                {
                    //如果发生读错误，则关闭连接，移除对应的定时器
                    if(errno != EAGAIN)
                    {
                        cb_func(&users[sockfd]);
                        if(timer)
                        {
                            timer_list.del_timer(timer);
                        }
                    }
                }
                else if(ret == 0)
                {
                    //如果对方已经关闭链接，我们也关闭链接，并移除相应的定时器
                    cb_func(&users[sockfd]);
                    if(timer)
                    {
                        timer_list.del_timer(timer);
                    }
                }
                else
                {
                    //如果某一个客户端有数据可以读，则我们要调整该链接对应的定时器，已延迟该链接被关闭的时间
                    if(timer)
                    {
                        time_t cur = time(NULL);
                        timer->expire = cur + 5*TIMESLOT;
                        printf("adjust time!");
                        timer_list.adjust_timer(timer);
                    }
                }
                
                
            }
            if(timeout)
            {
                timer_handler();
                timeout = false;
            }
        }
    }
    close(pipefd[0]);
    close(pipefd[1]);
    close(listenfd);
    delete[] users;
    return 0;
}

参考《linux高性能服务器编程》-游双