summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-10-10 10:07:19 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-10-10 10:07:19 (GMT)
commitd28fe8c8f461c153b1d3252d52d7b0c494402a4e (patch)
tree0341f675e5fb529d484ebb1a799da40eba17e7eb
parent3c3d3c73f3f55383f2ce71aebf08a1cd8c8ac7b4 (diff)
downloadcpython-d28fe8c8f461c153b1d3252d52d7b0c494402a4e.zip
cpython-d28fe8c8f461c153b1d3252d52d7b0c494402a4e.tar.gz
cpython-d28fe8c8f461c153b1d3252d52d7b0c494402a4e.tar.bz2
Issue #22564: ssl doc: mention how SSLSocket are usually created
-rw-r--r--Doc/library/ssl.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 5f4a118..6489ecf 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -782,6 +782,9 @@ SSL Sockets
the specification of normal, OS-level sockets. See especially the
:ref:`notes on non-blocking sockets <ssl-nonblocking>`.
+ Usually, :class:`SSLSocket` are not created directly, but using the
+ :func:`wrap_socket` function or the :meth:`SSLContext.wrap_socket` method.
+
SSL sockets also have the following additional methods and attributes:
.. method:: SSLSocket.read(len=0, buffer=None)