Skip to content

Commit b918de6

Browse files
chore(release): 4.1.0 [skip ci]
# [4.1.0](v4.0.0...v4.1.0) (2020-06-18) ### Bug Fixes * **Android:** Fix server socket events not being delivered ([50e9b79](50e9b79)), closes [#54](#54) ### Features * Add setTimeout() method ([#56](#56)) ([e642e1a](e642e1a))
1 parent e642e1a commit b918de6

File tree

5 files changed

+35
-18
lines changed

5 files changed

+35
-18
lines changed

CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# [4.1.0](https://github.com/Rapsssito/react-native-tcp-socket/compare/v4.0.0...v4.1.0) (2020-06-18)
2+
3+
4+
### Bug Fixes
5+
6+
* **Android:** Fix server socket events not being delivered ([50e9b79](https://github.com/Rapsssito/react-native-tcp-socket/commit/50e9b793603bf84c74174c1c3b048746e6c26d90)), closes [#54](https://github.com/Rapsssito/react-native-tcp-socket/issues/54)
7+
8+
9+
### Features
10+
11+
* Add setTimeout() method ([#56](https://github.com/Rapsssito/react-native-tcp-socket/issues/56)) ([e642e1a](https://github.com/Rapsssito/react-native-tcp-socket/commit/e642e1a1e2c89f51731d60c0776639e8bddef54b))
12+
113
# [4.0.0](https://github.com/Rapsssito/react-native-tcp-socket/compare/v3.7.1...v4.0.0) (2020-06-16)
214

315

coverage/coverage-final.json

+1-1
Large diffs are not rendered by default.

lib/types/TcpServer.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export default class TcpServer extends TcpSocket {
4141
tlsCheckValidity?: boolean | undefined;
4242
tlsCert?: any;
4343
}, callback?: ((address: string) => void) | undefined): TcpServer;
44-
setTimeout(msecs: number, callback?: ((...args: any[]) => void) | undefined): TcpServer;
44+
setTimeout(timeout: number, callback?: (() => void) | undefined): TcpServer;
4545
addListener(event: string | symbol, listener: (...args: any[]) => void): TcpServer;
4646
on(event: string | symbol, listener: (...args: any[]) => void): TcpServer;
4747
once(event: string | symbol, listener: (...args: any[]) => void): TcpServer;

lib/types/TcpSocket.d.ts

+20-15
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @typedef {{
33
* port: number;
44
* host?: string;
5-
* timeout?: number;
5+
* timeout?: number,
66
* localAddress?: string,
77
* localPort?: number,
88
* interface?: 'wifi' | 'cellular' | 'ethernet',
@@ -24,6 +24,9 @@ export default class TcpSocket extends EventEmitter {
2424
_id: number;
2525
_eventEmitter: import("react-native").NativeEventEmitter;
2626
/** @type {number} */
27+
_timeoutMsecs: number;
28+
_timeout: NodeJS.Timeout | undefined;
29+
/** @type {number} */
2730
_state: number;
2831
/**
2932
* @protected
@@ -55,26 +58,28 @@ export default class TcpSocket extends EventEmitter {
5558
}, callback?: ((address: string) => void) | undefined): TcpSocket;
5659
_destroyed: boolean | undefined;
5760
/**
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]
6172
*/
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;
6874
/**
6975
* @private
76+
* @param {number} [timeout]
7077
*/
71-
private _clearTimeout;
78+
private _activateTimer;
7279
/**
73-
* @deprecated
74-
* @param {number} msecs
75-
* @param {(...args: any[]) => void } [callback]
80+
* @private
7681
*/
77-
setTimeout(msecs: number, callback?: ((...args: any[]) => void) | undefined): TcpSocket;
82+
private _clearTimeout;
7883
/**
7984
* Enable/disable the use of Nagle's algorithm. When a TCP connection is created, it will have Nagle's algorithm enabled.
8085
*

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-native-tcp-socket",
33
"title": "React Native Tcp Socket",
4-
"version": "4.0.0",
4+
"version": "4.1.0",
55
"description": "React Native TCP socket API for Android & iOS with SSL/TLS support",
66
"main": "src/index.js",
77
"types": "lib/types/index.d.ts",

0 commit comments

Comments
 (0)