From 5f088b72ca92a27662476e5ec9b7a8ff777439c3 Mon Sep 17 00:00:00 2001 From: Mohammad Nejati Date: Fri, 26 Jan 2024 09:17:23 +0000 Subject: [PATCH] Clarify `teardown` and `async_teardown` are customization points Addresses #2479 --- include/boost/beast/websocket/ssl.hpp | 10 ++++++++++ include/boost/beast/websocket/teardown.hpp | 20 ++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/include/boost/beast/websocket/ssl.hpp b/include/boost/beast/websocket/ssl.hpp index 7f2a9cab..21198754 100644 --- a/include/boost/beast/websocket/ssl.hpp +++ b/include/boost/beast/websocket/ssl.hpp @@ -27,6 +27,11 @@ namespace beast { `net::ssl::stream`, callers are responsible for providing a suitable overload of this function. + @note + + This function serves as a customization point and is not intended + to be called directly. + @param role The role of the local endpoint @param stream The stream to tear down. @@ -50,6 +55,11 @@ teardown( callers are responsible for providing a suitable overload of this function. + @note + + This function serves as a customization point and is not intended + to be called directly. + @param role The role of the local endpoint @param stream The stream to tear down. diff --git a/include/boost/beast/websocket/teardown.hpp b/include/boost/beast/websocket/teardown.hpp index ab5321e4..9c92a913 100644 --- a/include/boost/beast/websocket/teardown.hpp +++ b/include/boost/beast/websocket/teardown.hpp @@ -29,6 +29,11 @@ namespace websocket { `net::ssl::stream`, callers are responsible for providing a suitable overload of this function. + @note + + This function serves as a customization point and is not intended + to be called directly. + @param role The role of the local endpoint @param socket The socket to tear down. @@ -65,6 +70,11 @@ teardown( callers are responsible for providing a suitable overload of this function. + @note + + This function serves as a customization point and is not intended + to be called directly. + @param role The role of the local endpoint @param socket The socket to tear down. @@ -122,6 +132,11 @@ namespace websocket { `net::ssl::stream`, callers are responsible for providing a suitable overload of this function. + @note + + This function serves as a customization point and is not intended + to be called directly. + @param role The role of the local endpoint @param socket The socket to tear down. @@ -146,6 +161,11 @@ teardown( callers are responsible for providing a suitable overload of this function. + @note + + This function serves as a customization point and is not intended + to be called directly. + @param role The role of the local endpoint @param socket The socket to tear down.