diff options
| author | Oleg Iarygin <oleg@arhadthedev.net> | 2022-11-02 04:52:19 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-02 04:52:19 (GMT) |
| commit | 898d0d9ad8328326ba5f7df9952e9dc287766ca3 (patch) | |
| tree | 93f0b3ffe66e2bca7584d49328b9d2fdf5a09def /Doc | |
| parent | 65d1407737befc3e9430eda8ae14ab1c7f9d8c7a (diff) | |
| download | cpython-898d0d9ad8328326ba5f7df9952e9dc287766ca3.zip cpython-898d0d9ad8328326ba5f7df9952e9dc287766ca3.tar.gz cpython-898d0d9ad8328326ba5f7df9952e9dc287766ca3.tar.bz2 | |
gh-92679: Clarify asyncio.loop.start_tls parameters (#92682)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/asyncio-eventloop.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 4f12074..d0a1ed2 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -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: |