summaryrefslogtreecommitdiffstats
path: root/Doc/library/ssl.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-09-19 13:19:21 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-09-19 13:19:21 (GMT)
commit792ff3e7beb1f15858a391d35a5cae3650afcc7a (patch)
tree365441dd0f96d3975a0815896de4a76dd990f5d5 /Doc/library/ssl.rst
parent035cedb4a35d7762e851b637d438042676d0996f (diff)
downloadcpython-792ff3e7beb1f15858a391d35a5cae3650afcc7a.zip
cpython-792ff3e7beb1f15858a391d35a5cae3650afcc7a.tar.gz
cpython-792ff3e7beb1f15858a391d35a5cae3650afcc7a.tar.bz2
Mention that SSL sockets provide the basic socket API.
Diffstat (limited to 'Doc/library/ssl.rst')
-rw-r--r--Doc/library/ssl.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index ab7ffdb..4ab21d2 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -325,6 +325,12 @@ Functions, Constants, and Exceptions
SSL Sockets
-----------
+SSL sockets provide the basic interface of :ref:`socket-objects`. However,
+not all functionality is supported (for example, passing a non-zero ``flags``
+argument to :meth:`recv()` is not allowed).
+
+SSL sockets also have the following additional methods and attributes:
+
.. method:: SSLSocket.read(nbytes=1024, buffer=None)
Reads up to ``nbytes`` bytes from the SSL-encrypted channel and returns them.