]> granicus.if.org Git - python/commitdiff
Backport docs for recv_into and recvfrom_into.
authorGeorg Brandl <georg@python.org>
Sun, 18 Mar 2007 08:26:23 +0000 (08:26 +0000)
committerGeorg Brandl <georg@python.org>
Sun, 18 Mar 2007 08:26:23 +0000 (08:26 +0000)
Doc/lib/libsocket.tex
Doc/whatsnew/whatsnew25.tex

index f510fd40c0afe83a133e1e0f609bab1ee2153d6d..e5a3c3280b0555acc0242904660faad66e876d04 100644 (file)
@@ -574,6 +574,28 @@ same meaning as for \method{recv()} above.
 (The format of \var{address} depends on the address family --- see above.)
 \end{methoddesc}
 
+\begin{methoddesc}[socket]{recvfrom_into}{buffer\optional{, nbytes\optional{, flags}}}
+Receive data from the socket, writing it into \var{buffer} instead of 
+creating a new string.  The return value is a pair
+\code{(\var{nbytes}, \var{address})} where \var{nbytes} is the number
+of bytes received and \var{address} is the address of the socket
+sending the data.  See the \UNIX{} manual page
+\manpage{recv}{2} for the meaning of the optional argument
+\var{flags}; it defaults to zero.  (The format of \var{address}
+depends on the address family --- see above.)
+\versionadded{2.5}
+\end{methoddesc}
+
+\begin{methoddesc}[socket]{recv_into}{buffer\optional{, nbytes\optional{, flags}}}
+Receive up to \var{nbytes} bytes from the socket,
+storing the data into a buffer rather than creating a new string.    
+If \var{nbytes} is not specified (or 0), 
+receive up to the size available in the given buffer.
+See the \UNIX{} manual page \manpage{recv}{2} for the meaning of the
+optional argument \var{flags}; it defaults to zero.
+\versionadded{2.5}
+\end{methoddesc}
+
 \begin{methoddesc}[socket]{send}{string\optional{, flags}}
 Send data to the socket.  The socket must be connected to a remote
 socket.  The optional \var{flags} argument has the same meaning as for
index fce392736e9e1c0a13231ebe1732664bbb303faa..85d5a2a5fad1c4e0cd75fe0ee6b4afc08d2e67e5 100644 (file)
@@ -1704,8 +1704,8 @@ article about them is at \url{http://www.linuxjournal.com/article/7356}.
 In Python code, netlink addresses are represented as a tuple of 2 integers, 
 \code{(\var{pid}, \var{group_mask})}.
 
-Two new methods on socket objects, \method{recv_buf(\var{buffer})} and
-\method{recvfrom_buf(\var{buffer})}, store the received data in an object 
+Two new methods on socket objects, \method{recv_into(\var{buffer})} and
+\method{recvfrom_into(\var{buffer})}, store the received data in an object 
 that supports the buffer protocol instead of returning the data as a
 string.  This means you can put the data directly into an array or a
 memory-mapped file.