TcpServer

Defined in: packages/node/src/net/tcp-server.ts:53

TCP server accepting incoming connections.

Example usage:

const server = TcpServer.from();
server.subscribe("connection", (socket) => {
  socket.stream.on("data", (data) => {
    console.log("Received:", data.toString());
  });
});
await server.listen(8080, { host: "0.0.0.0" });
// ... later
await server.close();

Extends

• StreamServer<TServer, TEvents>

Extended by

• TlsServer

Type Parameters

TServer

TServer extends net.Server = net.Server

TEvents

TEvents extends TcpServerEvents = TcpServerEvents

Constructors

Constructor

new TcpServer<TServer, TEvents>(server): TcpServer<TServer, TEvents>

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

Creates a new StreamServer instance.

Parameters

server

TServer

The underlying Node.js server.

Returns

TcpServer<TServer, TEvents>

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(): InetEndpoint | null

Defined in: packages/node/src/net/tcp-server.ts:89

Returns the endpoint the server is bound to.

Returns

InetEndpoint | null

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

Throws

When the server is bound to a path rather than an IP endpoint. Use IpcServer 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 string | number | symbol

Parameters

event

K

The event name.

listener

Callable<TEvents[K]>

The callback to check.

Returns

boolean

Inherited from

StreamServer.isSubscribed

---

listen()

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

Defined in: packages/node/src/net/tcp-server.ts:75

Binds the server and resolves once it is listening.

Parameters

port

number

The port to listen on. Use 0 to let the system assign one.

options?

Additional listen options.

backlog?

number

exclusive?

boolean

host?

string

ipv6Only?

boolean

Default

false

readableAll?

boolean

reusePort?

boolean

signal?

AbortSignal

writableAll?

boolean

Returns

Promise<void>

A promise that resolves once the server is listening.

Throws

When the address 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()

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

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

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

Callable<TEvents[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 string | number | symbol

Parameters

event

K

The event name.

listener

Callable<TEvents[K]>

The callback to remove.

Returns

void

Inherited from

StreamServer.unsubscribe

---

wait()

wait<K>(event, options?): Promise<TEvents[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 string | number | symbol

Parameters

event

K

The event name to wait for.

options?

EventDispatcherWaitOptions<TEvents[K]>

Optional settings including predicate and abort signal.

Returns

Promise<TEvents[K]>

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

Inherited from

StreamServer.wait

---

from()

static from(options?): TcpServer

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

Creates a new TcpServer instance.

Parameters

options?

ServerOpts

Options for creating the underlying Node.js server.

Returns

TcpServer

A new TcpServer instance.