Interface ITcp

Hierarchy

ITcp

Implemented by

TCPAdapter

Methods

addListener

addListener<K>(event: K, listener: TCPEvents[K]): void

Type parameters
- K: keyof TCPEvents
Parameters
- event: K
- listener: TCPEvents[K]
Returns void

addressOfServer

addressOfServer(): Promise<AddressInfo>

如果监听 IP 套接字，则返回操作系统报告的服务器的绑定 address、地址 family 名称和 port（用于在获取操作系统分配的地址时查找分配的端口）：{ port: 12346, family: 'IPv4', address: '127.0.0.1' }。

Returns Promise<AddressInfo>
返回绑定的地址信息

addressOfSocket

addressOfSocket(): Promise<AddressInfo>

返回操作系统报告的绑定 address、地址 family 名称和套接字的 port：{ port: 12346, family: 'IPv4', address: '127.0.0.1' }

Returns Promise<AddressInfo>
地址信息

close

close(): Promise<undefined | Error>

停止服务器接受新连接并保持现有连接。

Returns Promise<undefined | Error>
异步返回结果，如果close有错误返回错误

connect

connect(options?: SocketConnectOpts): Promise<void>

在给定的套接字上发起连接。建立连接后，将触发 'connect' 事件。如果连接出现问题，则将触发 'error' 事件并将错误传给 'error' 监听器，而不是触发 'connect' 事件。

Parameters
- Optional options: SocketConnectOpts
  
  连接函数的参数
Returns Promise<void>

createServer

createServer(options?: ServerOpts): Promise<string>

创建新的TCP服务

Parameters
- Optional options: ServerOpts
  
  server socket构建函数参数
Returns Promise<string>
新创建的server socket ID，以代表 server socket 引用

createSocket

createSocket(options?: SocketConstructorOpts): Promise<string>

创建新的套接字对象。TCP 客户端

Parameters
- Optional options: SocketConstructorOpts
  
  创建socket的构造函数参数
Returns Promise<string>
新创建的socket ID，以代表 Socket 引用

destroySocket

destroySocket(): Promise<undefined | Error>

确保此套接字上不再发生 I/O 活动。销毁流并关闭连接。

Returns Promise<undefined | Error>
返回错误或undefined

emit

emit<K>(event: K, ...args: Parameters<TCPEvents[K]>): void

Type parameters
- K: keyof TCPEvents
Parameters
- event: K
- Rest ...args: Parameters<TCPEvents[K]>
Returns void

end

end(strOrBuffer?: string | Uint8Array, encoding?: BufferEncoding): Promise<void>

半关闭套接字，即，它发送一个 FIN 数据包。因TCP是全双工的，关闭了客户端发往服务端的通道，但服务端仍可以发消息给客户端

Parameters
- Optional strOrBuffer: string | Uint8Array
  
  数据
- Optional encoding: BufferEncoding
  
  数据的编码
Returns Promise<void>

getBytesRead

getBytesRead(): Promise<number>

获取接收的流字节数

Returns Promise<number>
字节数

getBytesWritten

getBytesWritten(): Promise<number>

获取发送的流字节数

Returns Promise<number>
字节数

getConnections

getConnections(): Promise<{ count: number; error: null | Error }>

异步获取服务器上的并发连接数。

Returns Promise<{ count: number; error: null | Error }>
返回连接数或错误 { error: Error | null; count: number }

getMaxConnections

getMaxConnections(): Promise<number>

设置此属性以在服务器的连接计数变高时拒绝连接。

Returns Promise<number>
最大连接数

isConnecting

isConnecting(): Promise<boolean>

正在连接中？如果 true，则 connect() 已被调用且尚未完成。它将保持 true 直到套接字连接，然后将其设置为 false 并触发 'connect' 事件。

Returns Promise<boolean>
是否正在连接

isDestroyed

isDestroyed(): Promise<boolean>

指示连接是否被销毁。一旦连接被销毁，就不能再使用它传输数据。

Returns Promise<boolean>
是否已经销毁？true，已经销毁；false，未销毁

isListening

isListening(): Promise<boolean>

服务器是否正在监听连接

Returns Promise<boolean>

listen

listen(options?: ListenOptions): Promise<void>

启动监听连接的服务器。

Parameters
- Optional options: ListenOptions
  
  监听函数的参数
Returns Promise<void>

on

on<K>(event: K, listener: TCPEvents[K]): void

Type parameters
- K: keyof TCPEvents
Parameters
- event: K
- listener: TCPEvents[K]
Returns void

once

once<K>(event: K, listener: TCPEvents[K]): void

Type parameters
- K: keyof TCPEvents
Parameters
- event: K
- listener: TCPEvents[K]
Returns void

pause

pause(): Promise<void>

暂停读取数据。也就是说，不会触发 'data' 事件。用于限制上传。

Returns Promise<void>

resume

resume(): Promise<void>

调用 pause() 后的继续（恢复）读取。

Returns Promise<void>

setEncoding

setEncoding(encoding?: BufferEncoding): Promise<void>

设置流数据编码

Parameters
- Optional encoding: BufferEncoding
Returns Promise<void>

setKeepAlive

setKeepAlive(enable?: boolean, initialDelay?: number): Promise<void>

启用/禁用keepAlive功能，并可选择设置在空闲套接字上发送第一个keepAlive探测之前的初始延迟。

Parameters
- Optional enable: boolean
  
  默认false
- Optional initialDelay: number
  
  设置initialDelay（以毫秒为单位）设置接收到的最后一个数据包和第一个keepalive探测之间的延迟。默认0
Returns Promise<void>

setMaxConnections

setMaxConnections(maxConnections: number): Promise<void>

设置最大连接数

Parameters
- maxConnections: number
  
  最大连接数
Returns Promise<void>

setNoDelay

setNoDelay(noDelay?: boolean): Promise<void>

启用/禁用 Nagle 算法的使用。创建 TCP 连接时，它将启用 Nagle 算法。 Nagle 的算法在数据通过网络发送之前延迟数据。它试图以延迟为代价来优化吞吐量。

Parameters
- Optional noDelay: boolean
  
  默认true
Returns Promise<void>

setTimeout

setTimeout(timeout: number): Promise<void>

将套接字设置为在套接字上 timeout 毫秒不活动后超时。

Parameters
- timeout: number
  
  毫秒为单位。默认无timeout
Returns Promise<void>

write

write(strOrBuffer: string | Uint8Array, encoding?: BufferEncoding): Promise<{ error: undefined | Error; flushed: boolean }>

在套接字上发送数据。第二个参数指定字符串情况下的编码。它默认为 UTF8 编码。如果整个数据被成功刷新到内核缓冲区，则返回 flushed: true。如果所有或部分数据在用户内存中排队，则返回 flushed: false。当缓冲区再次空闲时，将触发 'drain'。

Parameters
- strOrBuffer: string | Uint8Array
  
  写入数据
- Optional encoding: BufferEncoding
  
  数据编码
Returns Promise<{ error: undefined | Error; flushed: boolean }>
error：错误信息，flushed：是否整个数据已成功刷新到内核缓冲区

Generated using TypeDoc