From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 02:47:55 +0200
Subject: Adding upstream version 124.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 docs/nspr/reference/pr_send.rst | 56 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 docs/nspr/reference/pr_send.rst

(limited to 'docs/nspr/reference/pr_send.rst')

diff --git a/docs/nspr/reference/pr_send.rst b/docs/nspr/reference/pr_send.rst
new file mode 100644
index 0000000000..1ffdad63e4
--- /dev/null
+++ b/docs/nspr/reference/pr_send.rst
@@ -0,0 +1,56 @@
+PR_Send
+=======
+
+Sends bytes from a connected socket.
+
+
+Syntax
+------
+
+.. code::
+
+   #include <prio.h>
+
+   PRInt32 PR_Send(
+     PRFileDesc *fd,
+     const 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 containing the data to be sent.
+``amount``
+   The size of ``buf`` (in bytes).
+``flags``
+   This obsolete parameter must always be zero.
+``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 successfully sent. If
+   the parameter fd is a blocking socket, this number must always equal
+   amount.
+-  The value -1 indicates a failure. The reason for the failure can be
+   obtained by calling :ref:`PR_GetError`.
+
+
+Description
+-----------
+
+:ref:`PR_Send` blocks until all bytes are sent, a timeout occurs, or an
+error occurs.
-- 
cgit v1.2.3