epoll聊天室的实现

1.服务端

a. 支持多个用户接入，实现聊天室的基本功能

b. 使用epoll机制实现并发，增加效率

2. 客户端

a. 支持用户输入聊天消息

b. 显示其他用户输入的信息

c. 使用fork创建两个进程

子进程有两个功能：

等待用户输入聊天信息
将聊天信息写到管道（pipe），并发送给父进程

父进程有两个功能

使用epoll机制接受服务端发来的信息，并显示给用户，使用户看到其他用户的聊天信息
将子进程发给的聊天信息从管道（pipe）中读取, 并发送给服务端

C/S模型

服务端和客户端采用经典的C/S模型，并且使用TCP连接.

TCP服务端通信的常规步骤

(1)使用socket()创建TCP套接字（socket）

(2)将创建的套接字绑定到一个本地地址和端口上（Bind）

(3)将套接字设为监听模式，准备接收客户端请求（listen）

(4)等待客户请求到来: 当请求到来后，接受连接请求，返回一个对应于此次连接的新的套接字（accept）

(5)用accept返回的套接字和客户端进行通信（使用write()/send()或send()/recv() )

(6)返回，等待另一个客户请求

(7)关闭套接字

TCP客户端通信的常规步骤

(1)创建套接字（socket）

(2)使用connect()建立到达服务器的连接（connect)

(3)客户端进行通信（使用write()/send()或send()/recv())

(4)使用close()关闭客户连接

阻塞与非阻塞socket

通常的，对一个文件描述符指定的文件或设备, 有两种工作方式: 阻塞与非阻塞方式。

（1）. 阻塞方式是指： 当试图对该文件描述符进行读写时，如果当时没有数据可读，或者暂时不可写，程序就进入等待状态，直到有东西可读或者可写为止。

（2）. 非阻塞方式是指： 如果没有数据可读，或者不可写，读写函数马上返回，而不会等待。

阻塞方式和非阻塞方式唯一的区别： 是否立即返回。本项目采用更高效的做法，所以应该将socket设置为非阻塞方式。这样能充分利用服务器资源，效率得到了很大提高。

epoll

当服务端的在线人数越来越多，会导致系统资源吃紧，I/O效率越来越慢，这时候就应该考虑epoll了。epoll是Linux内核为处理大批句柄而作改进的poll，是Linux特有的I/O函数。其特点如下：

epoll是Linux下多路复用IO接口select/poll的增强版本。其实现和使用方式与select/poll有很多不同，epoll通过一组函数来完成有关任务，而不是一个函数。

epoll之所以高效，是因为epoll将用户关心的文件描述符放到内核里的一个事件表中，而不是像select/poll每次调用都需要重复传入文件描述符集或事件集。比如当一个事件发生（比如说读事件），epoll无须遍历整个被侦听的描述符集，只要遍历那些被内核IO事件异步唤醒而加入就绪队列的描述符集合就行了。

epoll有两种工作方式，LT(level triggered)：水平触发和ET(edge-triggered)：边沿触发。LT是select/poll使用的触发方式，比较低效；而ET是epoll的高速工作方式（本项目使用epoll的ET方式）。

epoll 共3个函数, 如下:

1、int epoll_create(int size)
创建一个epoll句柄，参数size用来告诉内核监听的数目，size为epoll所支持的最大句柄数

2、int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event)
函数功能： epoll事件注册函数
　 参数epfd为epoll的句柄，即epoll_create返回值
　 参数op表示动作，用3个宏来表示：
　　 EPOLL_CTL_ADD(注册新的fd到epfd)，
　EPOLL_CTL_MOD(修改已经注册的fd的监听事件)，
　　 EPOLL_CTL_DEL(从epfd删除一个fd)；
　　 其中参数fd为需要监听的标示符；
　 参数event告诉内核需要监听的事件，event的结构如下：
struct epoll_event {
__uint32_t events; //Epoll events
epoll_data_t data; //User data variable
};
其中介绍events是宏的集合，本项目主要使用EPOLLIN(表示对应的文件描述符可以读，即读事件发生)

3、 int epoll_wait(int epfd, struct epoll_event * events, int maxevents, int timeout)
等待事件的产生，函数返回需要处理的事件数目（该数目是就绪事件的数目，就是前面所说漂亮女孩的个数N）

因此服务端使用epoll的时候，步骤如下：

调用epoll_create函数在Linux内核中创建一个事件表；
然后将文件描述符（监听套接字listener）添加到所创建的事件表中；
在主循环中，调用epoll_wait等待返回就绪的文件描述符集合；
分别处理就绪的事件集合，本项目中一共有两类事件：新用户连接事件和用户发来消息事件

服务端实现

utility.h完整源码

#ifndef UTILITY_H_INCLUDED
#define UTILITY_H_INCLUDED
 
#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;
 
// clients_list save all the clients's socket
list<int> clients_list;
 
/**********************   macro defintion **************************/
// server ip
#define SERVER_IP "127.0.0.1"
 
// server port
#define SERVER_PORT 8888
 
//epoll size
#define EPOLL_SIZE 5000
 
//message buffer 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!"
 
/**********************   some function **************************/
/**
  * @param sockfd: socket descriptor
  * @return 0
**/
int setnonblocking(int sockfd)
{
    fcntl(sockfd, F_SETFL, fcntl(sockfd, F_GETFD, 0)| O_NONBLOCK);
    return 0;
}
 
/**
  * @param epollfd: epoll handle
  * @param fd: socket descriptor
  * @param enable_et : enable_et = true, epoll use ET; otherwise LT
**/
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);
    printf("fd added to epoll!

");
}
 
/**
  * @param clientfd: socket descriptor
  * @return : len
**/
int sendBroadcastmessage(int clientfd)
{
    // buf[BUF_SIZE] receive new chat message
    // message[BUF_SIZE] save format message
    char buf[BUF_SIZE], message[BUF_SIZE];
    bzero(buf, BUF_SIZE);
    bzero(message, BUF_SIZE);
 
    // receive message
    printf("read from client(clientID = %d)
", clientfd);
    int len = recv(clientfd, buf, BUF_SIZE, 0);
 
    if(len == 0)  // len = 0 means the client closed connection
    {
        close(clientfd);
        clients_list.remove(clientfd); //server remove the client
        printf("ClientID = %d closed.
 now there are %d client in the char room
", clientfd, (int)clients_list.size());
 
    }
    else  //broadcast message 
    {
        if(clients_list.size() == 1) { // this means There is only one int the char room
            send(clientfd, CAUTION, strlen(CAUTION), 0);
            return len;
        }
        // format message to broadcast
        sprintf(message, SERVER_MESSAGE, clientfd, buf);
 
        list<int>::iterator it;
        for(it = clients_list.begin(); it != clients_list.end(); ++it) {
           if(*it != clientfd){
                if( send(*it, message, BUF_SIZE, 0) < 0 ) { perror("error"); exit(-1);}
           }
        }
    }
    return len;
}
#endif // UTILITY_H_INCLUDED

服务端完整源码

#include "utility.h"
 
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 = inet_addr(SERVER_IP);
    //创建监听socket
    int listener = socket(PF_INET, SOCK_STREAM, 0);
    if(listener < 0) { perror("listener"); exit(-1);}
    printf("listen socket created 
");
    //绑定地址
    if( bind(listener, (struct sockaddr *)&serverAddr, sizeof(serverAddr)) < 0) {
        perror("bind error");
        exit(-1);
    }
    //监听
    int ret = listen(listener, 5);
    if(ret < 0) { perror("listen error"); exit(-1);}
    printf("Start to listen: %s
", SERVER_IP);
    //在内核中创建事件表
    int epfd = epoll_create(EPOLL_SIZE);
    if(epfd < 0) { perror("epfd error"); exit(-1);}
    printf("epoll created, epollfd = %d
", epfd);
    static struct epoll_event events[EPOLL_SIZE];
    //往内核事件表里添加事件
    addfd(epfd, listener, true);
    //主循环
    while(1)
    {
        //epoll_events_count表示就绪事件的数目
        int epoll_events_count = epoll_wait(epfd, events, EPOLL_SIZE, -1);
        if(epoll_events_count < 0) {
            perror("epoll failure");
            break;
        }
 
        printf("epoll_events_count = %d
", epoll_events_count);
        //处理这epoll_events_count个就绪事件
        for(int i = 0; i < epoll_events_count; ++i)
        {
            int sockfd = events[i].data.fd;
            //新用户连接
            if(sockfd == listener)
            {
                struct sockaddr_in client_address;
                socklen_t client_addrLength = sizeof(struct sockaddr_in);
                int clientfd = accept( listener, ( struct sockaddr* )&client_address, &client_addrLength );
 
                printf("client connection from: %s : % d(IP : port), clientfd = %d 
",
                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
", clientfd);
                printf("Now there are %d clients int the chat room
", (int)clients_list.size());
 
                // 服务端发送欢迎信息  
                printf("welcome message
");                
                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("send error"); exit(-1); }
            }
            //处理用户发来的消息，并广播，使其他用户收到信息
            else
            {   
                int ret = sendBroadcastmessage(sockfd);
                if(ret < 0) { perror("error");exit(-1); }
            }
        }
    }
    close(listener); //关闭socket
    close(epfd);    //关闭内核
    return 0;
}

客户端实现

子进程和父进程的通信

通过调用int pipe(int fd[2])函数创建管道, 其中fd[0]用于父进程读， fd[1]用于子进程写。

通过int pid = fork()函数，创建子进程，当pid < 0 错误；当pid = 0, 说明是子进程；当pid > 0说明是父进程。根据pid的值，我们可以父子进程，从而实现对应的功能！

客户端完整源码

#include "utility.h"
 
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 = inet_addr(SERVER_IP);
 
    // 创建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); }
 
    // 创建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
");
 
        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]); 
 
        // 主循环(epoll_wait)
        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
", sock);
                        close(sock);
                        isClientwork = 0;
                    }
                    else printf("%s
", message);
 
                }
                //子进程写入事件发生，父进程处理并发送服务端
                else { 
                    //父进程从管道中读取数据
                    int ret = read(events[i].data.fd, message, BUF_SIZE);
 
                    // ret = 0
                    if(ret == 0) isClientwork = 0;
                    else{   // 将信息发送给服务端
                      send(sock, message, BUF_SIZE, 0);
                    }
                }
            }//for
        }//while
    }
 
    if(pid){
       //关闭父进程和sock
        close(pipe_fd[0]);
        close(sock);
    }else{
        //关闭子进程
        close(pipe_fd[1]);
    }
    return 0;
}