从网上找到的聊天室代码看epoll相关的API

最新推荐文章于 2023-08-18 13:17:46 发布

XDmonkey

最新推荐文章于 2023-08-18 13:17:46 发布

阅读量339

点赞数

分类专栏： C++ 操作系统/网络相关/计算机原理

本文链接：https://blog.csdn.net/ysayk/article/details/80010660

版权

C++ 同时被 2 个专栏收录

17 篇文章 1 订阅

订阅专栏

操作系统/网络相关/计算机原理

2 篇文章 0 订阅

订阅专栏

拿一个聊天室的demo来讲一下Socket网络编程中的epoll相关的api的使用

server端代码：

//server.cpp
#include <iostream>
#include <list>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/epoll.h>
#include <fcntl.h>
#include <errno.h>
#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

using namespace std;

//选用list存放sockfd
list<int> clients_list;

//server port
#define SERVER_PORT 8888

//epoll支持的最大并发量
#define EPOLL_SIZE 5000

//message buf size
#define BUF_SIZE 0xFFFF

#define SERVER_WELCOME "Welcome you join  to the chat room! Your chat ID is: Client #%d"

#define SERVER_MESSAGE "ClientID %d say >> %s"

// exit
#define EXIT "EXIT"

#define CAUTION "There is only one int the char room!"

int setnonblocking(int sockfd){
    fcntl(sockfd, F_SETFL, fcntl(sockfd, F_GETFD, 0) | O_NONBLOCK);
    return 0;
}

void addfd(int epollfd, int fd, bool enable_et){
    struct epoll_event ev;
    ev.data.fd = fd;
    ev.events = EPOLLIN;
    if(enable_et){
        ev.events = EPOLLIN | EPOLLET;
    }
    epoll_ctl(epollfd, EPOLL_CTL_ADD, fd, &ev);
    setnonblocking(fd);
}

int sendBroadcastmessage(int clientfd){
    char buf[BUF_SIZE], message[BUF_SIZE];
    //清零
    bzero(buf, BUF_SIZE);
    bzero(message, BUF_SIZE);

    printf("read from client(clientID = %d)\n", clientfd);
    int len = recv(clientfd, buf, BUF_SIZE, 0);
    //len=0 client关闭了连接
    if(len == 0){
        close(clientfd);
        clients_list.remove(clientfd);
        printf("ClientID = %d closed.\n now there are %d client in the char room\n", clientfd, (int)clients_list.size());
    }else{//进行广播
        if(clients_list.size() == 1){
            send(clientfd, CAUTION, strlen(CAUTION), 0);
            return len;
        }
        sprintf(message, SERVER_MESSAGE, clientfd, buf);

        list<int>::iterator iter;
        for(iter = clients_list.begin(); iter != clients_list.end(); iter++){
            if(*iter != clientfd){
                if(send(*iter, message, BUF_SIZE, 0) < 0){
                     perror("error"); 
                     exit(-1);
                }
            }
        }
    }
}

int main(int argc, char* argv[]){
	//服务器IP + port
    struct sockaddr_in serverAddr;
    serverAddr.sin_family = PF_INET;
    serverAddr.sin_port = htons(SERVER_PORT);
    serverAddr.sin_addr.s_addr = htonl (INADDR_ANY);

    //创建监听socket
    int listenfd = socket(PF_INET, SOCK_STREAM, 0);
    if(listenfd < 0){
    	perror("listenfd");
    	exit(-1);
    }
    printf("listen socket created");

    //绑定地址
    if( bind(listenfd, (struct sockaddr *)&serverAddr, sizeof(serverAddr)) < 0) {
        perror("bind error");
        exit(-1);
    }

    //监听
    int ret = listen(listenfd, 5);
    if(ret < 0) { 
        perror("listen error"); exit(-1);
    }

    //在内核中创建事件表
    int epfd = epoll_create(EPOLL_SIZE);
    if(epfd < 0){
        perror("epfd error");
        exit(-1);
    }
    printf("epoll created, epoll size = %d\n", epfd);

    static struct epoll_event events[EPOLL_SIZE];

    //往内核事件表里添加事件
    addfd(epfd, listenfd, true);

    //主循环
    while(1){
        int epoll_events_count = epoll_wait(epfd, events, EPOLL_SIZE, -1);
        if(epoll_events_count < 0){
            perror("epoll failure");
            break;
        }
        printf("epoll event counts = %d\n", epoll_events_count);

        for(int i = 0; i < epoll_events_count; i++){
            int sockfd = events[i].data.fd;
            if(sockfd == listenfd){
                struct sockaddr_in client_address;
                socklen_t client_addrLength = sizeof(struct sockaddr_in);
                int clientfd = accept(listenfd, (struct sockaddr*)&client_address, &client_addrLength);
                printf("client connection from: %s : % d(IP : port), clientfd = %d \n", inet_ntoa(client_address.sin_addr),
                ntohs(client_address.sin_port),
                clientfd);

                addfd(epfd, clientfd, true);

                //服务端用list保存用户连接
                clients_list.push_back(clientfd);
                printf("Add new clientfd = %d to epoll\n", clientfd);
                printf("Now there are %d clients int the chat room\n", (int)clients_list.size());

                //服务端发送欢迎消息
                char message[BUF_SIZE];
                bzero(message, BUF_SIZE);
                sprintf(message, SERVER_WELCOME, clientfd);
                int ret = send(clientfd, message, BUF_SIZE, 0);
                if(ret < 0){
                    perror("error");
                    exit(-1);
                }
            }
            else{
                int ret = sendBroadcastmessage(sockfd);
                if(ret < 0){
                    perror("error");
                    exit(-1);
                }
            }
        }
    }

    close(listenfd); //关闭socket
    close(epfd);    //关闭内核
    return 0;
}

Client端代码：

//client.cpp
#include <iostream>
#include <list>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/epoll.h>
#include <fcntl.h>
#include <errno.h>
#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

using namespace std;

// server port
#define SERVER_PORT 8888

//epoll 支持的最大并发量
#define EPOLL_SIZE 5000

//message buffer size
#define BUF_SIZE 0xFFFF

// exit
#define EXIT "EXIT"

//设置sockfd，pipefd非阻塞
int setnonblocking(int sockfd){
	fcntl(sockfd, F_SETFL, fcntl(sockfd, F_GETFD, 0) | O_NONBLOCK);
	return 0;
}

int addfd(int epollfd, int fd, bool enable_et){
	struct epoll_event ev;
	ev.data.fd = fd;
	ev.events = EPOLLIN; //输入出发epoll-event
	if(enable_et){
		ev.events = EPOLLIN | EPOLLET;
	}
	epoll_ctl(epollfd, EPOLL_CTL_ADD, fd, &ev);
	setnonblocking(fd);
}

int main(int argc, char* argv[]){
	//用户连接的服务器IP、端口
	struct sockaddr_in serverAddr;
	serverAddr.sin_family = PF_INET;
	serverAddr.sin_port = htons(SERVER_PORT);
	const char* servInetAddr = "127.0.0.1";
	inet_pton(AF_INET, servInetAddr, &serverAddr.sin_addr);

	//创建socket
	int sock = socket(PF_INET, SOCK_STREAM, 0);
	if(sock < 0){
		perror("sock error");
		exit(-1);
	}

	// 连接服务端
	if(connect(sock, (struct sockaddr*)&serverAddr, sizeof(serverAddr)) < 0){
		perror("connect error");
		exit(-1);
	}

	//创建管道，其中fd[0]用于父进程读，fd[1]用于子进程写
	int pipe_fd[2];
	if(pipe(pipe_fd) < 0){
		perror("pipe error");
		exit(-1);
	}

	// 1 创建epoll
	int epfd = epoll_create(EPOLL_SIZE);
	if(epfd < 0) { perror("epfd error"); exit(-1); }
	static struct epoll_event events[2];
	//将sock和管道读端都加到内核事件表中
	addfd(epfd, sock, true);
	addfd(epfd, pipe_fd[0], true);

	// 表示客户端是否正常工作
    bool isClientwork = true;

    // 聊天信息缓冲区
    char message[BUF_SIZE];


   	//Fork
   	int pid = fork();
   	if(pid < 0) { perror("fork error"); exit(-1); }
   	else if(pid == 0){  //子进程
   		//子进程负责写入管道，因此先关闭读端
   		close(pipe_fd[0]);
   		printf("Please input 'exit' to exit the chat room\n");

   		while(isClientwork){
   			bzero(&message, BUF_SIZE);
   			fgets(message, BUF_SIZE, stdin);

   			//客户端输出exit，退出
   			if(strncasecmp(message, EXIT, strlen(EXIT)) == 0){
   				isClientwork = 0;
   			}else{
   				//子进程将信息写入管道
   				if(write(pipe_fd[1], message, strlen(message) - 1) < 0){
   					{ perror("fork error"); exit(-1); }
   				}
   			} 
   		}
   	}else{		//pid > 0 父进程
   		//父进程负责读管道数据，因此先关闭写端
   		close(pipe_fd[1]);

  		while(isClientwork){
  			int epoll_events_count = epoll_wait(epfd, events, 2, -1);
   		//处理就绪事件
   		for(int i = 0; i < epoll_events_count; i++){
   			bzero(&message, BUF_SIZE);
   			//服务端发来消息
   			if(events[i].data.fd == sock){
   				//接受服务端消息
   				int ret = recv(sock, message, BUF_SIZE, 0);

   				//ret = 0  服务端关闭
   				if(ret == 0){
   					printf("Server closed connection: %d\n", sock);
                    close(sock);
                    isClientwork = 0;
   				}else{
   					printf("%s\n", message);
   				}
   			}else{
   				//子进程写入事件发生，父进程处理并发送数据
   				int ret = read(events[i].data.fd, message, BUF_SIZE);
   				if(ret = 0){
   					isClientwork = 0;
   				}else{
   					send(sock, message, BUF_SIZE, 0);
   				}
   			}
   		}
  		}
   		
   	}

   	if(pid){
   		close(pipe_fd[1]);
   		close(sock);
   	}else{
   		close(pipe_fd[0]);
   	}

   	return 0;
}

代码写得十分精炼，一般来说TCP服务端通信的常规步骤是：

使用socket()创建TCP套接字（socket）
将创建的套接字绑定到一个本地地址和端口上（bind）
将套接字设置成监听模式，准备接受客户端请求（listen）
等待客户端请求到来：当请求到来后，接受连接请求，返回一个对应此次连接的新的套接字（accept）
用accept返回的套接字和客户端进行通信（这里使用send()和recv()）
返回，等待又一个客户请求
关闭套接字
下面简单说一下这里使用epoll的相关API：

int epoll_create(int size);

参数size：用来告诉内核要监听的数目一共有多少个。
返回值：成功时，返回一个非负整数的文件描述符，作为创建好的epoll句柄。调用失败时，返回-1，错误信息可以通过errno获得。

int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);

参数epfd：epoll_create()函数返回的epoll句柄。
参数op：操作选项，OP可选的值有三个：EPOLL_CTL_ADD（注册新的fd到epfd上）、EPOLL_CTL_MOD（修改已经注册的fd的监听事件）、EPOLL_CTL_DEL（从epfd中删除一个fd）。
参数fd：要进行操作的目标文件描述符。
参数event：struct epoll_event结构指针，将fd和要进行的操作关联起来。
返回值：成功时，返回0，作为创建好的epoll句柄。调用失败时，返回-1，错误信息可以通过errno获得。
说明：epoll的事件注册函数，它不同与select()是在监听事件时告诉内核要监听什么类型的事件，而是在这里先注册要监听的事件类型。

另外，epoll_event的结构如下：

typedef union epoll_data {  
   void *ptr;  
   int fd;  
   __uint32_t u32;  
   __uint64_t u64;  
} epoll_data_t;  
  
struct epoll_event {  
   __uint32_t events; /* Epoll events */  
   epoll_data_t data; /* User data variable */  
};

events可以是以下几个宏的集合：

EPOLLIN ：表示对应的文件描述符可以读（包括对端SOCKET正常关闭）；
EPOLLOUT：表示对应的文件描述符可以写；
EPOLLPRI：表示对应的文件描述符有紧急的数据可读（这里应该表示有带外数据到来）；
EPOLLERR：表示对应的文件描述符发生错误；
EPOLLHUP：表示对应的文件描述符被挂断；
EPOLLET：将EPOLL设为边缘触发(Edge Triggered)模式，这是相对于水平触发(Level Triggered)来说的。
EPOLLONESHOT：只监听一次事件，当监听完这次事件之后，如果还需要继续监听这个socket的话，需要再次把这个socket加入到EPOLL队列里

int epoll_wait(int epfd, struct epoll_event * events, int maxevents, int timeout);

参数epfd：epoll_create()函数返回的epoll句柄。
参数events：struct epoll_event结构指针，用来从内核得到事件的集合。
参数 maxevents：告诉内核这个events有多大
参数 timeout: 等待时的超时时间，以毫秒为单位。
返回值：成功时，返回需要处理的事件数目。调用失败时，返回0，表示等待超时。