add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / direct / PollingProvider.js

/**\r
 * Provides for repetitive polling of the server at distinct {@link #interval intervals}.\r
 * The initial request for data originates from the client, and then is responded to by the\r
 * server.\r
 * \r
 * Configuration for the PollingProvider can be generated by the server-side\r
 * API portion of the Ext Direct stack.\r
 *\r
 * An instance of PollingProvider may be created directly via the new keyword or by simply\r
 * specifying `type = 'polling'`. For example:\r
 *\r
 *      var pollA = new Ext.direct.PollingProvider({\r
 *          type:'polling',\r
 *          url: 'php/pollA.php',\r
 *      });\r
 *      Ext.direct.Manager.addProvider(pollA);\r
 *      pollA.disconnect();\r
 *      \r
 *      Ext.direct.Manager.addProvider({\r
 *          type:'polling',\r
 *          url: 'php/pollB.php',\r
 *          id: 'pollB-provider'\r
 *      });\r
 *      var pollB = Ext.direct.Manager.getProvider('pollB-provider');\r
 *\r
 */\r
Ext.define('Ext.direct.PollingProvider', {\r
    extend: 'Ext.direct.JsonProvider',\r
    alias:  'direct.pollingprovider',\r
    \r
    requires: [\r
        'Ext.Ajax',\r
        'Ext.util.TaskRunner',\r
        'Ext.direct.ExceptionEvent'\r
    ],\r
    \r
    type: 'polling',\r
    \r
    /**\r
     * @cfg {Number} [interval=3000]\r
     * How often to poll the server-side in milliseconds. Defaults to every 3 seconds.\r
     */\r
    interval: 3000,\r
\r
    /**\r
     * @cfg {Object} [baseParams]\r
     * An object containing properties which are to be sent as parameters on every\r
     * polling request. Note that if baseParams are set and {@link #url} parameter\r
     * is an URL string, poll requests will use POST method instead of default GET.\r
     */\r
    \r
    /**\r
     * @cfg {String/Function} url\r
     * The url which the PollingProvider should contact with each request. This can also be\r
     * an imported Ext Direct method which will be passed baseParams as named arguments.\r
     *\r
     * *Note* that using string `url` is deprecated, use {@link #pollFn} instead.\r
     * @deprecated 5.1.0\r
     */\r
    \r
    /**\r
     * @cfg {String/Function} pollFn\r
     *\r
     * Ext Direct method to use for polling. If a method name is provided as a string,\r
     * the actual function will not be resolved until the first time this provider\r
     * is connected.\r
     *\r
     * The method should accept named arguments and will be passed {@link #baseParams}\r
     * if set.\r
     */\r
    \r
    /**\r
     * @event beforepoll\r
     * @preventable\r
     * Fired immediately before a poll takes place.\r
     *\r
     * @param {Ext.direct.PollingProvider} this\r
     */\r
\r
    /**\r
     * @event poll\r
     * Fired immediately after a poll takes place.\r
     *\r
     * @param {Ext.direct.PollingProvider} this\r
     */\r
    \r
    constructor: function(config) {\r
        var me = this;\r
        \r
        me.callParent([config]);\r
        \r
        me.pollTask = Ext.TaskManager.newTask({\r
            run: me.runPoll,\r
            interval: me.interval,\r
            scope: me\r
        });\r
    },\r
    \r
    destroy: function() {\r
        this.pollTask = null;\r
        \r
        this.callParent();\r
    },\r
    \r
    doConnect: function() {\r
        var me = this,\r
            url = me.url,\r
            pollFn = me.pollFn;\r
        \r
        // It is important that pollFn resolution happens at the time when\r
        // Provider is first connected, and not at construction time. If\r
        // pollFn is configured as a string, the API stub may not exist yet\r
        // when PollingProvider is constructed.\r
        if (pollFn && Ext.isString(pollFn)) {\r
            //<debug>\r
            var fnName = pollFn;\r
            //</debug>\r
            \r
            me.pollFn = pollFn = Ext.direct.Manager.parseMethod(pollFn);\r
            \r
            //<debug>\r
            if (!Ext.isFunction(pollFn)) {\r
                Ext.raise("Cannot resolve Ext Direct API method " + fnName +\r
                                " for PollingProvider");\r
            }\r
            //</debug>\r
        }\r
        else if (Ext.isFunction(url)) {\r
            //<debug>\r
            Ext.log.warn('Using a function for url is deprecated, use pollFn instead.');\r
            //</debug>\r
            \r
            me.pollFn = pollFn = url;\r
            me.url = url = null;\r
        }\r
        \r
        if (url || pollFn) {\r
            me.setInterval(me.interval);\r
            \r
            me.pollTask.start();\r
        }\r
    },\r
\r
    doDisconnect: function() {\r
        this.pollTask.stop();\r
    },\r
    \r
    getInterval: function() {\r
        return this.pollTask.interval;\r
    },\r
    \r
    setInterval: function(interval) {\r
        var me = this,\r
            pollTask = me.pollTask;\r
        \r
        //<debug>\r
        if (interval < 100) {\r
            Ext.raise("Attempting to configure PollProvider " + me.id +\r
                            " with interval that is less than 100ms.");\r
                            \r
        }\r
        //</debug>\r
        \r
        me.interval = pollTask.interval = interval;\r
        \r
        if (me.isConnected()) {\r
            pollTask.restart(interval);\r
        }\r
    },\r
    \r
    /**\r
     * @private\r
     */\r
    runPoll: function() {\r
        var me = this,\r
            url = me.url,\r
            pollFn = me.pollFn,\r
            baseParams = me.baseParams,\r
            args;\r
        \r
        if (me.fireEvent('beforepoll', me) !== false) {\r
            if (pollFn) {\r
                args = pollFn.directCfg.method.getArgs({\r
                    params: baseParams !== undefined ? baseParams : {},\r
                    callback: me.onPollFn,\r
                    scope: me\r
                });\r
                \r
                pollFn.apply(window, args);\r
            }\r
            else {\r
                Ext.Ajax.request({\r
                    url: url,\r
                    callback: me.onData,\r
                    scope: me,\r
                    params: baseParams\r
                });\r
            }\r
            \r
            me.fireEvent('poll', me);\r
        }\r
    },\r
\r
    /**\r
     * @private\r
     */\r
    onData: function(opt, success, response) {\r
        var me = this, \r
            i, len, events;\r
        \r
        if (success) {\r
            events = me.createEvents(response);\r
            \r
            for (i = 0, len = events.length; i < len; ++i) {\r
                me.fireEvent('data', me, events[i]);\r
            }\r
        }\r
        else {\r
            events = new Ext.direct.ExceptionEvent({\r
                data: null,\r
                code: Ext.direct.Manager.exceptions.TRANSPORT,\r
                message: 'Unable to connect to the server.',\r
                xhr: response\r
            });\r
            \r
            me.fireEvent('data', me, events);\r
        }\r
    },\r
    \r
    /**\r
     * @private\r
     */\r
    onPollFn: function(result, event, success, options) {\r
        this.onData(null, success, { responseText: result });\r
    },\r
    \r
    inheritableStatics: {\r
        /**\r
         * @private\r
         * @static\r
         * @inheritable\r
         */\r
        checkConfig: function(config) {\r
            // Polling provider needs either URI or pollFn\r
            return config && config.type === 'polling' &&\r
                   (config.url || config.pollFn);\r
        }\r
    }\r
});