TonBERRY/micropython
3
0
Fork 0
Code Pull Requests Activity

docs: Add a description of recv/recvfrom flags argument.

Browse Source 
Implementation added for various ports in the parent commits.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
This commit is contained in:
Angus Gratton
2025-05-16 16:09:12 +10:00
committed by Damien George
parent d23fb86934
commit ba92063d64
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/library/socket.rst
View File

@@ -227,22 +227,28 @@ Methods
has the same "no short writes" policy for blocking sockets, and will return has the same "no short writes" policy for blocking sockets, and will return
number of bytes sent on non-blocking sockets. number of bytes sent on non-blocking sockets.
.. method:: socket.recv(bufsize) .. method:: socket.recv(bufsize, [flags])
Receive data from the socket. The return value is a bytes object representing the data Receive data from the socket. The return value is a bytes object representing the data
received. The maximum amount of data to be received at once is specified by bufsize. received. The maximum amount of data to be received at once is specified by bufsize.
Most ports support the optional *flags* argument. Available *flags* are defined as constants
in the socket module and have the same meaning as in CPython. ``MSG_PEEK`` and ``MSG_DONTWAIT``
are supported on all ports which accept the *flags* argument.
.. method:: socket.sendto(bytes, address) .. method:: socket.sendto(bytes, address)
Send data to the socket. The socket should not be connected to a remote socket, since the Send data to the socket. The socket should not be connected to a remote socket, since the
destination socket is specified by *address*. destination socket is specified by *address*.
.. method:: socket.recvfrom(bufsize) .. method:: socket.recvfrom(bufsize, [flags])
Receive data from the socket. The return value is a pair *(bytes, address)* where *bytes* is a Receive data from the socket. The return value is a pair *(bytes, address)* where *bytes* is a
bytes object representing the data received and *address* is the address of the socket sending bytes object representing the data received and *address* is the address of the socket sending
the data. the data.
See the `recv` function for an explanation of the optional *flags* argument.
.. method:: socket.setsockopt(level, optname, value) .. method:: socket.setsockopt(level, optname, value)
Set the value of the given socket option. The needed symbolic constants are defined in the Set the value of the given socket option. The needed symbolic constants are defined in the