aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.7/packages/api-utils/docs/events.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.7/packages/api-utils/docs/events.md')
-rw-r--r--tools/addon-sdk-1.7/packages/api-utils/docs/events.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/tools/addon-sdk-1.7/packages/api-utils/docs/events.md b/tools/addon-sdk-1.7/packages/api-utils/docs/events.md
new file mode 100644
index 0000000..76f9efd
--- /dev/null
+++ b/tools/addon-sdk-1.7/packages/api-utils/docs/events.md
@@ -0,0 +1,78 @@
+<!-- This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this
+ - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
+
+The `events` module provides base API for emitting events.
+
+This module is not intended to be used directly by programs. Rather, it is
+intended to be used by other modules that provide APIs to programs.
+
+<api name="EventEmitter">
+@class
+The EventEmitter is the base building block for all compositions that
+would need to broadcast data to multiple consumers.
+
+Please note that `EventEmitter` does not expose either a method for emitting
+events or a list of available event listeners as its public API. Obviously
+both are accessible but from the instance itself through the private API.
+<api name="EventEmitter">
+@constructor
+Creates an EventEmitter object.
+</api>
+
+<api name="on">
+@method
+Registers an event `listener` that will be called when events of
+specified `type` are emitted.
+
+If the `listener` is already registered for this `type`, a call to this
+method has no effect.
+
+If the event listener is being registered while an event is being processed,
+the event listener is not called during the current emit.
+
+**Example:**
+
+ // worker is instance of EventEmitter
+ worker.on('message', function (data) {
+ console.log('data received: ' + data)
+ });
+
+@param type {String}
+ The type of the event.
+@param listener {Function}
+ The listener function that processes the event.
+</api>
+
+<api name="once">
+@method
+Registers an event `listener` that will only be called once, the next time
+an event of the specified `type` is emitted.
+
+If the event listener is registered while an event of the specified `type`
+is being emitted, the event listener will not be called during the current
+emit.
+
+@param type {String}
+ The type of the event.
+@param listener {Function}
+ The listener function that processes the event.
+</api>
+
+<api name="removeListener">
+@method
+Unregisters an event `listener` for the specified event `type`.
+
+If the `listener` is not registered for this `type`, a call to this
+method has no effect.
+
+If an event listener is removed while an event is being processed, it is
+still triggered by the current emit. After it is removed, the event listener
+is never invoked again (unless registered again for future processing).
+
+@param type {String}
+ The type of the event.
+@param listener {Function}
+ The listener function that processes the event.
+</api>
+</api>