...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Start tearing down a net::ip::tcp::socket
.
Defined in header <boost/beast/websocket/teardown.hpp>
template< class Protocol, class Executor, class TeardownHandler> void async_teardown( role_type role, net::basic_stream_socket< Protocol, Executor >& socket, TeardownHandler&& handler);
This begins tearing down a connection asynchronously. The implementation
will call the overload of this function based on the Stream
parameter used to consruct the socket. When Stream
is a user defined type, and not a net::ip::tcp::socket
or any net::ssl::stream
, callers are responsible for providing
a suitable overload of this function.
Name |
Description |
---|---|
|
The role of the local endpoint |
|
The socket to tear down. |
|
The completion handler to invoke when the operation completes. The implementation takes ownership of the handler by performing a decay-copy. The equivalent function signature of the handler must be: void handler( error_code const& error // result of operation ); |
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function. Invocation
of the handler will be performed in a manner equivalent to using net::post
.
Convenience header <boost/beast/websocket.hpp>