Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit dcea408971.
PrevUpHomeNext

teardown

Tear down a net::ssl::stream.

Synopsis

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

template<
    class SyncStream>
void
teardown(
    role_type role,
    net::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 net::ip::tcp::socket or any net::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.


PrevUpHomeNext