API Docs for: 3.8.0
Show:

File: datasource/js/datasource-polling.js

  1. /**
  2.  * Extends DataSource with polling functionality.
  3.  *
  4.  * @module datasource
  5.  * @submodule datasource-polling
  6.  */
  7.     
  8. /**
  9.  * Adds polling to the DataSource Utility.
  10.  * @class Pollable
  11.  * @extends DataSource.Local
  12.  */    
  13. function Pollable() {
  14.     this._intervals = {};
  15. }

  17. Pollable.prototype = {

  19.     /**
  20.     * @property _intervals
  21.     * @description Hash of polling interval IDs that have been enabled,
  22.     * stored here to be able to clear all intervals.
  23.     * @private
  24.     */
  25.     _intervals: null,

  27.     /**
  28.      * Sets up a polling mechanism to send requests at set intervals and
  29.      * forward responses to given callback.
  30.      *
  31.      * @method setInterval
  32.      * @param msec {Number} Length of interval in milliseconds.
  33.      * @param [request] {Object} An object literal with the following properties:
  34.      *     <dl>
  35.      *     <dt><code>request</code></dt>
  36.      *     <dd>The request to send to the live data source, if any.</dd>
  37.      *     <dt><code>callback</code></dt>
  38.      *     <dd>An object literal with the following properties:
  39.      *         <dl>
  40.      *         <dt><code>success</code></dt>
  41.      *         <dd>The function to call when the data is ready.</dd>
  42.      *         <dt><code>failure</code></dt>
  43.      *         <dd>The function to call upon a response failure condition.</dd>
  44.      *         <dt><code>argument</code></dt>
  45.      *         <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>
  46.      *         </dl>
  47.      *     </dd>
  48.      *     <dt><code>cfg</code></dt>
  49.      *     <dd>Configuration object, if any.</dd>
  50.      *     </dl>
  51.      * @return {Number} Interval ID.
  52.      */
  53.     setInterval: function(msec, request) {
  54.         var x = Y.later(msec, this, this.sendRequest, [ request ], true);
  55.         this._intervals[x.id] = x;
  56.         // First call happens immediately, but async
  57.         Y.later(0, this, this.sendRequest, [request]);
  58.         return x.id;
  59.     },

  61.     /**
  62.      * Disables polling mechanism associated with the given interval ID.
  63.      *
  64.      * @method clearInterval
  65.      * @param id {Number} Interval ID.
  66.      */
  67.     clearInterval: function(id, key) {
  68.         // In case of being called by clearAllIntervals()
  69.         id = key || id;
  70.         if(this._intervals[id]) {
  71.             // Clear the interval
  72.             this._intervals[id].cancel();
  73.             // Clear from tracker
  74.             delete this._intervals[id];
  75.         }
  76.     },

  78.     /**
  79.      * Clears all intervals.
  80.      *
  81.      * @method clearAllIntervals
  82.      */
  83.     clearAllIntervals: function() {
  84.         Y.each(this._intervals, this.clearInterval, this);
  85.     }
  86. };
  87.     
  88. Y.augment(Y.DataSource.Local, Pollable);

  90.