Networking

在 libuv 中，网络编程与直接使用 BSD socket 区别不大，有些地方还更简单，概念保持不变的同时，libuv 上所有接口都是非阻塞的。它还提供了很多工具函数，抽象了恼人、啰嗦的底层任务，如使用 BSD socket 结构体设置 socket 、DNS 查找以及调整各种 socket 参数。

在网络I/O中会使用到uv_tcp_t和uv_udp_t。

note

本章中的代码片段仅用于展示 libuv API ，并不是优质代码的范例，常有内存泄露和未关闭的连接。

TCP

TCP是面向连接的，字节流协议，因此基于libuv的stream实现。

server

服务器端的建立流程如下：

1.uv_tcp_init建立tcp句柄。
2.uv_tcp_bind绑定。
3.uv_listen建立监听，当有新的连接到来时，激活调用回调函数。
4.uv_accept接收链接。
5.使用stream操作来和客户端通信。

tcp-echo-server/main.c - The listen socket

  1. int main() {
  2.     loop = uv_default_loop();
  4.     uv_tcp_t server;
  5.     uv_tcp_init(loop, &server);
  7.     uv_ip4_addr("0.0.0.0", DEFAULT_PORT, &addr);
  9.     uv_tcp_bind(&server, (const struct sockaddr*)&addr, 0);
  10.     int r = uv_listen((uv_stream_t*) &server, DEFAULT_BACKLOG, on_new_connection);
  11.     if (r) {
  12.         fprintf(stderr, "Listen error %s\n", uv_strerror(r));
  13.         return 1;
  14.     }
  15.     return uv_run(loop, UV_RUN_DEFAULT);
  16. }

你可以调用uv_ip4_addr()函数来将ip地址和端口号转换为sockaddr_in结构，这样就可以被BSD的socket使用了。要想完成逆转换的话可以调用uv_ip4_name()。

note

对应ipv6有类似的uvip6*

大多数的设置函数是同步的，因为它们不会消耗太多cpu资源。到了uv_listen这句，我们再次回到回调函数的风格上来。第二个参数是待处理的连接请求队列－最大长度的请求连接队列。

当客户端开始建立连接的时候，回调函数on_new_connection需要使用uv_accept去建立一个与客户端socket通信的句柄。同时，我们也要开始从流中读取数据。

tcp-echo-server/main.c - Accepting the client

  1. void on_new_connection(uv_stream_t *server, int status) {
  2.     if (status < 0) {
  3.         fprintf(stderr, "New connection error %s\n", uv_strerror(status));
  4.         // error!
  5.         return;
  6.     }
  8.     uv_tcp_t *client = (uv_tcp_t*) malloc(sizeof(uv_tcp_t));
  9.     uv_tcp_init(loop, client);
  10.     if (uv_accept(server, (uv_stream_t*) client) == 0) {
  11.         uv_read_start((uv_stream_t*) client, alloc_buffer, echo_read);
  12.     }
  13.     else {
  14.         uv_close((uv_handle_t*) client, NULL);
  15.     }
  16. }

上述的函数集和stream的例子类似，在code文件夹中可以找到更多的例子。记得在socket不需要后，调用uv_close。如果你不需要接受连接，你甚至可以在uv_listen的回调函数中调用uv_close。

client

当你在服务器端完成绑定/监听/接收的操作后，在客户端只要简单地调用uv_tcp_connect，它的回调函数和上面类似，具体例子如下： 

  1. uv_tcp_t* socket = (uv_tcp_t*)malloc(sizeof(uv_tcp_t));
  2. uv_tcp_init(loop, socket);
  4. uv_connect_t* connect = (uv_connect_t*)malloc(sizeof(uv_connect_t));
  6. struct sockaddr_in dest;
  7. uv_ip4_addr("127.0.0.1", 80, &dest);
  9. uv_tcp_connect(connect, socket, dest, on_connect);

当建立连接后，回调函数on_connect会被调用。回调函数会接收到一个uv_connect_t结构的数据，它的handle指向通信的socket。

UDP

用户数据报协议(User Datagram Protocol)提供无连接的，不可靠的网络通信。因此，libuv不会提供一个stream实现的形式，而是提供了一个uv_udp_t句柄（接收端），和一个uv_udp_send_t句柄（发送端），还有相关的函数。也就是说，实际的读写api与正常的流读取类似。下面的例子展示了一个从DCHP服务器获取ip的例子。

note

你必须以管理员的权限运行udp-dhcp，因为它的端口号低于1024

udp-dhcp/main.c - Setup and send UDP packets

  1. uv_loop_t *loop;
  2. uv_udp_t send_socket;
  3. uv_udp_t recv_socket;
  5. int main() {
  6.     loop = uv_default_loop();
  8.     uv_udp_init(loop, &recv_socket);
  9.     struct sockaddr_in recv_addr;
  10.     uv_ip4_addr("0.0.0.0", 68, &recv_addr);
  11.     uv_udp_bind(&recv_socket, (const struct sockaddr *)&recv_addr, UV_UDP_REUSEADDR);
  12.     uv_udp_recv_start(&recv_socket, alloc_buffer, on_read);
  14.     uv_udp_init(loop, &send_socket);
  15.     struct sockaddr_in broadcast_addr;
  16.     uv_ip4_addr("0.0.0.0", 0, &broadcast_addr);
  17.     uv_udp_bind(&send_socket, (const struct sockaddr *)&broadcast_addr, 0);
  18.     uv_udp_set_broadcast(&send_socket, 1);
  20.     uv_udp_send_t send_req;
  21.     uv_buf_t discover_msg = make_discover_msg();
  23.     struct sockaddr_in send_addr;
  24.     uv_ip4_addr("255.255.255.255", 67, &send_addr);
  25.     uv_udp_send(&send_req, &send_socket, &discover_msg, 1, (const struct sockaddr *)&send_addr, on_send);
  27.     return uv_run(loop, UV_RUN_DEFAULT);
  28. }
note

ip地址为0.0.0.0，用来绑定所有的接口。255.255.255.255是一个广播地址，这也意味着数据报将往所有的子网接口中发送。端口号为0代表着由操作系统随机分配一个端口。

首先，我们设置了一个用于接收socket绑定了全部网卡，端口号为68作为DHCP客户端，然后开始从中读取数据。它会接收所有来自DHCP服务器的返回数据。我们设置了UV_UDP_REUSEADDR标记，用来和其他共享端口的 DHCP客户端和平共处。接着，我们设置了一个类似的发送socket，然后使用uv_udp_send向DHCP服务器（在67端口）发送广播。

设置广播发送是非常必要的，否则你会接收到EACCES错误。和此前一样，如果在读写中出错，返回码<0。

因为UDP不会建立连接，因此回调函数会接收到关于发送者的额外的信息。

当没有可读数据后，nread等于0。如果addr是null，它代表了没有可读数据（回调函数不会做任何处理）。如果不为null，则说明了从addr中接收到一个空的数据报。如果flag为UV_UDP_PARTIAL，则代表了内存分配的空间不够存放接收到的数据了，在这种情形下，操作系统会丢弃存不下的数据。

udp-dhcp/main.c - Reading packets

  1. void on_read(uv_udp_t *req, ssize_t nread, const uv_buf_t *buf, const struct sockaddr *addr, unsigned flags) {
  2.     if (nread < 0) {
  3.         fprintf(stderr, "Read error %s\n", uv_err_name(nread));
  4.         uv_close((uv_handle_t*) req, NULL);
  5.         free(buf->base);
  6.         return;
  7.     }
  9.     char sender[17] = { 0 };
  10.     uv_ip4_name((const struct sockaddr_in*) addr, sender, 16);
  11.     fprintf(stderr, "Recv from %s\n", sender);
  13.     // ... DHCP specific code
  14.     unsigned int *as_integer = (unsigned int*)buf->base;
  15.     unsigned int ipbin = ntohl(as_integer[4]);
  16.     unsigned char ip[4] = {0};
  17.     int i;
  18.     for (i = 0; i < 4; i++)
  19.         ip[i] = (ipbin >> i*8) & 0xff;
  20.     fprintf(stderr, "Offered IP %d.%d.%d.%d\n", ip[3], ip[2], ip[1], ip[0]);
  22.     free(buf->base);
  23.     uv_udp_recv_stop(req);
  24. }

UDP Options

生存时间（Time-to-live）

可以通过uv_udp_set_ttl更改生存时间。

只允许IPV6协议栈

在调用uv_udp_bind时，设置UV_UDP_IPV6ONLY标示，可以强制只使用ipv6。

组播

socket也支持组播，可以这么使用： 

  1. UV_EXTERN int uv_udp_set_membership(uv_udp_t* handle,
  2.                                     const char* multicast_addr,
  3.                                     const char* interface_addr,
  4.                                     uv_membership membership);

其中membership可以为UV_JOIN_GROUP和UV_LEAVE_GROUP。
这里有一篇很好的关于组播的文章。
可以使用uv_udp_set_multicast_loop修改本地的组播。
同样可以使用uv_udp_set_multicast_ttl修改组播数据报的生存时间。（设定生存时间可以防止数据报由于环路的原因，会出现无限循环的问题）。

Querying DNS

libuv提供了一个异步的DNS解决方案。它提供了自己的getaddrinfo。在回调函数中你可以像使用正常的socket操作一样。让我们来看一下例子：

dns/main.c

  1. int main() {
  2.     loop = uv_default_loop();
  4.     struct addrinfo hints;
  5.     hints.ai_family = PF_INET;
  6.     hints.ai_socktype = SOCK_STREAM;
  7.     hints.ai_protocol = IPPROTO_TCP;
  8.     hints.ai_flags = 0;
  10.     uv_getaddrinfo_t resolver;
  11.     fprintf(stderr, "irc.freenode.net is... ");
  12.     int r = uv_getaddrinfo(loop, &resolver, on_resolved, "irc.freenode.net", "6667", &hints);
  14.     if (r) {
  15.         fprintf(stderr, "getaddrinfo call error %s\n", uv_err_name(r));
  16.         return 1;
  17.     }
  18.     return uv_run(loop, UV_RUN_DEFAULT);
  19. }

如果uv_getaddrinfo返回非零值，说明设置错误了，因此也不会激发回调函数。在函数返回后，所有的参数将会被回收和释放。主机地址，请求服务器地址，还有hints的结构都可以在这里找到详细的说明。如果想使用同步请求，可以将回调函数设置为NULL。

在回调函数on_resolved中，你可以从struct addrinfo(s)链表中获取返回的IP，最后需要调用uv_freeaddrinfo回收掉链表。下面的例子演示了回调函数的内容。

dns/main.c

  1. void on_resolved(uv_getaddrinfo_t *resolver, int status, struct addrinfo *res) {
  2.     if (status < 0) {
  3.         fprintf(stderr, "getaddrinfo callback error %s\n", uv_err_name(status));
  4.         return;
  5.     }
  7.     char addr[17] = {'\0'};
  8.     uv_ip4_name((struct sockaddr_in*) res->ai_addr, addr, 16);
  9.     fprintf(stderr, "%s\n", addr);
  11.     uv_connect_t *connect_req = (uv_connect_t*) malloc(sizeof(uv_connect_t));
  12.     uv_tcp_t *socket = (uv_tcp_t*) malloc(sizeof(uv_tcp_t));
  13.     uv_tcp_init(loop, socket);
  15.     uv_tcp_connect(connect_req, socket, (const struct sockaddr*) res->ai_addr, on_connect);
  17.     uv_freeaddrinfo(res);
  18. }

libuv同样提供了DNS逆解析的函数uv_getnameinfo。

Network interfaces

可以调用uv_interface_addresses获得系统的网络接口信息。下面这个简单的例子打印出所有可以获取的信息。这在服务器开始准备绑定IP地址的时候很有用。

interfaces/main.c

  1. #include <stdio.h>
  2. #include <uv.h>
  4. int main() {
  5.     char buf[512];
  6.     uv_interface_address_t *info;
  7.     int count, i;
  9.     uv_interface_addresses(&info, &count);
  10.     i = count;
  12.     printf("Number of interfaces: %d\n", count);
  13.     while (i--) {
  14.         uv_interface_address_t interface = info[i];
  16.         printf("Name: %s\n", interface.name);
  17.         printf("Internal? %s\n", interface.is_internal ? "Yes" : "No");
  19.         if (interface.address.address4.sin_family == AF_INET) {
  20.             uv_ip4_name(&interface.address.address4, buf, sizeof(buf));
  21.             printf("IPv4 address: %s\n", buf);
  22.         }
  23.         else if (interface.address.address4.sin_family == AF_INET6) {
  24.             uv_ip6_name(&interface.address.address6, buf, sizeof(buf));
  25.             printf("IPv6 address: %s\n", buf);
  26.         }
  28.         printf("\n");
  29.     }
  31.     uv_free_interface_addresses(info, count);
  32.     return 0;
  33. }

is_internal可以用来表示是否是内部的IP。由于一个物理接口会有多个IP地址，所以每一次while循环的时候都会打印一次。