Bug 1858921 - Part 2: Move WasmStructObject inlinable allocation methods to new inlin...
[gecko.git] / docs / nspr / reference / pr_queuejob_read.rst
blob0b715a7fa55b7c1b445a726a7010094676a8962c
1 PR_QueueJob_Read
2 ================
4 Causes a job to be queued when a socket becomes readable.
7 Syntax
8 ------
10 .. code::
12    #include <prtpool.h>
14    NSPR_API(PRJob *)
15    PR_QueueJob_Read(
16      PRThreadPool *tpool,
17      PRJobIoDesc *iod,
18      PRJobFn fn,
19      void *arg,
20      PRBool joinable
21    );
24 Parameters
25 ~~~~~~~~~~
27 The function has the following parameters:
29 ``tpool``
30    A pointer to a :ref:`PRThreadPool` structure previously created by a
31    call to :ref:`PR_CreateThreadPool`.
32 ``iod``
33    A pointer to a :ref:`PRJobIoDesc` structure.
34 ``fn``
35    The function to be executed when the job is executed.
36 ``arg``
37    A pointer to an argument passed to ``fn``.
38 ``joinable``
39    If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not
40    joinable. See :ref:`PR_JoinJob`.
43 Returns
44 ~~~~~~~
46 Pointer to a :ref:`PRJob` structure or ``NULL`` on error.