tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

pr_waitforpollableevent.rst (655B)

      1 PR_WaitForPollableEvent
      2 =======================
      3 
      4 Blocks the calling thread until the pollable event is set, and then
      5 atomically unsetting the event before returning.
      6 
      7 
      8 Syntax
      9 ------
     10 
     11 .. code::
     12 
     13   NSPR_API(PRStatus) PR_WaitForPollableEvent(PRFileDesc *event);
     14 
     15 
     16 Parameter
     17 ~~~~~~~~~
     18 
     19 The function has the following parameter:
     20 
     21 ``event``
     22   Pointer to a :ref:`PRFileDesc` structure previously created via a call
     23   to :ref:`PR_NewPollableEvent`.
     24 
     25 
     26 Returns
     27 ~~~~~~~
     28 
     29 The function returns one of the following values:
     30 
     31 -  If successful, ``PR_SUCCESS``.
     32 -  If unsuccessful, ``PR_FAILURE``. The reason for the failure can be
     33   retrieved via :ref:`PR_GetError`.