Adding upstream version 110.0.1.upstream/110.0.1upstream

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

1 files changed, 49 insertions, 0 deletions

diff --git a/docs/nspr/reference/pr_queuejob_timer.rst b/docs/nspr/reference/pr_queuejob_timer.rst
new file mode 100644
index 0000000000..4460433fa5
--- /dev/null
+++ b/docs/nspr/reference/pr_queuejob_timer.rst
@@ -0,0 +1,49 @@
+PR_QueueJob_Timer
+=================
+
+Causes a job to be queued when a timer expires.
+
+
+Syntax
+------
+
+.. code::
+
+   #include <prtpool.h>
+
+   NSPR_API(PRJob *)
+   PR_QueueJob_Timer(
+     PRThreadPool *tpool,
+     PRIntervalTime timeout,
+     PRJobFn fn,
+     void * arg,
+     PRBool joinable
+   );
+
+
+Parameters
+~~~~~~~~~~
+
+The function has the following parameters:
+
+``tpool``
+   A pointer to a :ref:`PRThreadPool` structure previously created by a
+   call to :ref:`PR_CreateThreadPool`.
+``iod``
+   A pointer to a :ref:`PRJobIoDesc` structure.
+``timeout``
+   A value, expressed as a :ref:`PRIntervalTime`, to wait before queuing
+   the job.
+``fn``
+   The function to be executed when the job is executed.
+``arg``
+   A pointer to an argument passed to ``fn``.
+``joinable``
+   If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not
+   joinable. See :ref:`PR_JoinJob`.
+
+
+Returns
+~~~~~~~
+
+Pointer to a :ref:`PRJob` structure or ``NULL`` on error.