boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-30 12:57:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify teardown and async_teardown are customization points

Browse Source 
Addresses #2479
This commit is contained in:
Mohammad Nejati
2024-01-26 09:17:23 +00:00
committed by Mohammad Nejati
parent 3b837c6982
commit 5f088b72ca
2 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/boost/beast/websocket/ssl.hpp
View File

@ -27,6 +27,11 @@ namespace beast {
`net::ssl::stream`, callers are responsible for `net::ssl::stream`, callers are responsible for
providing a suitable overload of this function. 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 role The role of the local endpoint
@param stream The stream to tear down. @param stream The stream to tear down.
@ -50,6 +55,11 @@ teardown(
callers are responsible for providing a suitable overload callers are responsible for providing a suitable overload
of this function. 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 role The role of the local endpoint
@param stream The stream to tear down. @param stream The stream to tear down.

20
include/boost/beast/websocket/teardown.hpp
View File

@ -29,6 +29,11 @@ namespace websocket {
`net::ssl::stream`, callers are responsible for `net::ssl::stream`, callers are responsible for
providing a suitable overload of this function. 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 role The role of the local endpoint
@param socket The socket to tear down. @param socket The socket to tear down.
@ -65,6 +70,11 @@ teardown(
callers are responsible for providing a suitable overload callers are responsible for providing a suitable overload
of this function. 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 role The role of the local endpoint
@param socket The socket to tear down. @param socket The socket to tear down.
@ -122,6 +132,11 @@ namespace websocket {
`net::ssl::stream`, callers are responsible for `net::ssl::stream`, callers are responsible for
providing a suitable overload of this function. 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 role The role of the local endpoint
@param socket The socket to tear down. @param socket The socket to tear down.
@ -146,6 +161,11 @@ teardown(
callers are responsible for providing a suitable overload callers are responsible for providing a suitable overload
of this function. 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 role The role of the local endpoint
@param socket The socket to tear down. @param socket The socket to tear down.