redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-07-31 05:44:24 +03:00
Code Activity

feat(client): expose socketTimeout option (#2965)

Browse Source 
The maximum duration (in milliseconds) that the socket can remain idle (i.e., with no data sent or received) before being automatically closed. Default reconnectionStrategy will ignore the new SocketTimeoutError, but users are allowed to have custom strategies wich handle those errors in different ways
This commit is contained in:
Nikolay Karadzhov
2025-05-20 14:28:15 +03:00
committed by GitHub
parent d0a5c4c945
commit f3d1d3352e
4 changed files with 99 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/client-configuration.md
View File

@ -9,6 +9,7 @@
| socket.family | `0` | IP Stack version (one of `4 \| 6 \| 0`) |
| socket.path | | Path to the UNIX Socket |
| socket.connectTimeout | `5000` | Connection timeout (in milliseconds) |
| socket.socketTimeout | | The maximum duration (in milliseconds) that the socket can remain idle (i.e., with no data sent or received) before being automatically closed |
| socket.noDelay | `true` | Toggle [`Nagle's algorithm`](https://nodejs.org/api/net.html#net_socket_setnodelay_nodelay) |
| socket.keepAlive | `true` | Toggle [`keep-alive`](https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay) functionality |
| socket.keepAliveInitialDelay | `5000` | If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket |
@ -40,7 +41,12 @@ By default the strategy uses exponential backoff, but it can be overwritten like
```javascript
createClient({
socket: {
reconnectStrategy: retries => {
reconnectStrategy: (retries, cause) => {
// By default, do not reconnect on socket timeout.
if (cause instanceof SocketTimeoutError) {
return false;
}
// Generate a random jitter between 0 – 200 ms:
const jitter = Math.floor(Math.random() * 200);
// Delay is an exponential back off, (times^2) * 50 ms, with a maximum value of 2000 ms: