Linux服务器实例程序———使用定时器列表处理非活动连接
1、程序特点
这个服务器程序每隔5秒就收到一个SIGALRM信号，我们给该信号注册的处理函数是向一个管道的输入端写入信号的编号，而主函数中会使用epoll监听该管道读端的可读事件，发现是SIGALRM信号后，会触发对定时器链表的检查，程序会检查该链表上每个 socket 连接的定时器，检查是否超时，如果超时，说明这个客户端不会活动了，断开其连接，如果未超时，不做任何动作。
整体看逻辑还是很简单的，但是有很多细节的地方要注意。定时器链表的建立，注册信号处理函数等。
2、代码
timer_lst.h头文件
/* 本头文件实现了一个升序定时器链表 */
#ifndef LST_TIMER
#define LST_TIMER
#include<time.h>
#define BUFFER_SIZE 64
class util_timer; /* 前向声明 */
/* 用户数据结构体：客户端 socket 地址，socket 文件描述符，读缓存和定时器 */
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* tmp = head;
while (tmp)
{
head = tmp->next;
delete tmp;
tmp = head;
}
}
/* 将目标定时器 timer 添加到链表当中 */
void add_timer(util_timer* timer)
{
if (!timer)
{
return ;
}
if (!head)
{
head = tail = timer;
return;
}
/* 如果目标定时器的超时时间小于当前链表中所有定时器的超时时间，则把该定时器插入链表头部，作为链表新的头节点。
* 否则就需要调用重载函数 add_timer(util_timer* timer, util_timer* lst_head)，把他插入链表中合适的位置，以保证链表的升序特性 */
if (timer->expire < head->expire)
{
timer->next = head;
head->prev = timer;
head = timer;
return;
}
add_timer(timer, head);
}
/* 当某个定时任务发生变化时，调整对应的定时器在链表中的位置。这个函数只考虑被调整的定时器的超时时间延长的情况，即该定时器需要往链表的尾部移动 */
void adjust_timer(util_timer* timer)
{
if (!timer)
{
return;
}util_timer* tmp = timer->next;
/* 如果被调整的目标定时器出在链表尾部，或者该定时器新的超时值仍然小于下一个定时器的超时值，则不用调整 */
if (!tmp || (timer->expire < tmp->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, timer->next);
}
}
/* 将目标定时器 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 = timer->next;
head->prev = NULL;
delete timer;
return;
}
/* 若链表中至少有两个定时器，且目标定时器是链表的结尾节点 */
if (timer == tail)
{
tail = tail->prev;
tail->next = NULL;
delete timer;
return;
}
/* 若目标定时器位于链表中间 */
timer->prev->next = timer->next;
timer->next->prev = timer->prev;
return;
}
/* SIGALRM 信号每次被触发就在其信号处理函数（如果使用统一事件源，则是主函数）中执行一次 tick 函数，以处理到时任务 */
void tick()
{
if (!head)
{
return;
}
printf("timer tick\n");
timer_t cur = time(NULL); /* 获取系统当前时间 */
util_timer* tmp = head;
/* 从头节点开始依次处理每个定时器，直到遇到一个尚未到期的定时器，这就是定时器的核心逻辑 */
while (tmp)
{
/* 因为每个定时器都使用绝对时间作为超时值，所以把定时器的超时值和系统当前时间比较以判断定时器是否到期 */
if (cur < tmp->expire)
{
break;
}
/* 调用定时器的回调函数，以执行定时任务 */
tmp->cb_func(tmp->user_data);
/* 执行完定时器中的定时任务后，就将他从链表中删除，并重置链表头节点 */
head = tmp->next;
if (head)
{
head->prev = NULL;
}
delete tmp;
tmp = head;
}
}
private:
/* 一个重载的辅助函数，他被共有的 add_timer 函数和 adjust_timer 函数调用。该函数表示将目标定时器 timer 添加到节点 lst_head 之后的部分链表中 */
void add_timer(util_timer* timer, util_timer* lst_head)
{
util_timer* prev = lst_head;
util_timer* tmp = prev->next;
/* 遍历 lst_head 节点之后的部分链表，直到找到一个超时时间大于目标定时器的超时时间的节点，并将目标定时器插入该节点之前 */
while (tmp)
{
if (timer->expire < tmp->expire)
{
prev->next = timer;
timer->next = tmp;
tmp->prev = timer;
timer->prev = prev;
break;
}
prev = tmp;
tmp = tmp->next;
}
/* 如果便利完 lst_head 节点之后的部分链表，仍未找到超时时间大于目标定时器的超时时间的节点，则将其插入链表尾部，并设置为链表新的尾节点 */
if (!tmp)
{
prev->next = timer;
timer->prev = prev;
timer->next = NULL;
tail = timer;
}
}
private:
util_timer* head;
util_timer* tail;
};
#endif
nonactive_conn.c源文件
/* 这是一个服务器程序，这个服务器能够自动处理非活动的客户端连接 */
#include<sys/socket.h>
#include<sys/types.h>
#include<arpa/inet.h>
#include<netinet/in.h>
#include<assert.h>
#include<unistd.h>
#include<signal.h>
#include<stdio.h>
#include<string.h>
#include<stdlib.h>
#include<errno.h>
#include<pthread.h>
#include<sys/epoll.h>
#include<fcntl.h>
#include"lst_timer.h"
#define FD_LIMIT 65535
#define MAX_EVENT_NUMBER 1024
#define TIMESLOT 5
static int pipefd[2];
/* 使用升序链表管理定时器 */
static sort_timer_lst timer_lst;
static int epollfd = 0;
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 fd;
}
void addfd(int epollfd, int fd)
{
epoll_event event;
event.events = EPOLLIN | EPOLLET;
event.data.fd = fd;
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;
sa.sa_flags |= SA_RESTART;
sigfillset(&sa.sa_mask);
assert(sigaction(sig, &sa, NULL) != -1);
}
void timer_handler()
{
/* 定时处理任务，实际上就是调用 tick 函数 */
timer_lst.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)
{
return 1;
}
const char* ip = argv[1];
int port = atoi(argv[2]);
struct sockaddr_in address;
bzero(&address, sizeof(address));
address.sin_family = AF_INET;
address.sin_port = htons(port);
inet_pton(AF_INET, ip, &address.sin_addr);
int listenfd = socket(PF_INET, SOCK_STREAM, 0);
assert(listenfd >= 0);
int ret = bind(listenfd, (struct sockaddr*)&address, sizeof(address));
assert(ret != -1);
ret = listen(listenfd, 5);
assert(ret != -1);
epoll_event event[MAX_EVENT_NUMBER];
int epollfd = epoll_create(10);
assert(epollfd != -1);
addfd(epollfd, listenfd);
ret = socketpair(PF_UNIX, SOCK_STREAM, 0, pipefd);
assert(ret != -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, event, MAX_EVENT_NUMBER, -1);
if (number < 0 && errno != EINTR)
{
printf("epoll failure\n");
break;
}
for (int i = 0; i < number; i++)
{
int sockfd = event[i].data.fd;
if (sockfd == listenfd) /* 处理新到的客户端连接 */
{
struct sockaddr_in client_address;
socklen_t client_addrlength = sizeof(client_address);
int connfd = accept(sockfd, (struct sockaddr*)&client_address, &client_addrlength);
addfd(epollfd, connfd);
users[connfd].address = client_address;
users[connfd].sockfd = connfd;
/* 创建定时器，设置其回调函数与超时时间，然后绑定定时器与用户数据，最后将定时器添加到链表 timer_lst 中 */
util_timer* timer = new util_timer;
timer->user_data = &users[connfd];
timer->cb_func = cb_func;
time_t cur = time(NULL);
timer->expire = cur + 3 * TIMESLOT;
users[connfd].timer = timer;
timer_lst.add_timer(timer);
}
else if (sockfd == pipefd[0] && (event[i].events & EPOLLIN)) /* 处理信号 */
{
int sig;
char signals[1024];
ret = recv(pipefd[0], signals, sizeof(signals), 0);
if (ret == -1)
{
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 (event[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", ret, users[sockfd].buf, sockfd);
util_timer* timer = users[sockfd].timer;
if (ret < 0) /* 如果发生度错误，则关闭连接，并移除其对应的定时器 */
{
if (errno != EAGAIN)
{
cb_func(&users[sockfd]);
if (timer)
{
timer_lst.del_timer(timer);
}
}
}
else if (ret == 0) /* 如果对方已经关闭连接，则我们也关闭连接，并移除对应的定时器 */
{
cb_func(&users[sockfd]);
if (timer)
{
timer_lst.del_timer(timer);
}
}
else /* 若从客户端读到了数据，则需要调整该连接对应的定时器，以延迟该连接被关闭的时间 */
{
if (timer)
{
time_t cur = time(NULL);
timer->expire = cur + 3 * TIMESLOT;
printf("adjust timer once\n");
timer_lst.adjust_timer(timer);
}
}
}
else
{
// others
}
}
if (timeout) /* 最后处理定时事件，因为 I/O 事件有更高的优先级。当然喽，这样做将导致定时任务不能精确的按照预期的时间执行 */
{
timer_handler();
timeout = false;
}
}
close(listenfd);
close(pipefd[0]);
close(pipefd[1]);
delete [] users;
return 0;
}