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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
/* ************************************************************************
qooxdoo - the new era of web development
http://qooxdoo.org
Copyright:
2004-2007 1&1 Internet AG, Germany, http://www.1and1.org
2006 Derrell Lipman
License:
LGPL: http://www.gnu.org/licenses/lgpl.html
EPL: http://www.eclipse.org/org/documents/epl-v10.php
See the LICENSE file in the project's top-level directory for details.
Authors:
* Sebastian Werner (wpbasti)
* Andreas Ecker (ecker)
* Derrell Lipman (derrell)
************************************************************************ */
/* ************************************************************************
#module(io_remote)
************************************************************************ */
/**
* Handles scheduling of requests to be sent to a server.
*
* This class is a singleton and is used by qx.io.remote.Request to schedule its
* requests. It should not be used directly.
*/
qx.OO.defineClass("qx.io.remote.RequestQueue", qx.core.Target,
function()
{
qx.core.Target.call(this);
this._queue = [];
this._active = [];
this._totalRequests = 0;
// timeout handling
this._timer = new qx.client.Timer(500);
this._timer.addEventListener("interval", this._oninterval, this);
});
/*
---------------------------------------------------------------------------
PROPERTIES
---------------------------------------------------------------------------
*/
/**
* @deprecated
*/
qx.OO.addProperty({ name : "maxTotalRequests", type : "number" });
/**
* Maximum number of parallel requests.
*/
qx.OO.addProperty({ name : "maxConcurrentRequests", type : "number", defaultValue : 3 });
/**
* Default timeout for remote requests in milliseconds.
*/
qx.OO.addProperty({ name : "defaultTimeout", type : "number", defaultValue : 5000 });
/*
---------------------------------------------------------------------------
QUEUE HANDLING
---------------------------------------------------------------------------
*/
qx.Proto._debug = function()
{
// Debug output
var vText = this._active.length + "/" + (this._queue.length+this._active.length);
if (qx.Settings.getValueOfClass("qx.io.remote.Exchange", "enableDebug"))
{
this.debug("Progress: " + vText);
window.status = "Request-Queue Progress: " + vText;
}
}
qx.Proto._check = function()
{
// Debug output
this._debug();
// Check queues and stop timer if not needed anymore
if (this._active.length == 0 && this._queue.length == 0) {
this._timer.stop();
}
// Checking if enabled
if (!this.getEnabled()) {
return;
}
// Checking active queue fill
if (this._active.length >= this.getMaxConcurrentRequests() || this._queue.length == 0) {
return;
}
// Checking number of total requests
if (this.getMaxTotalRequests() != null && this._totalRequests >= this.getMaxTotalRequests()) {
return;
}
var vRequest = this._queue.shift();
var vTransport = new qx.io.remote.Exchange(vRequest);
// Increment counter
this._totalRequests++;
// Add to active queue
this._active.push(vTransport);
// Debug output
this._debug();
// Establish event connection between qx.io.remote.Exchange instance and qx.io.remote.Request
vTransport.addEventListener("sending", vRequest._onsending, vRequest);
vTransport.addEventListener("receiving", vRequest._onreceiving, vRequest);
vTransport.addEventListener("completed", vRequest._oncompleted, vRequest);
vTransport.addEventListener("aborted", vRequest._onaborted, vRequest);
vTransport.addEventListener("timeout", vRequest._ontimeout, vRequest);
vTransport.addEventListener("failed", vRequest._onfailed, vRequest);
// Establish event connection between qx.io.remote.Exchange and me.
vTransport.addEventListener("sending", this._onsending, this);
vTransport.addEventListener("completed", this._oncompleted, this);
vTransport.addEventListener("aborted", this._oncompleted, this);
vTransport.addEventListener("timeout", this._oncompleted, this);
vTransport.addEventListener("failed", this._oncompleted, this);
// Store send timestamp
vTransport._start = (new Date).valueOf();
// Send
vTransport.send();
// Retry
if (this._queue.length > 0) {
this._check();
}
}
qx.Proto._remove = function(vTransport)
{
var vRequest = vTransport.getRequest();
// Destruct event connection between qx.io.remote.Exchange instance and qx.io.remote.Request
vTransport.removeEventListener("sending", vRequest._onsending, vRequest);
vTransport.removeEventListener("receiving", vRequest._onreceiving, vRequest);
vTransport.removeEventListener("completed", vRequest._oncompleted, vRequest);
vTransport.removeEventListener("aborted", vRequest._onaborted, vRequest);
vTransport.removeEventListener("timeout", vRequest._ontimeout, vRequest);
vTransport.removeEventListener("failed", vRequest._onfailed, vRequest);
// Destruct event connection between qx.io.remote.Exchange and me.
vTransport.removeEventListener("sending", this._onsending, this);
vTransport.removeEventListener("completed", this._oncompleted, this);
vTransport.removeEventListener("aborted", this._oncompleted, this);
vTransport.removeEventListener("timeout", this._oncompleted, this);
vTransport.removeEventListener("failed", this._oncompleted, this);
// Remove from active transports
qx.lang.Array.remove(this._active, vTransport);
// Dispose transport object
vTransport.dispose();
// Check again
this._check();
}
/*
---------------------------------------------------------------------------
EVENT HANDLING
---------------------------------------------------------------------------
*/
qx.Proto._activeCount = 0;
qx.Proto._onsending = function(e)
{
if (qx.Settings.getValueOfClass("qx.io.remote.Exchange", "enableDebug"))
{
this._activeCount++;
e.getTarget()._counted = true;
this.debug("ActiveCount: " + this._activeCount);
}
}
qx.Proto._oncompleted = function(e)
{
if (qx.Settings.getValueOfClass("qx.io.remote.Exchange", "enableDebug"))
{
if (e.getTarget()._counted)
{
this._activeCount--;
this.debug("ActiveCount: " + this._activeCount);
}
}
this._remove(e.getTarget());
}
/*
---------------------------------------------------------------------------
TIMEOUT HANDLING
---------------------------------------------------------------------------
*/
qx.Proto._oninterval = function(e)
{
var vActive = this._active;
if (vActive.length == 0) {
return;
}
var vCurrent = (new Date).valueOf();
var vTransport;
var vRequest;
var vDefaultTimeout = this.getDefaultTimeout();
var vTimeout;
var vTime;
for (var i=vActive.length-1; i>=0; i--)
{
vTransport = vActive[i];
vRequest = vTransport.getRequest();
if (vRequest.isAsynchronous()) {
vTimeout = vRequest.getTimeout();
// if timer is disabled...
if (vTimeout == 0) {
// then ignore it.
continue;
}
if (vTimeout == null) {
vTimeout = vDefaultTimeout;
}
vTime = vCurrent - vTransport._start;
if (vTime > vTimeout)
{
this.warn("Timeout: transport " + vTransport.toHashCode());
this.warn(vTime + "ms > " + vTimeout + "ms");
vTransport.timeout();
}
}
}
}
/*
---------------------------------------------------------------------------
MODIFIERS
---------------------------------------------------------------------------
*/
qx.Proto._modifyEnabled = function(propValue, propOldValue, propData)
{
if (propValue) {
this._check();
}
this._timer.setEnabled(propValue);
return true;
}
/*
---------------------------------------------------------------------------
CORE METHODS
---------------------------------------------------------------------------
*/
/*!
Add the request to the pending requests queue.
*/
qx.Proto.add = function(vRequest)
{
vRequest.setState("queued");
this._queue.push(vRequest);
this._check();
if (this.getEnabled()) {
this._timer.start();
}
}
/*!
Remove the request from the pending requests queue.
The underlying transport of the request is forced into the aborted
state ("aborted") and listeners of the "aborted"
signal are notified about the event. If the request isn't in the
pending requests queue, this method is a noop.
*/
qx.Proto.abort = function(vRequest)
{
var vTransport = vRequest.getTransport();
if (vTransport)
{
vTransport.abort();
}
else if (qx.lang.Array.contains(this._queue, vRequest))
{
qx.lang.Array.remove(this._queue, vRequest);
}
}
/*
---------------------------------------------------------------------------
DISPOSER
---------------------------------------------------------------------------
*/
/**
* Disposer
*/
qx.Proto.dispose = function()
{
if (this.getDisposed()) {
return true;
}
if (this._active)
{
for (var i=0, a=this._active, l=a.length; i<l; i++) {
this._remove(a[i]);
}
this._active = null;
}
if (this._timer)
{
this._timer.removeEventListener("interval", this._oninterval, this);
this._timer = null;
}
this._queue = null;
return qx.core.Target.prototype.dispose.call(this);
}
/*
---------------------------------------------------------------------------
DEFER SINGLETON INSTANCE
---------------------------------------------------------------------------
*/
/**
* Singleton Instance Getter
*/
qx.Class.getInstance = qx.lang.Function.returnInstance;
|