Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • EventEmitter
    • TCPAdapter

Implements

Index

Constructors

constructor

  • Returns TCPAdapter

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

_bindEvents

  • _bindEvents(): void
  • Returns void

addListener

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

addressOfServer

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

    Returns Promise<AddressInfo>

addressOfSocket

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

    Returns Promise<AddressInfo>

close

  • close(): Promise<undefined | Error>
  • 停止服务器接受新连接并保持现有连接。

    Returns Promise<undefined | Error>

connect

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

    Parameters

    Returns Promise<void>

createServer

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

createSocket

destroySocket

  • destroySocket(): Promise<undefined | Error>
  • 确保此套接字上不再发生 I/O 活动。 销毁流并关闭连接。

    Returns Promise<undefined | Error>

emit

  • emit<K>(event: K, ...args: Parameters<TCPEvents[K]>): boolean
  • Type parameters

    Parameters

    • event: K
    • Rest ...args: Parameters<TCPEvents[K]>

    Returns boolean

end

  • end(strOrBuffer?: string | Uint8Array, encoding?: BufferEncoding): Promise<void>
  • 半关闭套接字,即,它发送一个 FIN 数据包。因TCP是全双工的,关闭了客户端发往服务端的通道,但服务端仍可以发消息给客户端

    Parameters

    • Optional strOrBuffer: string | Uint8Array
    • Optional encoding: BufferEncoding

    Returns Promise<void>

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

getBytesRead

  • getBytesRead(): Promise<number>
  • 获取接收的流字节数

    Returns Promise<number>

getBytesWritten

  • getBytesWritten(): Promise<number>

getConnections

  • getConnections(): Promise<{ count: number; error: null | Error }>
  • 异步获取服务器上的并发连接数。

    Returns Promise<{ count: number; error: null | Error }>

getMaxConnections

  • getMaxConnections(): Promise<number>
  • 设置此属性以在服务器的连接计数变高时拒绝连接。

    Returns Promise<number>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

isConnecting

  • isConnecting(): Promise<boolean>
  • 正在连接中?如果 true,则 connect() 已被调用且尚未完成。它将保持 true 直到套接字连接,然后将其设置为 false 并触发 'connect' 事件。

    Returns Promise<boolean>

isDestroyed

  • isDestroyed(): Promise<boolean>
  • 指示连接是否被销毁。一旦连接被销毁,就不能再使用它传输数据。

    Returns Promise<boolean>

isListening

  • isListening(): Promise<boolean>
  • 服务器是否正在监听连接

    Returns Promise<boolean>

listen

  • 启动监听连接的服务器。

    Parameters

    Returns Promise<void>

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): TCPAdapter
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TCPAdapter

on

  • on<K>(event: K, listener: TCPEvents[K]): this
  • Type parameters

    Parameters

    Returns this

once

  • once<K>(event: K, listener: TCPEvents[K]): this
  • Type parameters

    Parameters

    Returns this

pause

  • pause(): Promise<void>
  • 暂停读取数据。 也就是说,不会触发 'data' 事件。 用于限制上传。

    Returns Promise<void>

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): TCPAdapter
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TCPAdapter

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): TCPAdapter
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TCPAdapter

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): TCPAdapter
  • Parameters

    • Optional event: string | symbol

    Returns TCPAdapter

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): TCPAdapter
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TCPAdapter

resume

  • resume(): Promise<void>
  • 调用 pause() 后的继续(恢复)读取。

    Returns Promise<void>

setEncoding

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): Promise<void>
  • 启用/禁用keepAlive功能,并可选择设置在空闲套接字上发送第一个keepAlive探测之前的初始延迟。

    Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns Promise<void>

setMaxConnections

  • setMaxConnections(maxConnections: number): Promise<void>
  • 设置最大连接数

    Parameters

    • maxConnections: number

    Returns Promise<void>

setMaxListeners

  • Parameters

    • n: number

    Returns TCPAdapter

setNoDelay

  • setNoDelay(noDelay?: boolean): Promise<void>
  • 启用/禁用 Nagle 算法的使用。创建 TCP 连接时,它将启用 Nagle 算法。 Nagle 的算法在数据通过网络发送之前延迟数据。 它试图以延迟为代价来优化吞吐量。

    Parameters

    • Optional noDelay: boolean

    Returns Promise<void>

setTimeout

  • setTimeout(timeout: number): Promise<void>
  • 将套接字设置为在套接字上 timeout 毫秒不活动后超时。

    Parameters

    • timeout: number

    Returns Promise<void>

write

  • write(strOrBuffer: string | Uint8Array, encoding?: BufferEncoding): Promise<{ error: undefined | Error; flushed: boolean }>
  • 在套接字上发送数据。 第二个参数指定字符串情况下的编码。 它默认为 UTF8 编码。 如果整个数据被成功刷新到内核缓冲区,则返回 flushed: true。 如果所有或部分数据在用户内存中排队,则返回 flushed: false。当缓冲区再次空闲时,将触发 'drain'。

    Parameters

    Returns Promise<{ error: undefined | Error; flushed: boolean }>

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc