Skip to content

Commit 898d0d9

Browse files
authored
gh-92679: Clarify asyncio.loop.start_tls parameters (#92682)
1 parent 65d1407 commit 898d0d9

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

Doc/library/asyncio-eventloop.rst

+8-3
Original file line numberDiff line numberDiff line change
@@ -877,9 +877,14 @@ TLS Upgrade
877877
878878
Upgrade an existing transport-based connection to TLS.
879879

880-
Return a new transport instance, that the *protocol* must start using
881-
immediately after the *await*. The *transport* instance passed to
882-
the *start_tls* method should never be used again.
880+
Create a TLS coder/decoder instance and insert it between the *transport*
881+
and the *protocol*. The coder/decoder implements both *transport*-facing
882+
protocol and *protocol*-facing transport.
883+
884+
Return the created two-interface instance. After *await*, the *protocol*
885+
must stop using the original *transport* and communicate with the returned
886+
object only because the coder caches *protocol*-side data and sporadically
887+
exchanges extra TLS session packets with *transport*.
883888

884889
Parameters:
885890

0 commit comments

Comments
 (0)