C++开发网络通信程序时用asio是个不错的选择，但asio本身是一套函数集，自己还要处理诸如“通信线程池管理、连接及生命周期管理、多线程收发数据的同步保护等”。因此这里对asio进行了一层封装，大大简化了对asio的使用。代码使用了C++17相关功能，所以只能用在C++17以上。
其中http和websocket部分用的是boost::beast，因此如果需要用到http或websocket的功能，则必须使用boost库，如果用不到http则直接使用独立的asio即可。在config.hpp中通过对ASIO_STANDALONE这个宏定义的开关，即可设置是使用boost::asio还是使用asiostandalone.
代码大量使用了CRTP模板编程实现(没有使用virtual而用CRTP实现的静态多态)，因此编译比较耗时，但执行效率相对较好一点。
github地址：https://github.com/zhllxt/asio2
码云地址：https://gitee.com/zhllxt/asio2
Aopensourcecross-platformc++libraryfornetworkprogrammingbasedonasio,supportfortcp,udp,http,rpc,sslandsoon.
支持TCP,UDP,HTTP,WEBSOCKET,RPC,ICMP,SERIAL_PORT等;支持可靠UDP(基于KCP),支持SSL,支持从内存字符串加载SSL证书;TCP支持数据拆包功能(按指定的分隔符对数据自动进行拆包,保证用户收到的数据是一个完整的数据包);实现了TCP的数据报模式(类似WEBSOCKET);支持windows,linux,32位,64位;依赖asio(boost::asio或独立asio均可,若需要HTTP功能必须使用boost::asio),依赖C++17;代码采用hpp头文件方式,以源码级链入,无需编译,只需在工程的Include包含目录中添加asio2路径,然后在源码中#include<asio2/asio2.hpp>包含头文件即可;demo目录包含大量的示例工程(工程基于VS2017创建),各种使用方法请参考示例代码;TCP:服务端:
asio2::tcp_serverserver;server.bind_recv([&server](std::shared_ptr<asio2::tcp_session>&session_ptr,std::string_views){ session_ptr->no_delay(true); printf("recv:%u%.*s\n",(unsigned)s.size(),(int)s.size(),s.data()); //异步发送(所有发送操作都是异步且线程安全的)session_ptr->send(s);//发送时指定一个回调函数,当发送完成后会调用此回调函数,bytes_sent表示实际发送的字节数,//发送是否有错误可以用asio2::get_last_error()函数来获取错误码//session_ptr->send(s,[](std::size_tbytes_sent){});}).bind_connect([&server](auto&session_ptr){ printf("cliententer:%s%u%s%u\n", session_ptr->remote_address().c_str(),session_ptr->remote_port(), session_ptr->local_address().c_str(),session_ptr->local_port()); //可以用session_ptr这个会话启动一个定时器,这个定时器是在这个session_ptr会话的数据收 //发线程中执行的,这对于连接状态的判断或其它需求很有用(尤其在UDP这种无连接的协议中,有 //时需要在数据处理过程中使用一个定时器来延时做某些操作,而且这个定时器还需要和数据处理 //在同一个线程中安全触发) //session_ptr->start_timer(1,std::chrono::seconds(1),[](){});}).bind_disconnect([&server](auto&session_ptr){printf("clientleave:%s%u%s\n",session_ptr->remote_address().c_str(),session_ptr->remote_port(),asio2::last_error_msg().c_str());});server.start("0.0.0.0","8080");//server.start("0.0.0.0","8080",'\n');//按\n自动拆包(可以指定任意字符)//server.start("0.0.0.0","8080","\r\n");//按\r\n自动拆包(可以指定任意字符串)//server.start("0.0.0.0","8080",match_role('#'));//按match_role指定的规则自动拆包(match_role请参考demo代码)(用于对用户自定义的协议拆包)//server.start("0.0.0.0","8080",asio::transfer_exactly(100));//每次接收固定的100字节//server.start("0.0.0.0","8080",asio2::use_dgram);//数据报模式的TCP,无论发送多长的数据,双方接收的一定是相应长度的整包数据客户端:
asio2::tcp_clientclient;client.bind_connect([&](asio::error_codeec){if(asio2::get_last_error())printf("connectfailure:%d%s\n",asio2::last_error_val(),asio2::last_error_msg().c_str());elseprintf("connectsuccess:%s%u\n",client.local_address().c_str(),client.local_port());client.send("<abcdefghijklmnopqrstovuxyz0123456789>");}).bind_disconnect([](asio::error_codeec){printf("disconnect:%d%s\n",asio2::last_error_val(),asio2::last_error_msg().c_str());}).bind_recv([&](std::string_viewsv){printf("recv:%u%.*s\n",(unsigned)sv.size(),(int)sv.size(),sv.data());client.send(sv);})//.bind_recv(on_recv)//绑定全局函数//.bind_recv(std::bind(&listener::on_recv,&lis,std::placeholders::_1))//绑定成员函数(具体请查看demo代码)//.bind_recv(&listener::on_recv,lis)//按lis对象的引用来绑定成员函数(具体请查看demo代码)//.bind_recv(&listener::on_recv,&lis)//按lis对象的指针来绑定成员函数(具体请查看demo代码);client.async_start("0.0.0.0","8080");//异步连接服务端//client.start("0.0.0.0","8080");//同步连接服务端//client.async_start("0.0.0.0","8080",'\n');//按\n自动拆包(可以指定任意字符)//client.async_start("0.0.0.0","8080","\r\n");//按\r\n自动拆包(可以指定任意字符串)//client.async_start("0.0.0.0","8080",match_role);//按match_role指定的规则自动拆包(match_role请参考demo代码)(用于对用户自定义的协议拆包)//client.async_start("0.0.0.0","8080",asio::transfer_exactly(100));//每次接收固定的100字节//client.start("0.0.0.0","8080",asio2::use_dgram);//数据报模式的TCP,无论发送多长的数据,双方接收的一定是相应长度的整包数据//发送时也可以指定use_future参数,然后通过返回值future来阻塞等待直到发送完成,发送结果的错误码和发送字节数//保存在返回值future中(注意,不能在通信线程中用future去等待,这会阻塞通信线程进而导致死锁)//std::future<std::pair<asio::error_code,std::size_t>>future=client.send("abc",asio::use_future);UDP:服务端:
asio2::udp_serverserver;//...绑定监听器(请查看demo代码)server.start("0.0.0.0","8080");//常规UDP//server.start("0.0.0.0","8080",asio2::use_kcp);//可靠UDP客户端:
asio2::udp_clientclient;//...绑定监听器(请查看demo代码)client.start("0.0.0.0","8080");//client.async_start("0.0.0.0","8080",asio2::use_kcp);//可靠UDPRPC:服务端:
asio2::rpc_serverserver;//...绑定监听器(请查看demo代码)Aa;//A的定义请查看demo代码server.bind("add",add);//绑定RPC全局函数server.bind("mul",&A::mul,a);//绑定RPC成员函数server.bind("cat",[&](conststd::string&a,conststd::string&b){returna+b;});//绑定lambda表达式server.bind("get_user",&A::get_user,a);//绑定成员函数(按引用)server.bind("del_user",&A::del_user,&a);//绑定成员函数(按指针)//server.start("0.0.0.0","8080",asio2::use_dgram);//使用TCP数据报模式作为RPC通信底层支撑,启动服务端时必须要使用use_dgram参数server.start("0.0.0.0","8080");//使用websocket作为RPC通信底层支撑(需要到rcp_server.hpp文件末尾代码中选择使用websocket)客户端:
asio2::rpc_clientclient;//...绑定监听器(请查看demo代码)//client.start("0.0.0.0","8080",asio2::use_dgram);//使用TCP数据报模式作为RPC通信底层支撑,启动服务端时必须要使用use_dgram参数client.start("0.0.0.0","8080");//使用websocket作为RPC通信底层支撑asio::error_codeec;//同步调用RPC函数intsum=client.call<int>(ec,std::chrono::seconds(3),"add",11,2);printf("sum:%derr:%d%s\n",sum,ec.value(),ec.message().c_str());//异步调用RPC函数,第一个参数是回调函数,当调用完成或超时会自动调用该回调函数,如果超时或其它错误,//错误码保存在ec中,这里async_call没有指定返回值类型,则lambda表达式的第二个参数必须要指定类型client.async_call([](asio::error_codeec,intv){printf("sum:%derr:%d%s\n",v,ec.value(),ec.message().c_str());},"add",10,20);//这里async_call指定了返回值类型,则lambda表达式的第二个参数可以为auto类型client.async_call<int>([](asio::error_codeec,autov){printf("sum:%derr:%d%s\n",v,ec.value(),ec.message().c_str());},"add",12,21);//返回值为用户自定义数据类型(user类型的定义请查看demo代码)useru=client.call<user>(ec,"get_user");printf("%s%d",u.name.c_str(),u.age);for(auto&[k,v]:u.purview){printf("%d%s",k,v.c_str());}printf("\n");u.name="hanmeimei";u.age=((int)time(nullptr))%100;u.purview={{10,"get"},{20,"set"}};//如果RPC函数的返回值为void,则用户回调函数只有一个参数即可client.async_call([](asio::error_codeec){},"del_user",std::move(u));HTTP:服务端:asio2::http_serverserver;server.bind_recv([&](std::shared_ptr<asio2::http_session>&session_ptr,http::request<http::string_body>&req){//在收到http请求时尝试发送一个文件到对端{//如果请求是非法的,直接发送错误信息到对端并返回if(req.target().empty()||req.target()[0]!='/'||req.target().find("..")!=beast::string_view::npos){session_ptr->send(http::make_response(http::status::bad_request,"Illegalrequest-target"));session_ptr->stop();//同时直接断开这个连接return;}//Buildthepathtotherequestedfilestd::stringpath(req.target().data(),req.target().size());path.insert(0,std::filesystem::current_path().string());if(req.target().back()=='/')path.append("index.html");//打开文件beast::error_codeec;http::file_body::value_typebody;body.open(path.c_str(),beast::file_mode::scan,ec);//如果打开文件失败,直接发送错误信息到对端并直接返回if(ec==beast::errc::no_such_file_or_directory){session_ptr->send(http::make_response(http::status::not_found,std::string_view{req.target().data(),req.target().size()}));return;}//Cachethesizesinceweneeditafterthemoveautoconstsize=body.size();//生成一个文件形式的http响应对象,然后发送给对端http::response<http::file_body>res{std::piecewise_construct,std::make_tuple(std::move(body)),std::make_tuple(http::status::ok,req.version())};res.set(http::field::server,BOOST_BEAST_VERSION_STRING);res.set(http::field::content_type,http::extension_to_mimetype(path));res.content_length(size);res.keep_alive(req.keep_alive());res.chunked(true);//Specifyacallbackfunctionwhensending//session_ptr->send(std::move(res));session_ptr->send(std::move(res),[&res](std::size_tbytes_sent){autoopened=res.body().is_open();std::ignore=opened;autoerr=asio2::get_last_error();std::ignore=err;});//session_ptr->send(std::move(res),asio::use_future);return;}std::cout<<req<<std::endl;if(true){//用make_response生成一个http响应对象,状态码200表示操作成功,"suceess"是HTTP消息的body部分内容autorep=http::make_response(200,"suceess");session_ptr->send(rep,[](){autoerr=asio2::get_last_error();std::ignore=err;});}else{//也可以直接发送一个http标准响应字符串,内部会将这个字符串自动转换为http响应对象再发送出去std::string_viewrep="HTTP/1.1404NotFound\r\n"\"Server:Boost.Beast/181\r\n"\"Content-Length:7\r\n"\"\r\n"\"failure";//testsendstringsequence,thestringwillautomaticallyparsedintoastandardhttprequestsession_ptr->send(rep,[](std::size_tbytes_sent){autoerr=asio2::get_last_error();std::ignore=err;});}});server.start(host,port);客户端:asio2::error_codeec;autoreq1=http::make_request("https://www.baidu.com/get_user?name=a");//通过URL字符串生成一个http请求对象autoreq2=http::make_request("GET/HTTP/1.1\r\nHost:127.0.0.1:8443\r\n\r\n");//通过http协议字符串生成一个http请求对象req2.set(http::field::timeout,5000);//给请求设置一个超时时间autorep1=asio2::http_client::execute("https://www.baidu.com/get_user?name=a",ec);//通过URL字符串直接请求某个网址,返回结果在rep1中,如果有错误,错误码保存在ec中autorep2=asio2::http_client::execute("127.0.0.1","8080",req2);//通过IP端口以及前面生成的req2请求对象来发送一个http请求std::cout<<rep2<<std::endl;//显示http请求结果std::stringstreamss;ss<<rep2;std::stringresult=ss.str();//通过这种方式将http请求结果转换为字符串其它的HTTP使用方式以及WEBSOCKET使用方式请参考demo代码
ICMP:classping_test//模拟在一个类对象中使用ping组件(其它所有如TCP/UDP/HTTP等组件一样可以在类对象中使用){asio2::pingping;public:ping_test():ping(10)//构造函数传入的10表示只ping10次后就结束,传入-1表示一直ping{ping.timeout(std::chrono::seconds(3));//设置ping超时ping.interval(std::chrono::seconds(1));//设置ping间隔ping.body("0123456789abcdefghijklmnopqrstovuxyz");ping.bind_recv(&ping_test::on_recv,this)//绑定当前这个类的成员函数作为监听器.bind_start(std::bind(&ping_test::on_start,this,std::placeholders::_1))//也是绑定成员函数.bind_stop([this](asio::error_codeec){this->on_stop(ec);});//绑定lambda}voidon_recv(asio2::icmp_rep&rep){if(rep.lag.count()==-1)//如果延时的值等于-1表示超时了std::cout<<"requesttimedout"<<std::endl;elsestd::cout<<rep.total_length()-rep.header_length()<<"bytesfrom"<<rep.source_address()<<":icmp_seq="<<rep.sequence_number()<<",ttl="<<rep.time_to_live()<<",time="<<std::chrono::duration_cast<std::chrono::milliseconds>(rep.lag).count()<<"ms"<<std::endl;}voidon_start(asio::error_codeec){printf("start:%d%s\n",asio2::last_error_val(),asio2::last_error_msg().c_str());}voidon_stop(asio::error_codeec){printf("stop:%d%s\n",asio2::last_error_val(),asio2::last_error_msg().c_str());}voidrun(){if(!ping.start("127.0.0.1"))//if(!ping.start("123.45.67.89"))//if(!ping.start("stackoverflow.com"))printf("startfailure:%s\n",asio2::last_error_msg().c_str());while(std::getchar()!='\n');ping.stop();//ping结束后可以输出统计信息,包括丢包率,平均延时时长等printf("lossrate:%.0lf%%averagetime:%lldms\n",ping.plp(),std::chrono::duration_cast<std::chrono::milliseconds>(ping.avg_lag()).count());}}; SSL: TCP/HTTP/WEBSOCKET均支持SSL功能(需要在config.hpp中将#defineASIO2_USE_SSL宏定义放开)asio2::tcps_serverserver;//从内存字符串加载SSL证书(具体请查看demo代码)server.set_cert("test",cer,key,dh);//cer,key,dh这三个字符串的定义请查看demo代码//从文件加载SSL证书//server.set_cert_file("test","server.crt","server.key","dh512.pem");
TCP/HTTP/WEBSOCKET服务端、客户端等SSL功能请到DEMO代码中查看。 串口:请查看demo示例代码serialport部分
其它:定时器//框架中提供了定时器功能,使用非常简单,如下:asio2::timertimer;//参数1表示定时器ID,参数2表示定时器间隔,参数3为定时器回调函数timer.start_timer(1,std::chrono::seconds(1),[&](){printf("timer1\n");if(true)//满足某个条件时关闭定时器,当然也可以在其它任意地方关闭定时器timer.stop_timer(1);});
还有其它一些辅助类的功能,请在源码或使用中去体会吧.
评论