[关闭]
@khan-lau 2016-01-07T11:29:46.000000Z 字数 36955 阅读 3639

Boost.Asio c++ 网络编程

C++ Boost.ASIO


  实战出精华
  Boost.Asio C++ 网络编程
  用具体的C++网络编程例子来提升你的技能
    John Torjan

  用具体的C++网络编程例子来提升你的技能
  Copyright © 2013 Packt Publishing

  版权所有,除了在鉴定文章或者评论中进行简单引用,如果没有经过出版者事先的书面授权,该书的任何部分都不能被转载、存储在检索系统中、或者以任何形式和方式传阅。

  在这本书准备发行之前,我们已经尽我们最大的努力去保证书中信息的准确性。但是,这本书中包含的明示或者暗示的信息都没有保证。无论是本书作者、Packt   Publishing以及它的经销商和分销商都不承担由这本书直接或者间接造成的任何损害。
  Packt Publishing将尽最大努力,用适当的大写字母来对书中提到的所有公司和产品进行商标标识。但是,Packt Publishing不能保证这些信息的准确性。
  
第一版发布:2013年1月
产品编号:1120213
由Packt Publishing Ltd.发布

工作人员
作者:John Torjo
协调人:Sherin Padayatty
评审:Béla Tibor Bartha、Nicolae Ghimbovschi
校对:Claire Cresswell-Lane
组稿编辑:Erol Staveley
索引编制:Monica Ajmera Mehta
责任编辑:Ameya Sawant
图像处理:Valentina D'silva、Aditi Gajjar
技术编辑:Kaustubh S. Mayekar
协调出版:Conidon Miranda
封面:Conidon Miranda

关于作者
  做为一个权威的C++专家,在John Torjo超过15年的编程生涯中,他大部分的时间都用在了C++上。偶尔,他也用C#和Java写程序。
  他也很喜欢在C++ Users Journal和其他杂志上写一些关于编程的文章。
  闲暇时光,他喜欢打扑克、开快车。他有很多自由职业,其中有一个就把他对扑克和编程爱好结合起来。你可以通过john.code@torjo.com联系他。


  我要感谢我的朋友Alexandru Chis, Aurelian Hale, Bela Tibor Bartha, Cristian Fatu, Horia Uifaleanu, Nicolae Ghimbovschi以及Ovidiu Deac对本书提出的反馈和意见。同时我也要感谢Packt各位的理解,即使我时不时地错过一些截稿日期。然后最需要感谢的是Chris Kohlhoff,Boost.Asio的作者,是他写出了一个如此伟大的库。
把这本书献给我最好的朋友Darius。


关于评审员
Béla Tibor Bartha
  一个用各种技术和语言进行工作的专业软件工程师。尽管在过去的4年里,他做的是iOS和OSX应用开发,但是C++陪伴他度过了他早期个人游戏开发项目的激情岁月。


  我要感谢John,因为他我才能做这本书的评审


Nicolae Ghimbovschi
  一个参加各种各样的C++项目超过5年的天才个人开发者。他主要参与一些企业的通信工程的项目。他是一个狂热的Linux爱好者,他喜欢利用不同的操作系统、脚本工具、编程语言上进行测试和实验。除了编程,他还喜欢骑自行车、瑜伽和冥想。


  我要感谢John让我来评审这本书


前言

  网络编程由来已久,并且是一个极富挑战性的任务。Boost.Asio对网络编程做了一个极好的抽象,从而保证你用少量的编程就可以创造出一个优雅的client-server软件,并在创造的过程中,它能让你体会到极大的乐趣。而更为有益的是,Boost.Asio包含了一些非网络的特性,用Boost.Asio写出来的代码紧凑、易读,而且如果你按照我在书中所讲的来做,你的代码会无懈可击。

  这本书涵盖了什么?

  第一章:Boost.Asio入门将告诉你Boost.Asio是什么?怎么编译它?顺带着会有一些例子。你会发现Boost.Asio不仅仅是一个网络库。同时你也会接触到Boost.Asio中最核心的类io_service。

  第二章:Boost.Asio基本原理包含了你必须了解的内容:什么时候用Boost.Asio?我们将深入了解异步编程——一种比同步更需要技巧,且更有乐趣的编程方式。同时,当在你开发你自己的网络应用时,你需要回过头,把这一章里面的内容作为参考。

  第三章:回显服务端/客户端将会告诉你如何实现一个小的client-server应用;也许,这会是你写过的最简单的client-server应用。回显应用就是一个把客户端发过来的任何消息回显回去然后关闭客户端连接的服务。我们会先实现一个同步的应用,然后再实现一个异步的应用,这样你就可以非常容易地看到它们之间的不同。

  第四章:客户端和服务端会深入讨论如何用Boost.Asio创建一个简单的客户端服务端应用。我们将讨论如何避免诸如内存泄漏和死锁的缺陷。所有的程序都是简单的框架,从而使你更方便的对他们进行扩展并满足你的需求。

  第五章:同步VS异步会带你了解那些当你选择同步还是异步方式时需要考虑的事情。首先就是避免混淆它们。在这一章,我们将会看到每一个类型应用的实现、测试和调试是多么的容易。

  第六章:Boost.Asio的其他特性将带你了解一些Boost.Asio一些不为人知的特性。你会发现,虽然std streams和streambufs有一点点难用,但是却表现出了它们独天得厚的优势。最后,你会发现Boost.Asio后期的一个条目——协程,它可以让你用一种更易读的方式来写异步代码。(就好像它是同步的一样)

  第七章:Boost.Asio进阶会处理一些Boost.Asio的高端问题。虽然你不需要在日常编程中深入研究它们,但是了解它们对你有益无害(Boost.Asio高级调试,SSL,Windows特性,POSIX特性等)。


读这本书你需要准备什么?
  为了编译Boosta.Asio以及运行本书中的例子,你需要一个现代编译器。例如,Visual Studio 2008及其以上版本或者g++ 4.4及其以上版本


这本书是为谁准备的?
  这本书对于那些需要进行网络编程却不想深入研究复杂的原始网络API的开发者来说是一个福音。所有你需要的只是Boost.Asio提供的一个简单抽象。作为著名的Boost C++库的一部分,你只需要额外添加几个#include文件即可转换到Boost.Asio。
  在读这本书之前,你需要熟悉Boost核心库的一些知识,例如Boost智能指针boost::noncopyableBoost FunctorsBoost Bindshared_
from_this
/enabled_shared_from_thisBoost线程线程互斥量)。同时还需要了解Boost的Date/Time。读者还需要知道阻塞的概念以及“非阻塞”操作。


约定
  你会发现本书中用不同样式的文字来区分不同种类的信息。这里给出这些样式的例子以及它们的解释。
文本中的代码会这样显示:“通常一个io_service的例子就足够了”。
一段代码是下面这个样子的:

  1. read(stream, buffer [, extra options])
  2. async_read(stream, buffer [, extra options], handler)
  3. write(stream, buffer [, extra options])
  4. async_write(stream, buffer [, extra options], handler)

  专业词汇和重要的单词用黑体显示
  [!警告或者重要的注释在这样的一个框里面]
  [?技巧在这样的一个框里面]


读者反馈
  我们欢迎来自读者的反馈。告诉我们你对这本书的看法——你喜欢哪部分,不喜欢哪部分。读者的反馈对我们非常重要,它能让我们写出对读者帮助最大的书籍。
  你只需要发送一封邮件到feedback@packtpub.com即可进行一般的反馈,注意在邮件的主题中注明书名。
  如果你有一个擅长的专题,想撰写一本书或者为某本书做贡献。请阅读我们在www.packtpub.com/authors上的作者指引。


用户支持
  现在你已经是Packet书籍的拥有者,我们将告诉你一些事项,让你享受到购买本书的最大收益。


下载示例代码
  你可以在http://www.packtpub.com登录你的帐号,然后下载你所购买的书籍的全部示例代码。同时,你也可以通过访问http://www.packtpub.com/support进行注册,然后这些示例代码文件将直接发送到你的邮箱。


纠错
  尽管我们已经尽我们最大的努力去保证书中内容的准确性,但是错误始终是存在的。如果你在我们的书籍中发现了错误——也许是文字,也许是代码——如果你能将它们报告给我们,我们将不胜感激。这样的话,你不仅能让帮助其他读者避免一些疑惑,同时也能帮助我们改进这本书的下一个版本。如果你发现任何需要纠正的地方,访问http://www.packtpub.com/submit-errata,选择你的书籍,点击errata submission form链接,然后输入详细的纠错信息来将错误报告给我们。一经确定,你的提交就会通过并且纠错会上传到我们的网站,或者添加到那本书的纠错信息区域的纠错列表中。所有存在的纠错都可以访问http://www.packtpub.com/support,然后通过选择书名的方式来查看。

盗版
  在互联网上通过各种媒体盗版版权材料是个一直存在的问题。在Packet,版权和许可的保护非常严格。如果你在互联网上发现任何形式的关于我们作品的非法备份。请及时把链接或者网址反馈给我们以便我们采取补救措施。
请将可疑盗版材料的链接通过copyright@packtpub.com发送给我们。
对于你帮助我们保护我们的作者以及我们提供有价值内容能力的行为我们将不胜感激。

答疑

如果你有关于本书任何方面的问题,你可以通过questions@packtpub.com联系我们。我们将尽我们最大的努力进行解答


Boost.Asio入门

  什么是Boost.Asio
  简单来说,Boost.Asio是一个跨平台的、主要用于网络和其他一些底层输入/输出编程的C++库。
  计算机网络的设计方式有很多种,但是Boost.Asio的的方式远远优于它们。它在2005年就被包含进Boost,然后被广大Bosot的用户测试并在很多项目中使用,比如Remobo(http://www.remobo.com),可以让你创建你自己的即时私有网络(IPN),libtorrent(http://www.rasterbar.com/products/libtorrent)一个实现了比特流客户端的库,PokerTH (http://www.pokerth.net)一个支持LAN和互联网游戏的纸牌游戏。
  Boost.Asio在网络通信、COM串行端口和文件上成功地抽象了输入输出的概念。你可以基于这些进行同步或者异步的输入输出编程。

  1. read(stream, buffer [, extra options])
  2. async_read(stream, buffer [, extra options], handler)
  3. write(stream, buffer [, extra options])
  4. async_write(stream, buffer [, extra options], handler)
  5. [?…]

  从前面的代码片段可以看出,这些函数支持一个任意内容(不仅仅是一个socket,我们可以对它进行读写)的流实例。
  作为一个跨平台的库,Boost.Asio可以在大多数操作系统上使用。能同时支持数千个并发的连接。其网络部分的灵感来源于伯克利软件分发(BSD)套接字,它提供了一个可以支持传输控制协议(TCP)套接字、用户数据报协议(UDP)套接字和Internet控制消息协议(IMCP)套接字的API,而且如果有需要,你可以对其进行扩展以支持你自己的协议。

  历史
  Boost.Asio在2003被开发出来,然后在2005年的12月的Boost 1.35版本中引入。原作者是Christopher M. Kohlhoff,你可以通过chris@kohlhoff.com联系他。

这个库在如下的平台和编译器上测试通过:

32-bit和64-bit Windows,使用Visual C++ 7.1及以上Windows下使用MinGW Windows下使用Cygwin(确保已经定义 __USE_232_SOCKETS)

基于2.4和2.6内核的Linux,使用g++ 3.3及以上
Solaris下使用g++ 3.3及以上

MAC OS X 10.4以上下使用g++ 3.3及以上

它或许能在诸如AIX 5.3,HP-UX 11i v3,QNX Neutrino 6.3,Solaris下使用Sun Studio 11以上,True64 v5.1,Windows下使用Borland C++ 5.9.2以上等平台上使用。(更多细节请咨询www.boost.org)

  依赖
  Boost.Asio依赖于如下的库:

Boost.System:这个库为Boost库提供操作系统支持(http://www.boost.org/doc/libs/1_51_0/doc/html/boost_system/index.html)
Boost.Regex:使用这个库(可选的)以便你重载read_until()或者async_read_until()时使用boost::regex参数。
Boost.DateTime:使用这个库(可选的)以便你使用Boost.Asio中的计时器。
OpenSSL:使用这个库(可选的)以便你使用Boost.Asio提供的SSL支持。

  编译Boost.Asio
  Boost.Asio是一个仅有头文件的库。然而,根据你的编译器和你程序的大小,你可以选择用源文件的方式来编译Boost.Asio。如果你想要这么做以减少编译时间,有如下几种方式:
  在你的一个源文件中,添加#include <boost/asio/impl/src.hpp>(如果你在使用SSL,添加#include <boost/asio/ssl/impl/src.hpp>
  在你所有的源文件中,添加#define BOOST_ASIO_SEPARATE_COMPILATION
  注意Boost.Asio依赖于Boost.System,必要的时候还依赖于Boost.Regex,所以你需要用如下的指令先编译Boost:

  1. bjam with-system with-regex stage

  如果你还想同时编译tests,你需要使用如下的指令:

  1. bjam with-system with-thread with-date_time with-regex with-serialization stage

  这个库有大量的例子,你可以连同这本书中的例子一块看看。

  重要的宏
  如果有需要设置了BOOST_ASIO_DISABLE_THREADS;他会让Boost.Asio中的线程支持失效,不管在编译Boost的过程中是否使用了线程支持。

  同步VS异步

  首先,异步编程和同步编程是有极大的不同的。在同步编程中,你所有的操作都是顺序执行的,比如从一个socket中读取(请求),然后写入(回应)到socket中。每一个操作操作都是阻塞的。因为操作是阻塞的,所以为了不影响主程序,当读写一个socket时,通常创建一个或多个线程来处理socket的输入/输出。因此,同步的服务端/客户端通常是多线程的。
  相反的,异步编程是事件驱动的。你启动了一个操作,但是你不知道它何时会结束;你只是提供一个回调,当操作结束时,它会调用这个API,并返回操作结果。对于有着丰富经验的QT(诺基亚用来创建跨平台图形用户界面应用程序的库)程序员来说,这就是第二天性。因此,在异步编程中,你只需要一个线程。
  因为中途做改变会非常困难而且容易出错,所以你在项目初期(最好是一开始)就得决定用同步还是异步的方式实现网络通信。不仅API有极大的不同,你程序的语意也会完全改变(异步网络通信通常比同步网络通信更加难以测试和调试)。你需要考虑是采用阻塞调用和多线程的方式(同步,通常比较简单),或者是更少的线程和事件驱动(异步,通常更复杂)。
  下面是一个基本的同步客户端例子:

  1. using boost::asio;
  2. io_service service;
  3. ip::tcp::endpoint ep( ip::address::from_string("127.0.0.1"), 2001);
  4. ip::tcp::socket sock(service);
  5. sock.connect(ep);

  首先,你的程序需要至少一个io_service实例。Boost.Asio使用io_service同操作系统的输入/输出服务进行交互。通常一个io_service的实例就足够了。然后,创建你想要连接的地址和端口,然后建立socket。把socket连接到你的地址和端口。
  下面是一个简单的使用Boost.Asio的服务端:

  1. typedef boost::shared_ptr<ip::tcp::socket> socket_ptr;
  2. io_service service;
  3. ip::tcp::endpoint ep( ip::tcp::v4(), 2001)); // listen on 2001
  4. ip::tcp::acceptor acc(service, ep);
  5. while ( true) {
  6. socket_ptr sock(new ip::tcp::socket(service));
  7. acc.accept(*sock);
  8. boost::thread( boost::bind(client_session, sock));
  9. }
  10. void client_session(socket_ptr sock) {
  11. while ( true) {
  12. char data[512];
  13. size_t len = sock->read_some(buffer(data));
  14. if ( len > 0)
  15. write(*sock, buffer("ok", 2));
  16. }
  17. }

  首先,同样是需要至少一个io_service实例。然后你指定你想要监听的端口,然后创建一个接收器,一个用来接收客户端连接的对象。
  在接下来的循环中,你创建一个虚拟的socket来等待客户端的连接。然后当一个连接被建立时,你创建一个线程来处理这个连接。
  在client_session线程中来读取一个客户端的请求,进行解析,然后返回结果。
而创建一个异步的客户端,你需要做如下的事情:

  1. using boost::asio;
  2. io_service service;
  3. ip::tcp::endpoint ep( ip::address::from_string("127.0.0.1"), 2001);
  4. ip::tcp::socket sock(service);
  5. sock.async_connect(ep, connect_handler);
  6. service.run();
  7. void connect_handler(const boost::system::error_code & ec) {
  8. // here we know we connected successfully
  9. // if ec indicates success
  10. }

  在程序中你需要创建至少一个io_service实例。你需要指定连接的地址以及创建socket。
  当连接完成时(其完成处理程序)你就异步地连接到了指定的地址和端口,也就是说,connect_handler被调用了。
  当connect_handler被调用时,检查错误代码(ec),如果成功,你就可以向服务端进行异步的写入。
  注意:只要有待解决的异步操作,servece.run()循环就会一直运行。在之前的例子中,只执行了一个这样的操作,就是socket的async_connect。在这之后,service.run()就退出了。
  每一个异步操作都有一个完成处理程序——一个操作完成之后被调用的函数。
  下面的代码是一个基本的异步服务端

  1. using boost::asio;
  2. typedef boost::shared_ptr<ip::tcp::socket> socket_ptr;
  3. io_service service;
  4. ip::tcp::endpoint ep( ip::tcp::v4(), 2001)); // listen on 2001
  5. ip::tcp::acceptor acc(service, ep);
  6. socket_ptr sock(new ip::tcp::socket(service));
  7. start_accept(sock);
  8. service.run();
  9. void start_accept(socket_ptr sock) {
  10. acc.async_accept(*sock, boost::bind( handle_accept, sock, _1) );
  11. }
  12. void handle_accept(socket_ptr sock, const boost::system::error_code & err) {
  13. if ( err) return;
  14. // at this point, you can read/write to the socket
  15. socket_ptr sock(new ip::tcp::socket(service));
  16. start_accept(sock);
  17. }

  在之前的代码片段中,首先,你创建一个io_service实例,然后指定监听的端口。然后,你创建接收器acc——一个接受客户端连接,创建一个虚拟的socket,然后异步等待客户端连接的对象。
  最后,运行异步service.run()循环。当接收到客户端连接时,handle_accept被调用(调用async_accept的完成处理程序)。如果没有错误,这个socket就可以用来做读写操作。
  在使用这个socket之后,你创建了一个新的socket,然后再次调用start_accept(),用来创建另外一个“等待客户端连接”的异步操作,从而使service.run()循环一直保持忙碌状态。

  异常处理VS错误代码

  Boost.Asio允许同时使用异常处理或者错误代码,所有的异步函数都有抛出错误和返回错误码两种方式的重载。当函数抛出错误时,它经常抛出boost::system::system_error的错误。

  1. using boost::asio;
  2. ip::tcp::endpoint ep;
  3. ip::tcp::socket sock(service);
  4. sock.connect(ep); // Line 1
  5. boost::system::error_code err;
  6. sock.connect(ep, err); // Line 2

  在前面的代码中,sock.connect(ep)会抛出错误,sock.connect(ep, err)则会返回一个错误码。
  看一下下面的代码片段:

  1. try {
  2. sock.connect(ep);
  3. } catch(boost::system::system_error e) {
  4. std::cout << e.code() << std::endl;
  5. }

  下面的代码片段和前面的是一样的:

  1. boost::system::error_code err;
  2. sock.connect(ep, err);
  3. if ( err)
  4. std::cout << err << std::endl;

  当使用异步函数时,你可以在你的回调里面检查其返回的错误码。异步函数从来不抛出异常,因为这样做毫无意义。那谁会捕获到它呢?
  在你的异步函数中,你可以使用异常处理或者错误码(随心所欲),但要保持一致性。同时使用这两种方式会导致问题,大部分时候是崩溃(当你不小心出错,忘记去处理一个抛出来的异常时)。如果你的代码很复杂(调用很多socket读写函数),你最好选择异常处理的方式,把你的读写包含在一个函数try {} catch块里面。

  1. void client_session(socket_ptr sock) {
  2. try {
  3. ...
  4. } catch ( boost::system::system_error e) {
  5. // handle the error
  6. }
  7. }

  如果使用错误码,你可以使用如下的代码片段很好地看到连接是何时关闭的:

  1. char data[512];
  2. boost::system::error_code error;
  3. size_t length = sock.read_some(buffer(data), error);
  4. if (error == error::eof)
  5. return; // Connection closed

  Boost.Asio的所有错误码都包含在boost::asio::error的命名空间中(以便你创造一个大型的switch来检查错误的原因)。如果想要了解更多的细节,请参照boost/asio/error.hpp头文件。

  Boost.Asio中的线程
  当说到Boost.Asio的线程时,我们经常讨论:
  io_service:io_service是线程安全的。几个线程可以同时调用io_service::run()。大多数情况下你可能在一个必须等待所有异步操作完成之后才能继续执行的单线程函数中调用io_service::run()。然而,你其实可以在多个线程中调用io_service::run()。这会阻塞所有调用io_service::run()的线程。只要线程中的任何一个调用了io_service::run(),所有的回调都会同时被调用;这也就意味着,当你在一个线程中调用io_service::run()时,所有的回调都被调用了。
  socket:socket类不是线程安全的。所以,你要避免在某个线程里读一个socket时,同时在另外一个线程里面对其进行写入操作。(通常来说这种操作都是不推荐的,更别说Boost.Asio)。
  utility:就utility来说,因为它不是线程安全的,所以通常也不提倡在多个线程里面同时使用。里面的方法经常只是在很短的时间里面使用一下,然后就释放了。
  除了你自身的线程,Boost.Asio本身也包含几个线程。但是能保证那些线程不会调用你的代码。这也意味着,只有调用了io_service::run()方法的线程才会调用回调函数。

  不仅仅是网络通信
  除了网络通信,Boost.Asio还包含了其他的I/O功能。
Boost.Asio支持信号量,比如SIGTERM(软件终止)SIGINT(中断信号)SIGSEGV(段错误)等等。
你可以创建一个signal_set实例,指定异步等待的信号量,然后当这些信号量产生时,就会调用你的异步处理程序:

  1. void signal_handler(const boost::system::error_code & err, int signal)
  2. {
  3. // log this, and terminate application
  4. }
  5. boost::asio::signal_set sig(service, SIGINT, SIGTERM);
  6. sig.async_wait(signal_handler);

如果SIGINT产生,你就能在你的signal_handler回调中捕获到它。
你可以使用Boost.Asio轻松地连接到一个串行端口。在Windows上端口名称是COM7,在POSIX平台上是/dev/ttyS0。

  1. io_service service;
  2. serial_port sp(service, "COM7");

打开端口后,你就可以使用下面的代码设置一些端口选项,比如端口的波特率、奇偶校验和停止位。

  1. serial_port::baud_rate rate(9600);
  2. sp.set_option(rate);

打开端口后,你可以把这个串行端口看做一个流,然后基于这点,使用自由函数对串行端口进行读/写操作。比如async_read(), write, async_write(), 就像下面的代码片段:

  1. char data[512];
  2. read(sp, buffer(data, 512));

Boost.Asio也可以连接到Windows的文件,然后同样使用自由函数,比如read(), asyn_read()等等,像下面的代码片段:

  1. HANDLE h = ::OpenFile(...);
  2. windows::stream_handle sh(service, h);
  3. char data[512];
  4. read(h, buffer(data, 512));

对于POXIS文件描述符,比如管道,标准I/O和各种设备(但不包括普通文件)你也可以这样做,就像下面的代码所做的一样:

  1. posix::stream_descriptor sd_in(service, ::dup(STDIN_FILENO));
  2. char data[512];
  3. read(sd_in, buffer(data, 512));

  计时器
  一些I/O操作需要一个完成截止时间。你只能在异步操作上进行应用(同步意味着阻塞,因此没有截止时间)。例如,你的下一条信息必须在100毫秒内从你的同伴传递给你。

  1. bool read = false;
  2. void deadline_handler(const boost::system::error_code &) {
  3. std::cout << (read ? "read successfully" : "read failed") <<
  4. std::endl;
  5. }
  6. void read_handler(const boost::system::error_code &) {
  7. read = true;
  8. }
  9. ip::tcp::socket sock(service);
  10. read = false;
  11. char data[512];
  12. sock.async_read_some(buffer(data, 512));
  13. deadline_timer t(service, boost::posix_time::milliseconds(100));
  14. t.async_wait(&deadline_handler);
  15. service.run();

  在上一个代码片段中,如果你在截止时间之前读完了数据,read则被设置成true,如此我们的伙伴就及时地通知了我们。否则,当deadline_handler被调用时,read还是false,也就意味着我们没有满足我们的截止时间。
  Boost.Asio也支持同步计时器,当时他们通常和一个简单的sleep操作是一样的。boost::this_thread::sleep(500);这段代码和下面的代码片段完成了同一件事情:

  1. deadline_timer t(service, boost::posix_time::milliseconds(500));
  2. t.wait();

  io_service类
  你应该已经发现大部分使用Boost.Asio编写的代码都会使用几个ios_service的实例。ios_service是这个库里面最重要的类;它负责和操作系统打交道,等待所有异步操作的结束,然后为每一个异步操作调用完成处理程序。
  如果你选择用同步的方式来创建你的应用,你不需要考虑我将在这一节向你展示的东西。 你可以用几种不同的方式来使用io_service。在下面的例子中,我们有3个异步操作,2个socket连接和一个计时器等待:
  有一个
io_service`和一个处理线程的单线程例子:

  1. io_service service_;
  2. // all the socket operations are handled by service_
  3. ip::tcp::socket sock1(service_);
  4. // all the socket operations are handled by service_
  5. ip::tcp::socket sock2(service_);
  6. sock1.async_connect( ep, connect_handler);
  7. sock2.async_connect( ep, connect_handler);
  8. deadline_timer t(service_, boost::posix_time::seconds(5));
  9. t.async_wait(timeout_handler);
  10. service_.run();

  有单个io_service实例和多个处理线程的多线程例子:

  1. io_service service_;
  2. ip::tcp::socket sock1(service_);
  3. ip::tcp::socket sock2(service_);
  4. sock1.async_connect( ep, connect_handler);
  5. sock2.async_connect( ep, connect_handler);
  6. deadline_timer t(service_, boost::posix_time::seconds(5));
  7. t.async_wait(timeout_handler);
  8. for ( int i = 0; i < 5; ++i)
  9. boost::thread( run_service);
  10. void run_service() {
  11. service_.run();
  12. }

  有多个io_service实例和多个处理线程的多线程例子:

  1. io_service service_[2];
  2. ip::tcp::socket sock1(service_[0]);
  3. ip::tcp::socket sock2(service_[1]);
  4. sock1.async_connect( ep, connect_handler);
  5. sock2.async_connect( ep, connect_handler);
  6. deadline_timer t(service_[0], boost::posix_time::seconds(5));
  7. t.async_wait(timeout_handler);
  8. for ( int i = 0; i < 2; ++i)
  9. boost::thread( boost::bind(run_service, i));
  10. void run_service(int idx) {
  11. service_[idx].run();
  12. }

  首先,要注意你不能拥有多个io_service却只有一个线程。下面的代码片段没有任何意义:

  1. for ( int i = 0; i < 2; ++i)
  2. service_[i].run();

  上面的代码片段没有意义是因为service_[1].run()需要service_[0].run()先结束。因此,所有由service_[1]处理的异步操作都需要等待,这显然不是一个好主意。
  在前面的3个方案中,我们在等待3个异步操作结束。为了解释之间的不同点,我们假设:过一会操作1完成,然后接着操作2完成。同时我们假设每一个完成处理程序需要1秒钟来完成执行。
  在第一个例子中,我们在一个线程中等待三个操作全部完成,只要第1个操作完成,我们调用它的完成处理程序。尽管操作2紧接着完成了,操作2的完成处理程序需要在1秒钟后操作1的完成处理程序完成才被调用。
  第二个例子,我们在两个线程中等待3个异步操作结束。当操作1完成时,我们在第一个线程中调用它的完成处理程序。当操作2完成时,紧接着,我们就在第二个线程中调用它的完成处理函数(当线程1在忙着响应操作1的处理程序时,线程2空闲着并且可以回应任何新进来的操作)。
  在第三个例子中,因为操作1是sock1的connect,操作2是sock2的connect,所以应用程序会表现得像第二个例子一样。线程1会处理sock1 connect操作的完成处理程序,线程2会处理sock2的connect操作的完成处理程序。然而,如果sock1的connect操作是操作1,deadline_timer t的超时操作是操作2,线程1会结束正在处理的sock1 connect操作的完成处理程序。因而,deadline_timer t的超时操作必须等sock1 connect操作的完成处理程序结束(等待1秒钟),因为线程1要处理sock1的连接处理程序和t的超时处理程序。
  
  下面是你需要从前面的例子中学到的:
  第一种情况是非常基础的应用程序。因为是串行的方式,所以当几个处理程序要被同时调用时,你会经常遇到瓶颈。如果一个处理程序需要花费很长的时间来执行,所有随后的处理程序都不得不等待。
  第二种情况是比较适用的应用程序。他是非常强壮的——如果几个处理程序被同时调用了(这是有可能的),它们会在各自的线程里面被调用。唯一的瓶颈就是所有的处理线程都很忙的同时又有新的处理程序被调用。然而,这有快速的解决方式,增加处理线程的数目即可。
  第三种情况最复杂和最难理解的。你只有在第二种情况不能满足需求时才使用它。这种情况一般就是当你有成千上万实时(socket)连接时。你可以认为每一个处理线程(运行io_service::run()的线程)有它自己的select/epoll循环;它等待任何一个socket,然后监控一个读写操作,当它发现这种操作时,就执行。大部分情况下,你不需要担心什么,唯一你需要担心的就是当你监控的socket数目以指数级的方式增长时(超过1000个的socket)。在那种情况下,有几个select/epoll循环会增加响应时间。
  如果你觉得你成应用程序可能需要转换到第三种模式,请确保监听操作的这段代码(调用io_service::run()的代码)和应用程序其他部分是隔离的,这样你就可以很轻松的对其进行更改。
  最后,要一直记住如果没有其他需要监控的操作,.run()就会结束,就像下面给的代码片段:

  1. io_service service_;
  2. tcp::socket sock(service_);
  3. sock.async_connect( ep, connect_handler);
  4. service_.run();

  在上面的例子,只要sock建立了一个连接,connect_handler就会被调用,然后接着service_.run()就会完成执行。
  如果你想要service_.run()接着执行,你需要分配更多的工作给它。这里有两个方式来完成这个目标。一种方式是在connect_handler中启动另外一个异步操作来分配更多的工作。
另一种方式模拟一些工作给它,用下面的代码片段:

  1. typedef boost::shared_ptr<io_service::work> work_ptr;
  2. work_ptr dummy_work(new io_service::work(service_));

上面的代码可以保证service_.run()一直运行直到你调用useservice_.stop()或者

  1. dummy_work.reset(0);// 销毁 dummy_work.

  总结
  Boost.Asio是一个复杂的库,但是却让网络编程变得异常简单。编译它很简单。它避免使用宏,这一点做得很好;他虽然定义了少部分的宏来做选项开关,但是你需要担心的很少。
  Bosot.Asio支持同步和异步编程。他们有很大不同;你需要早早地选择其中的一种,因为它们之间的转换是非常复杂而且易错的。
  如果你选择同步,你可以选择异常处理或者错误码,从异常处理转到错误码;只需要在call函数中增加一个参数即可(错误码)。
  Boost.Asio不仅仅可以用来做网络编程。它还有其他更多的特性,这让它显得更有价值,比如信号量,计时器等等。
  下一章我们将深入研究大多数Boost.Asio中用来做网络编程的函数和类。同时我们也会学一些异步编程的诀窍。

Boost.Asio基本原理

  这一章涵盖了你使用Boost.Asio时必须知道的一些事情。我们也将深入研究比同步编程更机警、更有乐趣的异步编程。

  网络API
这一部分包含了当使用Boost.Asio编写网络应用程序时你必须知道的事情。

  Boost.Asio命名空间
  

  
Boost.Asio的一切都需要包含在boost::asio的命名空间或者其子命名空间内。
  boost::asio: 这是核心类和函数所在的地方。重要的类有io_servicestreambuf。类似read, read_at,   read_until,它们的异步同性,它们的写和异步写同行等自由函数也在这里。
  boost::asio::ip: 这是网络通信部分所在的地方。重要的类有address, endpoint, tcp, udpicmp,重要的自由函数有connectasync_connect。要注意的是在boost::asio::ip::tcp::socket中间,socket只是boost::asio::ip::tcp类中间的一个typedef关键字。
  boost::asio::error 这个命名空间包含了当调用I/O例程时返回的错误码
  boost::asio::ssl: 包含了SSL处理类的命名空间
  boost::asio::local: 这个命名空间包含了POSIX特性的类
  boost::asio::windows: 这个命名空间包含了Windows特性的类

  IP地址
对于IP地址的处理,Boost.Asio提供了ip::address , ip::address_v4ip::address_v6类。
它们提供了相当多的函数。下面列出了最重要的几个:

  ip::address(v4_or_v6_address):这个函数把一个v4或者v6的地址转换成ip::address
  ip::address:from_string(str):这个函数根据一个IPv4地址(用.隔开的)或者一个IPv6地址(十六进制表示)创建一个地址。
  ip::address::to_string():这个函数返回这个地址的友好展示。
  ip::address_v4::broadcast([addr, mask]):这个函数创建了一个广播地址
  ip::address_v4::any():这个函数返回一个能表示任意地址的地址。
  ip::address_v4::loopback(), ip_address_v6::loopback():这个函数返回环路地址(为v4/v6协议)
  ip::host_name():这个函数用string数据类型返回当前的主机名。
大多数情况你会选择用ip::address::from_string

  1. ip::address addr = ip::address::from_string("127.0.0.1");

如果你想要连接到一个主机名,继续读。下面的代码片断不管用:

  1. // 抛出异常
  2. ip::address addr = ip::address::from_string("www.yahoo.com");

  端点
  端点是你用某个端口连接到的一个地址。不同的类型socket有他自己的endpoint类,比如ip::tcp::endpointip::udp::endpointip::icmp::endpoint
  如果你想连接到本机的80端口,你可以这样做:

  1. ip::tcp::endpoint ep( ip::address::from_string("127.0.0.1"), 80);

  有三种方式来让你建立一个端点:
  endpoint():这是默认构造函数,某些时候可以用来创建UDP/ICMP套接字。
  endpoint(protocol, port):这个经常用来创建可以接受新连接的服务器端套接字。
  endpoint(addr, port):这个创建了一个连接到某地址某端口的端点。

  例子如下:

  1. ip::tcp::endpoint ep1;
  2. ip::tcp::endpoint ep2(ip::tcp::v4(), 80);
  3. ip::tcp::endpoint ep3( ip::address::from_string("127.0.0.1), 80);

  如果你想连接到一个主机(不是IP地址),你需要这样做:

  1. // 输出 "87.248.122.122"
  2. io_service service;
  3. ip::tcp::resolver resolver(service);
  4. ip::tcp::resolver::query query("www.yahoo.com", "80");
  5. ip::tcp::resolver::iterator iter = resolver.resolve( query);
  6. ip::tcp::endpoint ep = *iter;
  7. std::cout << ep.address().to_string() << std::endl;

  你可以用你需要的套接字类型来替换tcp。首先,创建一个你想要名字的查询,然后用resolve()函数解析它。如果成功,他会返回至少一个入口。利用返回的迭代器,或者使用第一个入口,或者迭代整个列表。
给点一个端点,可以获得他的地址,端口和IP协议(v4或者v6):

  1. std::cout << ep.address().to_string() << ":" << ep.port() << "/" << ep.protocol() << std::endl;

  套接字
  Boost.Asio有三种类型的套接字类:ip::tcp,   ip::udpip::icmp,当然它也是可扩展的。你可以创建你自己的socket类,尽管这相当复杂。如果你选择这样做,参照一下boost/asio/ip/tcp.hpp,   boost/asio/ip/udp.hppboost/asio/ip/icmp.hpp。它们都是有着内部typedef关键字的超小类。
  你可以把ip::tcp, ip::udp,   ip::icmp类当作占位符;它们让你可以便捷地访问其他类/函数,如下所示:
  ip::tcp::socket, ip::tcp::acceptor, ip::tcp::endpoint, ip::tcp::resolver,ip::tcp::iostream
  ip::udp::socket, ip::udp::endpoint, ip::udp::resolver
  ip::icmp::socket, ip::icmp::endpoint, ip::icmp::resolver

  socket类创建一个相应的socket。而你总是在构造的时候传入io_service实例:

  1. io_service service;
  2. ip::udp::socket sock(service);
  3. sock.set_option(ip::udp::socket::reuse_address(true));

  每一个socket的名字都是一个typedef关键字

  1. ip::tcp::socket = basic_stream_socket<tcp>
  2. ip::udp::socket = basic_datagram_socket<udp>
  3. ip::icmp::socket = basic_raw_socket<icmp>

  同步错误码
  所有的同步函数都有抛出异常或者返回错误码的重载,比如如下的代码片段:

  1. sync_func( arg1, arg2 ... argN); // 抛出异常
  2. boost::system::error_code ec;
  3. sync_func( arg1 arg2, ..., argN, ec); // 返回错误码

  在这一章剩下的部分,你会见到大量的同步函数。简单起见,我省略了返回错误码的重载,但是它们是存在的。

  套接字成员函数
  这些函数被分成了几组。在各个类型的套接字里并不是所有的函数都可用。这个部分的结尾将有一个列表来展示哪个函数是属于哪个socket类的。
  注意所有的异步函数都立刻返回,而它们相对的同步实现需要操作完成之后才能返回。

  连接相关的函数
  这些是连接或绑定套接字、断开套接字连接以及查询连接是活动还是非活动的函数:
  assign(protocol,socket):这个函数分配了一个原生的套接字给这个套接字实例。当处理老(旧)程序时使用它(也就是说,原生套接字已经被建立了)
  open(protocol):这个函数用给定的IP协议(v4或者v6)打开一个套接字。你主要在UDP/ICMP套接字,或者服务端套接字上使用。
  bind(endpoint):这个函数绑定到一个地址
  connect(endpoint):这个函数用同步的方式连接到一个地址
  async_connect(endpoint):这个函数用异步的方式连接到一个地址
  is_open():如果套接字已经打开,这个函数返回true
  close():这个函数关闭套接字。这个套接字上任何的异步操作都会被立即关闭,同时返回error::operation_aborted错误码
  shutdown(type_of_shutdown):这个函数立即使send或者receive操作失效,或者两者都失效。
  cancel():这个函数取消这个套接字上所有的异步操作。这个套接字上任何的异步操作都会立即结束,然后返回error::operation_aborted错误码。

  例子如下:

  1. ip::tcp::endpoint ep( ip::address::from_string("127.0.0.1"), 80);
  2. ip::tcp::socket sock(service);
  3. sock.open(ip::tcp::v4()); n
  4. sock.connect(ep);
  5. sock.write_some(buffer("GET /index.html\r\n"));
  6. char buff[1024]; sock.read_some(buffer(buff,1024));
  7. sock.shutdown(ip::tcp::socket::shutdown_receive);
  8. sock.close();

  读写函数
  这些是在套接字上执行I/O操作的函数
  对于异步函数来说,处理程序的签名void handler(const boost::system::error_code& e, size_t bytes)都是一样的.
  
  async_receive(buffer, [flags,] handler):这个函数启动从套接字异步receive数据的操作。
  async_read_some(buffer,handler):这个函数和async_receive(buffer, handler)功能一样。
  async_receive_from(buffer, endpoint[, flags], handler):这个函数启动从一个指定端点异步receive数据的操作。
  async_send(buffer [, flags], handler):这个函数启动了一个异步send缓冲区数据的功能。
  async_write_some(buffer, handler):这个函数和async_send(buffer, handler)功能一致。
  async_send_to(buffer, endpoint, handler):这个函数启动了一个异步send缓冲区数据到指定端点的功能。
  receive(buffer [, flags]):这个函数异步地从所给的缓冲区读取数据。在读完所有数据或者错误出现之前,这个函数都是阻塞的。
  read_some(buffer):这个函数的功能和receive(buffer)是一致的。
  receive_from(buffer, endpoint [, flags]):这个函数异步地从一个指定的端点获取数据并写入到给定的缓冲区。在读完所有数据或者错误出现之前,这个函数都是阻塞的。
  send(buffer [, flags]):这个函数同步地发送缓冲区的数据。在所有数据发送成功或者出现错误之前,这个函数都是阻塞的。
  write_some(buffer):这个函数和send(buffer)的功能一致。
  send_to(buffer, endpoint [, flags]):这个函数同步地把缓冲区数据发送到一个指定的端点。在所有数据发送成功或者出现错误之前,这个函数都是阻塞的。
  available():这个函数返回有多少字节的数据可以无阻塞地进行同步读取。

  稍后我们将讨论缓冲区。让我们先来了解一下标记。标记的默认值是0,但是也可以是以下几种:
  ip::socket_type::socket::message_peek:这个标记只监测消息。它会返回这个消息,但是下一次读消息的调用会重新读取这个消息。
  ip::socket_type::socket::message_out_of_band:这个标记处理带外(OOB)数据,OOB数据是被标记为比正常数据更重要的数据。关于OOB的讨论在这本书的内容之外。
  ip::socket_type::socket::message_do_not_route:这个标记指定数据不使用路由表来发送。
  ip::socket_type::socket::message_end_of_record:这个标记指定的数据标识了记录的结束。在Windows下不支持。

  你最有可能使用message_peek,如果使用请参照下面的代码片段:

  1. char buff[1024];
  2. sock.receive(buffer(buff), ip::tcp::socket::message_peek );
  3. memset(buff,1024, 0);
  4. // re-reads what was previously read
  5. sock.receive(buffer(buff) );

  
  下面的是一些告诉你如何同步或异步地从不同类型的套接字读取数据的例子:
  例子1是对一个TCP套接字进行同步的读写:

  1. ip::tcp::endpoint ep( ip::address::from_string("127.0.0.1"), 80);
  2. ip::tcp::socket sock(service);
  3. sock.connect(ep);
  4. sock.write_some(buffer("GET /index.html\r\n"));
  5. std::cout << "bytes available " << sock.available() << std::endl;
  6. char buff[512];
  7. size_t read = sock.read_some(buffer(buff));

  
  例子2是读一个UDP套接字进行同步的读写:

  1. ip::udp::socket sock(service);
  2. sock.open(ip::udp::v4());
  3. ip::udp::endpoint receiver_ep("87.248.112.181", 80);
  4. sock.send_to(buffer("testing\n"), receiver_ep);
  5. char buff[512];
  6. ip::udp::endpoint sender_ep;
  7. sock.receive_from(buffer(buff), sender_ep);

[?注意:像上面代码片段展示的那样,使用receive_from从一个UDP套接字读取时,你需要一个默认构造的端点]

  例子3是从一个UDP服务套接字中异步读取数据:

  1. using namespace boost::asio;
  2. io_service service;
  3. ip::udp::socket sock(service);
  4. boost::asio::ip::udp::endpoint sender_ep;
  5. char buff[512];
  6. void on_read(const boost::system::error_code & err, std::size_t read_bytes) {
  7. std::cout << "read " << read_bytes << std::endl;
  8. sock.async_receive_from(buffer(buff), sender_ep, on_read);
  9. }
  10. int main(int argc, char* argv[]) {
  11. ip::udp::endpoint ep( ip::address::from_string("127.0.0.1"), 8001);
  12. sock.open(ep.protocol());
  13. sock.set_option(boost::asio::ip::udp::socket::reuse_
  14. address(true));
  15. sock.bind(ep);
  16. sock.async_receive_from(buffer(buff,512), sender_ep, on_read);
  17. service.run();
  18. }

  
  套接字控制
  这些函数用来处理套接字的高级选项:
  get_io_service():这个函数返回构造函数中传入的io_service实例
  get_option(option):这个函数返回一个套接字的属性
  set_option(option):这个函数设置一个套接字的属性
  io_control(cmd):这个函数在套接字上执行一个I/O指令

  
  这些是你可以获取/设置的套接字选项:

名字 描述 类型
broadcast 如果为true,允许广播消息 bool
debug 如果为true,启用套接字级别的调试 bool
do_not_route 如果为true,则阻止路由选择只使用本地接口 bool
enable_connection_aborted 如果为true,记录在accept()时中断的连接 bool
keep_alive 如果为true,会发送心跳 bool
linger 如果为true,套接字会在有未发送数据的情况下挂起close() bool
receive_buffer_size 套接字接收缓冲区大小 int
receive_low_watemark 规定套接字输入处理的最小字节数 int
reuse_address 如果为true,套接字能绑定到一个已用的地址 bool
send_buffer_size 套接字发送缓冲区大小 int
send_low_watermark 规定套接字数据发送的最小字节数 int
ip::v6_only 如果为true,则只允许IPv6的连接 bool

  每个名字代表了一个内部套接字typedef或者类。下面是对它们的使用:

  1. ip::tcp::endpoint ep( ip::address::from_string("127.0.0.1"), 80);
  2. ip::tcp::socket sock(service);
  3. sock.connect(ep);
  4. // TCP socket can reuse address
  5. ip::tcp::socket::reuse_address ra(true);
  6. sock.set_option(ra);
  7. // get sock receive buffer size
  8. ip::tcp::socket::receive_buffer_size rbs;
  9. sock.get_option(rbs);
  10. std::cout << rbs.value() << std::endl;
  11. // set sock's buffer size to 8192
  12. ip::tcp::socket::send_buffer_size sbs(8192);
  13. sock.set_option(sbs);

[?在上述特性工作之前,套接字要被打开。否则,会抛出异常]

  TCP VS UDP VS ICMP
  就像我之前所说,不是所有的成员方法在所有的套接字类中都可用。我做了一个包含成员函数不同点的列表。如果一个成员函数没有出现在这,说明它在所有的套接字类都是可用的。

名字 TCP UDP ICMP
async_read_some - -
async_receive_from -
async_write_some - -
async_send_to -
read_some - -
receive_from -
write_some - -
send_to -

  其他方法
  其他与连接和I/O无关的函数如下:
  local_endpoint():这个方法返回套接字本地连接的地址。
  remote_endpoint():这个方法返回套接字连接到的远程地址。
  native_handle():这个方法返回原始套接字的处理程序。你只有在调用一个Boost.Asio不支持的原始方法时才需要用到它
  non_blocking():如果套接字是非阻塞的,这个方法返回true,否则false
  native_non_blocking():如果套接字是非阻塞的,这个方法返回true,否则返回false。但是,它是基于原生的套接字来调用本地的api。所以通常来说,你不需要调用这个方法(non_blocking()已经缓存了这个结果);你只有在直接调用native_handle()这个方法的时候猜需要使用到这个方法
  at_mark():如果套接字要读的是一段OOB数据,这个方法返回true。这个方法你很少会用到

  其他的考虑
  最后要注意,一个套接字实例不能被拷贝,因为拷贝构造方法和=操作符是不可访问的。

  1. ip::tcp::socket s1(service), s2(service);
  2. s1 = s2; // 编译时报错
  3. ip::tcp::socket s3(s1); // 编译时报错

这是非常有意义的,因为每一个实例都拥有并管理着一个资源(原生套接字本身)。如果我们允许拷贝构造,结果是我们会有两个实例拥有同样的原生套接字;这样我们就需要去处理所有者的问题(让一个实例拥有所有权?或者使用引用计数?还是其他的方法)Boost.Asio选择不允许拷贝(如果你想要创建一个备份,请使用共享指针)

  1. typedef boost::shared_ptr<ip::tcp::socket> socket_ptr;
  2. socket_ptr sock1(new ip::tcp::socket(service));
  3. socket_ptr sock2(sock1); // ok
  4. socket_ptr sock3;
  5. sock3 = sock1; // ok

  套接字缓冲区

  当从一个套接字读写内容时,你需要一个缓冲区,用来保存读入和写出的数据。缓冲区内存的有效时间必须比I/O操作的时间要长;你需要保证它们在I/O操作结束之前不被释放。

  对于同步操作来说,这很容易;当然,这个缓冲区在receive和send时都存在。

  1. char buff[512];
  2. ...
  3. sock.receive(buffer(buff));
  4. strcpy(buff, "ok\n");
  5. sock.send(buffer(buff));

  但是在异步操作时就这么简单了,看下面的代码片段:

  1. // 非常差劲的代码 ...
  2. void on_read(const boost::system::error_code & err, std::size_t read_bytes){
  3. ...
  4. }
  5. void func() {
  6. char buff[512];
  7. sock.async_receive(buffer(buff), on_read);
  8. }

  在我们调用async_receive()之后,buff就已经超出有效范围,它的内存当然会被释放。当我们开始从套接字接收一些数据时,我们会把它们拷贝到一片已经不属于我们的内存中;它可能会被释放,或者被其他代码重新开辟来存入其他的数据,结果就是:内存冲突。

  对于上面的问题有几个解决方案:
  使用全局缓冲区
  创建一个缓冲区,然后在操作结束时释放它
  使用一个集合对象管理这些套接字和其他的数据,比如缓冲区数组
  第一个方法显然不是很好,因为我们都知道使用全局变量很不好。此外,如果两个实例使用同一个缓冲区怎么办?

  下面是第二种方式的实现:

  1. void on_read(char * ptr, const boost::system::error_code & err, std::size_t read_bytes) {
  2. delete[] ptr;
  3. }
  4. ....
  5. char * buff = new char[512];
  6. sock.async_receive(buffer(buff, 512), boost::bind(on_read,buff,_1,_2))

  或者,如果你想要缓冲区在操作结束后自动超出范围,使用共享指针

  1. struct shared_buffer {
  2. boost::shared_array<char> buff;
  3. int size;
  4. shared_buffer(size_t size) : buff(new char[size]), size(size) {
  5. }
  6. mutable_buffers_1 asio_buff() const {
  7. return buffer(buff.get(), size);
  8. }
  9. };
  10. // 当on_read超出范围时, boost::bind对象被释放了,
  11. // 同时也会释放共享指针
  12. void on_read(shared_buffer, const boost::system::error_code & err, std::size_t read_bytes) {}
  13. sock.async_receive(buff.asio_buff(), boost::bind(on_read,buff,_1,_2));

  shared_buffer类拥有实质的shared_array<>shared_array<>存在的目的是用来保存shared_buffer实例的拷贝-当最后一个share_array<>元素超出范围时,shared_array<>就被自动销毁了,而这就是我们想要的结果。

  因为Boost.Asio会给完成处理句柄保留一个拷贝,当操作完成时就会调用这个完成处理句柄,所以你的目的达到了。那个拷贝是一个boost::bind的仿函数,它拥有着实际的shared_buffer实例。这是非常优雅的!

  第三个选择是使用一个连接对象来管理套接字和其他数据,比如缓冲区,通常来说这是正确的解决方案但是非常复杂。在这一章的末尾我们会对这种方法进行讨论。

  缓冲区函数包装
  纵观所有代码你会发现:无论什么时候,当我们需要对一个buffer进行读写操作时,代码会把实际的缓冲区对象包装在一个buffer()方法中,然后在把它传递给方法调用:

  1. char buff[512];
  2. sock.async_receive(buffer(buff), on_read);

  基本来说我们把任何缓冲区包含在一个类中以便Boost.Asio的方法能遍历这个缓冲区,比方说,你使用下面的代码:

  1. sock.async_receive(some_buffer, on_read);

  实例some_buffer会遇到一些需求,叫做ConstBufferSequence或者MutableBufferSequence(你可以在Boost.Asio的文档中查看它们)。创建你自己的类去处理这些需求的细节是非常复杂的,但是Boost.Asio已经提供了一些类用来处理这些需求。所以你不用直接访问这些缓冲区,而使用buffer()方法。

自信地讲,你可以把下面列出来的类型都包装到一个buffer()方法中:
一个char[] const 数组
一个字节大小的void *指针
一个std::string类型的字符串
一个POD const数组(POD代表纯数据,不做任何操作的构造器和释放器)
一个pod数据的std::vector
一个包含pod数据的boost::array
一个包含pod数据的std::array

下面的代码都是有效的:

  1. struct pod_sample { int i; long l; char c; };
  2. ...
  3. char b1[512];
  4. void * b2 = new char[512];
  5. std::string b3; b3.resize(128);
  6. pod_sample b4[16];
  7. std::vector<pod_sample> b5; b5.resize(16);
  8. boost::array<pod_sample,16> b6;
  9. std::array<pod_sample,16> b7;
  10. sock.async_send(buffer(b1), on_read);
  11. sock.async_send(buffer(b2,512), on_read);
  12. sock.async_send(buffer(b3), on_read);
  13. sock.async_send(buffer(b4), on_read);
  14. sock.async_send(buffer(b5), on_read);
  15. sock.async_send(buffer(b6), on_read);
  16. sock.async_send(buffer(b7), on_read);

  总的来说就是:与其创建你自己的类来处理ConstBufferSequence或者MutableBufferSequence的需求,不如创建一个能在你需要的的时候保留缓冲区,然后返回一个mutable_buffers_1实例的类,而我们早在shared_buffer类中就这样做了。

  read/write/connect自由函数
  Boost.Asio提供了自由函数来让你处理I/O,我们分四组来分析它们。

  connect方法
  这些方法把套接字连接到一个端点。
  connect(socket, begin [, end] [, condition]):这个方法通过尝试队列中从start到end的端点来同步连接。begin迭代器是socket_type::resolver::query调用的返回结果(你可能需要回顾一下端点这个章节)。特别提示end迭代器是可选的;你可以忽略它。你可以提供一个condition的方法供每次连接尝试之后调用。用法是Iterator connect_condition(const boost::system::error_code & err, Iterator next);。你可以选择返回一个不是next的迭代器,这样就你可以跳过一些端点。
  async_connect(socket, begin [, end] [, condition], handler):这个方法异步地调用连接方法,在结束时,它会调用完成处理方法。用法是void handler(const boost::system::error_code & err, Iterator iterator);。传递给处理方法的第二个参数是连接成功的端点的迭代器。(或者end迭代器)。
  它的例子如下:

  1. using namespace boost::asio::ip;
  2. tcp::resolver resolver(service);
  3. tcp::resolver::iterator iter = resolver.resolve( tcp::resolver::query("www.yahoo.com","80"));
  4. tcp::socket sock(service);
  5. connect(sock, iter);

  一个主机名可以被解析成多个地址,而connectasync_connect能让你很好的从尝试每个地址然后找到一个可用地址的繁重工作中解放出来,因为它们已经帮你做了这些。

  read/write方法
  这些方法对一个流进行读写操作(可以是套接字,或者其他表现的像流的类):

  async_read(stream, buffer [, completion],handler):这个方法异步地从一个流读取。结束时,处理方法被调用。处理方法的格式是:void handler(const boost::system::error_code & err, size_t bytes);。你可以选择指定一个完成处理方法。完成处理方法会在每个read操作调用成功之后调用,然后告诉Boost.Asio async_read操作是否完成(如果没有完成,它会继续读取)。它的格式是:size_t completion(const boost::system::error_code& err, size_t bytes_transfered) 。当这个完成处理方法返回0时,我们认为read操作完成;如果它返回一个非0值,它表示了下一个async_read_some操作需要从流中读取的字节数。

  接下来会有一个例子来详细展示这些。
  async_write(stream, buffer [, completion],handler):这个方法异步地向一个流写入数据。参数的意义和async_read是一样的。
  read(stream, buffer [, completion]):这个方法同步地从一个流中读取数据。参数的意义和async_read是一样的。
  write(stream, buffer [, completion]): 这个方法同步地向一个流写入数据。参数的意义和async_read是一样的。

  1. async_read(stream,stream_buffer [, completion], handler)
  2. async_write(strean,stream_buffer [, completion], handler)
  3. write(stream, stream_buffer[, completion])
  4. read(stream, stream_buffer[, completion])

  首先,要注意第一个参数变成了流,而不单是socket。这个包含了socket但不仅仅是socket。比如,你可以用一个Windows的文件句柄来替代socket。

  当下面情况出现时,所有read和write操作都会结束:
  可用的缓冲区满了(当读取时)或者所有的缓冲区已经被写入(当写入时)。
  完成处理方法返回0(如果你提供了这么一个方法)

  错误发生时

下面的代码会异步地从一个socket中间读取数据直到读取到’\n’:

  1. io_service service;
  2. ip::tcp::socket sock(service);
  3. char buff[512];
  4. int offset = 0;
  5. size_t up_to_enter(const boost::system::error_code &, size_t bytes) {
  6. for( size_t i = 0; i < bytes; ++i) {
  7. if ( buff[i + offset] == '\n')
  8. return 0;
  9. return 1;
  10. }
  11. void on_read(const boost::system::error_code &, size_t) {}
  12. ...
  13. async_read(sock, buffer(buff), up_to_enter,on_read);

  Boost.Asio也提供了一些简单的完成处理仿函数:
  • transfer_at_least(n)
  • transfer_exactly(n)
  • transfer_all()

  例子如下:

  1. char buff[512];
  2. void on_read(constboost::system::error_code &, size_t) {}
  3. // 读取32个字节
  4. async_read(sock, buffer(buff),transfer_exactly(32), on_read);

  上述的4个方法,不使用普通的缓冲区,而使用由Boost.Asio的std::streambuf类继承来的stream_buffer方法,stl流和流缓冲区非常复杂;下面是例子:

  1. io_service service;
  2. void on_read(streambuf& buf, constboost::system::error_code &, size_t) {
  3. std::istream in(&buf);
  4. std::string line;
  5. std::getline(in, line);
  6. std::cout << "first line: "<< line << std::endl;
  7. }
  8. int main(int argc, char* argv[]) {
  9. HANDLE file =::CreateFile("readme.txt", GENERIC_READ, 0, 0,
  10. OPEN_ALWAYS,
  11. FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
  12. 0);
  13. windows::stream_handle h(service, file);
  14. streambuf buf;
  15. async_read(h, buf,
  16. transfer_exactly(256),
  17. boost::bind(on_read, boost::ref(buf), _1, _2) );
  18. service.run();
  19. }

  在这里,我向你们展示了在一个Windows文件句柄上调用async_read。我们读取了前面的256个字符,然后把它们保存到缓冲区,当操作结束时。on_read被调用,然后创建std::istream来传递缓冲区,读取第一行(std::getline),最后把它输出到命令行中。

  
  read_until/async_read_until方法

  这些方法在条件满足之前一直读取:

  async_read_until(stream, stream_buffer,delim, handler):这个方法启动一个异步read操作。read操作会在读取到某个分隔符时结束。分隔符可以是字符, std::string或者boost::regex。处理方法的格式为:void handler(const boost::system::error_code & err, size_t bytes);。

  async_read_until(strem, stream_buffer,completion, handler):这个方法和之前的方法是一样的,但是没有分隔符,而是一个完成处理方法。完成处理方法的格式为:pair<iterator,bool> completion(iterator begin, iterator end);,其中迭代器的类型为buffers_iterator<streambuf::const_buffers_type>。你需要记住的是迭代器的类型是随机访问的迭代器。你扫描整个区间(begin,end),然后觉得read操作是否应该结束。你会返回一个结果对,第一个成员是一个指向最后被这个方法访问的字符的迭代器;第二个成员当read操作需要结束时返回true,否则返回false。
  read_until(stream, stream_buffer, delim):这个方法执行一个同步的read操作,参数的意义和async_read_until一样。

  read_until(stream, stream_buffer,completion):这个方法执行一个同步的read操作,参数的意义和async_read_until一样。

  下面这个例子会一直读取直到读到一个指定的标点符号

  1. typedef buffers_iterator<streambuf::const_buffers_type> iterator;
  2. std::pair<iterator, bool>match_punct(iterator begin, iterator end) {
  3. while ( begin != end)
  4. if ( std::ispunct(*begin))
  5. return std::make_pair(begin,true);
  6. return std::make_pair(end,false);
  7. }
  8. void on_read(constboost::system::error_code &, size_t) {}
  9. ...
  10. streambuf buf;
  11. async_read_until(sock, buf, match_punct,on_read);

  如果我们想读到一个空格结束,我们需要把最后一行修改为:

  1. async_read_until(sock, buff, ' ', on_read);

  _at方法
  这些方法在一个流上面做随机存取操作。你来指定read和write操作从什么地方开始(offset):
  
  async_read_at(stream, offset, buffer [, completion], handler):这个方法在一个指定的流上从offset处开始执行一个异步的read操作,当操作结束时,他会调用handler。handler的格式为:void handler(const boost::system::error_code& err, size_t bytes);。buffer可以是普通的wrapper()包装或者streambuf方法。如果你指定一个completion方法,它会在每次read操作成功之后调用,然后告诉Boost.Asio async_read_at操作已经完成(如果没有,则继续读取)。它的格式为:size_t completion(const boost::system::error_code& err, size_t bytes);。当completion方法返回0时,我们认为read操作完成了;如果返回一个非零值。它代表了下一次调用流的async_read_some_at方法的最大读取字节数。
  async_write_at(stream, offset, buffer [, completion], handler):这个方法执行一个异步的write操作。参数的意义和async_read_at是一样的
  read_at(stream, offset, buffer [, completion]):这个方法在一个执行的流上,指定的offset处开始read。参数的意义和async_read_at是一样的
  write_at(stream, offset, buffer [, completion]):这个方法在一个执行的流上,指定的offset处开始write。参数的意义和async_read_at是一样的
  
  这些方法不支持套接字。它们用来处理流的随机访问;也就是说,流是可以随机访问的。套接字显然不是这样(套接字是不可返回的)
  下面这个例子告诉你怎么从一个文件偏移为256的位置读取128个字节:

  1. io_service service;
  2. int main(int argc, char* argv[]) {
  3. HANDLE file = ::CreateFile("readme.txt", GENERIC_READ, 0, 0,
  4. OPEN_ALWAYS,
  5. FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
  6. 0);
  7. windows::random_access_handle h(service, file);
  8. streambuf buf;
  9. read_at(h, 256, buf, transfer_exactly(128));
  10. std::istream in(&buf);
  11. std::string line;
  12. std::getline(in, line);
  13. std::cout << "first line: " << line << std::endl;
  14. }

  异步编程
  这个部分对你在进行异步编程时可能碰到的一些问题进行了深入的探究。再读了一遍之后,我建议你在接下来学习这本书的时候,经常回过头来再读读,从而增强你对这部分的理解。
  
  异步的需求
  就像我之前所说的,同步编程比异步编程简单很多。这是因为,线性的思考是很简单的(调用A,调用A结束,调用B,调用B结束,然后继续,这是以事件处理的方式来思考)。在后面的你会碰到这种情况,比如:五件事情,你不知道它们执行的顺序,也不知道他们是否会执行!
  尽管异步编程更难,但是你会更倾向于它,比如:写一个需要处理很多并发访问的服务端。并发访问越多,异步编程就比同步编程越简单。
  假设:你有一个软件处理1000个并发访问,每个信息都从客户端发给服务端,然后再返回给客户端,以‘\n’结尾。
  
  同步方式的代码,1个线程:

  1. using namespace boost::asio;
  2. struct client {
  3. ip::tcp::socket sock;
  4. char buff[1024]; // each msg is at maximum this size
  5. int already_read; // how much have we already read?
  6. };
  7. std::vector<client> clients;
  8. void handle_clients() {
  9. while ( true)
  10. for ( int i = 0; i < clients.size(); ++i)
  11. if ( clients[i].sock.available() ) on_read(clients[i]);
  12. }
  13. void on_read(client & c) {
  14. int to_read = std::min( 1024 - c.already_read, c.sock.available());
  15. c.sock.read_some( buffer(c.buff + c.already_read, to_read));
  16. c.already_read += to_read;
  17. if ( std::find(c.buff, c.buff + c.already_read, '\n') < c.buff + c.already_read) {
  18. int pos = std::find(c.buff, c.buff + c.already_read, '\n') - c.buff;
  19. std::string msg(c.buff, c.buff + pos);
  20. std::copy(c.buff + pos, c.buff + 1024, c.buff);
  21. c.already_read -= pos;
  22. on_read_msg(c, msg);
  23. }
  24. }
  25. void on_read_msg(client & c, const std::string & msg) {
  26. // analyze message, and write back
  27. if ( msg == "request_login")
  28. c.sock.write( "request_ok\n");
  29. else if ...
  30. }

  有一件事情是你在任何服务端(和任何基于网络的软件)都需要避免的,就是代码不再响应。在我们例子里,我们需要handle_clients()方法尽可能少的阻塞。如果放在在任何点上阻塞,任何进来的信息都需要等待方法解除阻塞然后再去处理它们。
为了保持响应,我们只在一个套接字有数据的时候我们才读,也就是说,

  1. if (clients[i].sock.available() )
  2. on_read(clients[i])。

on_read时,我们只读可用的;调用read_until(c.sock, buffer(...), '\n')会是一个非常糟糕的选择,因为直到我们从一个选定的客户端读取了完整的消息之前,它都会是阻塞的(我们永远不知道它什么时候会读取到完整的消息)
  这里的瓶颈就是on_read_msg()方法;当它执行时,所以进来的消息都在等待。一个良好的on_read_msg()方法实现会保证这种情况基本不会发生,但是它还是会发生(有些时候向一个套接字写入数据时,当他的缓冲区满了,它会被阻塞)
  同步方式的代码,10个线程

  1. using namespace boost::asio;
  2. struct client {
  3. // ... same as before
  4. bool set_reading() {
  5. boost::mutex::scoped_lock lk(cs_);
  6. if ( is_reading_) {
  7. return false; // already reading
  8. } else {
  9. is_reading_ = true; return true;
  10. }
  11. }
  12. void unset_reading() {
  13. boost::mutex::scoped_lock lk(cs_);
  14. is_reading_ = false;
  15. }
  16. private:
  17. boost::mutex cs_;
  18. bool is_reading_;
  19. };
  20. std::vector<client> clients;
  21. void handle_clients() {
  22. for ( int i = 0; i < 10; ++i)
  23. boost::thread( handle_clients_thread);
  24. }
  25. void handle_clients_thread() {
  26. while ( true) {
  27. for ( int i = 0; i < clients.size(); ++i) {
  28. if ( clients[i].sock.available() ) {
  29. if ( clients[i].set_reading()) {
  30. on_read(clients[i]);
  31. clients[i].unset_reading();
  32. }
  33. }
  34. }
  35. }
  36. }
  37. void on_read(client & c) {
  38. // same as before
  39. }
  40. void on_read_msg(client & c, const std::string & msg) {
  41. // same as before
  42. }

  为了使用多线程,我们需要对它进行同步,这就是set_reading()set_unreading()所做的。set_reading()方法非常重要,你想要一步实现“测试读取然后标记为读取中”。如果你有两步(“测试读取”和“标记为读取中”),你可能会有两个线程同时为一个客户端做测试读取操作,然后你会有两个线程同时为一个客户端调用on_read,结果就是数据冲突甚至可能导致软件崩溃。
  你会发现代码变得极其复杂。
  同步编程有第三个选择,就是为每个连接开辟一个线程。当时当并发的线程增加时,这就变成了一个最不能出现的情况。
  然后,让我们来看异步编程。我们不断的异步读取。当一个客户端请求某些东西时,on_read被调用,然后回应,然后等待下一个请求(然后开始另外一个异步的read操作)。
  异步方式的代码,10个线程

  1. using namespace boost::asio;
  2. io_service service;
  3. struct client {
  4. ip::tcp::socket sock;
  5. streambuf buff; // reads the answer from the client
  6. }
  7. std::vector<client> clients;
  8. void handle_clients() {
  9. for ( int i = 0; i < clients.size(); ++i)
  10. async_read_until(clients[i].sock,
  11. clients[i].buff,
  12. '\n',
  13. boost::bind(on_read, clients[i], _1, _2));
  14. for ( int i = 0; i < 10; ++i)
  15. boost::thread(handle_clients_thread);
  16. }
  17. void handle_clients_thread() {
  18. service.run();
  19. }
  20. void on_read(client & c, const error_code & err, size_t read_bytes) {
  21. std::istream in(&c.buff);
  22. std::string msg;
  23. std::getline(in, msg);
  24. if ( msg == "request_login")
  25. c.sock.async_write( "request_ok\n", on_write);
  26. else if ...
  27. ...
  28. // now, wait for the next read from the same client
  29. async_read_until(c.sock, c.buff, '\n', boost::bind(on_read, c, _1, _2));
  30. }

  发现代码变得有多简单了吧?client结构里面只有两个成员,handle_clients()仅仅调用了async_read_until,然后它创建了10个线程,每个都调用service.run()。这些线程会处理任何来自客户端的异步read操作,然后分发任何向客户端的异步write操作。另外一件需要注意的事情是:on_read()一直在为下一次异步read操作做准备(看最后一行代码)

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注