IpcServer

Defined in: packages/node/src/net/ipc-server.ts:45

Server accepting connections on a Unix domain socket or a Windows named pipe.

Example usage:

const server = IpcServer.from();
server.subscribe("connection", (socket) => {
  socket.stream.on("data", (data) => {
    console.log("Received:", data.toString());
  });
});
await server.listen("/var/run/app.sock");
// ... later
await server.close();

On Unix the socket file is removed when the server closes, but not when the process exits abnormally: a stale file makes the next bind fail with EADDRINUSE.

Extends

StreamServer<net.Server, IpcServerEvents>

Constructors

Constructor

new IpcServer(server): IpcServer

Defined in: packages/node/src/net/stream-server.ts:43

Creates a new StreamServer instance.

Parameters

server

Server

The underlying Node.js server.

Returns

IpcServer

Inherited from

StreamServer.constructor

Accessors

listening

Get Signature

get listening(): boolean

Defined in: packages/node/src/net/stream-server.ts:49

Whether the server is currently listening for connections.

Returns

boolean

Inherited from

StreamServer.listening

maxConnections

Get Signature

get maxConnections(): number

Defined in: packages/node/src/net/stream-server.ts:54

Maximum number of concurrent connections accepted by the server.

Returns

number

Set Signature

set maxConnections(maxConnections): void

Defined in: packages/node/src/net/stream-server.ts:63

Updates the maximum number of concurrent connections.

Connections accepted beyond this limit are dropped.

Parameters

maxConnections

number

Returns

void

Inherited from

StreamServer.maxConnections

Methods

address()

address(): string | null

Defined in: packages/node/src/net/ipc-server.ts:79

Returns the path the server is bound to.

Returns

string | null

The bound path, or null when the server is not listening.

Throws

When the server is bound to an IP endpoint rather than a path. Use TcpServer for those.

close()

close(): Promise<void>

Defined in: packages/node/src/net/stream-server.ts:107

Stops the server from accepting new connections. Established connections are not closed; the promise resolves once the last of them ends.

Returns

Promise<void>

A promise that resolves when the server is fully closed.

Throws

When the server was not listening.

Inherited from

StreamServer.close

getConnections()

getConnections(): Promise<number>

Defined in: packages/node/src/net/stream-server.ts:72

Counts the connections currently handled by the server.

Returns

Promise<number>

A promise that resolves with the connection count.

Inherited from

StreamServer.getConnections

isSubscribed()

isSubscribed<K>(event, listener): boolean

Defined in: packages/async/src/events/event-dispatcher-map-base.ts:38

Check if a callback is subscribed to a specific event.

Type Parameters

K

K extends "connection" | keyof StreamServerEvents

Parameters

event

K

The event name.

listener

Callable<IpcServerEvents[K]>

The callback to check.

Returns

boolean

Inherited from

StreamServer.isSubscribed

listen()

listen(path, options?): Promise<void>

Defined in: packages/node/src/net/ipc-server.ts:65

Binds the server to the given path and resolves once it is listening.

Parameters

path

string

Filesystem path of the Unix domain socket, or the name of the Windows named pipe.

options?

Additional listen options.

backlog?

number

exclusive?

boolean

readableAll?

boolean

signal?

AbortSignal

writableAll?

boolean

Returns

Promise<void>

A promise that resolves once the server is listening.

Throws

When the path is already in use or cannot be bound.

ref()

ref(): void

Defined in: packages/node/src/net/stream-server.ts:88

Marks the server as referenced, preventing the Node.js process from exiting while it is listening.

Returns

void

Inherited from

StreamServer.ref

subscribe<K>(event, listener, options?): Callable | null

Defined in: packages/async/src/events/event-dispatcher-map-base.ts:23

Type Parameters

K

K extends "connection" | keyof StreamServerEvents

Parameters

event

K

listener

Callable<IpcServerEvents[K]>

options?

EventDispatcherSubscribeOptions

Returns

Callable | null

Inherited from

StreamServer.subscribe

unref()

unref(): void

Defined in: packages/node/src/net/stream-server.ts:96

Marks the server as unreferenced, allowing the Node.js process to exit even while it is listening.

Returns

void

Inherited from

StreamServer.unref

unsubscribe()

unsubscribe<K>(event, listener): void

Defined in: packages/async/src/events/event-dispatcher-map-base.ts:31

Unsubscribe a callback from a specific event.

Type Parameters

K

K extends "connection" | keyof StreamServerEvents

Parameters

event

K

The event name.

listener

Callable<IpcServerEvents[K]>

The callback to remove.

Returns

void

Inherited from

StreamServer.unsubscribe

wait()

wait<K>(event, options?): Promise<IpcServerEvents[K]>

Defined in: packages/async/src/events/event-dispatcher-map-base.ts:45

Wait for the next occurrence of a specific event, optionally matching a predicate.

This is a convenience method that subscribes to the dispatcher, waits for the next event that matches the predicate (if provided), and then unsubscribes automatically.

Type Parameters

K

K extends "connection" | keyof StreamServerEvents

Parameters

event

K

The event name to wait for.

options?

EventDispatcherWaitOptions<IpcServerEvents[K]>

Optional settings including predicate and abort signal.

Returns

Promise<IpcServerEvents[K]>

A promise that resolves with the event arguments as an array.

Inherited from

StreamServer.wait

from()

static from(options?): IpcServer

Defined in: packages/node/src/net/ipc-server.ts:52

Creates a new IpcServer instance.

Parameters

options?

ServerOpts

Options for creating the underlying Node.js server.

Returns

IpcServer

A new IpcServer instance.