Interface ServerOpts

interface ServerOpts {
    allowHalfOpen?: boolean;
    highWaterMark?: number;
    keepAlive?: boolean;
    keepAliveInitialDelay?: number;
    noDelay?: boolean;
    pauseOnConnect?: boolean;
}

Properties

allowHalfOpen? highWaterMark? keepAlive? keepAliveInitialDelay? noDelay? pauseOnConnect?

Properties

Optional allowHalfOpen

allowHalfOpen?: boolean

Indicates whether half-opened TCP connections are allowed.

Default

false

Optional highWaterMark

highWaterMark?: number

Optionally overrides all net.Sockets' readableHighWaterMark and writableHighWaterMark.

Default

See [stream.getDefaultHighWaterMark()](https://nodejs.org/docs/latest-v20.x/api/stream.html#streamgetdefaulthighwatermarkobjectmode).

Since

v18.17.0, v20.1.0

Optional keepAlive

keepAlive?: boolean

If set to true, it enables keep-alive functionality on the socket immediately after a new incoming connection is received, similarly on what is done in socket.setKeepAlive([enable][, initialDelay]).

Default

false

Since

v16.5.0

Optional keepAliveInitialDelay

keepAliveInitialDelay?: number

If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.

Default

0

Since

v16.5.0

Optional noDelay

noDelay?: boolean

If set to true, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.

Default

false

Since

v16.5.0

Optional pauseOnConnect

pauseOnConnect?: boolean

Indicates whether the socket should be paused on incoming connections.

Default

false

Settings

Member Visibility

Theme

On This Page

allowHalfOpenhighWaterMarkkeepAlivekeepAliveInitialDelaynoDelaypauseOnConnect