summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorHynek Schlawack <hs@ox.cx>2015-08-18 20:48:12 +0200
committerHynek Schlawack <hs@ox.cx>2015-08-18 20:48:12 +0200
commit2db996e1fdee2b2bfb88dddd94e28739b95a2d42 (patch)
tree01ee197401d1b37617fc5dbcae5f2226b17b2ea8 /doc/api
parentcd0d22c16447cfea0e0e2d3147a905f1866530ac (diff)
parent1d95dea7fea03c7c0df345a5ea30c12d8a0378d2 (diff)
downloadpyopenssl-2db996e1fdee2b2bfb88dddd94e28739b95a2d42.tar.gz
Merge pull request #294 from mhils/ssl_peek
Add support for SSL_peek
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/ssl.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index 89ae6a1..0548678 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -669,11 +669,12 @@ Connection objects have the following methods:
(**not** the underlying transport buffer).
-.. py:method:: Connection.recv(bufsize)
+.. py:method:: Connection.recv(bufsize[, flags])
Receive data from the Connection. The return value is a string representing the
data received. The maximum amount of data to be received at once, is specified
- by *bufsize*.
+ by *bufsize*. The only supported flag is ``MSG_PEEK``, all other flags are
+ ignored.
.. py:method:: Connection.recv_into(buffer[, nbytes[, flags]])
@@ -681,8 +682,7 @@ Connection objects have the following methods:
Receive data from the Connection and copy it directly into the provided
buffer. The return value is the number of bytes read from the connection.
The maximum amount of data to be received at once is specified by *nbytes*.
- *flags* is accepted for compatibility with ``socket.recv_into`` but its
- value is ignored.
+ The only supported flag is ``MSG_PEEK``, all other flags are ignored.
.. py:method:: Connection.bio_write(bytes)