Commit a9802d2e authored by Victor Stinner's avatar Victor Stinner

Issue #22564: ssl doc: use "class" marker to document the SSLSocket class

parent c451af6c
...@@ -755,30 +755,32 @@ Constants ...@@ -755,30 +755,32 @@ Constants
SSL Sockets SSL Sockets
----------- -----------
SSL sockets provide the following methods of :ref:`socket-objects`: .. class:: SSLSocket(socket.socket)
- :meth:`~socket.socket.accept()` SSL sockets provide the following methods of :ref:`socket-objects`:
- :meth:`~socket.socket.bind()`
- :meth:`~socket.socket.close()` - :meth:`~socket.socket.accept()`
- :meth:`~socket.socket.connect()` - :meth:`~socket.socket.bind()`
- :meth:`~socket.socket.detach()` - :meth:`~socket.socket.close()`
- :meth:`~socket.socket.fileno()` - :meth:`~socket.socket.connect()`
- :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()` - :meth:`~socket.socket.detach()`
- :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()` - :meth:`~socket.socket.fileno()`
- :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`, - :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()`
:meth:`~socket.socket.setblocking()` - :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()`
- :meth:`~socket.socket.listen()` - :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`,
- :meth:`~socket.socket.makefile()` :meth:`~socket.socket.setblocking()`
- :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()` - :meth:`~socket.socket.listen()`
(but passing a non-zero ``flags`` argument is not allowed) - :meth:`~socket.socket.makefile()`
- :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with - :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()`
the same limitation) (but passing a non-zero ``flags`` argument is not allowed)
- :meth:`~socket.socket.shutdown()` - :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with
the same limitation)
However, since the SSL (and TLS) protocol has its own framing atop - :meth:`~socket.socket.shutdown()`
of TCP, the SSL sockets abstraction can, in certain respects, diverge from
the specification of normal, OS-level sockets. See especially the However, since the SSL (and TLS) protocol has its own framing atop
:ref:`notes on non-blocking sockets <ssl-nonblocking>`. of TCP, the SSL sockets abstraction can, in certain respects, diverge from
the specification of normal, OS-level sockets. See especially the
:ref:`notes on non-blocking sockets <ssl-nonblocking>`.
SSL sockets also have the following additional methods and attributes: SSL sockets also have the following additional methods and attributes:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment