✨ Add missing keep-alive config options

Signed-off-by: Tomas Dvorak <[email protected]>

Author: Tomas2D

src/UltraVNCRepeater.ts

@@ -342,6 +342,7 @@ export class UltraVNCRepeater extends EventEmitter {
         port: this._options.serverPort,
         bufferSize: this._options.bufferSize,
         socketTimeout: this._options.socketTimeout,
+        keepAlive: this._options.keepAlive,
       },
       this._logger,
     );
@@ -386,6 +387,7 @@ export class UltraVNCRepeater extends EventEmitter {
         port: this._options.clientPort,
         bufferSize: this._options.bufferSize,
         socketTimeout: this._options.socketTimeout,
+        keepAlive: this._options.keepAlive,
       },
       this._logger,
     );

src/cli.ts

@@ -14,6 +14,8 @@ const EnvName = createEnumLowerCase([
   "REPEATER_REFUSE",
   "REPEATER_LOGFILE",
   "REPEATER_LOG_LEVEL",
+  "REPEATER_SOCKET_TIMEOUT",
+  "REPEATER_SOCKET_KEEPALIVE",
 ] as const);
 
 export async function run() {
@@ -82,6 +84,22 @@ export async function run() {
         default: getEnv(EnvName.REPEATER_LOG_LEVEL, { type: "string" }),
         demandOption: false,
       },
+      socketTimeout: {
+        describe: `Provide socket timeout in seconds (or use '${EnvName.REPEATER_SOCKET_TIMEOUT}' env)`,
+        type: "number",
+        default: getEnv(EnvName.REPEATER_SOCKET_TIMEOUT, {
+          type: "number",
+        }),
+        demandOption: false,
+      },
+      keepAlive: {
+        describe: `Provide keep-alive interval in seconds (or use '${EnvName.REPEATER_SOCKET_KEEPALIVE}' env)`,
+        type: "number",
+        default: getEnv(EnvName.REPEATER_SOCKET_KEEPALIVE, {
+          type: "number",
+        }),
+        demandOption: false,
+      },
     })
     .parseAsync();
 

src/constants.ts

@@ -11,6 +11,7 @@ export const DefaultServerOptions: VNCRepeaterOptions = {
   logger: undefined,
   socketTimeout: 30 * 60,
   killTimeout: 30,
+  keepAlive: 10,
 } as const;
 
 export const EventInternal = createEnumLowerCase([

src/gateway/BaseGateway.ts

@@ -13,7 +13,10 @@ export abstract class BaseGateway extends EventEmitter {
   protected _logger: Logger;
 
   protected constructor(
-    protected readonly _options: Pick<VNCRepeaterOptions, "socketTimeout"> & {
+    protected readonly _options: Pick<
+      VNCRepeaterOptions,
+      "socketTimeout" | "keepAlive"
+    > & {
       port: number;
     },
     logger: Logger,
@@ -30,7 +33,7 @@ export abstract class BaseGateway extends EventEmitter {
 
     this._server = net.createServer(
       {
-        keepAlive: true,
+        keepAlive: Boolean(this._options.keepAlive),
         allowHalfOpen: false,
         pauseOnConnect: false,
       },
@@ -135,12 +138,14 @@ export abstract class BaseGateway extends EventEmitter {
       );
       socket.setTimeout(this._options.socketTimeout * 1000);
     }
-    socket.setKeepAlive(true, 1000);
-    setKeepAliveInterval(socket, 1000);
-    setKeepAliveProbes(socket, 1);
+    if (this._options.keepAlive) {
+      socket.setKeepAlive(true, this._options.keepAlive * 1000);
+      setKeepAliveInterval(socket, this._options.keepAlive * 1000);
+      setKeepAliveProbes(socket, 1);
+    }
     socket.on("error", (e) => {
-      this._logger.error(e, "Socket error");
-      closeSocket(socket);
+      this._logger.error(e, "Socket has occurred an error");
+      closeSocket(socket, true);
     });
   }
 

src/gateway/ClientGateway.ts

@@ -10,7 +10,7 @@ export class ClientGateway extends BaseGateway {
   constructor(
     protected readonly _options: Pick<
       VNCRepeaterOptions,
-      "noRFB" | "bufferSize" | "refuse" | "socketTimeout"
+      "noRFB" | "bufferSize" | "refuse" | "socketTimeout" | "keepAlive"
     > & {
       port: number;
     },

src/gateway/ServerGateway.ts

@@ -13,7 +13,7 @@ export class ServerGateway extends BaseGateway {
   constructor(
     protected readonly _options: Pick<
       VNCRepeaterOptions,
-      "bufferSize" | "refuse" | "socketTimeout"
+      "bufferSize" | "refuse" | "socketTimeout" | "keepAlive"
     > & { port: number },
     logger: Logger,
   ) {

src/types.ts

@@ -12,6 +12,7 @@ export interface VNCRepeaterOptions {
   logger?: Logger;
   logLevel?: LogLevel;
   socketTimeout?: number;
+  keepAlive?: number;
   killTimeout?: number;
 }