8000 gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682) · python/cpython@46ccb35 · GitHub
[go: up one dir, main page]

Skip to content

Commit 46ccb35

Browse files
gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)
(cherry picked from commit 898d0d9) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
1 parent d683bcc commit 46ccb35

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

Doc/library/asyncio-eventloop.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -856,9 +856,14 @@ TLS Upgrade
856856
857857
Upgrade an existing transport-based connection to TLS.
858858

859-
Return a new transport instance, that the *protocol* must start using
860-
immediately after the *await*. The *transport* instance passed to
861-
the *start_tls* method should never be used again.
859+
Create a TLS coder/decoder instance and insert it between the *transport*
860+
and the *protocol*. The coder/decoder implements both *transport*-facing
861+
protocol and *protocol*-facing transport.
862+
863+
Return the created two-interface instance. After *await*, the *protocol*
864+
must stop using the original *transport* and communicate with the returned
865+
object only because the coder caches *protocol*-side data and sporadically
866+
exchanges extra TLS session packets with *transport*.
862867

863868
Parameters:
864869

0 commit comments

Comments
 (0)
0