src/cm/media/js/lib/yui/yui_3.10.3/build/io-queue/io-queue.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
/*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
YUI 3.10.3 (build 2fb5187)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
Copyright 2013 Yahoo! Inc. All rights reserved.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
Licensed under the BSD License.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
http://yuilibrary.com/license/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
*/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
YUI.add('io-queue', function (Y, NAME) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
Extends IO to implement Queue for synchronous
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
transaction processing.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
@module io
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
@submodule io-queue
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
@for IO
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
**/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
var io = Y.io._map['io:0'] || new Y.IO();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
Y.mix(Y.IO.prototype, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
    * Array of transactions queued for processing
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
    * @property _q
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
    * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
    * @type {Object}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
    _q: new Y.Queue(),
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
    _qActiveId: null,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
    _qInit: false,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
    * Property to determine whether the queue is set to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
    * 1 (active) or 0 (inactive).  When inactive, transactions
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
    * will be stored in the queue until the queue is set to active.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
    * @property _qState
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
    * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
    * @type {Number}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
    _qState: 1,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
    * Method Process the first transaction from the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
    * queue in FIFO order.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
    * @method _qShift
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
    * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
    _qShift: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
        var io = this,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
            o = io._q.next();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
        io._qActiveId = o.id;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
        io._qState = 0;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
        io.send(o.uri, o.cfg, o.id);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
    * Method for queueing a transaction before the request is sent to the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
    * resource, to ensure sequential processing.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
    * @method queue
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
    * @return {Object}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
    queue: function(uri, c) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
        var io = this,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
            o = { uri: uri, cfg:c, id: this._id++ };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
        if(!io._qInit) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
            Y.on('io:complete', function(id, o) { io._qNext(id); }, io);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
            io._qInit = true;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
        io._q.add(o);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
        if (io._qState === 1) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
            io._qShift();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
        return o;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
    _qNext: function(id) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
        var io = this;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
        io._qState = 1;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
        if (io._qActiveId === id && io._q.size() > 0) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
            io._qShift();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
    * Method for promoting a transaction to the top of the queue.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
    * @method promote
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
    qPromote: function(o) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
        this._q.promote(o);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
    * Method for removing a specific, pending transaction from
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
    * the queue.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
    * @method remove
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
    * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
    qRemove: function(o) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
        this._q.remove(o);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
    * Method for cancel all pending transaction from
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
    * the queue.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
    * @method empty
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
    * @since 3.7.3
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
    qEmpty: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
        this._q = new Y.Queue();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
    qStart: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
        var io = this;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
        io._qState = 1;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
        if (io._q.size() > 0) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
            io._qShift();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
    * Method for setting queue processing to inactive.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
    * Transaction requests to YUI.io.queue() will be stored in the queue, but
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
    * not processed until the queue is reset to "active".
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
    * @method _stop
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
    * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
    qStop: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
        this._qState = 0;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
   /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
    * Method to query the current size of the queue.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
    *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
    * @method _size
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
    * @private
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
    * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
    * @return {Number}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
    */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
    qSize: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
        return this._q.size();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
}, true);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
function _queue(u, c) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
    return io.queue.apply(io, [u, c]);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
_queue.start = function () { io.qStart(); };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
_queue.stop = function () { io.qStop(); };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
_queue.promote = function (o) { io.qPromote(o); };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
_queue.remove = function (o) { io.qRemove(o); };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
_queue.size = function () { io.qSize(); };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
_queue.empty = function () { io.qEmpty(); };
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
Y.io.queue = _queue;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
}, '3.10.3', {"requires": ["io-base", "queue-promote"]});