mirror of https://github.com/python/cpython
Issue #22564: ssl doc: use "class" marker to document the SSLSocket class
This commit is contained in:
parent
41f92c2818
commit
3c3d3c73f3
|
@ -755,30 +755,32 @@ Constants
|
|||
SSL Sockets
|
||||
-----------
|
||||
|
||||
SSL sockets provide the following methods of :ref:`socket-objects`:
|
||||
.. class:: SSLSocket(socket.socket)
|
||||
|
||||
- :meth:`~socket.socket.accept()`
|
||||
- :meth:`~socket.socket.bind()`
|
||||
- :meth:`~socket.socket.close()`
|
||||
- :meth:`~socket.socket.connect()`
|
||||
- :meth:`~socket.socket.detach()`
|
||||
- :meth:`~socket.socket.fileno()`
|
||||
- :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()`
|
||||
- :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()`
|
||||
- :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`,
|
||||
:meth:`~socket.socket.setblocking()`
|
||||
- :meth:`~socket.socket.listen()`
|
||||
- :meth:`~socket.socket.makefile()`
|
||||
- :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()`
|
||||
(but passing a non-zero ``flags`` argument is not allowed)
|
||||
- :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with
|
||||
the same limitation)
|
||||
- :meth:`~socket.socket.shutdown()`
|
||||
SSL sockets provide the following methods of :ref:`socket-objects`:
|
||||
|
||||
However, since the SSL (and TLS) protocol has its own framing atop
|
||||
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>`.
|
||||
- :meth:`~socket.socket.accept()`
|
||||
- :meth:`~socket.socket.bind()`
|
||||
- :meth:`~socket.socket.close()`
|
||||
- :meth:`~socket.socket.connect()`
|
||||
- :meth:`~socket.socket.detach()`
|
||||
- :meth:`~socket.socket.fileno()`
|
||||
- :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()`
|
||||
- :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()`
|
||||
- :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`,
|
||||
:meth:`~socket.socket.setblocking()`
|
||||
- :meth:`~socket.socket.listen()`
|
||||
- :meth:`~socket.socket.makefile()`
|
||||
- :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()`
|
||||
(but passing a non-zero ``flags`` argument is not allowed)
|
||||
- :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with
|
||||
the same limitation)
|
||||
- :meth:`~socket.socket.shutdown()`
|
||||
|
||||
However, since the SSL (and TLS) protocol has its own framing atop
|
||||
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:
|
||||
|
||||
|
|
Loading…
Reference in New Issue