/*! - * Ext JS Library 3.3.1 - * Copyright(c) 2006-2010 Sencha Inc. - * licensing@sencha.com - * http://www.sencha.com/license - */ -/** - * @class Ext.direct.PollingProvider + +- \ No newline at end of file +/** + * @class Ext.direct.PollingProvider * @extends Ext.direct.JsonProvider * - *+});Provides for repetitive polling of the server at distinct {@link #interval intervals}. + * <p>Provides for repetitive polling of the server at distinct {@link #interval intervals}. * The initial request for data originates from the client, and then is responded to by the - * server.
+ * server.</p> * - *All configurations for the PollingProvider should be generated by the server-side - * API portion of the Ext.Direct stack.
+ * <p>All configurations for the PollingProvider should be generated by the server-side + * API portion of the Ext.Direct stack.</p> * - *An instance of PollingProvider may be created directly via the new keyword or by simply - * specifying type = 'polling'. For example:
- *+var pollB = Ext.direct.Manager.getProvider('pollB-provider'); + * </code></pre> */ -Ext.direct.PollingProvider = Ext.extend(Ext.direct.JsonProvider, { - /** - * @cfg {Number} priority - * Priority of the request (defaults to 3). See {@link Ext.direct.Provider#priority}. - */ - // override default priority - priority: 3, +Ext.define('Ext.direct.PollingProvider', { + + /* Begin Definitions */ + + extend: 'Ext.direct.JsonProvider', + + alias: 'direct.pollingprovider', - /** - * @cfg {Number} interval - * How often to poll the server-side in milliseconds (defaults to 3000 - every - * 3 seconds). + uses: ['Ext.direct.ExceptionEvent'], + + requires: ['Ext.Ajax', 'Ext.util.DelayedTask'], + + /* End Definitions */ + + /** + * @cfg {Number} interval + * How often to poll the server-side in milliseconds. Defaults to every 3 seconds. */ interval: 3000, - /** - * @cfg {Object} baseParams An object containing properties which are to be sent as parameters - * on every polling request + /** + * @cfg {Object} baseParams + * An object containing properties which are to be sent as parameters on every polling request */ - /** - * @cfg {String/Function} url + /** + * @cfg {String/Function} url * The url which the PollingProvider should contact with each request. This can also be * an imported Ext.Direct method which will accept the baseParams as its only argument. */ // private constructor : function(config){ - Ext.direct.PollingProvider.superclass.constructor.call(this, config); + this.callParent(arguments); this.addEvents( - /** - * @event beforepoll + /** + * @event beforepoll * Fired immediately before a poll takes place, an event handler can return false * in order to cancel the poll. - * @param {Ext.direct.PollingProvider} + * @param {Ext.direct.PollingProvider} this */ 'beforepoll', - /** - * @event poll + /** + * @event poll * This event has not yet been implemented. - * @param {Ext.direct.PollingProvider} + * @param {Ext.direct.PollingProvider} this */ 'poll' ); @@ -94,68 +102,75 @@ Ext.direct.PollingProvider = Ext.extend(Ext.direct.JsonProvider, { return !!this.pollTask; }, - /** - * Connect to the server-side and begin the polling process. To handle each + /** + * Connect to the server-side and begin the polling process. To handle each * response subscribe to the data event. */ connect: function(){ - if(this.url && !this.pollTask){ - this.pollTask = Ext.TaskMgr.start({ + var me = this, url = me.url; + + if (url && !me.pollTask) { + me.pollTask = Ext.TaskManager.start({ run: function(){ - if(this.fireEvent('beforepoll', this) !== false){ - if(typeof this.url == 'function'){ - this.url(this.baseParams); - }else{ + if (me.fireEvent('beforepoll', me) !== false) { + if (Ext.isFunction(url)) { + url(me.baseParams); + } else { Ext.Ajax.request({ - url: this.url, - callback: this.onData, - scope: this, - params: this.baseParams + url: url, + callback: me.onData, + scope: me, + params: me.baseParams }); } } }, - interval: this.interval, - scope: this + interval: me.interval, + scope: me }); - this.fireEvent('connect', this); - }else if(!this.url){ - throw 'Error initializing PollingProvider, no url configured.'; + me.fireEvent('connect', me); + } else if (!url) { + //<debug> + Ext.Error.raise('Error initializing PollingProvider, no url configured.'); + //</debug> } }, - /** - * Disconnect from the server-side and stop the polling process. The disconnect + /** + * Disconnect from the server-side and stop the polling process. The disconnect * event will be fired on a successful disconnect. */ disconnect: function(){ - if(this.pollTask){ - Ext.TaskMgr.stop(this.pollTask); - delete this.pollTask; - this.fireEvent('disconnect', this); + var me = this; + + if (me.pollTask) { + Ext.TaskManager.stop(me.pollTask); + delete me.pollTask; + me.fireEvent('disconnect', me); } }, // private - onData: function(opt, success, xhr){ - if(success){ - var events = this.getEvents(xhr); - for(var i = 0, len = events.length; i < len; i++){ - var e = events[i]; - this.fireEvent('data', this, e); + onData: function(opt, success, response){ + var me = this, + i = 0, + len, + events; + + if (success) { + events = me.createEvents(response); + for (len = events.length; i < len; ++i) { + me.fireEvent('data', me, events[i]); } - }else{ - var e = new Ext.Direct.ExceptionEvent({ - data: e, - code: Ext.Direct.exceptions.TRANSPORT, + } else { + me.fireEvent('data', me, Ext.create('Ext.direct.ExceptionEvent', { + data: null, + code: Ext.direct.Manager.self.exceptions.TRANSPORT, message: 'Unable to connect to the server.', - xhr: xhr - }); - this.fireEvent('data', this, e); + xhr: response + })); } } -}); - -Ext.Direct.PROVIDERS['polling'] = Ext.direct.PollingProvider;+ * <p>An instance of PollingProvider may be created directly via the new keyword or by simply + * specifying <tt>type = 'polling'</tt>. For example:</p> + * <pre><code> var pollA = new Ext.direct.PollingProvider({ type:'polling', url: 'php/pollA.php', }); -Ext.Direct.addProvider(pollA); +Ext.direct.Manager.addProvider(pollA); pollA.disconnect(); -Ext.Direct.addProvider( +Ext.direct.Manager.addProvider( { type:'polling', url: 'php/pollB.php', id: 'pollB-provider' } ); -var pollB = Ext.Direct.getProvider('pollB-provider'); - *