/** * Ext.direct.Provider is an abstract class meant to be extended. * * For example Ext JS implements the following subclasses: * * Provider * | * +---{@link Ext.direct.JsonProvider JsonProvider} * | * +---{@link Ext.direct.PollingProvider PollingProvider} * | * +---{@link Ext.direct.RemotingProvider RemotingProvider} * * @abstract */Ext.define('Ext.direct.Provider', { alias: 'direct.provider', mixins: { observable: 'Ext.util.Observable' }, isProvider: true, /** * @cfg {String} id * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}). * You should assign an id if you need to be able to access the provider later and you do * not have an object reference available, for example: * * Ext.direct.Manager.addProvider({ * type: 'polling', * url: 'php/poll.php', * id: 'poll-provider' * }); * var p = {@link Ext.direct.Manager}.{@link Ext.direct.Manager#getProvider getProvider}('poll-provider'); * p.disconnect(); * */ /** * @cfg {String[]} relayedEvents * List of Provider events that should be relayed by {@link Ext.direct.Manager}. * 'data' event is always relayed. */ /** * @event connect * Fires when the Provider connects to the server-side * * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. */ /** * @event disconnect * Fires when the Provider disconnects from the server-side * * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. */ /** * @event data * Fires when the Provider receives data from the server-side * * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}. * @param {Ext.direct.Event} e The Ext.direct.Event type that occurred. */ /** * @event exception * Fires when the Provider receives an exception from the server-side */ constructor: function(config) { var me = this; Ext.apply(me, config); Ext.applyIf(me, { id: Ext.id(null, 'provider-') }); me.mixins.observable.constructor.call(me, config); }, /** * @method isConnected * Returns whether or not the server-side is currently connected. * Abstract method for subclasses to implement. * @template */ isConnected: function() { return false; }, /** * @method template * Abstract method for subclasses to implement. * @template */ connect: Ext.emptyFn, /** * @method disconnect * Abstract method for subclasses to implement. * @template */ disconnect: Ext.emptyFn});