Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TCPEvents

Index

Methods

close

  • close(had_error?: boolean): void
  • 服务器: 关闭时触发。 如果连接存在,则在所有连接结束之前不会触发此事件。 客户端: 一旦套接字完全关闭就触发。 参数 hadError 是布尔值,表示套接字是否由于传输错误而关闭。

    Parameters

    • Optional had_error: boolean

    Returns void

connect

  • connect(): void
  • 当成功建立套接字连接时触发。

    Returns void

connection

  • connection(socketId: string): void
  • 当有socket连接时

    Parameters

    • socketId: string

    Returns void

data

  • data(data: string | Buffer): void
  • 接收到数据时触发。 参数 data 将是 Buffer 或 String。

    Parameters

    • data: string | Buffer

    Returns void

drain

  • drain(): void
  • 当写缓冲区变空时触发。可用于限制上传。

    Returns void

end

  • end(): void
  • 当套接字的另一端表示传输结束时触发,从而结束套接字的可读端。 默认情况下(allowHalfOpen 是 false)套接字将发送传输结束数据包,并在写出其挂起的写入队列后销毁其文件描述符。 但是,如果 allowHalfOpen 设置为 true,套接字将不会自动将其可写端 end(),从而允许用户写入任意数量的数据。 用户必须显式调用 end() 来关闭连接(即发回一个 FIN 数据包)。

    Returns void

error

  • error(err: Error): void
  • 当socket 出现error时

    Parameters

    • err: Error

    Returns void

listening

  • listening(): void
  • 当server监听时

    Returns void

lookup

  • lookup(err: Error, address: string, family: string | number, host: string): void
  • 在解析主机名之后但在连接之前触发。 不适用于 Unix 套接字。

    Parameters

    • err: Error

      Error | null 错误对象。 参见 dns.lookup()。

    • address: string

      string IP 地址。

    • family: string | number

      string | null 地址类型。 参见 dns.lookup()。

    • host: string

      string 主机名。

    Returns void

ready

  • ready(): void
  • 当套接字准备好使用时触发。 'connect' 后立即触发。

    Returns void

timeout

  • timeout(): void
  • 如果套接字因不活动而超时则触发。 这只是通知套接字已空闲。 用户必须手动关闭连接。

    Returns void

Generated using TypeDoc