Class UdpSocket

保留数据报边界的 UDP 套接字，Packet 不附加 TCP 长度头。

Hierarchy (View Summary)

Socket
- UdpSocket

Constructors

constructor

new UdpSocket(): UdpSocket
创建尚未绑定的 UDP 套接字，默认使用异步阻塞语义。

Returns UdpSocket
Overrides Socket.constructor
- Defined in src/network/udp-socket.ts:38

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?: Socket

底层 UDP 套接字句柄。

`Static` `Readonly`AnyPort

AnyPort: 0

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

`Static` `Readonly`MaxDatagramSize

MaxDatagramSize: 65507

本实现允许的最大 UDP 数据报载荷字节数。

`Static` `Readonly`Status

Status: typeof SocketStatus = SocketStatus

套接字操作状态枚举。

`Static` `Readonly`Type

Type: typeof SocketType = SocketType

套接字传输协议枚举。

Methods

[socketAlive]

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

Returns boolean
Inherited from Socket.[socketAlive]
- Defined in src/network/socket.ts:93

[socketReady]

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

`Protected`allocateHandle

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

`Protected`awaitReady

awaitReady(check: () => boolean, generation: number): Promise<boolean>
Parameters
- check: () => boolean
- generation: number
Returns Promise<boolean>
Inherited from Socket.awaitReady
- 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>
Inherited from Socket.awaitWrite
- Defined in src/network/socket.ts:193

bind

bind(port: number, address?: IpAddress): Promise<SocketStatus>
异步绑定本地端口和地址；port 为 0 时由系统分配，默认使用 IPv4。
Parameters
- port: number
- address: IpAddress = IpAddress.Any
Returns Promise<SocketStatus>
- Defined in src/network/udp-socket.ts:44

`Protected`changed

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

`Protected`close

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

Returns void
Inherited from Socket.close
- Defined in src/network/socket.ts:113

`Protected`create

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

getLastError

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

Returns undefined | Error
Inherited from Socket.getLastError
- Defined in src/network/socket.ts:80

getLocalPort

getLocalPort(): number
返回已绑定的本地端口，未绑定时为 0。

Returns number
- Defined in src/network/udp-socket.ts:40

`Protected`getNativeHandle

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

Returns undefined | Socket
Overrides Socket.getNativeHandle
- Defined in src/network/udp-socket.ts:175

`Protected`getReadiness

getReadiness(mask: number): number
返回待接收数据报和当前绑定对应的就绪位。
Parameters
- mask: number
Returns number
Overrides Socket.getReadiness
- Defined in src/network/udp-socket.ts:171

`Protected`isAlive

isAlive(): boolean
返回绑定状态，允许派生类扩展。

Returns boolean
Overrides Socket.isAlive
- Defined in src/network/udp-socket.ts:169

isBlocking

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

Returns boolean
Inherited from Socket.isBlocking
- Defined in src/network/socket.ts:78

`Protected`onClose

onClose(): void
清空旧传输的绑定状态和数据报，旧读取通过代际变化取消。

Returns void
Overrides Socket.onClose
- Defined in src/network/udp-socket.ts:107

`Protected`onCreate

onCreate(): void
将分配或接管的 UDP 句柄接入同一数据报队列及绑定状态。

Returns void
Overrides Socket.onCreate
- Defined in src/network/udp-socket.ts:62

receive

receive(destination: Uint8Array | Packet): Promise<DatagramResult>
接收一个完整数据报；目标字节区过小时丢弃并返回 Error，非阻塞无数据为 NotReady。
Parameters
- destination: Uint8Array | Packet
Returns Promise<DatagramResult>
- Defined in src/network/udp-socket.ts:148

send

send(
    data: Uint8Array | Packet,
    address: IpAddress,
    port: number,
): Promise<SocketStatus>
发送调用时的数据快照为一个数据报；未绑定时按目标地址族自动绑定临时端口。
Parameters
- data: Uint8Array | Packet
- address: IpAddress
- port: number
Returns Promise<SocketStatus>
- Defined in src/network/udp-socket.ts:113

setBlocking

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

unbind

unbind(): void
关闭 UDP 传输并清空待接收的数据报。

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

`Protected`validateHandle

validateHandle(handle: SocketHandle): void
接管前拒绝非 UDP 的 Node 传输。
Parameters
- handle: SocketHandle
Returns void
Overrides Socket.validateHandle
- Defined in src/network/udp-socket.ts:58