Skip to content

Commit 722e189

Browse files
committed
Revert "bpo-44011: Document ssl_shutdown_timeout added by revisited asyncio SSL implementation (GH-31597)"
This reverts commit 41ddcd3.
1 parent 07e6a8f commit 722e189

File tree

1 file changed

+5
-55
lines changed

1 file changed

+5
-55
lines changed

Doc/library/asyncio-eventloop.rst

Lines changed: 5 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,6 @@ Opening network connections
376376
family=0, proto=0, flags=0, sock=None, \
377377
local_addr=None, server_hostname=None, \
378378
ssl_handshake_timeout=None, \
379-
ssl_shutdown_timeout=None, \
380379
happy_eyeballs_delay=None, interleave=None)
381380
382381
Open a streaming transport connection to a given
@@ -464,10 +463,6 @@ Opening network connections
464463
to wait for the TLS handshake to complete before aborting the connection.
465464
``60.0`` seconds if ``None`` (default).
466465

467-
* *ssl_shutdown_timeout* is the time in seconds to wait for the SSL shutdown
468-
to complete before aborting the connection. ``30.0`` seconds if ``None``
469-
(default).
470-
471466
.. versionchanged:: 3.5
472467

473468
Added support for SSL/TLS in :class:`ProactorEventLoop`.
@@ -496,10 +491,6 @@ Opening network connections
496491

497492
For more information: https://tools.ietf.org/html/rfc6555
498493

499-
.. versionchanged:: 3.11
500-
501-
Added the *ssl_shutdown_timeout* parameter.
502-
503494
.. seealso::
504495

505496
The :func:`open_connection` function is a high-level alternative
@@ -585,8 +576,7 @@ Opening network connections
585576

586577
.. coroutinemethod:: loop.create_unix_connection(protocol_factory, \
587578
path=None, *, ssl=None, sock=None, \
588-
server_hostname=None, ssl_handshake_timeout=None, \
589-
ssl_shutdown_timeout=None)
579+
server_hostname=None, ssl_handshake_timeout=None)
590580
591581
Create a Unix connection.
592582

@@ -609,10 +599,6 @@ Opening network connections
609599
Added the *ssl_handshake_timeout* parameter.
610600
The *path* parameter can now be a :term:`path-like object`.
611601

612-
.. versionchanged:: 3.11
613-
614-
Added the *ssl_shutdown_timeout* parameter.
615-
616602

617603
Creating network servers
618604
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -623,9 +609,7 @@ Creating network servers
623609
flags=socket.AI_PASSIVE, \
624610
sock=None, backlog=100, ssl=None, \
625611
reuse_address=None, reuse_port=None, \
626-
ssl_handshake_timeout=None, \
627-
ssl_shutdown_timeout=None, \
628-
start_serving=True)
612+
ssl_handshake_timeout=None, start_serving=True)
629613
630614
Create a TCP server (socket type :data:`~socket.SOCK_STREAM`) listening
631615
on *port* of the *host* address.
@@ -685,10 +669,6 @@ Creating network servers
685669
for the TLS handshake to complete before aborting the connection.
686670
``60.0`` seconds if ``None`` (default).
687671

688-
* *ssl_shutdown_timeout* is the time in seconds to wait for the SSL shutdown
689-
to complete before aborting the connection. ``30.0`` seconds if ``None``
690-
(default).
691-
692672
* *start_serving* set to ``True`` (the default) causes the created server
693673
to start accepting connections immediately. When set to ``False``,
694674
the user should await on :meth:`Server.start_serving` or
@@ -709,10 +689,6 @@ Creating network servers
709689
The socket option :py:data:`~socket.TCP_NODELAY` is set by default
710690
for all TCP connections.
711691

712-
.. versionchanged:: 3.11
713-
714-
Added the *ssl_shutdown_timeout* parameter.
715-
716692
.. seealso::
717693

718694
The :func:`start_server` function is a higher-level alternative API
@@ -722,9 +698,7 @@ Creating network servers
722698

723699
.. coroutinemethod:: loop.create_unix_server(protocol_factory, path=None, \
724700
*, sock=None, backlog=100, ssl=None, \
725-
ssl_handshake_timeout=None, \
726-
ssl_shutdown_timeout=None, \
727-
start_serving=True)
701+
ssl_handshake_timeout=None, start_serving=True)
728702
729703
Similar to :meth:`loop.create_server` but works with the
730704
:py:data:`~socket.AF_UNIX` socket family.
@@ -744,14 +718,8 @@ Creating network servers
744718
Added the *ssl_handshake_timeout* and *start_serving* parameters.
745719
The *path* parameter can now be a :class:`~pathlib.Path` object.
746720

747-
.. versionchanged:: 3.11
748-
749-
Added the *ssl_shutdown_timeout* parameter.
750-
751-
752721
.. coroutinemethod:: loop.connect_accepted_socket(protocol_factory, \
753-
sock, *, ssl=None, ssl_handshake_timeout=None, \
754-
ssl_shutdown_timeout=None)
722+
sock, *, ssl=None, ssl_handshake_timeout=None)
755723
756724
Wrap an already accepted connection into a transport/protocol pair.
757725

@@ -773,10 +741,6 @@ Creating network servers
773741
wait for the SSL handshake to complete before aborting the connection.
774742
``60.0`` seconds if ``None`` (default).
775743

776-
* *ssl_shutdown_timeout* is the time in seconds to wait for the SSL shutdown
777-
to complete before aborting the connection. ``30.0`` seconds if ``None``
778-
(default).
779-
780744
Returns a ``(transport, protocol)`` pair.
781745

782746
.. versionadded:: 3.5.3
@@ -785,10 +749,6 @@ Creating network servers
785749

786750
Added the *ssl_handshake_timeout* parameter.
787751

788-
.. versionchanged:: 3.11
789-
790-
Added the *ssl_shutdown_timeout* parameter.
791-
792752

793753
Transferring files
794754
^^^^^^^^^^^^^^^^^^
@@ -825,8 +785,7 @@ TLS Upgrade
825785

826786
.. coroutinemethod:: loop.start_tls(transport, protocol, \
827787
sslcontext, *, server_side=False, \
828-
server_hostname=None, ssl_handshake_timeout=None, \
829-
ssl_shutdown_timeout=None)
788+
server_hostname=None, ssl_handshake_timeout=None)
830789
831790
Upgrade an existing transport-based connection to TLS.
832791

@@ -852,17 +811,8 @@ TLS Upgrade
852811
wait for the TLS handshake to complete before aborting the connection.
853812
``60.0`` seconds if ``None`` (default).
854813

855-
* *ssl_shutdown_timeout* is the time in seconds to wait for the SSL shutdown
856-
to complete before aborting the connection. ``30.0`` seconds if ``None``
857-
(default).
858-
859814
.. versionadded:: 3.7
860815

861-
.. versionchanged:: 3.11
862-
863-
Added the *ssl_shutdown_timeout* parameter.
864-
865-
866816

867817
Watching file descriptors
868818
^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)