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