Skip to content

Commit 5f0d266

Browse files
gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)
(cherry picked from commit 898d0d9) Co-authored-by: Oleg Iarygin <[email protected]>
1 parent 8a7695e commit 5f0d266

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
@@ -808,9 +808,14 @@ TLS Upgrade
808808
809809
Upgrade an existing transport-based connection to TLS.
810810

811-
Return a new transport instance, that the *protocol* must start using
812-
immediately after the *await*. The *transport* instance passed to
813-
the *start_tls* method should never be used again.
811+
Create a TLS coder/decoder instance and insert it between the *transport*
812+
and the *protocol*. The coder/decoder implements both *transport*-facing
813+
protocol and *protocol*-facing transport.
814+
815+
Return the created two-interface instance. After *await*, the *protocol*
816+
must stop using the original *transport* and communicate with the returned
817+
object only because the coder caches *protocol*-side data and sporadically
818+
exchanges extra TLS session packets with *transport*.
814819

815820
Parameters:
816821

0 commit comments

Comments
 (0)