Class SockDaemonClient<Request, Response>Abstract

Override this class to create a Client that can talk to the SockDaemonServer you've created.

Note that the static serviceName and daemonScript getters MUST be defined on the extended class, referencing the service name and location of the daemon script.

Type Parameters

Hierarchy

  • SockDaemonClient

Constructors

constructor

Properties

#clientID #connected #connection? #daemonScript #debug #didPing #execArgv #logFile #msgID #mtimeCheckP? #mtimeFile #path #pidFile #ping? #pingTimer? #reader? #requests #serviceName #socket

Accessors

connected connection execArgv logFile mtimeFile path pidFile requests socket daemonScript serviceName

Methods

#checkMtime #connect #onData clear disconnect isMessage isResponse kill ping request

Constructors

constructor

Properties

Private #clientID

#clientID: string = ...

Private #connected

#connected: boolean = false

Private Optional #connection

#connection?: Socket

Private #daemonScript

#daemonScript: string

Private #debug

#debug: boolean

Private #didPing

#didPing: boolean = false

Private #execArgv

#execArgv: string[]

Private #logFile

#logFile: string

Private #msgID

#msgID: number = 0

Private Optional #mtimeCheckP

#mtimeCheckP?: Promise<boolean>

Private #mtimeFile

#mtimeFile: string

Private #path

#path: string

Private #pidFile

#pidFile: string

Private Optional #ping

#ping?: Ping

Private Optional #pingTimer

#pingTimer?: Timeout

Private Optional #reader

#reader?: Reader

Private #requests

#requests: Map<string, ClientRequest<Request, Response>> = ...

Private #serviceName

#serviceName: string

Private #socket

#socket: string

Accessors

connected

  • get connected(): boolean

  • True if currently connected to the daemon service

    Returns boolean

connection

  • get connection(): undefined | Socket

  • True if the client is currently connected

    Returns undefined | Socket

execArgv

  • get execArgv(): string[]

  • The execArgv that is used when spawning the daemon script.

    Returns string[]

logFile

  • get logFile(): string

  • Path where daemon logs are written

    Returns string

mtimeFile

  • get mtimeFile(): string

  • Path where the daemonScript mtime is written

    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

requests

socket

  • get socket(): string

  • Path to the socket used by this service

    Returns string

Static daemonScript

  • get daemonScript(): string | URL

  • The location of the daemon script that starts up the SockDaemonServer service that this client talks to.

    Returns string | URL

Static serviceName

  • get serviceName(): string

  • The name of the service. Must match the value set in the SockDaemonServer class this talks to.

    Returns string

Methods

Private #checkMtime

  • #checkMtime(): Promise<boolean>

  • Returns Promise<boolean>

Private #connect

  • #connect(): Promise<void>

  • Returns Promise<void>

Private #onData

  • #onData(chunk): void

  • Parameters

    • chunk: Buffer

    Returns void

clear

  • Drop all pending requests

    Returns void

disconnect

  • Immediately disconnect from the server. Pending requests will be replayed on the next connection, unless clear() is called.

    Returns void

isMessage

isResponse

  • Set to check that a response is valid

    Parameters

    • msg: any

    Returns msg is Response

kill

  • Kill the server, if it is running.

    Attempts to send a SIGHUP to allow for graceful shutdown, but this is not possible on Windows.

    Returns Promise<void>

ping

  • Send a PING message to the server. This can be useful when you want to start the daemon, without making any specific request.

    Returns Promise<Omit<Ping, "PING"> & {
        PING: "PONG";
        pid: number;
    } & {
        duration: number;
    }>

request

  • Send a request. The id property is made optional, because it will be overridden anyway by a generated message ID. Starts the daemon script automatically if not already running, and connects if needed.

    If an AbortSignal is provided, then the request will be dropped on an abort signal, and the promise rejected with the abort reason, if it has not already been resolved.

    Parameters

    • msg: Omit<Ping, "id">
    • Optional signal: AbortSignal

    Returns Promise<Omit<Ping, "PING"> & {
        PING: "PONG";
        pid: number;
    } & {
        duration: number;
    }>

  • Parameters

    • msg: Omit<Request, "id">
    • Optional signal: AbortSignal

    Returns Promise<Response>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc