method Socket.prototype.setKeepAlive

#Socket.prototype.setKeepAlive(enable?: boolean,
initialDelay?: number,
): this

Enable/disable keep-alive functionality, and optionally set the initial delay before the first keepalive probe is sent on an idle socket.

Set initialDelay (in milliseconds) to set the delay between the last data packet received and the first keepalive probe. Setting 0 forinitialDelay will leave the value unchanged from the default (or previous) setting.

Enabling the keep-alive functionality will set the following socket options:

SO_KEEPALIVE=1
TCP_KEEPIDLE=initialDelay
TCP_KEEPCNT=10
TCP_KEEPINTVL=1

Parameters #

optional

#enable: boolean = false

optional

#initialDelay: number = 0

Return Type #

this

The socket itself.