docs/nspr/reference/pr_queuejob_read.rst

   1 PR_QueueJob_Read
   2 ================
   3
   4 Causes a job to be queued when a socket becomes readable.
   5
   6
   7 Syntax
   8 ------
   9
  10 .. code::
  11
  12    #include <prtpool.h>
  13
  14    NSPR_API(PRJob *)
  15    PR_QueueJob_Read(
  16      PRThreadPool *tpool,
  17      PRJobIoDesc *iod,
  18      PRJobFn fn,
  19      void *arg,
  20      PRBool joinable
  21    );
  22
  23
  24 Parameters
  25 ~~~~~~~~~~
  26
  27 The function has the following parameters:
  28
  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`.
  41
  42
  43 Returns
  44 ~~~~~~~
  45
  46 Pointer to a :ref:`PRJob` structure or ``NULL`` on error.