gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)

(cherry picked from commit 898d0d9ad8)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
This commit is contained in:
Miss Islington (bot) 2022-11-01 22:05:28 -07:00 committed by GitHub
parent 8a7695e2b7
commit 5f0d266af9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View 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: