1、概述
操作系统在API层为我们提供了进行网络通讯的库(一组socket函数库),但使用起来未免复杂,而且极易出错,虽然这些socket库最初起源于 BSD系统,各个操作系统厂商都提供了自身平台的接口实现,但这些接口在不同OS上又略有差别,所以当你想写一个跨平台的网络通信程序时,工作量还是有的,并且如不知晓各个平台下的差异也极易出错。
本节向你介绍了怎样使用ACL库中的数据流(ACL_VSTREAM)来快速搭建你的网络通信程序;另外,ACL_VSTREAM 不仅是跨平台的,而且既可用于网络通信流,又可用于文件流,本节仅介绍网络流的例子。
2、网络通信函数接口说明
2.1)服务端接口
/** * 监听某个地址(对于UNIX,还可以监听域套接字) * @param addr {const char*} 监听地址 * 如:127.0.0.1:80, 或域套接字, 如:/tmp/test.sock * @param qlen {int} 监听队列的长度 * @return {ACL_VSTREAM*} 监听流指针 */ ACL_API ACL_VSTREAM *acl_vstream_listen(const char *addr, int qlen); /** * 从监听流中接收一个客户端连接流 * @param listen_stream {ACL_VSTREAM*} 监听流 * @param ipbuf {char*} 如果不为空则用来存储客户端的IP地址 * @param bsize {int} 如果 ipbuf 不为空,则表示 ipbuf 的空间大小 * @return {ACL_VSTREAM*} 如果不为空则表示新接收的客户端流 */ ACL_API ACL_VSTREAM *acl_vstream_accept(ACL_VSTREAM *listen_stream, char *ipbuf, int bsize);
2.2、客户端接口
/** * 远程连接服务器 * @param addr {const char*} 服务器地址,格式如:127.0.0.1, * 或 域套接地址:/tmp/test.sock * @param block_mode {int} 阻塞连接还是非阻塞连接,ACL_BLOCKING, ACL_NON_BLOCKING * @param connect_timeout {int} 连接超时时间(秒) * @param rw_timeout {int} 连接流成功后的读写超时时间,单位为秒 * @param rw_bufsize {int} 连接流成功后的缓冲区大小 * @return {ACL_VSTREAM*} 如果不为空,则表示连接成功后的数据流 */ ACL_API ACL_VSTREAM *acl_vstream_connect(const char *addr, int block_mode, int connect_timeout, int rw_timeout, int rw_bufsize);
2.3、读写过程接口
/** * 从数据流中一次性读取 n 个数据, 该 n 有可能会小于用户所需要的 maxlen * @param stream {ACL_VSTREAM*} 数据流 * @param vptr {void*} 用户的数据缓冲区指针地址 * @param maxlen {size_t} vptr 数据缓冲区的空间大小 * @return ret {int}, ret == ACL_VSTREAM_EOF: 表示出错, 应该关闭本地数据流, * ret > 0: 表示读到了 ret 个字节的数据 * 注: 如果缓冲区内有数据, 则直接把缓冲区内的数据复制到用户的缓冲区然后直接返回; * 如果缓冲区内无数据, 则需要调用系统读操作(有可能会阻塞在系统读操作上), 该 * 次调用返回后则把读到数据复制到用户缓冲区返回. * 在这两种情况下都不能保证读到的字节数等于所要求的字节数, 若想读到所要求的 * 字节后才返回则请调用 vstream_loop_readn() 函数. */ ACL_API int acl_vstream_read(ACL_VSTREAM *stream, void *vptr, size_t maxlen); /** * 从数据流中读取一行数据, 直到读到 "\n" 或读结束为止, 正常情况下包括 "\n" * @param stream {ACL_VSTREAM*} 数据流 * @param vptr {void*} 用户所给的内存缓冲区指针 * @param maxlen {size_t} vptr 缓冲区的大小 * @return ret {int}, ret == ACL_VSTREAM_EOF: 读出错或对方关闭了连接, * 应该关闭本地数据流; n > 0: 读到 了 n 个字节的数据, 如果该 n 个数据 * 的最后一个非 0 字符为 "\n" 表明读到了一个完整的行, 否则表明读到了 n * 个数据但对方未发送 "\n" 就关闭了连接; 还可以通过检查 * (stream->flag & ACL_VSTREAM_FLAG_TAGYES) * 不等于 0 来判断是否读到了 "\n", 如果非 0 则表示读到了 "\n". */ ACL_API int acl_vstream_gets(ACL_VSTREAM *stream, void *vptr, size_t maxlen); /** * 循环向数据流中写 dlen 个字节的数据直至写完或出错为止 * @param stream {ACL_VSTREAM*} 数据流 * @param vptr {const char*} 数据区指针地址 * @param dlen {size_t} 待写的数据区数据长度 * @return ret {int}, ret == ACL_VSTREAM_EOF: 表示写出错, 应该关闭本地数据流, * ret > 0: 表示成功写了 dlen 个字节的数据 */ ACL_API int acl_vstream_writen(ACL_VSTREAM *stream, const void *vptr, size_t dlen); /** * 带格式的流输出, 类似于 fprintf() * @param stream {ACL_VSTREAM*} 数据流 * @param fmt {const char*} 数据格式 * @return ret {int}, ret == ACL_VSTREAM_EOF: 表示写出错, 应该关闭本地数据流, * ret > 0: 表示成功写了 dlen 个字节的数据 */ ACL_API int acl_vstream_fprintf(ACL_VSTREAM *stream, const char *fmt, ...);
2.3、流关闭接口
/** * 释放一个数据流的内存空间并关闭其所携带的 socket 描述符 * @param stream {ACL_VSTREAM*} 数据流 */ ACL_API int acl_vstream_close(ACL_VSTREAM *stream);
3、网络通信实例
3.1 一个简单的服务器程序
#include "lib_acl.h" /* 先包含ACL库头文件 */ #include <stdio.h> #include <stdlib.h> static void echo_client(ACL_VSTREAM *client) { char buf[1024]; int n; /* 设置客户端流的读超时时间为30秒 */ ACL_VSTREAM_SET_RWTIMO(client, 30); /* 循环读客户端的数据,直到其关闭或出错或超时 */ while (1) { /* 等待读客户端发来的数据 */ n = acl_vstream_read(client, buf, sizeof(buf)); if (n == ACL_VSTREAM_EOF) break; /* 将读到的数据写回至客户端流 */ if (acl_vstream_writen(client, buf, n) == ACL_VSTREAM_EOF) break; } /* 关闭客户端流 */ acl_vstream_close(client); } static void run(const char *addr) { const char *myname = "run"; ACL_VSTREAM *sstream; char ebuf[256]; /* 监听一个本地地址 */ sstream = acl_vstream_listen(addr, 128); if (sstream == NULL) { printf("%s(%d): listen on %s error(%s)\r\n", myname, __LINE__, addr, acl_last_strerror(ebuf, sizeof(ebuf))); return; } printf("%s: listen %s ok\r\n", myname, addr); while (1) { /* 等待接受客户端的连接 */ client = acl_vstream_accept(sstream, NULL, 0); if (client == NULL) { printf("%s(%d): accept error(%s)\r\n", myname, __LINE__, acl_last_strerror(ebuf, sizeof(ebuf))); return; } printf("accept one\r\n"); /* 获得一个客户端连接流 */ /* 开始处理该客户端连接流 */ echo_client(client); } } static void init(void) { acl_init(); /* 初始化ACL库 */ } static void usage(const char *procname) { printf("usage: %s listen_addr\r\n", procname); printf("example: %s 127.0.0.1:8081\r\n", procname); } int main(int argc, char *argv[]) { if (argc != 2) { usage(argv[0]); return (0); } init(); run(argv[1]); return (0); }
由上可以看出,创建一个服务器程序是多么的简单,当然,这是一个阻塞式线程的服务器程序,如果你要想提高并发度,可以在线程里处理来自客户端的连接。
3.2、一个简单的客户端程序
#include "lib_acl.h" #include <stdio.h> #include <stdlib.h> static void run(const char *addr) { const char *myname = "run"; ACL_VSTREAM *client; char ebuf[256], buf[1024]; int n, cnt = 0; /* 连接远程服务器,采用阻塞模式连接,连接超时为10秒, * 流的读超时时间为20秒,流的缓冲区大小为1024字节 */ client = acl_vstream_connect(addr, ACL_BLOCKING, 10, 20, 1024); if (client == NULL) { printf("%s(%d): connect addr %s error(%s)\r\n", myname, __LINE__, addr, acl_last_strerror(ebuf, sizeof(ebuf))); return; } printf("%s: connect %s ok\r\n", myname, addr); while (1) { /* 向服务器发送一行数据 */ n = acl_vstream_fprintf(client, ">>hi, I'm coming in...(%d)\r\n", ++cnt); if (n == ACL_VSTREAM_EOF) break; /* 从服务器读取一行数据 */ n = acl_vstream_gets(client, buf, sizeof(buf)); if (n == ACL_VSTREAM_EOF) break; /* 最多循环5次 */ if (cnt >= 5) break; /* 休息一下 */ sleep(1); } /* 关闭流 */ acl_vstream_close(client); } static void init(void) { acl_init(); /* 初始化ACL库 */ } static void usage(const char *procname) { printf("usage: %s server_addr\r\n", procname); printf("example: %s 127.0.0.1:8081\r\n", procname); } int main(int argc, char *argv[]) { if (argc != 2) { usage(argv[0]); return (0); } init(); run(argv[1]); return (0); }
嗯,看来创建网络客户端程序原来也这么简单。
4、小结
由以上例子可以看出,ACL库屏蔽底层SOCKET的细节操作,使网络编程变得简单,使使用者可以专心于其应用,而不是拘泥于SOCKET操作上。
当然,若要完全编译通过,别忘了还需要包含ACL库的二进制版本 lib_acl.a (Unix) 或 lib_acl_vc2003.lib(Windows)。
个人微博:http://weibo.com/zsxxsz
acl 库的下载地址:https://sourceforge.net/projects/acl/
svn:svn checkout svn://svn.code.sf.net/p/acl/code/trunk acl-code
github:https://github.com/acl-dev/acl
QQ 群:242722074
国内镜像:http://git.oschina.net/acl-dev/acl