summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorbeavailable <beavailable@proton.me>2023-02-01 11:03:59 (GMT)
committerGitHub <noreply@github.com>2023-02-01 11:03:59 (GMT)
commitcc407b9de645ab7c137df8ea2409a005369169a5 (patch)
treec2df6b351a04a56153016e535f34f8f99b7a4724 /Doc
parent75227fba1dd1683289d90ada7abba237bff55d14 (diff)
downloadcpython-cc407b9de645ab7c137df8ea2409a005369169a5.zip
cpython-cc407b9de645ab7c137df8ea2409a005369169a5.tar.gz
cpython-cc407b9de645ab7c137df8ea2409a005369169a5.tar.bz2
gh-101317: Add `ssl_shutdown_timeout` parameter for `asyncio.StreamWriter.start_tls` (#101335)
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/asyncio-stream.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index c1ae8ab..533bdec 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -335,7 +335,7 @@ StreamWriter
returns immediately.
.. coroutinemethod:: start_tls(sslcontext, \*, server_hostname=None, \
- ssl_handshake_timeout=None)
+ ssl_handshake_timeout=None, ssl_shutdown_timeout=None)
Upgrade an existing stream-based connection to TLS.
@@ -350,8 +350,16 @@ StreamWriter
handshake to complete before aborting the connection. ``60.0`` seconds
if ``None`` (default).
+ * *ssl_shutdown_timeout* is the time in seconds to wait for the SSL shutdown
+ to complete before aborting the connection. ``30.0`` seconds if ``None``
+ (default).
+
.. versionadded:: 3.11
+ .. versionchanged:: 3.12
+ Added the *ssl_shutdown_timeout* parameter.
+
+
.. method:: is_closing()
Return ``True`` if the stream is closed or in the process of