Class Socket`Abstract`

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

Hierarchy (View Summary)

Socket

Index

Constructors

`Protected`constructor

new Socket(type?: SocketType): Socket
初始化套接字公共状态，默认启用阻塞语义。
Parameters
- type: SocketType = SocketType.Tcp
Returns Socket
- Defined in src/network/socket.ts:67

Properties

`Readonly`[socketEvents]

"[socketEvents]": EventEmitter<DefaultEventMap> = ...

`Protected`blocking

blocking: boolean = true

`Protected` `Optional`detach

detach?: () => void

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

`Protected`epoch

epoch: number = 0

`Protected` `Optional`failure

failure?: Error

`Protected` `Optional`transport

transport?: SocketHandle

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

`Static` `Readonly`AnyPort

AnyPort: 0

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

`Static` `Readonly`Status

Status: typeof SocketStatus = SocketStatus

套接字操作状态枚举。

`Static` `Readonly`Type

Type: typeof SocketType = SocketType

套接字传输协议枚举。

Methods

[socketAlive]

"[socketAlive]"(): boolean
供 Selector 查询子类可覆盖的存活状态。

Returns boolean
- Defined in src/network/socket.ts:93

[socketReady]

"[socketReady]"(mask: number): number
供 Selector 读取子类可覆盖的就绪条件。
Parameters
- mask: number
Returns number
- Defined in src/network/socket.ts:91

`Protected`allocateHandle

allocateHandle(addressType: IpAddressType): SocketHandle
按协议分配未连接传输；监听器可覆盖为 Node Server。
Parameters
- addressType: IpAddressType
Returns SocketHandle
- Defined in src/network/socket.ts:134

`Protected`awaitReady

awaitReady(check: () => boolean, generation: number): Promise<boolean>
Parameters
- check: () => boolean
- generation: number
Returns Promise<boolean>
- Defined in src/network/socket.ts:82

`Protected`awaitWrite

awaitWrite(
completion: Promise<SocketStatus>,
generation: number,
): Promise<SocketStatus>
等待写操作或代际取消；关闭时不依赖底层写回调是否会触发。
Parameters
- completion: Promise<SocketStatus>
- generation: number
Returns Promise<SocketStatus>
- Defined in src/network/socket.ts:193

`Protected`changed

changed(): void
Returns void
- Defined in src/network/socket.ts:81

`Protected`close

close(): void
关闭当前传输并唤醒旧代际的等待；重复调用安全，阻塞标志不变。

Returns void
- Defined in src/network/socket.ts:113

`Protected`create

create(addressType?: IpAddressType): void
分配指定地址族的传输，不隐式连接或绑定端口。
Parameters
- OptionaladdressType: IpAddressType
Returns void
- Defined in src/network/socket.ts:97
create(handle: SocketHandle): void
接管 Node 传输并关闭旧传输；不接管裸文件描述符。
Parameters
- handle: SocketHandle
Returns void
- Defined in src/network/socket.ts:99

getLastError

getLastError(): undefined | Error
返回最近的底层错误；未记录错误时为 undefined。

Returns undefined | Error
- Defined in src/network/socket.ts:80

`Protected`getNativeHandle

getNativeHandle(): undefined | SocketHandle
供子类访问底层 Node 传输对象；未创建时为 undefined。

Returns undefined | SocketHandle
- Defined in src/network/socket.ts:95

`Protected`getReadiness

getReadiness(mask: number): number
默认 TCP 按可读字节和写入背压就绪，已绑定 UDP 可发送。 UDP 数据报和 Server 连接队列由子类通过此钩子和 changed() 通知 Selector。
Parameters
- mask: number
Returns number
- Defined in src/network/socket.ts:179

`Protected`isAlive

isAlive(): boolean
默认查询 Node 传输是否存活；子类可覆盖，不需要导入内部 symbol。

Returns boolean
- Defined in src/network/socket.ts:166

isBlocking

isBlocking(): boolean
返回是否使用异步等待的阻塞语义。

Returns boolean
- Defined in src/network/socket.ts:78

`Protected`onClose

onClose(): void
关闭时清理子类状态，调用时旧传输已解除关联。

Returns void
- Defined in src/network/socket.ts:164

`Protected`onCreate

onCreate(): void
安装默认 TCP/UDP/Server 状态监听；子类可覆盖以管理自己的收发队列。

Returns void
- Defined in src/network/socket.ts:146

setBlocking

setBlocking(blocking: boolean): void
设置是否异步等待可读/可写；false 时按当前队列状态返回 NotReady 或 Partial。
Parameters
- blocking: boolean
Returns void
- Defined in src/network/socket.ts:72

`Protected`validateHandle

validateHandle(handle: SocketHandle): void
接管前验证传输类型，避免关闭旧连接后才发现类型错误。
Parameters
- handle: SocketHandle
Returns void
- Defined in src/network/socket.ts:139