diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-11-02 05:12:52 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-02 05:12:52 (GMT) |
| commit | 46ccb35a400b1abe8c29ad2d7f17295610d768c7 (patch) | |
| tree | dccef6f801eab3a37121ca6229d701b46eb3f60e | |
| parent | d683bcc7d092545d91ad3478a0d2c24c39d9ab02 (diff) | |
| download | cpython-46ccb35a400b1abe8c29ad2d7f17295610d768c7.zip cpython-46ccb35a400b1abe8c29ad2d7f17295610d768c7.tar.gz cpython-46ccb35a400b1abe8c29ad2d7f17295610d768c7.tar.bz2 | |
gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)
(cherry picked from commit 898d0d9ad8328326ba5f7df9952e9dc287766ca3)
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
| -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 93bca96..cf9b3b7 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -856,9 +856,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: |