Class TCPServer

Hierarchy

Server
- TCPServer

Index

Constructors

Accessors

bindIP bindPort sockets

Methods

start stop create

Constructors

constructor

new TCPServer(
options?: ServerOpts,
connectionListener?: (socket: Socket) => void,
): TCPServer
Constructs a new instance of the server
Parameters
- options: ServerOpts = {}
- OptionalconnectionListener: (socket: Socket) => void
Returns TCPServer
Overrides Server.constructor

Accessors

bindIP

get bindIP(): string
Returns the interface address that the server is bound to

Returns string

bindPort

get bindPort(): number
Returns the interface port that the server is bound to

Returns number

sockets

get sockets(): Socket[]
Returns an iterator of currently connected sockets

Returns Socket[]

Methods

start

start(port?: number, hostname?: string, backlog?: number): Promise<void>
Starts the TCP server
Parameters
- Optionalport: number
- Optionalhostname: string
- backlog: number = 511
Returns Promise<void>

stop

stop(): Promise<void>
Destroys all connected sockets and stops the TCP server

Returns Promise<void>

`Static`create

create(
options?: ServerOpts,
connectionListener?: (socket: Socket) => void,
): TCPServer
Creates a new TCP server with the provided options
Parameters
- options: ServerOpts = {}
- OptionalconnectionListener: (socket: Socket) => void
Returns TCPServer