Changeset 15455 for trunk/FACT++

Timestamp:

04/28/13 11:30:58 (12 years ago)

Author:

tbretz

Message:

Added dimctrl.setInterruptHandler

File:

• trunk/FACT++/scripts/doc/dimctrl.js (modified) (1 diff)

trunk/FACT++/scripts/doc/dimctrl.js

@@ -91 +91 @@
  */
 dimctrl.getState = function() { /* [native code] */ }
+
+/**
+ * Set an interrupt handler, a function which is called if an
+ * interrupt is received, e.g. via dim (dimctrl --interrupt).
+ * Note that the interrupt handler is executed in its own JavaScript
+ * thread. Thus it interrupts the execution of the script, but does
+ * not stop its execution. Please also note that this is a callback
+ * from the main loop. As long as the handler is executed, no other
+ * event (dim or command interface) will be processed.
+ *
+ * @param {Function} [func]
+ *    Function to be called when an interrupt is received. Null, undefined
+ *    or no argument to remove the handler.
+ *
+ * @throws
+ *    if number of type of arguments is wrong
+ *
+ * @example
+ *     function handleIrq(payload, time, user)
+ *     {
+ *         console.out("Data received:  "+payload);
+ *         console.out("Interrupt time: "+time);
+ *         console.out("Issuing user:   "+user);
+ *     }
+ *     dimctrl.setInterruptHandler(handleIrq);
+ */
+dimctrl.setInterruptHandler = function() { /* [native code] */ }