Mention that SSL sockets provide the basic socket API.

792ff3e7 · Antoine Pitrou · 035cedb4 · 792ff3e7
Commit 792ff3e7 authored Sep 19, 2010 by Antoine Pitrou
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

Doc/library/ssl.rst Doc/library/ssl.rst +6 -0

No files found.
--- 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.