Adding upstream version 124.0.1.upstream/124.0.1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 56 insertions, 0 deletions

diff --git a/docs/nspr/reference/pr_recv.rst b/docs/nspr/reference/pr_recv.rst
new file mode 100644
index 0000000000..bfc1b7e5f9
--- /dev/null
+++ b/docs/nspr/reference/pr_recv.rst
@@ -0,0 +1,56 @@
+PR_Recv
+=======
+
+Receives bytes from a connected socket.
+
+
+Syntax
+------
+
+.. code::
+
+   #include <prio.h>
+
+   PRInt32 PR_Recv(
+     PRFileDesc *fd,
+     void *buf,
+     PRInt32 amount,
+     PRIntn flags,
+     PRIntervalTime timeout);
+
+
+Parameters
+~~~~~~~~~~
+
+The function has the following parameters:
+
+``fd``
+   A pointer to a :ref:`PRFileDesc` object representing a socket.
+``buf``
+   A pointer to a buffer to hold the data received.
+``amount``
+   The size of ``buf`` (in bytes).
+``flags``
+   Must be zero or ``PR_MSG_PEEK``.
+``timeout``
+   A value of type :ref:`PRIntervalTime` specifying the time limit for
+   completion of the receive operation.
+
+
+Returns
+~~~~~~~
+
+The function returns one of the following values:
+
+-  A positive number indicates the number of bytes actually received.
+-  The value 0 means the network connection is closed.
+-  The value -1 indicates a failure. The reason for the failure can be
+   obtained by calling :ref:`PR_GetError`.
+
+
+Description
+-----------
+
+:ref:`PR_Recv` blocks until some positive number of bytes are transferred,
+a timeout occurs, or an error occurs. No more than ``amount`` bytes will
+be transferred.