summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_clearinterrupt.rst
blob: 27900e40d9607e077c0641f9273e5e2ab7522d36 (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
PR_ClearInterrupt
=================

Clears the interrupt request for the calling thread.


Syntax
------

.. code::

   #include <prthread.h>

   void PR_ClearInterrupt(void);


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

Interrupting is a cooperative process, so it's possible that the thread
passed to :ref:`PR_Interrupt` may never respond to the interrupt request.
For example, the target thread may reach the agreed-on control point
without providing an opportunity for the runtime to notify the thread of
the interrupt request. In this case, the request for interrupt is still
pending with the thread and must be explicitly canceled. Therefore it is
sometimes necessary to call :ref:`PR_ClearInterrupt` to clear a previous
interrupt request.

If no interrupt request is pending, :ref:`PR_ClearInterrupt` is a no-op.