seq-queue.js
4.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
var EventEmitter = require('events').EventEmitter;
var util = require('util');
var DEFAULT_TIMEOUT = 3000;
var INIT_ID = 0;
var EVENT_CLOSED = 'closed';
var EVENT_DRAINED = 'drained';
/**
* Instance a new queue
*
* @param {Number} timeout a global timeout for new queue
* @class
* @constructor
*/
var SeqQueue = function(timeout) {
EventEmitter.call(this);
if(timeout && timeout > 0) {
this.timeout = timeout;
} else {
this.timeout = DEFAULT_TIMEOUT;
}
this.status = SeqQueueManager.STATUS_IDLE;
this.curId = INIT_ID;
this.queue = [];
};
util.inherits(SeqQueue, EventEmitter);
/**
* Add a task into queue.
*
* @param fn new request
* @param ontimeout callback when task timeout
* @param timeout timeout for current request. take the global timeout if this is invalid
* @returns true or false
*/
SeqQueue.prototype.push = function(fn, ontimeout, timeout) {
if(this.status !== SeqQueueManager.STATUS_IDLE && this.status !== SeqQueueManager.STATUS_BUSY) {
//ignore invalid status
return false;
}
if(typeof fn !== 'function') {
throw new Error('fn should be a function.');
}
this.queue.push({fn: fn, ontimeout: ontimeout, timeout: timeout});
if(this.status === SeqQueueManager.STATUS_IDLE) {
this.status = SeqQueueManager.STATUS_BUSY;
var self = this;
process.nextTick(function() {
self._next(self.curId);
});
}
return true;
};
/**
* Close queue
*
* @param {Boolean} force if true will close the queue immediately else will execute the rest task in queue
*/
SeqQueue.prototype.close = function(force) {
if(this.status !== SeqQueueManager.STATUS_IDLE && this.status !== SeqQueueManager.STATUS_BUSY) {
//ignore invalid status
return;
}
if(force) {
this.status = SeqQueueManager.STATUS_DRAINED;
if(this.timerId) {
clearTimeout(this.timerId);
this.timerId = undefined;
}
this.emit(EVENT_DRAINED);
} else {
this.status = SeqQueueManager.STATUS_CLOSED;
this.emit(EVENT_CLOSED);
}
};
/**
* Invoke next task
*
* @param {String|Number} tid last executed task id
* @api private
*/
SeqQueue.prototype._next = function(tid) {
if(tid !== this.curId || this.status !== SeqQueueManager.STATUS_BUSY && this.status !== SeqQueueManager.STATUS_CLOSED) {
//ignore invalid next call
return;
}
if(this.timerId) {
clearTimeout(this.timerId);
this.timerId = undefined;
}
var task = this.queue.shift();
if(!task) {
if(this.status === SeqQueueManager.STATUS_BUSY) {
this.status = SeqQueueManager.STATUS_IDLE;
this.curId++; //modify curId to invalidate timeout task
} else {
this.status = SeqQueueManager.STATUS_DRAINED;
this.emit(EVENT_DRAINED);
}
return;
}
var self = this;
task.id = ++this.curId;
var timeout = task.timeout > 0 ? task.timeout : this.timeout;
timeout = timeout > 0 ? timeout : DEFAULT_TIMEOUT;
this.timerId = setTimeout(function() {
process.nextTick(function() {
self._next(task.id);
});
self.emit('timeout', task);
if(task.ontimeout) {
task.ontimeout();
}
}, timeout);
try {
task.fn({
done: function() {
var res = task.id === self.curId;
process.nextTick(function() {
self._next(task.id);
});
return res;
}
});
} catch(err) {
self.emit('error', err, task);
process.nextTick(function() {
self._next(task.id);
});
}
};
/**
* Queue manager.
*
* @module
*/
var SeqQueueManager = module.exports;
/**
* Queue status: idle, welcome new tasks
*
* @const
* @type {Number}
* @memberOf SeqQueueManager
*/
SeqQueueManager.STATUS_IDLE = 0;
/**
* Queue status: busy, queue is working for some tasks now
*
* @const
* @type {Number}
* @memberOf SeqQueueManager
*/
SeqQueueManager.STATUS_BUSY = 1;
/**
* Queue status: closed, queue has closed and would not receive task any more
* and is processing the remaining tasks now.
*
* @const
* @type {Number}
* @memberOf SeqQueueManager
*/
SeqQueueManager.STATUS_CLOSED = 2;
/**
* Queue status: drained, queue is ready to be destroy
*
* @const
* @type {Number}
* @memberOf SeqQueueManager
*/
SeqQueueManager.STATUS_DRAINED = 3;
/**
* Create Sequence queue
*
* @param {Number} timeout a global timeout for the new queue instance
* @return {Object} new queue instance
* @memberOf SeqQueueManager
*/
SeqQueueManager.createQueue = function(timeout) {
return new SeqQueue(timeout);
};