summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_exitmonitor.rst
blob: 3cb8463e85649a918514e0616857c6e617e493f3 (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
44
PR_ExitMonitor
==============

Decrements the entry count associated with a specified monitor and, if
the entry count reaches zero, releases the monitor's lock.


Syntax
------

.. code::

   #include <prmon.h>

   PRStatus PR_ExitMonitor(PRMonitor *mon);


Parameter
~~~~~~~~~

The function has the following parameter:

``mon``
   A reference to an existing structure of type :ref:`PRMonitor`. The
   monitor object referenced must be one for which the calling thread
   currently holds the lock.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful (the calling thread has not entered the monitor),
   ``PR_FAILURE``.


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

If the decremented entry count is zero, :ref:`PR_ExitMonitor` releases the
monitor's lock. Threads that were blocked trying to enter the monitor
will be rescheduled.