websocket::async_teardown (1 of 3 overloads)

Start tearing down a boost::asio::ssl::stream.

Synopsis

Defined in header <boost/beast/websocket/ssl.hpp>

template<
    class AsyncStream,
    class TeardownHandler>
void
async_teardown(
    role_type role,
    boost::asio::ssl::stream< AsyncStream >& stream,
    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 boost::asio::ip::tcp::socket or any boost::asio::ssl::stream, callers are responsible for providing a suitable overload of this function.

Parameters

Name	Description
`role`	The role of the local endpoint
`stream`	The stream to tear down.
`handler`	Invoked when the operation completes. The handler may be moved or copied as needed. 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 boost::asio::io_context::post().

Name

Description

role

The role of the local endpoint

stream

The stream to tear down.

handler

Invoked when the operation completes. The handler may be moved or copied as needed. 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 boost::asio::io_context::post().

Convenience header <boost/beast/websocket.hpp>

Boost C++ Libraries

websocket::async_teardown (1 of 3 overloads)

Synopsis

Description

Parameters