summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_queuejob_connect.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_queuejob_connect.rst')
-rw-r--r--docs/nspr/reference/pr_queuejob_connect.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_queuejob_connect.rst b/docs/nspr/reference/pr_queuejob_connect.rst
new file mode 100644
index 0000000000..b5aeaf899e
--- /dev/null
+++ b/docs/nspr/reference/pr_queuejob_connect.rst
@@ -0,0 +1,49 @@
+PR_QueueJob_Connect
+===================
+
+Causes a job to be queued when a socket can be connected.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prtpool.h>
+
+ NSPR_API(PRJob *)
+ PR_QueueJob_Connect(
+ PRThreadPool *tpool,
+ PRJobIoDesc *iod,
+ const PRNetAddr *addr,
+ 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.
+``addr``
+ Pointer to a :ref:`PRNetAddr` structure for the socket being connected.
+``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.