WebSocketMultiplayerPeer — C# API

class WebSocketMultiplayerPeerReckfellSharpНаследует MultiplayerPeer

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

Базовый класс для сервера WebSocket и клиента, позволяющий использовать их в качестве многопользователя MultiplayerApi. Примечание: При экспорте в Андроид убедитесь, что вы можете INTERNET В противном случае любая связь будет заблокирована Android.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

WebSocketMultiplayerPeerКонструктор

# WebSocketMultiplayerPeer

C#
public WebSocketMultiplayerPeer();

Свойства6

HandshakeHeadersСвойство

# HandshakeHeaders

C#
public string[] HandshakeHeaders { get; set; }

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

HandshakeTimeoutСвойство

# HandshakeTimeout

C#
public float HandshakeTimeout { get; set; }

Максимальное время, в течение которого каждый узел может оставаться в состоянии подключения, прежде чем соединение будет отключено.

InboundBufferSizeСвойство

# InboundBufferSize

C#
public int InboundBufferSize { get; set; }

Размер входящего буфера для подключенных пиров. См. WebSocketPeer.InboundBufferSize для получения более подробной информации.

MaxQueuedPacketsСвойство

# MaxQueuedPackets

C#
public int MaxQueuedPackets { get; set; }

Максимальное количество пакетов в очереди для подключенных пиров. См. WebSocketPeer.MaxQueuedPackets для получения более подробной информации.

OutboundBufferSizeСвойство

# OutboundBufferSize

C#
public int OutboundBufferSize { get; set; }

Размер исходящего буфера для подключенных пиров. См. WebSocketPeer.OutboundBufferSize для получения более подробной информации.

SupportedProtocolsСвойство

# SupportedProtocols

C#
public string[] SupportedProtocols { get; set; }

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

Методы19

CreateClientError

# CreateClient

C#
public Error CreateClient(string url, TlsOptions tlsClientOptions = null);

Запускает новый многопользовательский клиент, подключающийся к указанному url. Сертификаты TLS будут проверены по имени хоста при подключении с использованием протокола wss://. Вы можете передать необязательный параметр tls_client_options, чтобы настроить доверенные центры сертификации, или отключить проверку общего имени. См. TlsOptions.Client и TlsOptions.ClientUnsafe. Примечание: Рекомендуется указывать часть схемы URL, т. е. url должен начинаться либо с ws://, либо с wss://.

Параметры
Имя	Тип	По умолчанию
`url`	`string`	—
`tlsClientOptions`	`TlsOptions`	`null`

Возвращает Error

CreateServerError

# CreateServer

C#
public Error CreateServer(int port, string bindAddress = "*", TlsOptions tlsServerOptions = null);

Запускает новый многопользовательский сервер, прослушивающий указанный port. Вы можете дополнительно указать bind_address и предоставить допустимые tls_server_options для использования TLS. См. TlsOptions.Server.

Параметры
Имя	Тип	По умолчанию
`port`	`int`	—
`bindAddress`	`string`	`"*"`
`tlsServerOptions`	`TlsOptions`	`null`

Возвращает Error

GetHandshakeHeadersstring[]

# GetHandshakeHeaders

C#
public string[] GetHandshakeHeaders();

Возвращает string[]

GetHandshakeTimeoutfloat

# GetHandshakeTimeout

C#
public float GetHandshakeTimeout();

Возвращает float

GetInboundBufferSizeint

# GetInboundBufferSize

C#
public int GetInboundBufferSize();

Возвращает int

GetMaxQueuedPacketsint

# GetMaxQueuedPackets

C#
public int GetMaxQueuedPackets();

Возвращает int

GetOutboundBufferSizeint

# GetOutboundBufferSize

C#
public int GetOutboundBufferSize();

Возвращает int

GetPeerWebSocketPeer

# GetPeer

C#
public WebSocketPeer GetPeer(int peerId);

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

Параметры
Имя	Тип	По умолчанию
`peerId`	`int`	—

Возвращает WebSocketPeer

GetPeerAddressstring

# GetPeerAddress

C#
public string GetPeerAddress(int id);

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

Параметры
Имя	Тип	По умолчанию
`id`	`int`	—

Возвращает string

GetPeerPortint

# GetPeerPort

C#
public int GetPeerPort(int id);

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

Параметры
Имя	Тип	По умолчанию
`id`	`int`	—

Возвращает int

GetSupportedProtocolsstring[]

# GetSupportedProtocols

C#
public string[] GetSupportedProtocols();

Возвращает string[]

SetHandshakeHeaders2 перегрузки

# SetHandshakeHeaders · 1/2

C#
public void SetHandshakeHeaders(ReadOnlySpan<string> protocols);

Параметры
Имя	Тип	По умолчанию
`protocols`	`ReadOnlySpan<string>`	—

# SetHandshakeHeaders · 2/2

C#
public void SetHandshakeHeaders(string[] protocols);

Параметры
Имя	Тип	По умолчанию
`protocols`	`string[]`	—

SetHandshakeTimeoutvoid

# SetHandshakeTimeout

C#
public void SetHandshakeTimeout(float timeout);

Параметры
Имя	Тип	По умолчанию
`timeout`	`float`	—

SetInboundBufferSizevoid

# SetInboundBufferSize

C#
public void SetInboundBufferSize(int bufferSize);

Параметры
Имя	Тип	По умолчанию
`bufferSize`	`int`	—

SetMaxQueuedPacketsvoid

# SetMaxQueuedPackets

C#
public void SetMaxQueuedPackets(int maxQueuedPackets);

Параметры
Имя	Тип	По умолчанию
`maxQueuedPackets`	`int`	—

SetOutboundBufferSizevoid

# SetOutboundBufferSize

C#
public void SetOutboundBufferSize(int bufferSize);

Параметры
Имя	Тип	По умолчанию
`bufferSize`	`int`	—

SetSupportedProtocols2 перегрузки

# SetSupportedProtocols · 1/2

C#
public void SetSupportedProtocols(ReadOnlySpan<string> protocols);

Параметры
Имя	Тип	По умолчанию
`protocols`	`ReadOnlySpan<string>`	—

# SetSupportedProtocols · 2/2

C#
public void SetSupportedProtocols(string[] protocols);

Параметры
Имя	Тип	По умолчанию
`protocols`	`string[]`	—