asio: Document asynchronous parameter for listen_and_serve

This commit is contained in:
Tatsuhiro Tsujikawa 2015-04-22 22:25:16 +09:00
parent a200bb1084
commit 4928959213
1 changed files with 8 additions and 2 deletions

View File

@ -136,14 +136,20 @@ public:
http2 &operator=(http2 &&other) noexcept; http2 &operator=(http2 &&other) noexcept;
// Starts listening connection on given address and port and serves // Starts listening connection on given address and port and serves
// incoming requests in cleartext TCP connection. // incoming requests in cleartext TCP connection. If |asynchronous|
// is false, this function blocks forever unless there is an error.
// If it is true, after server has started, this function returns
// immediately, and the caller should call join() to shutdown server
// gracefully.
boost::system::error_code listen_and_serve(boost::system::error_code &ec, boost::system::error_code listen_and_serve(boost::system::error_code &ec,
const std::string &address, const std::string &address,
const std::string &port, const std::string &port,
bool asynchronous = false); bool asynchronous = false);
// Starts listening connection on given address and port and serves // Starts listening connection on given address and port and serves
// incoming requests in SSL/TLS encrypted connection. // incoming requests in SSL/TLS encrypted connection. For
// |asynchronous| parameter, see cleartext version
// |listen_and_serve|.
boost::system::error_code boost::system::error_code
listen_and_serve(boost::system::error_code &ec, listen_and_serve(boost::system::error_code &ec,
boost::asio::ssl::context &tls_context, boost::asio::ssl::context &tls_context,