Skip to content

Commit

Permalink
Update documentation for SSLSocket.eager_recv
Browse files Browse the repository at this point in the history
  • Loading branch information
Safihre committed Nov 29, 2022
1 parent ed876cf commit 5938d5f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Doc/library/ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1315,6 +1315,20 @@ SSL sockets also have the following additional methods and attributes:

.. versionadded:: 3.2

.. attribute:: SSLSocket.eager_recv

If set to ``True``, a call to :meth:`~socket.socket.recv()` or
:meth:`~socket.socket.recv_into()` on a
:ref:`non-blocking <ssl-nonblocking>` TLS socket
will drop the GIL once to read the entire buffer instead of reading at most
one TLS record (16 KB).

.. note::
Reading the entire buffer can include the TLS EOF segment, which will
close the TLS layer without raising :exc:`SSLEOFError`.

.. versionadded:: 3.11

.. attribute:: SSLSocket.server_side

A boolean which is ``True`` for server-side sockets and ``False`` for
Expand Down

0 comments on commit 5938d5f

Please sign in to comment.