ServeUnixOptions
Defined in: src/launcher/serve-unix.ts:31
Configuration for serveUnix.
Properties
Section titled “Properties”announcementSink?
Section titled “announcementSink?”optional announcementSink?: WritableStream;Defined in: src/launcher/serve-unix.ts:66
Override the stream used for the UNIX:<path> line. Defaults to
process.stdout.
backlog?
Section titled “backlog?”optional backlog?: number;Defined in: src/launcher/serve-unix.ts:59
Maximum sequential listen backlog. Mirrors Python’s serve_unix
(backlog=16). Default: 16.
dispatchHook?
Section titled “dispatchHook?”optional dispatchHook?: DispatchHook;Defined in: src/launcher/serve-unix.ts:52
Optional dispatch hook for observability.
enableDescribe?
Section titled “enableDescribe?”optional enableDescribe?: boolean;Defined in: src/launcher/serve-unix.ts:50
Host vgi_rpc.Reflection.v1. Default: true.
Named for the __describe__ method it used to switch on. What it gates
is introspection, which is now a co-hosted protocol rather than a
reserved method answered before dispatch.
externalLocation?
Section titled “externalLocation?”optional externalLocation?: ExternalLocationConfig;Defined in: src/launcher/serve-unix.ts:54
Optional external-storage config for large-batch externalisation.
idleTimeout?
Section titled “idleTimeout?”optional idleTimeout?: number;Defined in: src/launcher/serve-unix.ts:36
Self-terminate after this many seconds with zero connected clients.
Default: 300. 0 disables the timer (server runs until killed).
onBound?
Section titled “onBound?”optional onBound?: (sockPath) => void;Defined in: src/launcher/serve-unix.ts:63
Called after listen() returns successfully but before
UNIX:<path> is printed. The launcher uses this hook to write the
announcement only after we’re sure the bind took.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sockPath |
string |
Returns
Section titled “Returns”void
onServeStart?
Section titled “onServeStart?”optional onServeStart?: ServeStartHook;Defined in: src/launcher/serve-unix.ts:56
Lifecycle hook fired once before the first dispatched request.
protocolVersion?
Section titled “protocolVersion?”optional protocolVersion?: string;Defined in: src/launcher/serve-unix.ts:42
Optional logical-service / protocol-contract version label.
serverId?
Section titled “serverId?”optional serverId?: string;Defined in: src/launcher/serve-unix.ts:44
Custom server identifier.
startupGraceSeconds?
Section titled “startupGraceSeconds?”optional startupGraceSeconds?: number;Defined in: src/launcher/serve-unix.ts:40
Grace period after listen() succeeds before the idle timer starts
ticking. Default: 5 — gives the first launcher caller a chance to
connect after the UNIX:<path> announcement.
unixPath
Section titled “unixPath”unixPath: string;Defined in: src/launcher/serve-unix.ts:33
Absolute path to the Unix socket file the worker should bind.