...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Inherited from basic_socket.
Start an asynchronous connect.
template< typename ConnectToken = default_completion_token_t<executor_type>> DEDUCED async_connect( const endpoint_type & peer_endpoint, ConnectToken && token = default_completion_token_t< executor_type >());
This function is used to asynchronously connect a socket to the specified remote endpoint. It is an initiating function for an asynchronous operation, and always returns immediately.
The socket is automatically opened if it is not already open. If the connect fails, and the socket was automatically opened, the socket is not returned to the closed state.
The remote endpoint to which the socket will be connected. Copies will be made of the endpoint object as required.
The completion
token that will be used to produce a completion handler, which
will be called when the connect completes. Potential completion tokens
include use_future
, use_awaitable
, yield_context
, or a function
object with the correct completion signature. The function signature
of the completion handler must be:
void handler( const boost::system::error_code& error // Result of operation. );
Regardless of whether the asynchronous operation completes immediately
or not, the completion handler will not be invoked from within this
function. On immediate completion, invocation of the handler will
be performed in a manner equivalent to using async_immediate
.
void(boost::system::error_code)
void connect_handler(const boost::system::error_code& error) { if (!error) { // Connect succeeded. } } ... boost::asio::ip::tcp::socket socket(my_context); boost::asio::ip::tcp::endpoint endpoint( boost::asio::ip::address::from_string("1.2.3.4"), 12345); socket.async_connect(endpoint, connect_handler);
On POSIX or Windows operating systems, this asynchronous operation supports
cancellation for the following cancellation_type
values:
cancellation_type::terminal
cancellation_type::partial
cancellation_type::total