TlsServer

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

TLS server accepting encrypted incoming connections.

Example usage:

const server = TlsServer.from({ key, cert });
server.subscribe("secureConnection", (socket) => {
  console.log("Client cipher:", socket.getCipher().name);
});
await server.listen(8443, "0.0.0.0");
// ... later
await server.close();

Every event of TcpServer is still emitted, so TcpServerEvents.connection reports the plaintext socket accepted before the handshake. Wait for TlsServerEvents.secureConnection to read or write application data.

The session-resumption events Node.js exposes with a completion callback (newSession, resumeSession and OCSPRequest) are deliberately not forwarded: Node.js falls back to its default behaviour only while no listener is attached, so forwarding them would stall every handshake that nobody subscribed to.

Extends

TcpServer<tls.Server, TlsServerEvents>

Constructors

Constructor

new TlsServer(server): TlsServer

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

Creates a new StreamServer instance.

Parameters

server

Server

The underlying Node.js server.

Returns

TlsServer

Inherited from

TcpServer.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

TcpServer.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

TcpServer.maxConnections

Methods

addContext()

addContext(hostname, context): void

Defined in: packages/node/src/net/tls-server.ts:71

Adds a secure context to serve when a client requests hostname through SNI.

Parameters

hostname

string

The server name to match, which may contain wildcards.

context

TlsSecureContext

The secure context or the options to build one from.

Returns

void

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.

Inherited from

TcpServer.address

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

TcpServer.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

TcpServer.getConnections

getTicketKeys()

getTicketKeys(): Buffer

Defined in: packages/node/src/net/tls-server.ts:93

Returns the keys used to encrypt session tickets.

Sharing them across server instances lets clients resume a session on any of them; they are sensitive key material and must be handled as secrets.

Returns

Buffer

The 48-byte session ticket keys.

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

Parameters

event

K

The event name.

listener

Callable<TlsServerEvents[K]>

The callback to check.

Returns

boolean

Inherited from

TcpServer.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.

Inherited from

TcpServer.listen

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

TcpServer.ref

setSecureContext()

setSecureContext(context): void

Defined in: packages/node/src/net/tls-server.ts:81

Replaces the default secure context, affecting connections established after the call.

Parameters

context

SecureContextOptions

The options to build the secure context from.

Returns

void

setTicketKeys()

setTicketKeys(keys): void

Defined in: packages/node/src/net/tls-server.ts:103

Sets the keys used to encrypt session tickets, affecting connections established after the call.

Parameters

keys

Buffer

The 48-byte session ticket keys.

Returns

void

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

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

Type Parameters

K

Parameters

event

K

listener

Callable<TlsServerEvents[K]>

options?

EventDispatcherSubscribeOptions

Returns

Callable | null

Inherited from

TcpServer.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

TcpServer.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

Parameters

event

K

The event name.

listener

Callable<TlsServerEvents[K]>

The callback to remove.

Returns

void

Inherited from

TcpServer.unsubscribe

wait()

wait<K>(event, options?): Promise<TlsServerEvents[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

Parameters

event

K

The event name to wait for.

options?

EventDispatcherWaitOptions<TlsServerEvents[K]>

Optional settings including predicate and abort signal.

Returns

Promise<TlsServerEvents[K]>

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

Inherited from

TcpServer.wait

from()

static from(options?): TlsServer

Defined in: packages/node/src/net/tls-server.ts:60

Creates a new TlsServer instance.

Parameters

options?

TlsOptions

Options for creating the underlying Node.js server, including the certificate chain and private key to serve.

Returns

TlsServer

A new TlsServer instance.

Overrides

TcpServer.from