aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/api/nointerrupts.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-12-15 01:50:56 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-12-15 16:16:31 -0500
commit7f31099eead99718d279d9a4bb543131329891ce (patch)
treed1bca663d7a8e3541085951664ecf26bea31c006 /source/lang/api/nointerrupts.rst
parent210f3d2b1555bae87c9de27ea145e16d3bddb0f8 (diff)
downloadlibrambutan-7f31099eead99718d279d9a4bb543131329891ce.tar.gz
librambutan-7f31099eead99718d279d9a4bb543131329891ce.zip
Finalized 0.0.9 documentation.
Diffstat (limited to 'source/lang/api/nointerrupts.rst')
-rw-r--r--source/lang/api/nointerrupts.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/source/lang/api/nointerrupts.rst b/source/lang/api/nointerrupts.rst
new file mode 100644
index 0000000..68f0498
--- /dev/null
+++ b/source/lang/api/nointerrupts.rst
@@ -0,0 +1,47 @@
+.. highlight:: cpp
+
+.. _lang-nointerrupts:
+
+noInterrupts()
+==============
+
+Description
+-----------
+
+Disables interrupts. Interrupts allow certain important tasks to
+happen in the background and are enabled by default. Some functions
+will not work while interrupts are disabled, and incoming
+communication may be ignored. Interrupts can slightly disrupt the
+timing of code, however, and may be disabled for particularly critical
+sections of code.
+
+Library Documentation
+---------------------
+
+.. doxygenfunction:: noInterrupts
+
+Example
+-------
+
+::
+
+ void setup() {}
+
+ void loop() {
+ noInterrupts();
+ // critical, time-sensitive code here
+ interrupts();
+ // other code here
+ }
+
+See Also
+--------
+
+- :ref:`interrupts() <lang-interrupts>`
+- :ref:`attachInterrupt() <lang-attachinterrupt>`
+- :ref:`detachInterrupt() <lang-detachinterrupt>`
+- :ref:`Timers reference <timers>`
+- :ref:`Timer API <lang-hardwaretimer>`
+- :ref:`External interrupts <external-interrupts>`
+
+.. include:: /lang/cc-attribution.txt