GFNetworkBackend¶
API Reference / Network / 类索引
- 路径：
addons/gf/extensions/network/backends/gf_network_backend.gd - 模块：
Network - 继承：
RefCounted - API：
public - 类别：协议与扩展点 (
protocol) - 首次版本：
3.17.0
网络后端抽象基类。 后端负责具体传输协议，框架层只依赖该统一接口与信号。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 信号 | connected |
signal connected |
| 信号 | disconnected |
signal disconnected(reason: String) |
| 信号 | peer_connected |
signal peer_connected(peer_id: int) |
| 信号 | peer_disconnected |
signal peer_disconnected(peer_id: int) |
| 信号 | message_received |
signal message_received(peer_id: int, bytes: PackedByteArray) |
| 方法 | host |
func host(_options: Dictionary = {}) -> Error: |
| 方法 | connect_to_endpoint |
func connect_to_endpoint(_endpoint: String, _options: Dictionary = {}) -> Error: |
| 方法 | disconnect_backend |
func disconnect_backend() -> void: |
| 方法 | send_bytes |
func send_bytes(_peer_id: int, _bytes: PackedByteArray, _options: Dictionary = {}) -> Error: |
| 方法 | poll |
func poll(_delta: float) -> void: |
| 方法 | get_debug_snapshot |
func get_debug_snapshot() -> Dictionary: |
信号¶
connected¶
- API：
public
连接成功后发出。
disconnected¶
- API：
public
断开连接后发出。
参数：
| 名称 | 说明 |
|---|---|
reason |
断开原因。 |
peer_connected¶
- API：
public
远端节点连接后发出。
参数：
| 名称 | 说明 |
|---|---|
peer_id |
远端 peer 标识。 |
peer_disconnected¶
- API：
public
远端节点断开后发出。
参数：
| 名称 | 说明 |
|---|---|
peer_id |
远端 peer 标识。 |
message_received¶
- API：
public
收到原始消息 bytes 后发出。
参数：
| 名称 | 说明 |
|---|---|
peer_id |
远端 peer 标识。 |
bytes |
原始消息 bytes。 |
方法¶
host¶
- API：
public
启动主机。
参数：
| 名称 | 说明 |
|---|---|
_options |
后端自定义选项。 |
返回：Godot 错误码。
结构：
_options: Dictionary，后端自定义启动选项。
connect_to_endpoint¶
- API：
public
连接远端。
参数：
| 名称 | 说明 |
|---|---|
_endpoint |
远端地址。 |
_options |
后端自定义选项。 |
返回：Godot 错误码。
结构：
_options: Dictionary，后端自定义连接选项。
disconnect_backend¶
- API：
public
断开连接。
send_bytes¶
- API：
public
发送 bytes。
参数：
| 名称 | 说明 |
|---|---|
_peer_id |
目标 peer；后端可约定 -1 表示广播。 |
_bytes |
消息 bytes。 |
_options |
后端自定义发送选项。 |
返回：Godot 错误码。
结构：
_options: Dictionary，后端自定义发送选项。
poll¶
- API：
public
后端轮询入口。需要轮询的后端可重写。
参数：
| 名称 | 说明 |
|---|---|
_delta |
帧间隔。 |
get_debug_snapshot¶
- API：
public
获取后端调试快照。
返回：调试信息字典。
结构：
return: Dictionary，包含 backend、available 以及后端自定义状态字段。