Options for ipcServer — Unix-domain RPC (same-machine).
export interface IpcServerOptions {
/** Filesystem path for the Unix-domain listen socket (required). */
readonly IpcServerOptions.path: stringFilesystem path for the Unix-domain listen socket (required).
path: string;
readonly IpcServerOptions.serialization?: Layer.Layer<RpcSerialization.RpcSerialization, never, never> | undefinedserialization?: import LayerLayer.interface Layer<in ROut, out E = never, out RIn = never>A Layer describes how to build one or more services for dependency injection.
When to use
Use to model construction of application services for dependency injection,
especially when services have dependencies, can fail during construction, or
need scoped setup and release.
Details
A Layer<ROut, E, RIn> represents ROut as the services this layer
provides, E as the possible errors during layer construction, and RIn as
the services this layer requires as dependencies.
Layer<import RpcSerializationRpcSerialization.class RpcSerializationclass RpcSerialization {
key: Identifier;
Service: {
makeUnsafe: () => RpcSerialization.Parser;
contentType: string;
includesFraming: boolean;
};
}
Service that describes how RPC protocol messages are encoded and decoded,
including the content type and whether the serialization format provides
message framing.
When to use
Use to provide the serialization boundary shared by RPC clients and servers
for a chosen wire format.
RpcSerialization>;
/**
* Node log key for auto-mounted {@link NodeStatus} durable `logs.query`.
* When omitted, inferred from served tags' bound {@link Node} when all share one key.
*/
readonly IpcServerOptions.node?: string | {
readonly key: string;
} | undefined
Node log key for auto-mounted
NodeStatus
durable logs.query.
When omitted, inferred from served tags' bound
Node
when all share one key.
node?: string | { readonly key: stringkey: string };
/**
* Best-effort `unlink` of `path` before bind and when the server scope closes
* (default `false` — same as {@link Lookup.layerOptions} / named-pipe listen).
* Opt in with `unlink: true` to clear a stale `.sock` from a previous crash; leaving the
* default avoids unlink-steal of a live peer's socket.
*/
readonly IpcServerOptions.unlink?: boolean | undefinedBest-effort unlink of path before bind and when the server scope closes
(default false — same as
Lookup.layerOptions
/ named-pipe listen).
Opt in with unlink: true to clear a stale .sock from a previous crash; leaving the
default avoids unlink-steal of a live peer's socket.
unlink?: boolean;
/**
* Soft Lookup directory advertise after serve registration (`Node.unix` / protocol listen).
*
* @internal
*/
readonly IpcServerOptions.advertiseNode?: anySoft Lookup directory advertise after serve registration (Node.unix / protocol listen).
advertiseNode?: import AnyNodeAnyNode & { readonly key: stringkey: string };
/**
* Call-site advertise conflict policy (forwarded to {@link Lookup.directoryAdvertiseLayer}).
*
* @internal
*/
readonly IpcServerOptions.onConflict?: anyCall-site advertise conflict policy (forwarded to
Lookup.directoryAdvertiseLayer
).
onConflict?: import OnConflictOnConflict;
}