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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* Combines a lot of the Mozilla networking interfaces into a sane interface for
* simple(r) use of sockets code.
*
* This implements nsIServerSocketListener, nsIStreamListener,
* nsIRequestObserver, nsITransportEventSink, nsIBadCertListener2,
* and nsIProtocolProxyCallback.
*
* This uses nsIRoutedSocketTransportService, nsIServerSocket, nsIThreadManager,
* nsIBinaryInputStream, nsIScriptableInputStream, nsIInputStreamPump,
* nsIProxyService, nsIProxyInfo.
*
* High-level methods:
* connect(<originHost>, <originPort>[, ("starttls" | "ssl" | "udp")
* [, <proxy>[, <host>, <port>]]])
* disconnect()
* listen(<port>)
* stopListening()
* sendData(String <data>[, <logged data>])
* sendString(String <data>[, <encoding>[, <logged data>]])
* sendBinaryData(<arraybuffer data>)
* startTLS()
* resetPingTimer()
* cancelDisconnectTimer()
*
* High-level properties:
* binaryMode
* delimiter
* inputSegmentSize
* outputSegmentSize
* proxyFlags
* connectTimeout (default is no timeout)
* readWriteTimeout (default is no timeout)
* disconnected
* sslStatus
*
* Users should "subclass" this object, i.e. set their .__proto__ to be it. And
* then implement:
* onConnection()
* onConnectionHeard()
* onConnectionTimedOut()
* onConnectionReset()
* onBadCertificate(boolean aIsSslError, AString aNSSErrorMessage)
* onConnectionClosed()
* onDataReceived(String <data>)
* <length handled> = onBinaryDataReceived(ArrayBuffer <data>)
* onTransportStatus(nsISocketTransport <transport>, nsresult <status>,
* unsigned long <progress>, unsigned long <progress max>)
* sendPing()
* LOG(<message>)
* DEBUG(<message>)
*
* Optional features:
* The ping functionality: Included in the socket object is a higher level
* "ping" messaging system, which is commonly used in instant messaging
* protocols. The ping functionality works by calling a user defined method,
* sendPing(), if resetPingTimer() is not called after two minutes. If no
* ping response is received after 30 seconds, the socket will disconnect.
* Thus, a socket using this functionality should:
* 1. Implement sendPing() to send an appropriate ping message for the
* protocol.
* 2. Call resetPingTimer() to start the ping messages.
* 3. Call resetPingTimer() each time a message is received (i.e. the
* socket is known to still be alive).
* 4. Call cancelDisconnectTimer() when a ping response is received.
*/
/*
* To Do:
* Add a message queue to keep from flooding a server (just an array, just
* keep shifting the first element off and calling as setTimeout for the
* desired flood time?).
*/
this.EXPORTED_SYMBOLS = ["Socket"];
var {classes: Cc, interfaces: Ci, results: Cr, utils: Cu} = Components;
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource:///modules/ArrayBufferUtils.jsm");
Cu.import("resource:///modules/imXPCOMUtils.jsm");
// Network errors see: xpcom/base/nsError.h
var NS_ERROR_MODULE_NETWORK = 2152398848;
var NS_ERROR_CONNECTION_REFUSED = NS_ERROR_MODULE_NETWORK + 13;
var NS_ERROR_NET_TIMEOUT = NS_ERROR_MODULE_NETWORK + 14;
var NS_ERROR_NET_RESET = NS_ERROR_MODULE_NETWORK + 20;
var NS_ERROR_UNKNOWN_HOST = NS_ERROR_MODULE_NETWORK + 30;
var NS_ERROR_UNKNOWN_PROXY_HOST = NS_ERROR_MODULE_NETWORK + 42;
var NS_ERROR_PROXY_CONNECTION_REFUSED = NS_ERROR_MODULE_NETWORK + 72;
var BinaryInputStream =
Components.Constructor("@mozilla.org/binaryinputstream;1",
"nsIBinaryInputStream", "setInputStream");
var BinaryOutputStream =
Components.Constructor("@mozilla.org/binaryoutputstream;1",
"nsIBinaryOutputStream", "setOutputStream");
var ScriptableInputStream =
Components.Constructor("@mozilla.org/scriptableinputstream;1",
"nsIScriptableInputStream", "init");
var ServerSocket =
Components.Constructor("@mozilla.org/network/server-socket;1",
"nsIServerSocket", "init");
var InputStreamPump =
Components.Constructor("@mozilla.org/network/input-stream-pump;1",
"nsIInputStreamPump", "init");
var ScriptableUnicodeConverter =
Components.Constructor("@mozilla.org/intl/scriptableunicodeconverter",
"nsIScriptableUnicodeConverter");
var Socket = {
// Use this to use binary mode for the
binaryMode: false,
// Set this for non-binary mode to automatically parse the stream into chunks
// separated by delimiter.
delimiter: "",
// Set this for the segment size of outgoing binary streams.
outputSegmentSize: 0,
// Flags used by nsIProxyService when resolving a proxy.
proxyFlags: Ci.nsIProtocolProxyService.RESOLVE_PREFER_SOCKS_PROXY,
// Time (in seconds) for nsISocketTransport to continue trying before
// reporting a failure, 0 is forever.
connectTimeout: 0,
readWriteTimeout: 0,
// A nsISSLStatus instance giving details about the certificate error.
sslStatus: null,
/*
*****************************************************************************
******************************* Public methods ******************************
*****************************************************************************
*/
// Synchronously open a connection.
// It connects to aHost and aPort, but uses aOriginHost and aOriginPort for
// checking the certificate for them (see nsIRoutedSocketTransportService
// in nsISocketTransportService.idl).
connect: function(aOriginHost, aOriginPort, aSecurity, aProxy,
aHost = aOriginHost, aPort = aOriginPort) {
if (Services.io.offline)
throw Cr.NS_ERROR_FAILURE;
// This won't work for Linux due to bug 758848.
Services.obs.addObserver(this, "wake_notification", false);
this.LOG("Connecting to: " + aHost + ":" + aPort);
this.originHost = aOriginHost;
this.originPort = aOriginPort;
this.host = aHost;
this.port = aPort;
this.disconnected = false;
this._pendingData = [];
delete this._stopRequestStatus;
// Array of security options
this.security = aSecurity || [];
// Choose a proxy, use the given one, otherwise get one from the proxy
// service
if (aProxy)
this._createTransport(aProxy);
else {
try {
// Attempt to get a default proxy from the proxy service.
let proxyService = Cc["@mozilla.org/network/protocol-proxy-service;1"]
.getService(Ci.nsIProtocolProxyService);
// Add a URI scheme since, by default, some protocols (i.e. IRC) don't
// have a URI scheme before the host.
let uri = Services.io.newURI("http://" + this.host);
// This will return null when the result is known immediately and
// the callback will just be dispatched to the current thread.
this._proxyCancel = proxyService.asyncResolve(uri, this.proxyFlags, this);
} catch(e) {
Cu.reportError(e);
// We had some error getting the proxy service, just don't use one.
this._createTransport(null);
}
}
},
// Disconnect all open streams.
disconnect: function() {
this.LOG("Disconnect");
// Don't handle any remaining unhandled data.
this._pendingData = [];
// Close all input and output streams.
if ("_inputStream" in this) {
this._inputStream.close();
delete this._inputStream;
}
if ("_outputStream" in this) {
this._outputStream.close();
delete this._outputStream;
}
if ("transport" in this) {
this.transport.close(Cr.NS_OK);
delete this.transport;
}
if ("_proxyCancel" in this) {
if (this._proxyCancel)
this._proxyCancel.cancel(Cr.NS_ERROR_ABORT); // Has to give a failure code
delete this._proxyCancel;
}
if (this._pingTimer) {
clearTimeout(this._pingTimer);
delete this._pingTimer;
delete this._resetPingTimerPending;
}
this.cancelDisconnectTimer();
delete this._lastAliveTime;
Services.obs.removeObserver(this, "wake_notification");
this.disconnected = true;
},
// Listen for a connection on a port.
// XXX take a timeout and then call stopListening
listen: function(aPort) {
this.LOG("Listening on port " + aPort);
this.serverSocket = new ServerSocket(aPort, false, -1);
this.serverSocket.asyncListen(this);
},
// Stop listening for a connection.
stopListening: function() {
this.LOG("Stop listening");
// Close the socket to stop listening.
if ("serverSocket" in this)
this.serverSocket.close();
},
// Send data on the output stream. Provide aLoggedData to log something
// different than what is actually sent.
sendData: function(/* string */ aData, aLoggedData = aData) {
this.LOG("Sending:\n" + aLoggedData);
try {
this._outputStream.write(aData, aData.length);
} catch(e) {
Cu.reportError(e);
}
},
// Send a string to the output stream after converting the encoding. Provide
// aLoggedData to log something different than what is actually sent.
sendString: function(aString, aEncoding = "UTF-8", aLoggedData = aString) {
this.LOG("Sending:\n" + aLoggedData);
let converter = new ScriptableUnicodeConverter();
converter.charset = aEncoding;
try {
let stream = converter.convertToInputStream(aString);
this._outputStream.writeFrom(stream, stream.available());
} catch(e) {
Cu.reportError(e);
}
},
sendBinaryData: function(/* ArrayBuffer */ aData, aLoggedData) {
this.LOG("Sending binary data:\n" + (aLoggedData ||
"<" + ArrayBufferToHexString(aData) + ">"));
let byteArray = ArrayBufferToBytes(aData);
try {
// Send the data as a byte array
this._binaryOutputStream.writeByteArray(byteArray, byteArray.length);
} catch(e) {
Cu.reportError(e);
}
},
disconnected: true,
startTLS: function() {
this.transport.securityInfo.QueryInterface(Ci.nsISSLSocketControl).StartTLS();
},
// If using the ping functionality, this should be called whenever a message is
// received (e.g. when it is known the socket is still open). Calling this for
// the first time enables the ping functionality.
resetPingTimer: function() {
// Clearing and setting timeouts is expensive, so we do it at most
// once per eventloop spin cycle.
if (this._resetPingTimerPending)
return;
this._resetPingTimerPending = true;
executeSoon(this._delayedResetPingTimer.bind(this));
},
kTimeBeforePing: 120000, // 2 min
kTimeAfterPingBeforeDisconnect: 30000, // 30 s
_delayedResetPingTimer: function() {
if (!this._resetPingTimerPending)
return;
delete this._resetPingTimerPending;
if (this._pingTimer)
clearTimeout(this._pingTimer);
// Send a ping every 2 minutes if there's no traffic on the socket.
this._pingTimer = setTimeout(this._sendPing.bind(this), this.kTimeBeforePing);
},
// If using the ping functionality, this should be called when a ping receives
// a response.
cancelDisconnectTimer: function() {
if (!this._disconnectTimer)
return;
clearTimeout(this._disconnectTimer);
delete this._disconnectTimer;
},
// Plenty of time may have elapsed if the computer wakes from sleep, so check
// if we should reconnect immediately.
_lastAliveTime: null,
observe: function(aSubject, aTopic, aData) {
if (aTopic != "wake_notification")
return;
let elapsedTime = Date.now() - this._lastAliveTime;
// If there never was any activity before we went to sleep,
// or if we've been waiting for a ping response for over 30s,
// or if the last activity on the socket is longer ago than we usually
// allow before we timeout,
// declare the connection timed out immediately.
if (!this._lastAliveTime ||
(this._disconnectTimer && elapsedTime > this.kTimeAfterPingBeforeDisconnect) ||
elapsedTime > this.kTimeBeforePing + this.kTimeAfterPingBeforeDisconnect)
this.onConnectionTimedOut();
else if (this._pingTimer) {
// If there was a ping timer running when the computer went to sleep,
// ping immediately to discover if we are still connected.
clearTimeout(this._pingTimer);
this._sendPing();
}
},
/*
*****************************************************************************
***************************** Interface methods *****************************
*****************************************************************************
*/
/*
* nsIProtocolProxyCallback methods
*/
onProxyAvailable: function(aRequest, aURI, aProxyInfo, aStatus) {
if (!("_proxyCancel" in this)) {
this.LOG("onProxyAvailable called, but disconnect() was called before.");
return;
}
if (aProxyInfo) {
if (aProxyInfo.type == "http") {
this.LOG("ignoring http proxy");
aProxyInfo = null;
}
else {
this.LOG("using " + aProxyInfo.type + " proxy: " +
aProxyInfo.host + ":" + aProxyInfo.port);
}
}
this._createTransport(aProxyInfo);
delete this._proxyCancel;
},
/*
* nsIServerSocketListener methods
*/
// Called after a client connection is accepted when we're listening for one.
onSocketAccepted: function(aServerSocket, aTransport) {
this.LOG("onSocketAccepted");
// Store the values
this.transport = aTransport;
this.host = this.transport.host;
this.port = this.transport.port;
this._resetBuffers();
this._openStreams();
this.onConnectionHeard();
this.stopListening();
},
// Called when the listening socket stops for some reason.
// The server socket is effectively dead after this notification.
onStopListening: function(aSocket, aStatus) {
this.LOG("onStopListening");
if ("serverSocket" in this)
delete this.serverSocket;
},
/*
* nsIStreamListener methods
*/
// onDataAvailable, called by Mozilla's networking code.
// Buffers the data, and parses it into discrete messages.
onDataAvailable: function(aRequest, aContext, aInputStream, aOffset, aCount) {
if (this.disconnected)
return;
this._lastAliveTime = Date.now();
if (this.binaryMode) {
// Load the data from the stream
this._incomingDataBuffer = this._incomingDataBuffer
.concat(this._binaryInputStream
.readByteArray(aCount));
let size = this._incomingDataBuffer.length;
// Create a new ArrayBuffer.
let buffer = new ArrayBuffer(size);
let uintArray = new Uint8Array(buffer);
// Set the data into the array while saving the extra data.
uintArray.set(this._incomingDataBuffer);
// Notify we've received data.
// Variable data size, the callee must return how much data was handled.
size = this.onBinaryDataReceived(buffer);
// Remove the handled data.
this._incomingDataBuffer.splice(0, size);
}
else {
if (this.delimiter) {
// Load the data from the stream.
this._incomingDataBuffer += this._scriptableInputStream.read(aCount);
let data = this._incomingDataBuffer.split(this.delimiter);
// Store the (possibly) incomplete part.
this._incomingDataBuffer = data.pop();
if (!data.length)
return;
// Add the strings to the queue.
this._pendingData = this._pendingData.concat(data);
}
else {
// Add the whole string to the queue.
this._pendingData.push(this._scriptableInputStream.read(aCount));
}
this._activateQueue();
}
},
_pendingData: [],
_handlingQueue: false,
_activateQueue: function() {
if (this._handlingQueue)
return;
this._handlingQueue = true;
this._handleQueue();
},
// Asynchronously send each string to the handle data function.
_handleQueue: function() {
let begin = Date.now();
while (this._pendingData.length) {
this.onDataReceived(this._pendingData.shift());
// If more than 10ms have passed, stop blocking the thread.
if (Date.now() - begin > 10)
break;
}
if (this._pendingData.length) {
executeSoon(this._handleQueue.bind(this));
return;
}
delete this._handlingQueue;
// If there was a stop request, handle it.
if ("_stopRequestStatus" in this)
this._handleStopRequest(this._stopRequestStatus);
},
/*
* nsIRequestObserver methods
*/
// Signifies the beginning of an async request
onStartRequest: function(aRequest, aContext) {
if (this.disconnected) {
// Ignore this if we're already disconnected.
return;
}
this.DEBUG("onStartRequest");
},
// Called to signify the end of an asynchronous request.
onStopRequest: function(aRequest, aContext, aStatus) {
if (this.disconnected) {
// We're already disconnected, so nothing left to do here.
return;
}
this.DEBUG("onStopRequest (" + aStatus + ")");
this._stopRequestStatus = aStatus;
// The stop request will be handled when the queue is next empty.
this._activateQueue();
},
// Close the connection after receiving a stop request.
_handleStopRequest: function(aStatus) {
if (this.disconnected)
return;
this.disconnected = true;
if (aStatus == NS_ERROR_NET_RESET)
this.onConnectionReset();
else if (aStatus == NS_ERROR_NET_TIMEOUT)
this.onConnectionTimedOut();
else if (!Components.isSuccessCode(aStatus)) {
let nssErrorsService =
Cc["@mozilla.org/nss_errors_service;1"].getService(Ci.nsINSSErrorsService);
if ((aStatus <= nssErrorsService.getXPCOMFromNSSError(nssErrorsService.NSS_SEC_ERROR_BASE) &&
aStatus >= nssErrorsService.getXPCOMFromNSSError(nssErrorsService.NSS_SEC_ERROR_LIMIT - 1)) ||
(aStatus <= nssErrorsService.getXPCOMFromNSSError(nssErrorsService.NSS_SSL_ERROR_BASE) &&
aStatus >= nssErrorsService.getXPCOMFromNSSError(nssErrorsService.NSS_SSL_ERROR_LIMIT - 1))) {
this.onBadCertificate(nssErrorsService.getErrorClass(aStatus) ==
nssErrorsService.ERROR_CLASS_SSL_PROTOCOL,
nssErrorsService.getErrorMessage(aStatus));
return;
}
}
this.onConnectionClosed();
},
/*
* nsIBadCertListener2
*/
// Called when there's an error, return true to suppress the modal alert.
// Whatever this function returns, NSS will close the connection.
notifyCertProblem: function(aSocketInfo, aStatus, aTargetSite) {
this.sslStatus = aStatus;
return true;
},
/*
* nsITransportEventSink methods
*/
onTransportStatus: function(aTransport, aStatus, aProgress, aProgressmax) {
// Don't send status change notifications after the socket has been closed.
// The event sink can't be removed after opening the transport, so we can't
// do better than adding a null check here.
if (!this.transport)
return;
const nsITransportEventSinkStatus = {
0x804b0003: "STATUS_RESOLVING",
0x804b000b: "STATUS_RESOLVED",
0x804b0007: "STATUS_CONNECTING_TO",
0x804b0004: "STATUS_CONNECTED_TO",
0x804b0005: "STATUS_SENDING_TO",
0x804b000a: "STATUS_WAITING_FOR",
0x804b0006: "STATUS_RECEIVING_FROM"
};
let status = nsITransportEventSinkStatus[aStatus];
this.DEBUG("onTransportStatus(" + (status || ("0x" + aStatus.toString(16))) +")");
if (status == "STATUS_CONNECTED_TO") {
// Notify that the connection has been established.
this.onConnection();
}
},
/*
*****************************************************************************
****************************** Private methods ******************************
*****************************************************************************
*/
_resetBuffers: function() {
this._incomingDataBuffer = this.binaryMode ? [] : "";
this._outgoingDataBuffer = [];
},
_createTransport: function(aProxy) {
this.proxy = aProxy;
// Empty incoming and outgoing data storage buffers
this._resetBuffers();
// Create a routed socket transport
// We connect to host and port, but the origin host and origin port are
// given to PSM (e.g. check the certificate).
let socketTS = Cc["@mozilla.org/network/socket-transport-service;1"]
.getService(Ci.nsIRoutedSocketTransportService);
this.transport =
socketTS.createRoutedTransport(this.security, this.security.length,
this.originHost, this.originPort,
this.host, this.port,
this.proxy);
this._openStreams();
},
// Open the incoming and outgoing streams, and init the nsISocketTransport.
_openStreams: function() {
// Security notification callbacks (must support nsIBadCertListener2
// for SSL connections, and possibly other interfaces).
this.transport.securityCallbacks = this;
// Set the timeouts for the nsISocketTransport for both a connect event and
// a read/write. Only set them if the user has provided them.
if (this.connectTimeout) {
this.transport.setTimeout(Ci.nsISocketTransport.TIMEOUT_CONNECT,
this.connectTimeout);
}
if (this.readWriteTimeout) {
this.transport.setTimeout(Ci.nsISocketTransport.TIMEOUT_READ_WRITE,
this.readWriteTimeout);
}
this.transport.setEventSink(this, Services.tm.currentThread);
// No limit on the output stream buffer
this._outputStream =
this.transport.openOutputStream(0, this.outputSegmentSize, -1);
if (!this._outputStream)
throw "Error getting output stream.";
this._inputStream = this.transport.openInputStream(0, // flags
0, // Use default segment size
0); // Use default segment count
if (!this._inputStream)
throw "Error getting input stream.";
if (this.binaryMode) {
// Handle binary mode
this._binaryInputStream = new BinaryInputStream(this._inputStream);
this._binaryOutputStream = new BinaryOutputStream(this._outputStream);
} else {
// Handle character mode
this._scriptableInputStream =
new ScriptableInputStream(this._inputStream);
}
this.pump = new InputStreamPump(this._inputStream, // Data to read
-1, // Current offset
-1, // Read all data
0, // Use default segment size
0, // Use default segment length
false); // Do not close when done
this.pump.asyncRead(this, this);
},
_pingTimer: null,
_disconnectTimer: null,
_sendPing: function() {
delete this._pingTimer;
this.sendPing();
this._disconnectTimer = setTimeout(this.onConnectionTimedOut.bind(this),
this.kTimeAfterPingBeforeDisconnect);
},
/*
*****************************************************************************
********************* Methods for subtypes to override **********************
*****************************************************************************
*/
LOG: function(aString) { },
DEBUG: function(aString) { },
// Called when a connection is established.
onConnection: function() { },
// Called when a socket is accepted after listening.
onConnectionHeard: function() { },
// Called when a connection times out.
onConnectionTimedOut: function() { },
// Called when a socket request's network is reset.
onConnectionReset: function() { },
// Called when the certificate provided by the server didn't satisfy NSS.
onBadCertificate: function(aNSSErrorMessage) { },
// Called when the other end has closed the connection.
onConnectionClosed: function() { },
// Called when ASCII data is available.
onDataReceived: function(/* string */ aData) { },
// Called when binary data is available.
onBinaryDataReceived: function(/* ArrayBuffer */ aData) { },
// If using the ping functionality, this is called when a new ping message
// should be sent on the socket.
sendPing: function() { },
/* QueryInterface and nsIInterfaceRequestor implementations */
_interfaces: [Ci.nsIServerSocketListener, Ci.nsIStreamListener,
Ci.nsIRequestObserver, Ci.nsITransportEventSink,
Ci.nsIBadCertListener2, Ci.nsIProtocolProxyCallback],
QueryInterface: function(iid) {
if (iid.equals(Ci.nsISupports) ||
this._interfaces.some(i => i.equals(iid)))
return this;
throw Cr.NS_ERROR_NO_INTERFACE;
},
getInterface: function(iid) { return this.QueryInterface(iid); }
};
|