Skip to main content

TCP Socket

The TCP Socket APIs (api.tcpsocket) provide the ability to create and manage TCP sockets.

create

Creates new TCP socket.

Method

create(options?: SocketsTcpCreationProperties): Promise,TcpSocket>

Parameters

Name

Type

Description

options

SocketsTcpCreationProperties

(Optional) TCP socket parameters

Returns

TcpSocket object

TcpSocket Interface

The TcpSocket interface:

Name

Parameter:Type

Return

setNoDelay

value: number

Promise<void>

send

data: Buffer | string

Promise<void>

resume

None

Promise<void>

pause

None

Promise<void>

close

None

Promise<void>

connect

port: number, host: string

Promise<void>

on

event: string, listener: (...args: any[])

Promise<void>

TcpSocket Events

The TcpSocket events:

Name

Argument:Type

error

error: Error

close

None

connect

None

data

data: Buffer