From 8d2f1c23318bbf755ca14bb8aa3c1e81a6199e65 Mon Sep 17 00:00:00 2001 From: Oleg Iarygin Date: Wed, 2 Nov 2022 08:52:19 +0400 Subject: [PATCH] gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682) (cherry picked from commit 898d0d9ad8328326ba5f7df9952e9dc287766ca3) Co-authored-by: Oleg Iarygin --- Doc/library/asyncio-eventloop.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 0565f902b7bc8a..4ad8dc08186da1 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -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: