WebSocketMultiplayerPeer

继承： MultiplayerPeer < PacketPeer < RefCounted < Object

WebSocket 服务器和客户端的基类。

描述

WebSocket服务器和客户端的基类，可以将它们用作多人应用对等 MultiplayerAPI.

Note: 导出到Android时，请确保启用 INTERNET 在导出项目或使用一键部署之前，在Android导出预设中获得许可。 否则，任何类型的网络通信将被Android阻止。

属性

PackedStringArray	handshake_headers	PackedStringArray()
float	handshake_timeout	3.0
int	inbound_buffer_size	65535
int	max_queued_packets	4096
int	outbound_buffer_size	65535
PackedStringArray	supported_protocols	PackedStringArray()

方法

Error	create_client(url: String, tls_client_options: TLSOptions = null)
Error	create_server(port: int, bind_address: String = "*", tls_server_options: TLSOptions = null)
WebSocketPeer	get_peer(peer_id: int) const
String	get_peer_address(id: int) const
int	get_peer_port(id: int) const

---

属性说明

PackedStringArray handshake_headers = PackedStringArray() 🔗

• void set_handshake_headers(value: PackedStringArray)

• PackedStringArray get_handshake_headers()

握手过程中要使用的额外标头。详见 WebSocketPeer.handshake_headers。

注意： 返回的数组被 复制 ，其任何更改都不会更新原始属性值。 看 PackedStringArray 有关更多详细信息。

---

float handshake_timeout = 3.0 🔗

• void set_handshake_timeout(value: float)

• float get_handshake_timeout()

每个对等体在被丢弃之前可以保持在连接状态的最长时间。

---

int inbound_buffer_size = 65535 🔗

• void set_inbound_buffer_size(value: int)

• int get_inbound_buffer_size()

已连接对等体的入站缓冲区大小。详见 WebSocketPeer.inbound_buffer_size。

---

int max_queued_packets = 4096 🔗

• void set_max_queued_packets(value: int)

• int get_max_queued_packets()

已连接对等体的最大排队数据包数量。详见 WebSocketPeer.max_queued_packets。

---

int outbound_buffer_size = 65535 🔗

• void set_outbound_buffer_size(value: int)

• int get_outbound_buffer_size()

已连接对等体的出站缓冲区大小。详见 WebSocketPeer.outbound_buffer_size。

---

PackedStringArray supported_protocols = PackedStringArray() 🔗

• void set_supported_protocols(value: PackedStringArray)

• PackedStringArray get_supported_protocols()

支持的 WebSocket 子协议。详情见 WebSocketPeer.supported_protocols。

注意： 返回的数组被 复制 ，其任何更改都不会更新原始属性值。 看 PackedStringArray 有关更多详细信息。

---

方法说明

Error create_client(url: String, tls_client_options: TLSOptions = null) 🔗

启动一个新的多人客户端，连接到给定``url``. 使用TLS证书在使用该宿主的名称进行验证``wss://`` 协议。 您可以通过可选 tls_client_options 定制可信赖认证机构或禁用通用名称验证的参数。 看 TLSOptions.client() 和 TLSOptions.client_unsafe().

注意: 建议指定URL的方案一部分，即 url 应该从任何一个开始 ws:// 或者 wss://.

---

Error create_server(port: int, bind_address: String = "*", tls_server_options: TLSOptions = null) 🔗

启动新的多人服务器，监听给定的 port。可以指定 bind_address，也可以提供有效的 tls_server_options 来使用 TLS。见 TLSOptions.server()。

---

WebSocketPeer get_peer(peer_id: int) const 🔗

返回与给定 peer_id 关联的 WebSocketPeer。

---

String get_peer_address(id: int) const 🔗

返回给定对等体的 IP 地址。

---

int get_peer_port(id: int) const 🔗

返回给定对等体的远程端口。