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

This commit is contained in:
Oleg Iarygin 2022-11-02 08:52:19 +04:00 committed by GitHub
parent 65d1407737
commit 898d0d9ad8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions

View File

@ -877,9 +877,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: