Class TcpServer

TCP server to accept incoming connections.

Example usage:

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

Hierarchy

EventDispatcherMapBase<TcpServerEvents>
- TcpServer

Implements

IEventDispatcherMap<TcpServerEvents>

Index

Constructors

constructor

new TcpServer(srv: Server): TcpServer
Parameters
- srv: Server
Returns TcpServer
Overrides EventDispatcherMapBase<TcpServerEvents>.constructor
- Defined in packages/misc-util/src/node/net/tcp-server.ts:78

Accessors

listening

get listening(): boolean
Gets whether the server is currently listening for connections.

Returns boolean
- Defined in packages/misc-util/src/node/net/tcp-server.ts:103

maxConnections

get maxConnections(): number
Gets the maximum number of queued pending connections.

Returns number
- Defined in packages/misc-util/src/node/net/tcp-server.ts:119
set maxConnections(maxConnections: number): void
Sets the maximum number of queued pending connections.
Parameters
- maxConnections: number
  The maximum number of connections to queue.
Returns void
- Defined in packages/misc-util/src/node/net/tcp-server.ts:112

Methods

address

address(): InetEndpoint | null
Gets the address information of the server.

Returns InetEndpoint | null
The server's endpoint information or null if the server is not listening.
- Defined in packages/misc-util/src/node/net/tcp-server.ts:194

close

close(): Promise<void>
Closes the TCP server, stopping it from accepting new connections. Existing connections are not automatically closed.

Returns Promise<void>
A promise that resolves when the server is fully closed.
- Defined in packages/misc-util/src/node/net/tcp-server.ts:177

`Protected`dispatch

dispatch<K extends keyof TcpServerEvents>(
event: K,
...args: TcpServerEvents[K],
): void
Dispatches an event to all listeners for the given event name.
Type Parameters
- K extends keyof TcpServerEvents
Parameters
- event: K
  The event name.
- ...args: TcpServerEvents[K]
  Arguments to pass to listeners.
Returns void
Inherited from EventDispatcherMapBase.dispatch
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:58

getConnections

getConnections(): Promise<number>
Gets the current number of concurrent connections on the server.

Returns Promise<number>
A promise that resolves with the connection count.
- Defined in packages/misc-util/src/node/net/tcp-server.ts:88

isSubscribed

isSubscribed<K extends keyof TcpServerEvents>(
event: K,
listener: Callable<TcpServerEvents[K]>,
): boolean
Check if a callback is subscribed to a specific event.
Type Parameters
- K extends keyof TcpServerEvents
Parameters
- event: K
  The event name.
- listener: Callable<TcpServerEvents[K]>
  The callback to check.
Returns boolean
Implementation of IEventDispatcherMap.isSubscribed
Inherited from EventDispatcherMapBase.isSubscribed
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:38

listen

listen(
    port: number,
    host?: string,
    options?: {
        backlog?: number;
        exclusive?: boolean;
        ipv6Only?: boolean;
        path?: string;
        readableAll?: boolean;
        reusePort?: boolean;
        signal?: AbortSignal;
        writableAll?: boolean;
    },
): Promise<void>
Starts the TCP server listening on the specified port and host.
Parameters
- port: number
  The port to listen on. If 0, a random available port will be assigned.
- Optionalhost: string
  The host/interface to bind to. Defaults to '::' (IPv6) or '0.0.0.0' (IPv4).
- Optionaloptions: {
      backlog?: number;
      exclusive?: boolean;
      ipv6Only?: boolean;
      path?: string;
      readableAll?: boolean;
      reusePort?: boolean;
      signal?: AbortSignal;
      writableAll?: boolean;
  }
  Additional listen options.
  - Optionalbacklog?: number
  - Optionalexclusive?: boolean
  - Optionalipv6Only?: boolean
    Default
    false
  - Optionalpath?: string
  - OptionalreadableAll?: boolean
  - OptionalreusePort?: boolean
  - Optionalsignal?: AbortSignal
    When provided the corresponding AbortController can be used to cancel an asynchronous action.
  - OptionalwritableAll?: boolean
Returns Promise<void>
A promise that resolves when the server is successfully listening.
- Defined in packages/misc-util/src/node/net/tcp-server.ts:145

ref

ref(): void
References the server, preventing the process from exiting while the server is active.

Returns void
- Defined in packages/misc-util/src/node/net/tcp-server.ts:126

subscribe<K extends keyof TcpServerEvents>(
    event: K,
    listener: Callable<TcpServerEvents[K]>,
    options?: EventDispatcherSubscribeOptions,
): Callable | null
Type Parameters
- K extends keyof TcpServerEvents
Parameters
- event: K
- listener: Callable<TcpServerEvents[K]>
- Optionaloptions: EventDispatcherSubscribeOptions
Returns Callable | null
Implementation of IEventDispatcherMap.subscribe
Inherited from EventDispatcherMapBase.subscribe
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:23

unref

unref(): void
Unreferences the server, allowing the process from exiting even if the server is active.

Returns void
- Defined in packages/misc-util/src/node/net/tcp-server.ts:133

unsubscribe

unsubscribe<K extends keyof TcpServerEvents>(
event: K,
listener: Callable<TcpServerEvents[K]>,
): void
Unsubscribe a callback from a specific event.
Type Parameters
- K extends keyof TcpServerEvents
Parameters
- event: K
  The event name.
- listener: Callable<TcpServerEvents[K]>
  The callback to remove.
Returns void
Implementation of IEventDispatcherMap.unsubscribe
Inherited from EventDispatcherMapBase.unsubscribe
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:31

wait

wait<K extends keyof TcpServerEvents>(
event: K,
options?: EventDispatcherWaitOptions<TcpServerEvents[K]>,
): Promise<TcpServerEvents[K]>
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 extends keyof TcpServerEvents
Parameters
- event: K
  The event name to wait for.
- Optionaloptions: EventDispatcherWaitOptions<TcpServerEvents[K]>
  Optional settings including predicate and abort signal.
Returns Promise<TcpServerEvents[K]>
A promise that resolves with the event arguments as an array.
Implementation of IEventDispatcherMap.wait
Inherited from EventDispatcherMapBase.wait
- Defined in packages/misc-util/src/async/events/_event-dispatcher-map-base.ts:45

`Static`from

from(options?: ServerOpts): TcpServer
Creates a new TcpServer instance with the specified options.
Parameters
- Optionaloptions: ServerOpts
  Options for creating the TCP server.
Returns TcpServer
A new TcpServer instance.
- Defined in packages/misc-util/src/node/net/tcp-server.ts:72

Class TcpServer

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TcpServer

Accessors

listening

Returns boolean

maxConnections

Returns number

Parameters

Returns void

Methods

address

Returns InetEndpoint | null

close

Returns Promise<void>

Protecteddispatch

Type Parameters

Parameters

Returns void

getConnections

Returns Promise<number>

isSubscribed

Type Parameters

Parameters

Returns boolean

listen

Parameters

Optionalbacklog?: number

Optionalexclusive?: boolean

Optionalipv6Only?: boolean

Default

Optionalpath?: string

OptionalreadableAll?: boolean

OptionalreusePort?: boolean

Optionalsignal?: AbortSignal

OptionalwritableAll?: boolean

Returns Promise<void>

ref

Returns void

subscribe

Type Parameters

Parameters

Returns Callable | null

unref

Returns void

unsubscribe

Type Parameters

Parameters

Returns void

wait

Type Parameters

Parameters

Returns Promise<TcpServerEvents[K]>

Staticfrom

Parameters

Returns TcpServer

Settings

On This Page

`Protected`dispatch

`Optional`backlog?: number

`Optional`exclusive?: boolean

`Optional`ipv6Only?: boolean

`Optional`path?: string

`Optional`readableAll?: boolean

`Optional`reusePort?: boolean

`Optional`signal?: AbortSignal

`Optional`writableAll?: boolean

`Static`from