Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

WebSocketMultiplayerPeer

Наследует: MultiplayerPeer < PacketPeer < RefCounted < Object

Базовый класс для сервера и клиента WebSocket.

Описание

Базовый класс для сервера и клиента WebSocket, позволяющий использовать их в качестве многопользовательского однорангового узла для MultiplayerAPI.

Примечание: При экспорте в 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() 🔗

Дополнительные заголовки для использования во время рукопожатия. См. WebSocketPeer.handshake_headers для получения более подробной информации.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

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() 🔗

Поддерживаемые подпротоколы WebSocket. Подробнее см. WebSocketPeer.supported_protocols.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

Описания метода

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 🔗

Возвращает WebSocketPeer, связанный с указанным peer_id.

String get_peer_address(id: int) const 🔗

Возвращает IP-адрес указанного однорангового узла.

int get_peer_port(id: int) const 🔗

Возвращает удаленный порт указанного однорангового узла.