Linux epoll

1
2
3
4
5
6
7

// 创建一个epoll句柄
// 创建一个epoll的句柄，size用来告诉内核这个监听的数目一共有多大，在红黑树中该参数size无效
int epoll_create(int size);	
// 返回值：
//	EINVAL 大小不是正数。
//  ENFILE 已达到系统对打开文件总数的限制。
//  ENOMEM 没有足够的内存来创建内核对象。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// 添加文件描述符到红黑树中
int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);
    
// epfd：为epoll_create创建的fd
// op：指定操作类型
//   EPOLL_CTL_ADD：	将目标文件描述符fd添加到epoll描述符epfd中，并将事件event与fd链接的内部文件关联起来。
//   EPOLL_CTL_MOD：	更改与目标文件描述符fd关联的事件event。
//   EPOLL_CTL_DEL：	从epoll文件描述符epfd中删除目标文件描述符fd。该事件被忽略，可以为NULL。
// fd：要操作的文件描述符，也就是我们要加入的fd，可以是创建的socket或其他文件句柄。
// event：指定事件，它是epoll_event结构指针类型
//   epoll_event 定义：
//      events：描述事件类型，和poll支持的事件类型基本相同（两个额外的事件：EPOLLET和EPOLLONESHOT，高效运作的关键）
//        events可以是以下几个宏的集合：
//          EPOLLIN ：表示对应的文件描述符可以读（包括对端SOCKET正常关闭）。关联文件描述符的read()操作
//          EPOLLOUT：表示对应的文件描述 符可以写，关联文件描述符的write()操作。
//          EPOLLPRI：表示对应的文件描述符有紧急的数据可读（这里应该表示有带外数据到来）
//          EPOLLERR：描述符产生错误时触发，默认检测事件
//          EPOLLHUP：本端描述符产生一个挂断事件，默认监测事件
//          EPOLLRDHUP：对端描述符产生一个挂断事件
//          EPOLLET： 将EPOLL设为边缘触发(Edge Triggered)模式，这是相对于水平触发(Level Triggered)来说的
//          EPOLLONESHOT：只监听一次事件，当监听完这次事件之后，如果还需要继续监听这个socket的话，需要再次把这个socket加入到EPOLL队列里
//      data：存储用户数据，该字段是一个指针类型因此在wait函数中我们可以拿到该数据进行相关操作
// event是我们所关心的事件类型，注意只有我们注册的事件才会在epoll_wait被唤醒后传递到用户空间，否则虽然内核可以收到但不会传递

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// 成功时返回就绪的文件描述符的个数，失败时返回-1并设置errno
int epoll_wait(int epfd, struct epoll_event *events, int maxevents, int timeout);

// timeout：指定epoll的超时时间，单位是毫秒
//   当timeout为-1时，epoll_wait调用将永久阻塞，直到某个事件发生
//   当timeout为0时，epoll_wait调用将立即返回
//   当timeout大于0时，epoll_wait阻塞timeout事件后返回
// maxevents：指定最多监听多少个事件，意思是一次返回最大的就绪事件数量
// events：检测到事件，将所有就绪的事件从内核事件表中复制到它的第二个参数events指向的数组中
//   该参数获取从内核得到的事件的集合，拿到前面函数注册的用户数据进行标记
// 返回值int，表示需要处理的事件数目，如果返回0表示已超时

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

int socket(int domain, int type, int protocol);

// 1) domain 参数：互联网协议族，常用的有以下
//      AF_INET： 表示通过IPv4,通信方式(通过IPv4网络连接起来的主机),应用程序间的通信(32位IPv4地址+16位端口号),地址结构(sockaddr_in)
//      AF_INET6：表示通过IPv6,通信方式(通过IPv6网络连接起来的主机),应用程序间的通信(128位Ipv6地址+16位端口号),地址结构(sockaddr_in6)
//      AF_UNIX： 内核中,同一主机间通信,地址格式(路径名),地址结构(sockaddr_un)
//      AF_ROUTE：路由套接字
//      AF_KEY：密钥套接字
//      AF_UNSPEC：未指定
//      AF：是“Address Family”的简写，INET是“Inetnet”的简写
// 2) type 参数：表示 数据传输方式/套接字类型
//      SOCK_STREAM：表示使用 "流格式套接字/面向连接的套接字"，有序的、面向连接的、可靠的双向通信的字节流通信
//      SOCK_DGRAM： 表示使用 "数据报套接字/无连接的套接字"，不连接、不可靠、固定长度的数据报通信
//      SOCK_NONBLOCK：将socket函数返回的文件描述符指定为非阻塞，可以和上面的宏使用’|’运算（如采用SOCK_STREAM | SOCK_NONBLOCK表示使用TCP协议且是非阻塞），默认是阻塞模式
//      SOCK_RDM：表示想使用原始网络通信（如当domain参数设置为PF_INET时就表示直接使用TCP/IP协议族中的ip协议）
//      SOCK_CLOEXEC：一旦进程exec执行新程序时，自动关闭socket返回的套接字文件描述符，也就是fork的程序不能共用一个socket
// 3) protocol 参数：表示传输协议，常用的有以下
//      IPPROTO_TCP： 表示TCP传输协议
//      IPPTOTO_UDP： 表示UDP传输协议
//      IPPROTO_SCTP：表示SCTP传输协议
//      IPPROTO_TIPC：表示TIPC传输协议
//      一般该参数默认传入0，socket程序根据前两个参数自动推断类型
// 返回值：成功时返回创建的socket的文件描述符;失败时返回-1，并设置errno错误信息

// 有了地址类型和数据传输方式，还不足以决定采用哪种协议吗？为什么还需要第三个参数呢？
//   1. 一般情况下有了前两个参数就可以创建socket，操作系统会自动推演出协议类型
//   2. 除非遇到这样的情况：有两种不同的协议支持同一种地址类型和数据传输类型
//   3. 如果我们不指明使用哪种协议，操作系统是没办法自动推演的

// int tcp_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
// 满足前面两个参数的只有TCP协议，因此可以写成如下
// int tcp_socket = socket(AF_INET, SOCK_STREAM, 0);

// int udp_socket = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
// 满足前面两个参数的只有UDP协议，因此可以写成如下
// int udp_socket = socket(AF_INET, SOCK_DGRAM, 0);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

int bind(int sockfd, const struct sockaddr *addr, socklen_t addrlen);
    
// sockfd：参数是调用socket函数返回的socket描述符
// addr：参数是一个指向包含有本机IP地址及端口号等信息的sockaddr类型的指针
//      早期的sockaddr   
//          struct sockaddr {
//          sa_family_t sa_faily;	// 地址族,AF_XXX
//              char sa_data[14];	// 字符数组，存放ip和端口
//          }
//      后面出现了IPv4和IPv6，因此把sockaddr结构更详细细分,下面结构都能与sockaddr进行转换
//      ipv4
//          struct sockaddr_in {
//              __kernel_sa_family_t sin_family;    // 地址族
//              __be16 sin_port;                    // 端口
//              struct in_addr sin_addr;            // Internet地址
//              // 占位,以满足sockaddr_in所占大小与sockaddr相同
//              unsigned char __pad[__SOCK_SIZE__ - sizeof(short int) - sizeof(unsigned short int) - sizeof(struct in_addr)];
//          }
//          // Internet地址
//          struct in_addr {
//              __be32 s_addr;  // 32为无符号整型数据，正好存储IP地址
//          };
//      ipv6
//          struct sockaddr_in6 {
//              unsigned short int sin6_family; // AF_INET6
//              __be16 sin6_port;               // 传输层端口
//              __be32 sin6_flowinfo;           // IPv6 流信息
//              struct in6_addr sin6_addr;      // IPv6 地址
//              __u32 sin6_scope_id;   // scope id (new in RFC2553)
//          };
//      unix addr
//          #define UNIX_PATH_MAX 108
//          struct sockaddr_un {
//              __kernel_sa_family_t sun_family;    // AF_UNIX
//              char sun_path[UNIX_PATH_MAX];
//          };
// addrlen：参数是地址参数的长度sizeof(addr)    
// 返回值：成功返回0，失败返回-1, 并且设置errno
    
// 比如绑定一个ipv4地址
struct sockaddr_in addr;    // 定义结构体变量
addr.sin_family = AF_INET;  // 指定协议族为IPv4
addr.sin_port = htons(5006);// 指定端口号
addr.sin_addr.s_addr = inet_addr("192.168.1.10");   // 指定IP
// 进行套接字文件 ip/端口的绑定
ret = bind(sockfd, (struct sockaddr*)&addr, sizeof(addr));

// 其他相关函数
// htonl() 把32位值从主机字节序转换成网络字节序
// htons() 把16位值从主机字节序转换成网络字节序
// ntohl() 把32位值从网络字节序转换成主机字节序
// ntohs() 把16位值从网络字节序转换成主机字节序

// inet_addr() 字符串形式的ip,用于将点分十进制IP转换为IPV4的32位无符号整型IP

1
2
3
4
5
6

int listen(int sockfd, int backlog);
    
// sockfd：socket()所创建的fd
// backlog：在tcp三次握手的时候，第一次握手发送SYN=1，server端接收到之后，在回复了Ack=1之后，
//  会把这个还未完成3次握手的连接放入到一个队列中，这个队列需要指定一个长度，该参数就是用来指定这个半连接队列长度的
//  在linux中该参数默认值由cat /proc/sys/net/ipv4/tcp_max_syn_backlog决定，默认1024

1
2
3
4
5

int accept(int sockfd, struct sockaddr *cliaddr, socklen_t *addrlen);
// 返回值：非负数成功，返回一个新的fd，这个fd用来和对端进行通信，-1 出错
// sockfd：监听后的套接字，也就是listen函数返回的fd
// cliaddr：用来接收对端的连接地址信息，如果对客户端信息不感兴趣可以把该值设置成空NULL
// addrlen：cliaddr的长度

1

int accept4(int sockfd, struct sockaddr *addr,socklen_t *addrlen, int flags);

1
2
3

int connect(int sockfd, const struct sockaddr *servaddr, socklen_t addrlen);
// sockfd：由socket函数返回的套接字描述符
// 第二、三个参数分别是指向套接口地址结构的指针和该结构的大小，套接口地址结构必须含有服务器的IP地址和端口号

1
2
3
4
5

ssize_t read(int fd, void *buf, size_t count);
// fd：socket的文件描述符
// buf：读取到的容器
// count：buf的大小
// 返回值：为实际读取到的字节数，如果返回0，表示已达到文件尾或是无可读的数据