API 参考
正在准备搜索索引…

Socket

抽象

Node 网络传输的公共基类;默认使用异步等待的阻塞语义。

继承关系

层级 (查看层级一览)

源码与继承
成员目录27

构造函数

属性

方法

构造函数

属性

blocking: boolean = true
源码与继承
detach?: () => void

移除当前传输的事件监听。

源码与继承
epoch: number = 0
源码与继承
failure?: Error
源码与继承
transport?: SocketHandle

当前独占的 Node 传输,关闭或重建时由 Node 释放。

源码与继承
AnyPort: 0

绑定端口时由系统自动分配可用端口。

源码与继承
Status: typeof SocketStatus = SocketStatus

套接字操作状态枚举。

源码与继承
Type: typeof SocketType = SocketType

套接字传输协议枚举。

源码与继承

方法

  • 参数

    check
    () => boolean
    generation
    number

    返回值

    Promise<boolean>
    源码与继承
  • 关闭当前传输并唤醒旧代际的等待;重复调用安全,阻塞标志不变。

    返回值

    void
    源码与继承
  • 返回最近的底层错误;未记录错误时为 undefined。

    返回值

    undefined | Error
    源码与继承
  • 默认 TCP 按可读字节和写入背压就绪,已绑定 UDP 可发送。 UDP 数据报和 Server 连接队列由子类通过此钩子和 changed() 通知 Selector。

    参数

    mask
    number

    返回值

    number
    源码与继承
  • 默认查询 Node 传输是否存活;子类可覆盖,不需要导入内部 symbol。

    返回值

    boolean
    源码与继承
  • 返回是否使用异步等待的阻塞语义。

    返回值

    boolean
    源码与继承
  • 关闭时清理子类状态,调用时旧传输已解除关联。

    返回值

    void
    源码与继承
  • 安装默认 TCP/UDP/Server 状态监听;子类可覆盖以管理自己的收发队列。

    返回值

    void
    源码与继承
  • 设置是否异步等待可读/可写;false 时按当前队列状态返回 NotReady 或 Partial。

    参数

    blocking
    boolean

    返回值

    void
    源码与继承

符号成员

"[socketEvents]": EventEmitter<DefaultEventMap> = ...
源码与继承
  • 供 Selector 查询子类可覆盖的存活状态。

    返回值

    boolean
    源码与继承
  • 供 Selector 读取子类可覆盖的就绪条件。

    参数

    mask
    number

    返回值

    number
    源码与继承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0