File: pr_cnotify.rst

package info (click to toggle)
firefox 147.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,484 kB
  • sloc: cpp: 7,607,246; javascript: 6,533,185; ansic: 3,775,227; python: 1,415,393; xml: 634,561; asm: 438,951; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (43 lines) | stat: -rw-r--r-- 1,018 bytes parent folder | download | duplicates (18) 
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_CNotify
==========

Notify a thread waiting on a change in the state of monitored data.


Syntax
------

.. code::

   #include <prcmon.h>

   PRStatus PR_CNotify(void *address);


Parameter
~~~~~~~~~

The function has the following parameter:

``address``
   The address of the monitored object. The calling thread must be in
   the monitor defined by the value of the address.


Returns
~~~~~~~

 - :ref:`PR_SUCCESS` indicates that the calling thread is the holder of the
   mutex for the monitor referred to by the address parameter.
 - :ref:`PR_FAILURE` indicates that the monitor has not been entered by the
   calling thread.


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

Using the value specified in the ``address`` parameter to find a monitor
in the monitor cache, :ref:`PR_CNotify` notifies single a thread waiting
for the monitor's state to change. If a thread is waiting on the monitor
(having called :ref:`PR_CWait`), then that thread is made ready. As soon as
the thread is scheduled, it attempts to reenter the monitor.