diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-11-02 05:05:28 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-02 05:05:28 (GMT) |
| commit | 5f0d266af952ac140ea9ab68e65f4a423acd0672 (patch) | |
| tree | a69f38b1909e1c6cb1f5f19a25889a0cf2652538 | |
| parent | 8a7695e2b7c4d18719680995cffc88ccecf2a6a4 (diff) | |
| download | cpython-5f0d266af952ac140ea9ab68e65f4a423acd0672.zip cpython-5f0d266af952ac140ea9ab68e65f4a423acd0672.tar.gz cpython-5f0d266af952ac140ea9ab68e65f4a423acd0672.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 0565f90..4ad8dc0 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -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: |