Changeset 15097 for trunk/FACT++/scripts/doc/Subscription.js

Timestamp:

03/18/13 14:44:23 (12 years ago)

Author:

tbretz

Message:

Added how to look for an already open Subscription.

File:

• trunk/FACT++/scripts/doc/Subscription.js (modified) (2 diffs)

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

@@ -23 +23 @@
  * too much.
  *
+ * Each subscription must exist only once, therefore the function-call
+ * can be used to check for an open subscription.  
+ *
  * @param {String} service
  *    Name of the DIM service to which a subscription should be made.
@@ -38 +41 @@
  *
  * @example
- *    var handle1 = new Subscription("MAGIC_WEATHER/DATA");
+ *    var handle1 = Subscription("MAGIC_WEATHER/DATA");
+ *    if (!handle1)
+ *        handle1 = new Subscription("MAGIC_WEATHER/DATA");
  *    var handle2 = new Subscription("TNG_WEATHER/DATA", function(evt) { console.out(JSON.stringify(evt)); });
  *    ...