基于 Boost Asio 的 C++ 网络编程
环境: Boost v1.66, VS 2013 & 2015
说明: 这篇教程形成于 Boost v1.62 时代,最近(2018/01)针对 v1.66 做了一次大的更新。 此外,在代码风格上,C++11 用得更多了。
概述
近期学习 Boost Asio,依葫芦画瓢,写了不少例子,对这个「轻量级」的网络库算是有了一定理解。但是秉着理论与实践结合的态度,决定写一篇教程,把脑子里一知半解的东西,试图说清楚。
Asio,即「异步 IO」(Asynchronous Input/Output),本是一个 独立的 C++ 网络程序库,似乎并不为人所知,后来因为被 Boost 相中,才声名鹊起。
从设计上来看,Asio 相似且重度依赖于 Boost,与 thread、bind、smart pointers 等结合时,体验顺滑。从使用上来看,依然是重组合而轻继承,一贯的 C++ 标准库风格。
什么是「异步 IO」?
简单来说,就是你发起一个 IO 操作,却不用等它结束,你可以继续做其他事情,当它结束时,你会得到通知。
当然这种表述是不精确的,操作系统并没有直接提供这样的机制。以 Unix 为例,有五种 IO 模型可用:
- 阻塞 I/O
- 非阻塞 I/O
- I/O 多路复用(multiplexing)(
select
和poll
) - 信号驱动 I/O(
SIGIO
) - 异步 I/O(POSIX
aio_
系列函数)
这五种模型的定义和比较,详见「Unix Network Programming, Volume 1: The Sockets Networking API」一书 6.2 节,或者可参考 这篇笔记。
Asio 封装的正是「I/O 多路复用」。具体一点,epoll
之于 Linux,kqueue
之于 Mac 和 BSD。epoll
和 kqueue
比 select
和 poll
更高效。当然在 Windows 上封装的则是 IOCP(完成端口)。
Asio 的「I/O 操作」,主要还是指「网络 IO」,比如 socket 读写。由于网络传输的特性,「网络 IO」相对比较费时,设计良好的服务器,不可能同步等待一个 IO 操作的结束,这太浪费 CPU 了。
对于普通的「文件 IO」,操作系统并没有提供“异步”读写机制,libuv 的做法是用线程模拟异步,为网络和文件提供了一致的接口。Asio 并没有这样做,它专注于网络。提供机制而不是策略,这很符合 C++ 哲学。
下面以示例,由浅到深,由简单到复杂,逐一介绍 Asio 的用法。 简单起见,头文件一律省略。
I/O Context
每个 Asio 程序都至少有一个 io_context
对象,它代表了操作系统的 I/O 服务(io_context
在 Boost 1.66 之前一直叫 io_service
),把你的程序和这些服务链接起来。
下面这个程序空有 io_context
对象,却没有任何异步操作,所以它其实什么也没做,也没有任何输出。
1
2
3
4
5
int main() {
boost::asio::io_context ioc;
ioc.run();
return 0;
}
io_context.run
是一个阻塞(blocking)调用,姑且把它想象成一个 loop(事件循环),直到所有异步操作完成后,loop 才结束,run
才返回。但是这个程序没有任何异步操作,所以 loop 直接就结束了。
Timer
有了 io_context
还不足以完成 I/O 操作,用户一般也不跟 io_context
直接交互。
根据 I/O 操作的不同,Asio 提供了不同的 I/O 对象,比如 timer(定时器),socket,等等。 Timer 是最简单的一种 I/O 对象,可以用来实现异步调用的超时机制,下面是最简单的用法:
1
2
3
4
5
6
7
8
9
10
11
void Print(boost::system::error_code ec) {
std::cout << "Hello, world!" << std::endl;
}
int main() {
boost::asio::io_context ioc;
boost::asio::steady_timer timer(ioc, std::chrono::seconds(3));
timer.async_wait(&Print);
ioc.run();
return 0;
}
先创建一个 steady_timer
,指定时间 3 秒,然后异步等待这个 timer,3 秒后,timer 超时结束,Print
被调用。
以下几点需要注意:
- 所有 I/O 对象都依赖
io_context
,一般在构造时指定。 async_wait
初始化了一个异步操作,但是这个异步操作的执行,要等到io_context.run
时才开始。- Timer 除了异步等待(
async_wait
),还可以同步等待(wait
)。同步等待是阻塞的,直到 timer 超时结束。基本上所有 I/O 对象的操作都有同步和异步两个版本,也许是出于设计上的完整性。 async_wait
的参数是一个函数对象,异步操作完成时它会被调用,所以也叫 completion handler,简称 handler,可以理解成回调函数。- 所有 I/O 对象的
async_xyz
函数都有 handler 参数,对于 handler 的签名,不同的异步操作有不同的要求,除了官方文档里的说明,也可以直接查看 Boost 源码。
async_wait
的 handler 签名为 void (boost::system::error_code)
,如果要传递额外的参数,就得用 bind
。不妨修改一下 Print
,让它每隔一秒打印一次计数,从 0
递增到 3
。
1
2
3
4
5
6
7
8
9
10
11
12
void Print(boost::system::error_code ec,
boost::asio::steady_timer* timer,
int* count) {
if (*count < 3) {
std::cout << *count << std::endl;
++(*count);
timer->expires_after(std::chrono::seconds(1));
timer->async_wait(std::bind(&Print, std::placeholders::_1, timer, count));
}
}
与前版相比,Print
多了两个参数,以便访问当前计数及重启 timer。
1
2
3
4
5
6
7
8
9
int main() {
boost::asio::io_context ioc;
boost::asio::steady_timer timer(ioc, std::chrono::seconds(1));
int count = 0;
timer.async_wait(std::bind(&Print, std::placeholders::_1, &timer, &count));
ioc.run();
return 0;
}
调用 bind
时,使用了占位符(placeholder)std::placeholders::_1
。数字占位符共有 9 个,_1
- _9
。占位符也有很多种写法,这里就不详述了。
Echo Server
Socket 也是一种 I/O 对象,这一点前面已经提及。相比于 timer,socket 更为常用,毕竟 Asio 是一个网络程序库。
下面以经典的 Echo 程序为例,实现一个 TCP Server。所谓 Echo,就是 Server 把 Client 发来的内容原封不动发回给 Client。
先从同步方式开始,异步太复杂,慢慢来。
同步方式
Session
代表会话,负责管理一个 client 的连接。参数 socket
传的是值,但是会用到 move 语义来避免拷贝。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
void Session(tcp::socket socket) {
try {
while (true) {
boost::array<char, BUF_SIZE> data;
boost::system::error_code ec;
std::size_t length = socket.read_some(boost::asio::buffer(data), ec);
if (ec == boost::asio::error::eof) {
std::cout << "连接被 client 妥善的关闭了" << std::endl;
break;
} else if (ec) {
// 其他错误
throw boost::system::system_error(ec);
}
boost::asio::write(socket, boost::asio::buffer(data, length));
}
} catch (const std::exception& e) {
std::cerr << "Exception: " << e.what() << std::endl;
}
}
其中,tcp
即 boost::asio::ip::tcp
;BUF_SIZE
定义为 enum { BUF_SIZE = 1024 };
。这些都是细节,后面的例子不再赘述。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
int main(int argc, char* argv[]) {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " <port>" << std::endl;
return 1;
}
unsigned short port = std::atoi(argv[1]);
boost::asio::io_context ioc;
// 创建 Acceptor 侦听新的连接
tcp::acceptor acceptor(ioc, tcp::endpoint(tcp::v4(), port));
try {
// 一次处理一个连接
while (true) {
Session(acceptor.accept());
}
} catch (const std::exception& e) {
std::cerr << "Exception: " << e.what() << std::endl;
}
return 0;
}
启动时,通过命令行参数指定端口号,比如:
1
$ echo_server_sync 8080
因为 Client 部分还未实现,先用 netcat
测试一下:
1
2
3
$ nc localhost 8080
hello
hello
以下几点需要注意:
tcp::acceptor
也是一种 I/O 对象,用来接收 TCP 连接,连接端口由tcp::endpoint
指定。- 数据 buffer 以
boost::array<char, BUF_SIZE>
表示,也可以用char data[BUF_SIZE]
,或std::vector<char> data(BUF_SIZE)
。事实上,用std::vector
是最推荐的,因为它不但可以动态调整大小,还支持 Buffer Debugging。 - 同步方式下,没有调用
io_context.run
,因为accept
、read_some
和write
都是阻塞的。这也意味着一次只能处理一个 Client 连接,但是可以连续 echo,除非 Client 断开连接。 - 写回数据时,没有直接调用
socket.write_some
,因为它不能保证一次写完所有数据,但是boost::asio::write
可以。我觉得这是 Asio 接口设计不周,应该提供socket.write
。 acceptor.accept
返回一个新的 socket 对象,利用 move 语义,直接就转移给了Session
的参数,期间并没有拷贝开销。
异步方式
异步方式下,困难在于对象的生命周期,可以用 shared_ptr
解决。
为了同时处理多个 Client 连接,需要保留每个连接的 socket 对象,于是抽象出一个表示连接会话的类,叫 Session
:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class Session : public std::enable_shared_from_this<Session> {
public:
Session(tcp::socket socket) : socket_(std::move(socket)) {
}
void Start() {
DoRead();
}
void DoRead() {
auto self(shared_from_this());
socket_.async_read_some(
boost::asio::buffer(buffer_),
[this, self](boost::system::error_code ec, std::size_t length) {
if (!ec) {
DoWrite(length);
}
});
}
void DoWrite(std::size_t length) {
auto self(shared_from_this());
boost::asio::async_write(
socket_,
boost::asio::buffer(buffer_, length),
[this, self](boost::system::error_code ec, std::size_t length) {
if (!ec) {
DoRead();
}
});
}
private:
tcp::socket socket_;
std::array<char, BUF_SIZE> buffer_;
};
就代码风格来说,有以下几点需要注意:
- 优先使用 STL,比如
std::enable_shared_from_this
,std::bind
,std::array
,等等。 - 定义 handler 时,尽量使用匿名函数(lambda 表达式)。
- 以 C++
std::size_t
替 Csize_t
。 刚开始,你可能会不习惯,我也是这样,过了好久才慢慢拥抱 C++11 乃至 C++14。
Session
有两个成员变量,socket_
与 Client 通信,buffer_
是接收 Client 数据的缓存。只要 Session
对象在,socket 就在,连接就不断。Socket 对象是构造时传进来的,而且是通过 move 语义转移进来的。
虽然还没看到 Session
对象是如何创建的,但可以肯定的是,它必须用 std::shared_ptr
进行封装,这样才能保证异步模式下对象的生命周期。
此外,在 Session::DoRead
和 Session::DoWrite
中,因为读写都是异步的,同样为了防止当前 Session
不被销毁(因为超出作用域),所以要增加它的引用计数,即 auto self(shared_from_this());
这一句的作用。
至于读写的逻辑,基本上就是把 read_some
换成 async_read_some
,把 write
换成 async_write
,然后以匿名函数作为 completion handler。
接收 Client 连接的代码,提取出来,抽象成一个类 Server
:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class Server {
public:
Server(boost::asio::io_context& ioc, std::uint16_t port)
: acceptor_(ioc, tcp::endpoint(tcp::v4(), port)) {
DoAccept();
}
private:
void DoAccept() {
acceptor_.async_accept(
[this](boost::system::error_code ec, tcp::socket socket) {
if (!ec) {
std::make_shared<Session>(std::move(socket))->Start();
}
DoAccept();
});
}
private:
tcp::acceptor acceptor_;
};
同样,async_accept
替换了 accept
。async_accept
不再阻塞,DoAccept
即刻就会返回。
为了保证 Session
对象继续存在,使用 std::shared_ptr
代替普通的栈对象,同时把新接收的 socket 对象转移过去。
最后是 main()
:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
int main(int argc, char* argv[]) {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " <port>" << std::endl;
return 1;
}
std::uint16_t port = std::atoi(argv[1]);
boost::asio::io_context ioc;
Server server(ioc, port);
ioc.run();
return 0;
}
Echo Client
虽然用 netcat
测试 Echo Server 非常方便,但是自己动手写一个 Echo Client 仍然十分必要。
还是先考虑同步方式。
同步方式
首先通过 host
和 port
解析出 endpoints(对,是复数!):
1
2
tcp::resolver resolver(ioc);
auto endpoints = resolver.resolve(tcp::v4(), host, port);
resolve
返回的 endpoints 类型为 tcp::resolver::results_type
,代之以 auto
可以简化代码。类型推导应适当使用,至于连 int
都用 auto
就没有必要了。
host
和 port
通过命令行参数指定,比如 localhost
和 8080
。
接着创建 socket,建立连接:
1
2
tcp::socket socket(ioc);
boost::asio::connect(socket, endpoints);
这里没有直接调用 socket.connect
,因为 endpoints
可能会有多个,boost::asio::connect
会挨个尝试,逐一调用 socket.connect
直到连接成功。
其实这样说不太严谨,根据我的测试,resolve
在没有指定 protocol 时,确实会返回多个 endpoints,一个是 IPv6,一个是 IPv4。但是我们已经指定了 protocol 为 tcp::v4()
:
1
resolver.resolve(tcp::v4(), host, port)
所以,应该只有一个 endpoint。
接下来,从标准输入(std::cin
)读一行数据,然后通过 boost::asio::write
发送给 Server:
1
2
3
4
5
6
7
8
9
char request[BUF_SIZE];
std::size_t request_length = 0;
do {
std::cout << "Enter message: ";
std::cin.getline(request, BUF_SIZE);
request_length = std::strlen(request);
} while (request_length == 0);
boost::asio::write(socket, boost::asio::buffer(request, request_length));
do...while
是为了防止用户直接 Enter 导致输入为空。boost::asio::write
是阻塞调用,发送完才返回。
从 Server 同步接收数据有两种方式:
- 使用
boost::asio::read
(对应于boost::asio::write
); - 使用
socket.read_some
。
两者的差别是,boost::asio::read
读到指定长度时,就会返回,你需要知道你想读多少;而 socket.read_some
一旦读到一些数据就会返回,所以必须放在循环里,然后手动判断是否已经读到想要的长度,否则无法退出循环。
下面分别是两种实现的代码。
使用 boost::asio::read
:
1
2
3
4
5
6
char reply[BUF_SIZE];
std::size_t reply_length = boost::asio::read(
socket,
boost::asio::buffer(reply, request_length));
std::cout.write(reply, reply_length);
使用 socket.read_some
:
1
2
3
4
5
6
7
8
9
10
11
12
std::size_t total_reply_length = 0;
while (true) {
std::array<char, BUF_SIZE> reply;
std::size_t reply_length = socket.read_some(boost::asio::buffer(reply));
std::cout.write(reply.data(), reply_length);
total_reply_length += reply_length;
if (total_reply_length >= request_length) {
break;
}
}
不难看出,socket.read_some
用起来更为复杂。
Echo 程序的特殊之处就是,你可以假定 Server 会原封不动的把请求发回来,所以你知道 Client 要读多少。
但是很多时候,我们不知道要读多少数据。
所以,socket.read_some
反倒更为实用。
此外,在这个例子中,我们没有为各函数指定输出参数 boost::system::error_code
,而是使用了异常,把整个代码块放在 try...catch
中。
1
2
3
4
5
try {
// ...
} catch (const std::exception& e) {
std::cerr << e.what() << std::endl;
}
Asio 的 API 基本都通过重载(overload),提供了 error_code
和 exception
两种错误处理方式。使用异常更易于错误处理,也可以简化代码,但是 try...catch
该包含多少代码,并不是那么明显,新手很容易误用,什么都往 try...catch
里放。
一般来说,异步方式下,使用 error_code
更方便一些。所以 complete handler 的参数都有 error_code
。
异步方式
就 Client 来说,异步也许并非必要,除非想同时连接多个 Server。
异步读写前面已经涉及,我们就先看 async_resolve
和 async_connect
。
首先,抽取出一个类 Client
:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
class Client {
public:
Client(boost::asio::io_context& ioc,
const std::string& host, const std::string& port)
: socket_(ioc), resolver_(ioc) {
}
private:
tcp::socket socket_;
tcp::resolver resolver_;
char cin_buf_[BUF_SIZE];
std::array<char, BUF_SIZE> buf_;
};
resolver_
是为了 async_resolve
,作为成员变量,生命周期便得到了保证,不会因为函数结束而失效。
下面来看 async_resolve
实现(代码在构造函数中):
1
2
3
4
5
6
Client(...) {
resolver_.async_resolve(tcp::v4(), host, port,
std::bind(&Client::OnResolve, this,
std::placeholders::_1,
std::placeholders::_2));
}
async_resolve
的 handler:
1
2
3
4
5
6
7
8
9
10
11
void OnResolve(boost::system::error_code ec,
tcp::resolver::results_type endpoints) {
if (ec) {
std::cerr << "Resolve: " << ec.message() << std::endl;
} else {
boost::asio::async_connect(socket_, endpoints,
std::bind(&Client::OnConnect, this,
std::placeholders::_1,
std::placeholders::_2));
}
}
async_connect
的 handler:
1
2
3
4
5
6
7
8
void OnConnect(boost::system::error_code ec, tcp::endpoint endpoint) {
if (ec) {
std::cout << "Connect failed: " << ec.message() << std::endl;
socket_.close();
} else {
DoWrite();
}
}
连接成功后,调用 DoWrite
,从标准输入读取一行数据,然后异步发送给 Server。
下面是异步读写相关的函数,一并给出:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
void DoWrite() {
std::size_t len = 0;
do {
std::cout << "Enter message: ";
std::cin.getline(cin_buf_, BUF_SIZE);
len = strlen(cin_buf_);
} while (len == 0);
boost::asio::async_write(socket_,
boost::asio::buffer(cin_buf_, len),
std::bind(&Client::OnWrite, this,
std::placeholders::_1));
}
void OnWrite(boost::system::error_code ec) {
if (!ec) {
std::cout << "Reply is: ";
socket_.async_read_some(boost::asio::buffer(buf_),
std::bind(&Client::OnRead, this,
std::placeholders::_1,
std::placeholders::_2));
}
}
void OnRead(boost::system::error_code ec, std::size_t length) {
if (!ec) {
std::cout.write(buf_.data(), length);
std::cout << std::endl;
// 如果想继续下一轮,可以在这里调用 DoWrite()。
}
}
异步读写在异步 Server 那一节已经介绍过,这里就不再赘述了。
最后是 main()
:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
int main(int argc, char* argv[]) {
if (argc != 3) {
std::cerr << "Usage: " << argv[0] << " <host> <port>" << std::endl;
return 1;
}
const char* host = argv[1];
const char* port = argv[2];
boost::asio::io_context ioc;
Client client(ioc, host, port);
ioc.run();
return 0;
}
至此,异步方式的 Echo Client 就算实现了。
为了避免文章太长,Asio 的介绍暂时先告一段落。若有补遗,会另行记录。
完整及更加丰富的示例代码,请移步 GitHub。
Asio Tips And Notes
本文列举 Asio 各种值得注意的细节。
No Deprecated
在包含 Asio 头文件之前,定义宏 BOOST_ASIO_NO_DEPRECATED
,这样在编译时,Asio 就会剔除那些已经过时的接口。
比如在最新的 Boost 1.66 中,io_service
已经改名为 io_context
,如果没有 BOOST_ASIO_NO_DEPRECATED
,还是可以用 io_service
的,虽然那只是 io_context
的一个 typedef
。
BOOST_ASIO_NO_DEPRECATED
可以保证你用的是最新修订的 API。长期来看,有便于代码的维护。何况,这些修订正是 Asio 进入标准库的前奏。
1
2
3
4
#define BOOST_ASIO_NO_DEPRECATED
#include "boost/asio/io_context.hpp"
#include "boost/asio/steady_timer.hpp"
...
_WIN32_WINNT Warning
在 Windows 平台,编译时会遇到关于 _WIN32_WINNT
的警告。
可以说,这是 Asio 自身的问题。
它应该在某个地方包含 SDKDDKVer.h
。
不应该让用户自己去定义平台的版本。
如果你用 CMake,可以借助下面这个宏自动检测 _WIN32_WINNT
:
(详见:https://stackoverflow.com/a/40217291/6825348)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
if (WIN32)
macro(get_WIN32_WINNT version)
if (CMAKE_SYSTEM_VERSION)
set(ver ${CMAKE_SYSTEM_VERSION})
string(REGEX MATCH "^([0-9]+).([0-9])" ver ${ver})
string(REGEX MATCH "^([0-9]+)" verMajor ${ver})
# Check for Windows 10, b/c we'll need to convert to hex 'A'.
if ("${verMajor}" MATCHES "10")
set(verMajor "A")
string(REGEX REPLACE "^([0-9]+)" ${verMajor} ver ${ver})
endif ("${verMajor}" MATCHES "10")
# Remove all remaining '.' characters.
string(REPLACE "." "" ver ${ver})
# Prepend each digit with a zero.
string(REGEX REPLACE "([0-9A-Z])" "0\\1" ver ${ver})
set(${version} "0x${ver}")
endif(CMAKE_SYSTEM_VERSION)
endmacro(get_WIN32_WINNT)
get_WIN32_WINNT(ver)
add_definitions(-D_WIN32_WINNT=${ver})
endif(WIN32)
尽量少包含头文件
尽量不要直接包含大而全的 boost/asio.hpp
。
这样做,是为了帮助自己记忆哪个类源于哪个具体的头文件,以及避免包含那些不必要的头文件。
在实际项目中,在你自己的某个「头文件」里简单粗暴的包含 boost/asio.hpp
是很不妥的;当然,在你的「源文件」里包含 boost/asio.hpp
是可以接受的,毕竟实际项目依赖的东西比较多,很难搞清楚每一个定义源自哪里。
Handler 签名问题
虽然关于 Handler 的签名,文档里都有说明,但是直接定位到源码,更方便,也更精确。
以 steady_timer.async_wait()
为例,在 IDE 里定位到 async_wait()
的定义,代码(片段)如下:
1
2
3
4
5
template <typename WaitHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(WaitHandler,
void (boost::system::error_code))
async_wait(BOOST_ASIO_MOVE_ARG(WaitHandler) handler)
{
通过宏 BOOST_ASIO_INITFN_RESULT_TYPE
,WaitHandler
的签名一目了然。
Handler 的 error_code 参数到底是不是引用?
其实,早期的版本应该是 const boost::system::error_code&
,现在文档和代码注释里还有这么写的,估计是没来得及更新。
前面在说 Handler 签名时,已经看到 BOOST_ASIO_INITFN_RESULT_TYPE
这个宏的提示作用,翻一翻 Asio 源码,error_code
其实都已经传值了。
奇怪的是,即使你的 Handler 传 error_code
为引用,编译运行也都没有问题。
1
2
3
4
5
6
7
8
9
10
11
12
13
void Print(const boost::system::error_code& ec) {
std::cout << "Hello, world!" << std::endl;
}
int main() {
boost::asio::io_context ioc;
boost::asio::steady_timer timer(ioc, std::chrono::seconds(3));
timer.async_wait(&Print);
ioc.run();
return 0;
}
而我发现,当 Handler 是成员函数时,就不行了。下面这个 timer 的例子,如果把 Print
的 error_code
改成引用,就不能编译了。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class Printer {
public:
...
void Start() {
timer_.async_wait(std::bind(&Printer::Print, this, std::placeholders::_1));
}
private:
// 不能用 const boost::system::error_code&
void Print(boost::system::error_code ec) {
...
}
private:
boost::asio::steady_timer timer_;
int count_;
};
这个问题在习惯了引用的情况下,害苦了我,真是百思不得其解!也算是 Boost 比较坑的一个地方吧。 2019/08/30: 实测 1.70 没有这个问题,可以用 const reference。也许是 1.66 的 bug 吧。
Bind 占位符
调用 bind
时,使用了占位符(placeholder),其实下面四种写法都可以:
1
2
3
4
boost::bind(Print, boost::asio::placeholders::error, &timer, &count)
boost::bind(Print, boost::placeholders::_1, &timer, &count);
boost::bind(Print, _1, &timer, &count);
std::bind(Print, std::placeholders::_1, &timer, &count);
第一种,占位符是 Boost Asio 定义的。
第二种,占位符是 Boost Bind 定义的。
第三种,同第二种,之所以可行,是因为 boost/bind.hpp
里有一句 using namespace boost::placeholders;
。
1
2
3
4
5
6
7
// boost/bind.hpp
#include <boost/bind/bind.hpp>
#ifndef BOOST_BIND_NO_PLACEHOLDERS
using namespace boost::placeholders;
...
第四种,STL Bind,类似于 Boost Bind,只是没有声明 using namespace std::placeholders;
。
四种写法,推荐使用二或四。至于是用 Boost Bind 还是 STL Bind,没那么重要。
此外,数字占位符共有 9 个,_1
- _9
。
Endpoint 是一个单词
不要写成 “end point”。
Server 也可以用 Resolver
TCP Server 的 acceptor 一般是这样构造的:
1
tcp::acceptor(io_context, tcp::endpoint(tcp::v4(), port))
也就是说,指定 protocol (tcp::v4()
) 和 port 就行了。
但是,Asio 的 http 这个例子,确实用了 resolver,根据 IP 地址 resolve 出 endpoint:
1
2
3
4
5
6
7
8
9
10
11
12
tcp::resolver resolver(io_context_);
tcp::resolver::results_type endpoints = resolver.resolve(address, port);
tcp::endpoint endpoint = *endpoints.begin();
acceptor_.open(endpoint.protocol());
acceptor_.set_option(tcp::acceptor::reuse_address(true));
acceptor_.bind(endpoint);
acceptor_.listen();
acceptor_.async_accept(...);
http 这个例子之所以这么写,主要是初始化 acceptor_
时,还拿不到 endpoint,否则可以直接用下面这个构造函数:
1
2
basic_socket_acceptor(boost::asio::io_context& io_context,
const endpoint_type& endpoint, bool reuse_addr = true)
这个构造函数注释说它等价于下面这段代码:
1
2
3
4
5
6
basic_socket_acceptor<Protocol> acceptor(io_context);
acceptor.open(endpoint.protocol());
if (reuse_addr)
acceptor.set_option(socket_base::reuse_address(true));
acceptor.bind(endpoint);
acceptor.listen(listen_backlog);
下面是不同的 address
对应的 endpoints 结果(假定 port 都是 8080
):
- “localhost”: [::1]:8080, v6; [127.0.0.1]:8080, v4
- “0.0.0.0”: 0.0.0.0:8080, v4
- “0::0”: [::]:8080, v6
- 本机实际 IP 地址 (e.g., IPv4 “10.123.164.142”): 10.123.164.142:8080, v4。这时候,本机 client 无法通过 “localhost” 连接到这个 server,通过具体的 IP 地址则可以。
- 一个具体的非本机地址 (e.g., IPv4 “10.123.164.145”): exception: bind: The requested address is not valid in its context
Move Acceptable Handler
使用 acceptor.async_accept
时,发现了 Move Acceptable Handler。
简单来说,async_accept
接受两种 AcceptHandler,直接看源码:
1
2
3
4
template <typename MoveAcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(MoveAcceptHandler,
void (boost::system::error_code, typename Protocol::socket))
async_accept(BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler)
1
2
3
4
5
6
template <typename Protocol1, typename AcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(AcceptHandler,
void (boost::system::error_code))
async_accept(basic_socket<Protocol1>& peer,
BOOST_ASIO_MOVE_ARG(AcceptHandler) handler,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
第一种是 Move Acceptable Handler,它的第二个参数是新 accept 的 socket。 第二种是普通的 Handler,它的第一个参数是预先构造的 socket。
对于 Move Acceptable Handler,用 bind 行不通。比如给定:
1
2
3
void Server::HandleAccept(boost::system::error_code ec,
boost::asio::ip::tcp::socket socket) {
}
在 VS 2015 下(支持 C++14),std::bind
可以编译,boost::bind
则不行。
1
2
3
4
5
// std::bind 可以,boost::bind 不可以。
acceptor_.async_accept(std::bind(&Server::HandleAccept,
this,
std::placeholders::_1,
std::placeholders::_2));
在 VS 2013 下,std::bind
和 boost::bind
都不行。
结论是,对于 Move Acceptable Handler,不要用 bind,直接用 lambda 表达式:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
void DoAccept() {
acceptor_.async_accept(
[this](boost::system::error_code ec, boost::asio::ip::tcp::socket socket) {
// Check whether the server was stopped by a signal before this
// completion handler had a chance to run.
if (!acceptor_.is_open()) {
return;
}
if (!ec) {
connection_manager_.Start(
std::make_shared<Connection>(std::move(socket),
connection_manager_,
request_handler_));
}
DoAccept();
});
}