]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 2 Nov 2022 05:05:28 +0000 (22:05 -0700)
committerGitHub <noreply@github.com>
Wed, 2 Nov 2022 05:05:28 +0000 (22:05 -0700)
(cherry picked from commit 898d0d9ad8328326ba5f7df9952e9dc287766ca3)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
Doc/library/asyncio-eventloop.rst

index 0565f902b7bc8ac51b356782e8d0b2fe25d695c4..4ad8dc08186da100b5d0e23a869520b838f11d24 100644 (file)
@@ -808,9 +808,14 @@ TLS Upgrade
 
    Upgrade an existing transport-based connection to TLS.
 
-   Return a new transport instance, that the *protocol* must start using
-   immediately after the *await*.  The *transport* instance passed to
-   the *start_tls* method should never be used again.
+   Create a TLS coder/decoder instance and insert it between the *transport*
+   and the *protocol*. The coder/decoder implements both *transport*-facing
+   protocol and *protocol*-facing transport.
+
+   Return the created two-interface instance. After *await*, the *protocol*
+   must stop using the original *transport* and communicate with the returned
+   object only because the coder caches *protocol*-side data and sporadically
+   exchanges extra TLS session packets with *transport*.
 
    Parameters: