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

PrevUpHomeNext
websocket::teardown (2 of 2 overloads)

Tear down a net::ip::tcp::socket.

Synopsis

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

template<
    class Protocol,
    class Executor>
void
teardown(
    role_type role,
    net::basic_stream_socket< Protocol, Executor >& socket,
    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

socket

The socket to tear down.

ec

Set to the error if any occurred.

Convenience header <boost/beast/websocket.hpp>


PrevUpHomeNext