summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_cnotifyall.rst
blob: 80a7c2aeb9fe1bfb7aefca8c0f4fa19397c81c73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
PR_CNotifyAll
=============

Notifies all the threads waiting for a change in the state of monitored
data.


Syntax
------

.. code::

   #include <prcmon.h>

   PRStatus PR_CNotifyAll(void *address);


Parameter
~~~~~~~~~

The function has the following parameter:

``address``
   The address of the monitored object. The calling thread must be in
   the monitor at the time :ref:`PR_CNotifyAll` is called.


Returns
~~~~~~~

 - :ref:`PR_SUCCESS` indicates that the referenced monitor was located and
   the calling thread was in the monitor.
 - :ref:`PR_FAILURE` indicates that the referenced monitor could not be
   located or that the calling thread was not in the monitor


Description
-----------

Using the value specified in the address parameter to find a monitor in
the monitor cache, :ref:`PR_CNotifyAll` notifies all threads waiting for
the monitor's state to change. All of the threads waiting on the state
change are then scheduled to reenter the monitor.