Class SockDaemonServer<Request, Response>Abstract

Extend this class to create a SockDaemonService that is used by your daemonScript program to service requests.

Type Parameters

Hierarchy

  • SockDaemonServer

Constructors

constructor

Properties

#connectionTimeout #daemonScript? #didOnExit #idleTimeout #idleTimer? #logFile #mtimeFile #name #path #pidFile #server? #socket #startingLock

Accessors

connectionTimeout idleTimeout logFile mtimeFile path pidFile server socket serviceName

Methods

#idleTick #listen #onListen #onServerError #tryConnect #usurp close handle isMessage isRequest listen

Constructors

constructor

Properties

Private #connectionTimeout

#connectionTimeout: number = 1_000

Private Optional #daemonScript

#daemonScript?: string

Private #didOnExit

#didOnExit: boolean = false

Private #idleTimeout

#idleTimeout: number = ...

Private Optional #idleTimer

#idleTimer?: Timeout

Private #logFile

#logFile: string

Private #mtimeFile

#mtimeFile: string

Private #name

#name: string

Private #path

#path: string

Private #pidFile

#pidFile: string

Private Optional #server

#server?: Server

Private #socket

#socket: string

Private #startingLock

#startingLock: StartingLock

Accessors

connectionTimeout

  • get connectionTimeout(): number

  • Time in milliseconds before a connection will be disconnected if it does not make any requests. Defaults to 1000 (1 second)

    Returns number

idleTimeout

  • get idleTimeout(): number

  • Time in milliseconds before the daemon will close if no requests are received. Defaults to 3_600_000 (1 hour)

    Returns number

logFile

  • get logFile(): string

  • Path where daemon logs are written

    Returns string

mtimeFile

  • get mtimeFile(): string

  • File containing the numeric mtime of the daemon script, so that it can be restarted on change.

    Returns string

path

  • get path(): string

  • The folder where this daemon service stores stuff

    Returns string

pidFile

  • get pidFile(): string

  • File containing the daemon process ID

    Returns string

server

  • get server(): undefined | Server

  • When listening, the net.Server object

    Returns undefined | Server

socket

  • get socket(): string

  • Path to the socket used by this service

    Returns string

Static serviceName

  • get serviceName(): string

  • The name of the service. Must match the value set in the SockDaemonClient class that connects to this service.

    Returns string

Methods

Private #idleTick

  • #idleTick(n?): void

  • Parameters

    • n: number = ...

    Returns void

Private #listen

  • #listen(): Promise<void>

  • Returns Promise<void>

Private #onListen

  • #onListen(server): Promise<void>

  • Parameters

    • server: Server

    Returns Promise<void>

Private #onServerError

  • #onServerError(er): Promise<void>

  • Parameters

    • er: Error

    Returns Promise<void>

Private #tryConnect

  • #tryConnect(n): Promise<void>

  • Parameters

    • n: number

    Returns Promise<void>

Private #usurp

  • #usurp(): Promise<void>

  • Returns Promise<void>

close

  • Stop listening for requests and close the socket.

    Returns void

Abstract handle

  • Method that receives Request objects and returns a Response object to be sent over the socket to the client.

    Parameters

    • msg: Request

    Returns Omit<Response, "id"> & {
        id?: string;
    } | Promise<Omit<Response, "id"> & {
        id?: string;
    }>

isMessage

isRequest

  • Parameters

    • msg: any

    Returns msg is Request

listen

  • Check if a daemon server is already running for this cwd/name, and if so, gracefully exit. Otherwise, start up the server and write process id to the pidFile

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc