From: Antoine Pitrou <solipsis@pitrou.net>
Date: Sun, 19 Sep 2010 13:19:21 +0000 (+0000)
Subject: Mention that SSL sockets provide the basic socket API.
X-Git-Tag: v3.2a3~213
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=792ff3e7beb1f15858a391d35a5cae3650afcc7a;p=python

Mention that SSL sockets provide the basic socket API.
---

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index ab7ffdb0d3..4ab21d2e0d 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.