Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
websocket::teardown (1 of 3 overloads)

Tear down a boost::asio::ssl::stream.

Synopsis

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

template<
    class SyncStream>
void
teardown(
    role_type role,
    boost::asio::ssl::stream< SyncStream >& stream,
    error_code& ec);
Description

This tears down a connection. 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.

ec

Set to the error if any occurred.

Convenience header <boost/beast/websocket.hpp>


PrevUpHomeNext