2. 同步Timer

本章介紹asio如何在定時器上進行阻塞等待( blocking wait ). 
實現,我們包含必要的頭文件. 
所有的asio類可以簡單的通過 include "asio.hpp" 來調用.

1. #include <iostream>
2. #include <boost/asio.hpp>

此外,這個示例用到了 timer ,我們還要包含 Boost.Date_Time 的頭文件來控制時間.

1. #include <boost/date_time/posix_time/posix_time.hpp>

使用asio至少需要一個 boost::asio::io_service 對象.該類提供了訪問I/O的功能.我們首先在main函數中聲明它.

1. int main()
2. {
3.     boost::asio::io_service io;

下一步我們聲明 boost::asio::deadline_timer 對象.這個asio的核心類提供I/O的功能(這里更確切的說是定時功能),總是把一個 io_service 對象作為他的第一個構造函數,而第二個構造函數的參數設定timer會在5秒后到時(expired).

1. boost::asio::deadline_timer t(io, boost::posix_time::seconds(5));

這個簡單的示例中我們演示了定時器上的一個阻塞等待.就是說,調用 boost::asio::deadline_timer::wait() 的在創建后5秒內(注意:不是等待開始后),timer到時之前不會返回任何值. 
一個 deadline_timer 只有兩種狀態: 到時 , 未到時 . 
如果 boost::asio::deadline_timer::wait() 在到時的timer對象上調用,會立即return.

1. t.wait();

最后,我們輸出理所當然的"Hello, world!"來演示timer到時了.

1.     std::cout << "Hello, world! ";
2.     return 0;
3. }

完整的代碼:

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/date_time/posix_time/posix_time.hpp>
4. int main()
5. {
6.     boost::asio::io_service io;
7.     boost::asio::deadline_timer t(io, boost::posix_time::seconds(5));
8.     t.wait();
9.     std::cout << "Hello, world! ";
10.     return 0;
11. }

 

3. 異步Timer

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/date_time/posix_time/posix_time.hpp>

asio的異步函數會在一個異步操作完成后被回調.這里我們定義了一個將被回調的函數.

1. void print(const asio::error& /*e*/)
2. {
3.     std::cout << "Hello, world! ";
4. }
5. int main()
6. {
7.     asio::io_service io;
8.     asio::deadline_timer t(io, boost::posix_time::seconds(5));

這里我們調用 asio::deadline_timer::async_wait() 來異步等待

1. t.async_wait(print);

最后,我們必須調用 asio::io_service::run() . 
asio庫只會調用那個正在運行的 asio::io_service::run() 的回調函數. 
如果 asio::io_service::run() 不被調用,那么回調永遠不會發生. 
asio::io_service::run() 會持續工作到點,這里就是timer到時,回調完成. 
別忘了在調用  asio::io_service::run() 之前設置好io_service的任務.比如,這里,如果我們忘記先調用 asio::deadline_timer::async_wait() 則 asio::io_service::run() 會在瞬間return.

1.     io.run();
2.     return 0;
3. }

完整的代碼:

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/date_time/posix_time/posix_time.hpp>
4. void print(const asio::error& /*e*/)
5. {
6.     std::cout << "Hello, world! ";
7. }
8. int main()
9. {
10.     asio::io_service io;
11.     asio::deadline_timer t(io, boost::posix_time::seconds(5));
12.     t.async_wait(print);
13.     io.run();
14.     return 0;
15. }

4. 回調函數的參數

這里我們將每秒回調一次,來演示如何回調函數參數的含義

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>

首先,調整一下timer的持續時間,開始一個異步等待.顯示,回調函數需要訪問timer來實現周期運行,所以我們再介紹兩個新參數

• 指向timer的指針
• 一個int*來指向計數器

1. void print(const asio::error& /*e*/,
2.     asio::deadline_timer* t, int* count)
3. {

我們打算讓這個函數運行6個周期,然而你會發現這里沒有顯式的方法來終止io_service.不過,回顧上一節,你會發現當 asio::io_service::run()會在所有任務完成時終止.這樣我們當計算器的值達到5時(0為第一次運行的值),不再開啟一個新的異步等待就可以了.

1.     if (*count < 5)
2.     {
3.         std::cout << *count << " ";
4.         ++(*count);
5. ...

然后,我們推遲的timer的終止時間.通過在原先的終止時間上增加延時,我們可以確保timer不會在處理回調函數所需時間內的到期. 
(原文:By calculating the new expiry time relative to the old, we can ensure that the timer does not drift away from the whole-second mark due to any delays in processing the handler.)

1. t->expires_at(t->expires_at() + boost::posix_time::seconds(1));

然后我們開始一個新的同步等待.如您所見,我們用把print和他的多個參數用boost::bind函數合成一個的形為void(const asio::error&)回調函數(准確的說是function object). 
在這個例子中, boost::bind的asio::placeholders::error參數是為了給回調函數傳入一個error對象.當進行一個異步操作,開始 boost::bind時,你需要使用它來匹配回調函數的參數表.下一節中你會學到回調函數不需要error參數時可以省略它.

1.      t->async_wait(boost::bind(print,
2.         asio::placeholders::error, t, count));
3.     }
4. }
5. int main()
6. {
7.     asio::io_service io;
8.     int count = 0;
9.     asio::deadline_timer t(io, boost::posix_time::seconds(1));

和上面一樣,我們再一次使用了綁定asio::deadline_timer::async_wait()

1. t.async_wait(boost::bind(print,
2.     asio::placeholders::error, &t, &count));
3. io.run();

在結尾,我們打印出的最后一次沒有設置timer的調用的count的值

1.     std::cout << "Final count is " << count << " ";
2.     return 0;
3. }

完整的代碼:

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>
5. void print(const asio::error& /*e*/,
6.   bsp;     asio::deadline_timer* t, int* count)
7. {
8.     if (*count < 5)
9.     {
10.         std::cout << *count << " ";
11.         ++(*count);
12.         t->expires_at(t->expires_at() + boost::posix_time::seconds(1));
13.         t->async_wait(boost::bind(print,
14.                     asio::placeholders::error, t, count));
15.     }
16. }
17. int main()
18. {
19.     asio::io_service io;
20.     int count = 0;
21.     asio::deadline_timer t(io, boost::posix_time::seconds(1));
22.     t.async_wait(boost::bind(print,
23.                 asio::placeholders::error, &t, &count));
24.     io.run();
25.     std::cout << "Final count is " << count << " ";
26.     return 0;
27. }

 

5. 成員函數作為回調函數

本例的運行結果和上一節類似

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>

我們先定義一個printer類

1. class printer
2. {
3. public:
4. //構造函數有一個io_service參數,並且在初始化timer_時用到了它.用來計數的count_這里同樣作為了成員變量
5.     printer(boost::asio::io_service& io)
6.         : timer_(io, boost::posix_time::seconds(1)),
7.             count_(0)
8.     {

boost::bind 同樣可以出色的工作在成員函數上.眾所周知,所有的非靜態成員函數都有一個隱式的this參數,我們需要把this作為參數bind到成員函數上.和上一節類似,我們再次用bind構造出void(const boost::asio::error&)形式的函數. 
注意,這里沒有指定boost::asio::placeholders::error占位符,因為這個print成員函數沒有接受一個error對象作為參數.

1. timer_.async_wait(boost::bind(&printer::print, this));
2.  

在類的折構函數中我們輸出最后一次回調的count的值

1. ~printer()
2. {
3.     std::cout << "Final count is " << count_ << " ";
4. }

print函數於上一節的十分類似,但是用成員變量取代了參數.

1.     void print()
2.     {
3.         if (count_ < 5)
4.         {
5.             std::cout << count_ << " ";
6.             ++count_;
7.             timer_.expires_at(timer_.expires_at() + boost::posix_time::seconds(1));
8.             timer_.async_wait(boost::bind(&printer::print, this));
9.         }
10.     }
11. private:
12.     boost::asio::deadline_timer timer_;
13.     int count_;
14. };
15.  

現在main函數清爽多了,在運行io_service之前只需要簡單的定義一個printer對象.

1. int main()
2. {
3.     boost::asio::io_service io;
4.     printer p(io);
5.     io.run();
6.     return 0;
7. }

完整的代碼:

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>
5. class printer
6. {
7.     public:
8.         printer(boost::asio::io_service& io)
9.             : timer_(io, boost::posix_time::seconds(1)),
10.             count_(0)
11.     {
12.         timer_.async_wait(boost::bind(&printer::print, this));
13.     }
14.         ~printer()
15.         {
16.             std::cout << "Final count is " << count_ << " ";
17.         }
18.         void print()
19.         {
20.             if (count_ < 5)
21.             {
22.                 std::cout << count_ << " ";
23.                 ++count_;
24.                 timer_.expires_at(timer_.expires_at() + boost::posix_time::seconds(1));
25.                 timer_.async_wait(boost::bind(&printer::print, this));
26.             }
27.         }
28.     private:
29.         boost::asio::deadline_timer timer_;
30.         int count_;
31. };
32. int main()
33. {
34.     boost::asio::io_service io;
35.     printer p(io);
36.     io.run();
37.     return 0;
38. }

 

 

6. 多線程回調同步

本節演示了使用 boost::asio::strand在多線程程序中進行回調同步(synchronise). 
先前的幾節闡明了如何在單線程程序中用 boost::asio::io_service::run()進行同步.如您所見,asio庫確保 僅當當前線程調用 boost::asio::io_service::run()時產生回調.顯然,僅在一個線程中調用  boost::asio::io_service::run() 來確保回調是適用於並發編程的. 
一個基於asio的程序最好是從單線程入手,但是單線程有如下的限制,這一點在服務器上尤其明顯:

• 當回調耗時較長時,反應遲鈍.
• 在多核的系統上無能為力

如果你發覺你陷入了這種困擾,可以替代的方法是建立一個 boost::asio::io_service::run()的線程池.然而這樣就允許回調函數並發執行.所以,當回調函數需要訪問一個共享,線程不安全的資源時,我們需要一種方式來同步操作.

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/thread.hpp>
4. #include <boost/bind.hpp>
5. #include <boost/date_time/posix_time/posix_time.hpp>

在上一節的基礎上我們定義一個printer類,此次,它將並行運行兩個timer

1. class printer
2. {
3. public:

除了聲明了一對 boost::asio::deadline_timer,構造函數也初始化了類型為 boost::asio::strand的 strand_成員. 
boost::asio::strand 可以分配的回調函數.它保證無論有多少線程調用了 boost::asio::io_service::run(),下一個回調函數僅在前一個回調函數完成后開始,當然回調函數仍然可以和那些不使用 boost::asio::strand 分配,或是使用另一個 boost::asio::strand分配的回調函數一起並發執行.

1. printer(boost::asio::io_service& io)
2.     : strand_(io),
3.     timer1_(io, boost::posix_time::seconds(1)),
4.     timer2_(io, boost::posix_time::seconds(1)),
5.     count_(0)
6. {

當一個異步操作開始時,用 boost::asio::strand來 "wrapped(包裝)"回調函數. boost::asio::strand::wrap()會返回一個由 boost::asio::strand分配的新的handler(句柄),這樣,我們可以確保它們不會同時運行.

1.     timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
2.     timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
3. }
4. ~printer()
5. {
6.     std::cout << "Final count is " << count_ << " ";
7. }

多線程程序中,回調函數在訪問共享資源前需要同步.這里共享資源是 std::cout 和 count_變量. 

1.     void print1()
2.     {
3.         if (count_ < 10)
4.         {
5.             std::cout << "Timer 1: " << count_ << " ";
6.             ++count_;
7.             timer1_.expires_at(timer1_.expires_at() + boost::posix_time::seconds(1));
8.             timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
9.         }
10.     }
11.     void print2()
12.     {
13.         if (count_ < 10)
14.         {
15.             std::cout << "Timer 2: " << count_ << " ";
16.             ++count_;
17.             timer2_.expires_at(timer2_.expires_at() + boost::posix_time::seconds(1));
18.             timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
19.         }
20.     }
21. private:
22.     boost::asio::strand strand_;
23.     boost::asio::deadline_timer timer1_;
24.     boost::asio::deadline_timer timer2_;
25.     int count_;
26. };

main函數中 boost::asio::io_service::run()在兩個線程中被調用:主線程、一個 boost::thread線程. 
正如單線程中那樣,並發的 boost::asio::io_service::run()會一直運行直到完成任務.后台的線程將在所有異步線程完成后終結. 

1. int main()
2. {
3.     boost::asio::io_service io;
4.     printer p(io);
5.     boost::thread t(boost::bind(&boost::asio::io_service::run, &io));
6.     io.run();
7.     t.join();
8.     return 0;
9. }

完整的代碼:

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/thread.hpp>
4. #include <boost/bind.hpp>
5. #include <boost/date_time/posix_time/posix_time.hpp>
6. class printer
7. {
8. public:
9.         printer(boost::asio::io_service& io)
10.             : strand_(io),
11.             timer1_(io, boost::posix_time::seconds(1)),
12.             timer2_(io, boost::posix_time::seconds(1)),
13.             count_(0)
14.     {
15.         timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
16.         timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
17.     }
18.         ~printer()
19.         {
20.             std::cout << "Final count is " << count_ << " ";
21.         }
22.         void print1()
23.         {
24.             if (count_ < 10)
25.             {
26.                 std::cout << "Timer 1: " << count_ << " ";
27.                 ++count_;
28.                 timer1_.expires_at(timer1_.expires_at() + boost::posix_time::seconds(1));
29.                 timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
30.             }
31.         }
32.         void print2()
33.         {
34.             if (count_ < 10)
35.             {
36.                 std::cout << "Timer 2: " << count_ << " ";
37.                 ++count_;
38.                 timer2_.expires_at(timer2_.expires_at() + boost::posix_time::seconds(1));
39.                 timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
40.             }
41.         }
42. private:
43.         boost::asio::strand strand_;
44.         boost::asio::deadline_timer timer1_;
45.         boost::asio::deadline_timer timer2_;
46.         int count_;
47. };
48. int main()
49. {
50.     boost::asio::io_service io;
51.     printer p(io);
52.     boost::thread t(boost::bind(&boost::asio::io_service::run, &io));
53.     io.run();
54.     t.join();
55.     return 0;
56. }

 

7. TCP客戶端:對准時間

1. #include <iostream>
2. #include <boost/array.hpp>
3. #include <boost/asio.hpp>

本程序的目的是訪問一個時間同步服務器,我們需要用戶指定一個服務器(如time-nw.nist.gov),用IP亦可. 
(譯者注:日期查詢協議,這種時間傳輸協議不指定固定的傳輸格式，只要求按照ASCII標准發送數據。)

1. using boost::asio::ip::tcp;
2. int main(int argc, char* argv[])
3. {
4.     try
5.     {
6.         if (argc != 2)
7.         {
8.             std::cerr << "Usage: client <host>" << std::endl;
9.             return 1;
10.             }

用asio進行網絡連接至少需要一個boost::asio::io_service對象

1. boost::asio::io_service io_service;

我們需要把在命令行參數中指定的服務器轉換為TCP上的節點.完成這項工作需要boost::asio::ip::tcp::resolver對象

1. tcp::resolver resolver(io_service);

一個resolver對象查詢一個參數,並將其轉換為TCP上節點的列表.這里我們把argv[1]中的sever的名字和要查詢字串daytime關聯.

1. tcp::resolver::query query(argv[1], "daytime");

節點列表可以用 boost::asio::ip::tcp::resolver::iterator 來進行迭代.iterator默認的構造函數生成一個end iterator.

1. tcp::resolver::iterator endpoint_iterator = resolver.resolve(query);
2. tcp::resolver::iterator end;

現在我們建立一個連接的sockert,由於獲得節點既有IPv4也有IPv6的.所以,我們需要依次嘗試他們直到找到一個可以正常工作的.這步使得我們的程序獨立於IP版本

1. tcp::socket socket(io_service);
2. boost::asio::error error = boost::asio::error::host_not_found;
3. while (error && endpoint_iterator != end)
4. {
5.     socket.close();
6.     socket.connect(*endpoint_iterator++, boost::asio::assign_error(error));
7. }
8. if (error)
9.     throw error;

連接完成,我們需要做的是讀取daytime服務器的響應. 
我們用boost::array來保存得到的數據,boost::asio::buffer()會自動根據array的大小暫停工作,來防止緩沖溢出.除了使用boost::array,也可以使用char [] 或std::vector.

1. for (;;)
2. {
3.     boost::array<char, 128> buf;
4.     boost::asio::error error;
5.     size_t len = socket.read_some(
6.         boost::asio::buffer(buf), boost::asio::assign_error(error));

當服務器關閉連接時,boost::asio::ip::tcp::socket::read_some()會用boost::asio::error::eof標志完成, 這時我們應該退出讀取循環了.

1. if (error == boost::asio::error::eof)
2.     break; // Connection closed cleanly by peer.
3. else if (error)
4.     throw error; // Some other error.
5. std::cout.write(buf.data(), len);
6.  

如果發生了什么異常我們同樣會拋出它

1. }
2. catch (std::exception& e)
3. {
4.     std::cerr << e.what() << std::endl;
5. }

運行示例:在windowsXP的cmd窗口下 
輸入:upload.exe time-a.nist.gov

輸出:54031 06-10-23 01:50:45 07 0 0 454.2 UTC(NIST) *

完整的代碼:

1. #include <iostream>
2. #include <boost/array.hpp>
3. #include <asio.hpp>
4. using asio::ip::tcp;
5. int main(int argc, char* argv[])
6. {
7.     try
8.     {
9.         if (argc != 2)
10.         {
11.             std::cerr << "Usage: client <host>" << std::endl;
12.             return 1;
13.         }
14.         asio::io_service io_service;
15.         tcp::resolver resolver(io_service);
16.         tcp::resolver::query query(argv[1], "daytime");
17.         tcp::resolver::iterator endpoint_iterator = resolver.resolve(query);
18.         tcp::resolver::iterator end;
19.         tcp::socket socket(io_service);
20.         asio::error error = asio::error::host_not_found;
21.         while (error && endpoint_iterator != end)
22.         {
23.             socket.close();
24.             socket.connect(*endpoint_iterator++, asio::assign_error(error));
25.         }
26.         if (error)
27.             throw error;
28.         for (;;)
29.         {
30.             boost::array<char, 128> buf;
31.             asio::error error;
32.             size_t len = socket.read_some(
33.                     asio::buffer(buf), asio::assign_error(error));
34.             if (error == asio::error::eof)
35.                 break; // Connection closed cleanly by peer.
36.             else if (error)
37.                 throw error; // Some other error.
38.             std::cout.write(buf.data(), len);
39.         }
40.     }
41.     catch (std::exception& e)
42.     {
43.         std::cerr << e.what() << std::endl;
44.     }
45.     return 0;
46. }

 

8. TCP同步時間服務器

1. #include <ctime>
2. #include <iostream>
3. #include <string>
4. #include <asio.hpp>
5. using asio::ip::tcp;

我們先定義一個函數返回當前的時間的string形式.這個函數會在我們所有的時間服務器示例上被使用.

1. std::string make_daytime_string()
2. {
3.     using namespace std; // For time_t, time and ctime;
4.     time_t now = time(0);
5.     return ctime(&now);
6. }
7. int main()
8. {
9.     try
10.     {
11.         asio::io_service io_service;

新建一個asio::ip::tcp::acceptor對象來監聽新的連接.我們監聽TCP端口13,IP版本為V4

1. tcp::acceptor acceptor(io_service, tcp::endpoint(tcp::v4(), 13));

這是一個iterative server,也就是說同一時間只能處理一個連接.建立一個socket來表示一個和客戶端的連接, 然后等待客戶端的連接.

1. for (;;)
2. {
3.     tcp::socket socket(io_service);
4.     acceptor.accept(socket);

當客戶端訪問服務器時,我們獲取當前時間,然后返回它.

1.         std::string message = make_daytime_string();
2.         asio::write(socket, asio::buffer(message),
3.             asio::transfer_all(), asio::ignore_error());
4.     }
5. }

最后處理異常

1. catch (std::exception& e)
2.     {
3.         std::cerr << e.what() << std::endl;
4.     }
5.     return 0;
6.  

運行示例:運行服務器,然后運行上一節的客戶端,在windowsXP的cmd窗口下 
輸入:client.exe 127.0.0.1 
輸出:Mon Oct 23 09:44:48 2006

完整的代碼:

1. #include <ctime>
2. #include <iostream>
3. #include <string>
4. #include <asio.hpp>
5. using asio::ip::tcp;
6. std::string make_daytime_string()
7. {
8.     using namespace std; // For time_t, time and ctime;
9.     time_t now = time(0);
10.     return ctime(&now);
11. }
12. int main()
13. {
14.     try
15.     {
16.         asio::io_service io_service;
17.         tcp::acceptor acceptor(io_service, tcp::endpoint(tcp::v4(), 13));
18.         for (;;)
19.         {
20.             tcp::socket socket(io_service);
21.             acceptor.accept(socket);
22.             std::string message = make_daytime_string();
23.             asio::write(socket, asio::buffer(message),
24.                     asio::transfer_all(), asio::ignore_error());
25.         }
26.     }
27.     catch (std::exception& e)
28.     {
29.         std::cerr << e.what() << std::endl;
30.     }
31.     return 0;
32. }

2. 同步Timer

本章介紹asio如何在定時器上進行阻塞等待(blocking wait). 
實現,我們包含必要的頭文件. 
所有的asio類可以簡單的通過include "asio.hpp"來調用.

1. #include <iostream>
2. #include <boost/asio.hpp>

此外,這個示例用到了timer,我們還要包含Boost.Date_Time的頭文件來控制時間.

1. #include <boost/date_time/posix_time/posix_time.hpp>

使用asio至少需要一個boost::asio::io_service對象.該類提供了訪問I/O的功能.我們首先在main函數中聲明它.

1. int main()
2. {
3.     boost::asio::io_service io;

下一步我們聲明boost::asio::deadline_timer對象.這個asio的核心類提供I/O的功能(這里更確切的說是定時功能),總是把一個io_service對象作為他的第一個構造函數,而第二個構造函數的參數設定timer會在5秒后到時(expired).

1. boost::asio::deadline_timer t(io, boost::posix_time::seconds(5));

這個簡單的示例中我們演示了定時器上的一個阻塞等待.就是說,調用boost::asio::deadline_timer::wait()的在創建后5秒內(注意:不是等待開始后),timer到時之前不會返回任何值. 
一個deadline_timer只有兩種狀態:到時,未到時. 
如果boost::asio::deadline_timer::wait()在到時的timer對象上調用,會立即return.

1. t.wait();

最后,我們輸出理所當然的"Hello, world!"來演示timer到時了.

1.     std::cout << "Hello, world! ";
2.     return 0;
3. }

完整的代碼:

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/date_time/posix_time/posix_time.hpp>
4. int main()
5. {
6.     boost::asio::io_service io;
7.     boost::asio::deadline_timer t(io, boost::posix_time::seconds(5));
8.     t.wait();
9.     std::cout << "Hello, world! ";
10.     return 0;
11. }

 

3. 異步Timer

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/date_time/posix_time/posix_time.hpp>

asio的異步函數會在一個異步操作完成后被回調.這里我們定義了一個將被回調的函數.

1. void print(const asio::error& /*e*/)
2. {
3.     std::cout << "Hello, world! ";
4. }
5. int main()
6. {
7.     asio::io_service io;
8.     asio::deadline_timer t(io, boost::posix_time::seconds(5));

這里我們調用asio::deadline_timer::async_wait()來異步等待

1. t.async_wait(print);

最后,我們必須調用asio::io_service::run(). 
asio庫只會調用那個正在運行的asio::io_service::run()的回調函數. 
如果asio::io_service::run()不被調用,那么回調永遠不會發生. 
asio::io_service::run()會持續工作到點,這里就是timer到時,回調完成. 
別忘了在調用 asio::io_service::run()之前設置好io_service的任務.比如,這里,如果我們忘記先調用asio::deadline_timer::async_wait()則asio::io_service::run()會在瞬間return.

1.     io.run();
2.     return 0;
3. }

完整的代碼:

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/date_time/posix_time/posix_time.hpp>
4. void print(const asio::error& /*e*/)
5. {
6.     std::cout << "Hello, world! ";
7. }
8. int main()
9. {
10.     asio::io_service io;
11.     asio::deadline_timer t(io, boost::posix_time::seconds(5));
12.     t.async_wait(print);
13.     io.run();
14.     return 0;
15. }

4. 回調函數的參數

這里我們將每秒回調一次,來演示如何回調函數參數的含義

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>

首先,調整一下timer的持續時間,開始一個異步等待.顯示,回調函數需要訪問timer來實現周期運行,所以我們再介紹兩個新參數

• 指向timer的指針
• 一個int*來指向計數器

1. void print(const asio::error& /*e*/,
2.     asio::deadline_timer* t, int* count)
3. {

我們打算讓這個函數運行6個周期,然而你會發現這里沒有顯式的方法來終止io_service.不過,回顧上一節,你會發現當 asio::io_service::run()會在所有任務完成時終止.這樣我們當計算器的值達到5時(0為第一次運行的值),不再開啟一個新的異步等待就可以了.

1.     if (*count < 5)
2.     {
3.         std::cout << *count << " ";
4.         ++(*count);
5. ...

然后,我們推遲的timer的終止時間.通過在原先的終止時間上增加延時,我們可以確保timer不會在處理回調函數所需時間內的到期. 
(原文:By calculating the new expiry time relative to the old, we can ensure that the timer does not drift away from the whole-second mark due to any delays in processing the handler.)

1. t->expires_at(t->expires_at() + boost::posix_time::seconds(1));

然后我們開始一個新的同步等待.如您所見,我們用把print和他的多個參數用boost::bind函數合成一個的形為void(const asio::error&)回調函數(准確的說是function object). 
在這個例子中, boost::bind的asio::placeholders::error參數是為了給回調函數傳入一個error對象.當進行一個異步操作,開始 boost::bind時,你需要使用它來匹配回調函數的參數表.下一節中你會學到回調函數不需要error參數時可以省略它.

1.      t->async_wait(boost::bind(print,
2.         asio::placeholders::error, t, count));
3.     }
4. }
5. int main()
6. {
7.     asio::io_service io;
8.     int count = 0;
9.     asio::deadline_timer t(io, boost::posix_time::seconds(1));

和上面一樣,我們再一次使用了綁定asio::deadline_timer::async_wait()

1. t.async_wait(boost::bind(print,
2.     asio::placeholders::error, &t, &count));
3. io.run();

在結尾,我們打印出的最后一次沒有設置timer的調用的count的值

1.     std::cout << "Final count is " << count << " ";
2.     return 0;
3. }

完整的代碼:

1. #include <iostream>
2. #include <asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>
5. void print(const asio::error& /*e*/,
6.   bsp;     asio::deadline_timer* t, int* count)
7. {
8.     if (*count < 5)
9.     {
10.         std::cout << *count << " ";
11.         ++(*count);
12.         t->expires_at(t->expires_at() + boost::posix_time::seconds(1));
13.         t->async_wait(boost::bind(print,
14.                     asio::placeholders::error, t, count));
15.     }
16. }
17. int main()
18. {
19.     asio::io_service io;
20.     int count = 0;
21.     asio::deadline_timer t(io, boost::posix_time::seconds(1));
22.     t.async_wait(boost::bind(print,
23.                 asio::placeholders::error, &t, &count));
24.     io.run();
25.     std::cout << "Final count is " << count << " ";
26.     return 0;
27. }

 

5. 成員函數作為回調函數

本例的運行結果和上一節類似

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>

我們先定義一個printer類

1. class printer
2. {
3. public:
4. //構造函數有一個io_service參數,並且在初始化timer_時用到了它.用來計數的count_這里同樣作為了成員變量
5.     printer(boost::asio::io_service& io)
6.         : timer_(io, boost::posix_time::seconds(1)),
7.             count_(0)
8.     {

boost::bind 同樣可以出色的工作在成員函數上.眾所周知,所有的非靜態成員函數都有一個隱式的this參數,我們需要把this作為參數bind到成員函數上.和上一節類似,我們再次用bind構造出void(const boost::asio::error&)形式的函數. 
注意,這里沒有指定boost::asio::placeholders::error占位符,因為這個print成員函數沒有接受一個error對象作為參數.

1. timer_.async_wait(boost::bind(&printer::print, this));
2.  

在類的折構函數中我們輸出最后一次回調的count的值

1. ~printer()
2. {
3.     std::cout << "Final count is " << count_ << " ";
4. }

print函數於上一節的十分類似,但是用成員變量取代了參數.

1.     void print()
2.     {
3.         if (count_ < 5)
4.         {
5.             std::cout << count_ << " ";
6.             ++count_;
7.             timer_.expires_at(timer_.expires_at() + boost::posix_time::seconds(1));
8.             timer_.async_wait(boost::bind(&printer::print, this));
9.         }
10.     }
11. private:
12.     boost::asio::deadline_timer timer_;
13.     int count_;
14. };
15.  

現在main函數清爽多了,在運行io_service之前只需要簡單的定義一個printer對象.

1. int main()
2. {
3.     boost::asio::io_service io;
4.     printer p(io);
5.     io.run();
6.     return 0;
7. }

完整的代碼:

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/bind.hpp>
4. #include <boost/date_time/posix_time/posix_time.hpp>
5. class printer
6. {
7.     public:
8.         printer(boost::asio::io_service& io)
9.             : timer_(io, boost::posix_time::seconds(1)),
10.             count_(0)
11.     {
12.         timer_.async_wait(boost::bind(&printer::print, this));
13.     }
14.         ~printer()
15.         {
16.             std::cout << "Final count is " << count_ << " ";
17.         }
18.         void print()
19.         {
20.             if (count_ < 5)
21.             {
22.                 std::cout << count_ << " ";
23.                 ++count_;
24.                 timer_.expires_at(timer_.expires_at() + boost::posix_time::seconds(1));
25.                 timer_.async_wait(boost::bind(&printer::print, this));
26.             }
27.         }
28.     private:
29.         boost::asio::deadline_timer timer_;
30.         int count_;
31. };
32. int main()
33. {
34.     boost::asio::io_service io;
35.     printer p(io);
36.     io.run();
37.     return 0;
38. }

 

 

6. 多線程回調同步

本節演示了使用boost::asio::strand在多線程程序中進行回調同步(synchronise). 
先前的幾節闡明了如何在單線程程序中用boost::asio::io_service::run()進行同步.如您所見,asio庫確保 僅當當前線程調用boost::asio::io_service::run()時產生回調.顯然,僅在一個線程中調用 boost::asio::io_service::run() 來確保回調是適用於並發編程的. 
一個基於asio的程序最好是從單線程入手,但是單線程有如下的限制,這一點在服務器上尤其明顯:

• 當回調耗時較長時,反應遲鈍.
• 在多核的系統上無能為力

如果你發覺你陷入了這種困擾,可以替代的方法是建立一個boost::asio::io_service::run()的線程池.然而這樣就允許回調函數並發執行.所以,當回調函數需要訪問一個共享,線程不安全的資源時,我們需要一種方式來同步操作.

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/thread.hpp>
4. #include <boost/bind.hpp>
5. #include <boost/date_time/posix_time/posix_time.hpp>

在上一節的基礎上我們定義一個printer類,此次,它將並行運行兩個timer

1. class printer
2. {
3. public:

除了聲明了一對boost::asio::deadline_timer,構造函數也初始化了類型為boost::asio::strand的strand_成員. 
boost::asio::strand 可以分配的回調函數.它保證無論有多少線程調用了boost::asio::io_service::run(),下一個回調函數僅在前一個回調函數完成后開始,當然回調函數仍然可以和那些不使用boost::asio::strand分配,或是使用另一個boost::asio::strand分配的回調函數一起並發執行.

1. printer(boost::asio::io_service& io)
2.     : strand_(io),
3.     timer1_(io, boost::posix_time::seconds(1)),
4.     timer2_(io, boost::posix_time::seconds(1)),
5.     count_(0)
6. {

當一個異步操作開始時,用boost::asio::strand來 "wrapped(包裝)"回調函數.boost::asio::strand::wrap()會返回一個由boost::asio::strand分配的新的handler(句柄),這樣,我們可以確保它們不會同時運行.

1.     timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
2.     timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
3. }
4. ~printer()
5. {
6.     std::cout << "Final count is " << count_ << " ";
7. }

多線程程序中,回調函數在訪問共享資源前需要同步.這里共享資源是std::cout 和count_變量. 

1.     void print1()
2.     {
3.         if (count_ < 10)
4.         {
5.             std::cout << "Timer 1: " << count_ << " ";
6.             ++count_;
7.             timer1_.expires_at(timer1_.expires_at() + boost::posix_time::seconds(1));
8.             timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
9.         }
10.     }
11.     void print2()
12.     {
13.         if (count_ < 10)
14.         {
15.             std::cout << "Timer 2: " << count_ << " ";
16.             ++count_;
17.             timer2_.expires_at(timer2_.expires_at() + boost::posix_time::seconds(1));
18.             timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
19.         }
20.     }
21. private:
22.     boost::asio::strand strand_;
23.     boost::asio::deadline_timer timer1_;
24.     boost::asio::deadline_timer timer2_;
25.     int count_;
26. };

main函數中boost::asio::io_service::run()在兩個線程中被調用:主線程、一個boost::thread線程. 
正如單線程中那樣,並發的boost::asio::io_service::run()會一直運行直到完成任務.后台的線程將在所有異步線程完成后終結. 

1. int main()
2. {
3.     boost::asio::io_service io;
4.     printer p(io);
5.     boost::thread t(boost::bind(&boost::asio::io_service::run, &io));
6.     io.run();
7.     t.join();
8.     return 0;
9. }

完整的代碼:

1. #include <iostream>
2. #include <boost/asio.hpp>
3. #include <boost/thread.hpp>
4. #include <boost/bind.hpp>
5. #include <boost/date_time/posix_time/posix_time.hpp>
6. class printer
7. {
8. public:
9.         printer(boost::asio::io_service& io)
10.             : strand_(io),
11.             timer1_(io, boost::posix_time::seconds(1)),
12.             timer2_(io, boost::posix_time::seconds(1)),
13.             count_(0)
14.     {
15.         timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
16.         timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
17.     }
18.         ~printer()
19.         {
20.             std::cout << "Final count is " << count_ << " ";
21.         }
22.         void print1()
23.         {
24.             if (count_ < 10)
25.             {
26.                 std::cout << "Timer 1: " << count_ << " ";
27.                 ++count_;
28.                 timer1_.expires_at(timer1_.expires_at() + boost::posix_time::seconds(1));
29.                 timer1_.async_wait(strand_.wrap(boost::bind(&printer::print1, this)));
30.             }
31.         }
32.         void print2()
33.         {
34.             if (count_ < 10)
35.             {
36.                 std::cout << "Timer 2: " << count_ << " ";
37.                 ++count_;
38.                 timer2_.expires_at(timer2_.expires_at() + boost::posix_time::seconds(1));
39.                 timer2_.async_wait(strand_.wrap(boost::bind(&printer::print2, this)));
40.             }
41.         }
42. private:
43.         boost::asio::strand strand_;
44.         boost::asio::deadline_timer timer1_;
45.         boost::asio::deadline_timer timer2_;
46.         int count_;
47. };
48. int main()
49. {
50.     boost::asio::io_service io;
51.     printer p(io);
52.     boost::thread t(boost::bind(&boost::asio::io_service::run, &io));
53.     io.run();
54.     t.join();
55.     return 0;
56. }

 

7. TCP客戶端:對准時間

1. #include <iostream>
2. #include <boost/array.hpp>
3. #include <boost/asio.hpp>

本程序的目的是訪問一個時間同步服務器,我們需要用戶指定一個服務器(如time-nw.nist.gov),用IP亦可. 
(譯者注:日期查詢協議,這種時間傳輸協議不指定固定的傳輸格式，只要求按照ASCII標准發送數據。)

1. using boost::asio::ip::tcp;
2. int main(int argc, char* argv[])
3. {
4.     try
5.     {
6.         if (argc != 2)
7.         {
8.             std::cerr << "Usage: client <host>" << std::endl;
9.             return 1;
10.             }

用asio進行網絡連接至少需要一個boost::asio::io_service對象

1. boost::asio::io_service io_service;

我們需要把在命令行參數中指定的服務器轉換為TCP上的節點.完成這項工作需要boost::asio::ip::tcp::resolver對象

1. tcp::resolver resolver(io_service);

一個resolver對象查詢一個參數,並將其轉換為TCP上節點的列表.這里我們把argv[1]中的sever的名字和要查詢字串daytime關聯.

1. tcp::resolver::query query(argv[1], "daytime");

節點列表可以用 boost::asio::ip::tcp::resolver::iterator 來進行迭代.iterator默認的構造函數生成一個end iterator.

1. tcp::resolver::iterator endpoint_iterator = resolver.resolve(query);
2. tcp::resolver::iterator end;

現在我們建立一個連接的sockert,由於獲得節點既有IPv4也有IPv6的.所以,我們需要依次嘗試他們直到找到一個可以正常工作的.這步使得我們的程序獨立於IP版本

1. tcp::socket socket(io_service);
2. boost::asio::error error = boost::asio::error::host_not_found;
3. while (error && endpoint_iterator != end)
4. {
5.     socket.close();
6.     socket.connect(*endpoint_iterator++, boost::asio::assign_error(error));
7. }
8. if (error)
9.     throw error;

連接完成,我們需要做的是讀取daytime服務器的響應. 
我們用boost::array來保存得到的數據,boost::asio::buffer()會自動根據array的大小暫停工作,來防止緩沖溢出.除了使用boost::array,也可以使用char [] 或std::vector.

1. for (;;)
2. {
3.     boost::array<char, 128> buf;
4.     boost::asio::error error;
5.     size_t len = socket.read_some(
6.         boost::asio::buffer(buf), boost::asio::assign_error(error));

當服務器關閉連接時,boost::asio::ip::tcp::socket::read_some()會用boost::asio::error::eof標志完成, 這時我們應該退出讀取循環了.

1. if (error == boost::asio::error::eof)
2.     break; // Connection closed cleanly by peer.
3. else if (error)
4.     throw error; // Some other error.
5. std::cout.write(buf.data(), len);
6.  

如果發生了什么異常我們同樣會拋出它

1. }
2. catch (std::exception& e)
3. {
4.     std::cerr << e.what() << std::endl;
5. }

運行示例:在windowsXP的cmd窗口下 
輸入:upload.exe time-a.nist.gov

輸出:54031 06-10-23 01:50:45 07 0 0 454.2 UTC(NIST) *

完整的代碼:

1. #include <iostream>
2. #include <boost/array.hpp>
3. #include <asio.hpp>
4. using asio::ip::tcp;
5. int main(int argc, char* argv[])
6. {
7.     try
8.     {
9.         if (argc != 2)
10.         {
11.             std::cerr << "Usage: client <host>" << std::endl;
12.             return 1;
13.         }
14.         asio::io_service io_service;
15.         tcp::resolver resolver(io_service);
16.         tcp::resolver::query query(argv[1], "daytime");
17.         tcp::resolver::iterator endpoint_iterator = resolver.resolve(query);
18.         tcp::resolver::iterator end;
19.         tcp::socket socket(io_service);
20.         asio::error error = asio::error::host_not_found;
21.         while (error && endpoint_iterator != end)
22.         {
23.             socket.close();
24.             socket.connect(*endpoint_iterator++, asio::assign_error(error));
25.         }
26.         if (error)
27.             throw error;
28.         for (;;)
29.         {
30.             boost::array<char, 128> buf;
31.             asio::error error;
32.             size_t len = socket.read_some(
33.                     asio::buffer(buf), asio::assign_error(error));
34.             if (error == asio::error::eof)
35.                 break; // Connection closed cleanly by peer.
36.             else if (error)
37.                 throw error; // Some other error.
38.             std::cout.write(buf.data(), len);
39.         }
40.     }
41.     catch (std::exception& e)
42.     {
43.         std::cerr << e.what() << std::endl;
44.     }
45.     return 0;
46. }

 

8. TCP同步時間服務器

1. #include <ctime>
2. #include <iostream>
3. #include <string>
4. #include <asio.hpp>
5. using asio::ip::tcp;

我們先定義一個函數返回當前的時間的string形式.這個函數會在我們所有的時間服務器示例上被使用.

1. std::string make_daytime_string()
2. {
3.     using namespace std; // For time_t, time and ctime;
4.     time_t now = time(0);
5.     return ctime(&now);
6. }
7. int main()
8. {
9.     try
10.     {
11.         asio::io_service io_service;

新建一個asio::ip::tcp::acceptor對象來監聽新的連接.我們監聽TCP端口13,IP版本為V4

1. tcp::acceptor acceptor(io_service, tcp::endpoint(tcp::v4(), 13));

這是一個iterative server,也就是說同一時間只能處理一個連接.建立一個socket來表示一個和客戶端的連接, 然后等待客戶端的連接.

1. for (;;)
2. {
3.     tcp::socket socket(io_service);
4.     acceptor.accept(socket);

當客戶端訪問服務器時,我們獲取當前時間,然后返回它.

1.         std::string message = make_daytime_string();
2.         asio::write(socket, asio::buffer(message),
3.             asio::transfer_all(), asio::ignore_error());
4.     }
5. }

最后處理異常

1. catch (std::exception& e)
2.     {
3.         std::cerr << e.what() << std::endl;
4.     }
5.     return 0;
6.  

運行示例:運行服務器,然后運行上一節的客戶端,在windowsXP的cmd窗口下 
輸入:client.exe 127.0.0.1 
輸出:Mon Oct 23 09:44:48 2006

完整的代碼:

1. #include <ctime>
2. #include <iostream>
3. #include <string>
4. #include <asio.hpp>
5. using asio::ip::tcp;
6. std::string make_daytime_string()
7. {
8.     using namespace std; // For time_t, time and ctime;
9.     time_t now = time(0);
10.     return ctime(&now);
11. }
12. int main()
13. {
14.     try
15.     {
16.         asio::io_service io_service;
17.         tcp::acceptor acceptor(io_service, tcp::endpoint(tcp::v4(), 13));
18.         for (;;)
19.         {
20.             tcp::socket socket(io_service);
21.             acceptor.accept(socket);
22.             std::string message = make_daytime_string();
23.             asio::write(socket, asio::buffer(message),
24.                     asio::transfer_all(), asio::ignore_error());
25.         }
26.     }
27.     catch (std::exception& e)
28.     {
29.         std::cerr << e.what() << std::endl;
30.     }
31.     return 0;
32. }