diff options
author | Victor Stinner <victor.stinner@gmail.com> | 2014-10-10 10:06:51 (GMT) |
---|---|---|
committer | Victor Stinner <victor.stinner@gmail.com> | 2014-10-10 10:06:51 (GMT) |
commit | 3c3d3c73f3f55383f2ce71aebf08a1cd8c8ac7b4 (patch) | |
tree | a13cb161f1c4a574a8b6cbc9a8f9bf2f998747dc /Doc | |
parent | 41f92c2818a2ea63a82a444547c10d7f88a30f1a (diff) | |
download | cpython-3c3d3c73f3f55383f2ce71aebf08a1cd8c8ac7b4.zip cpython-3c3d3c73f3f55383f2ce71aebf08a1cd8c8ac7b4.tar.gz cpython-3c3d3c73f3f55383f2ce71aebf08a1cd8c8ac7b4.tar.bz2 |
Issue #22564: ssl doc: use "class" marker to document the SSLSocket class
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/ssl.rst | 50 |
1 files changed, 26 insertions, 24 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 7d89ea6..5f4a118 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -755,30 +755,32 @@ Constants SSL Sockets ----------- -SSL sockets provide the following methods of :ref:`socket-objects`: - -- :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>`. +.. class:: SSLSocket(socket.socket) + + SSL sockets provide the following methods of :ref:`socket-objects`: + + - :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: |