2
2
* @typedef {{
3
3
* port: number;
4
4
* host?: string;
5
- * timeout?: number;
5
+ * timeout?: number,
6
6
* localAddress?: string,
7
7
* localPort?: number,
8
8
* interface?: 'wifi' | 'cellular' | 'ethernet',
@@ -24,6 +24,9 @@ export default class TcpSocket extends EventEmitter {
24
24
_id : number ;
25
25
_eventEmitter : import ( "react-native" ) . NativeEventEmitter ;
26
26
/** @type {number } */
27
+ _timeoutMsecs : number ;
28
+ _timeout : NodeJS . Timeout | undefined ;
29
+ /** @type {number } */
27
30
_state : number ;
28
31
/**
29
32
* @protected
@@ -55,26 +58,28 @@ export default class TcpSocket extends EventEmitter {
55
58
} , callback ?: ( ( address : string ) => void ) | undefined ) : TcpSocket ;
56
59
_destroyed : boolean | undefined ;
57
60
/**
58
- * @private
59
- * @param {number } msecs
60
- * @param {() => void } [wrapper]
61
+ * Sets the socket to timeout after `timeout` milliseconds of inactivity on the socket. By default `TcpSocket` do not have a timeout.
62
+ *
63
+ * When an idle timeout is triggered the socket will receive a `'timeout'` event but the connection will not be severed.
64
+ * The user must manually call `socket.end()` or `socket.destroy()` to end the connection.
65
+ *
66
+ * If `timeout` is 0, then the existing idle timeout is disabled.
67
+ *
68
+ * The optional `callback` parameter will be added as a one-time listener for the `'timeout'` event.
69
+ *
70
+ * @param {number } timeout
71
+ * @param {() => void } [callback]
61
72
*/
62
- private _activeTimer ;
63
- _timeout : {
64
- handle : NodeJS . Timeout ;
65
- wrapper : ( ) => void ;
66
- msecs : number ;
67
- } | null | undefined ;
73
+ setTimeout ( timeout : number , callback ?: ( ( ) => void ) | undefined ) : TcpSocket ;
68
74
/**
69
75
* @private
76
+ * @param {number } [timeout]
70
77
*/
71
- private _clearTimeout ;
78
+ private _activateTimer ;
72
79
/**
73
- * @deprecated
74
- * @param {number } msecs
75
- * @param {(...args: any[]) => void } [callback]
80
+ * @private
76
81
*/
77
- setTimeout ( msecs : number , callback ?: ( ( ... args : any [ ] ) => void ) | undefined ) : TcpSocket ;
82
+ private _clearTimeout ;
78
83
/**
79
84
* Enable/disable the use of Nagle's algorithm. When a TCP connection is created, it will have Nagle's algorithm enabled.
80
85
*
0 commit comments