summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_queuejob_write.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_queuejob_write.rst')
-rw-r--r--docs/nspr/reference/pr_queuejob_write.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_queuejob_write.rst b/docs/nspr/reference/pr_queuejob_write.rst
new file mode 100644
index 0000000000..9551b3bc4b
--- /dev/null
+++ b/docs/nspr/reference/pr_queuejob_write.rst
@@ -0,0 +1,46 @@
+PR_QueueJob_Write
+=================
+
+Causes a job to be queued when a socket becomes writable.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prtpool.h>
+
+ NSPR_API(PRJob *)
+ PR_QueueJob_Write(
+ PRThreadPool *tpool,
+ PRJobIoDesc *iod,
+ 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.
+``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.