WebRtcDataChannel — C# API

class WebRtcDataChannelReckfellSharpНаследует PacketPeer

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

Свойства1

WriteModeСвойство

C#
public WebRtcDataChannel.WriteModeEnum WriteMode { get; set; }

Режим передачи, используемый при отправке исходящего пакета. Текстовый или двоичный.

Методы14

Closevoid

# Close

C#
public void Close();

Закрывает этот канал данных, уведомляя другого однорангового узла.

GetBufferedAmountint

# GetBufferedAmount

C#
public int GetBufferedAmount();

Возвращает количество байтов, находящихся в очереди на отправку по этому каналу.

Возвращает int

GetIdint

# GetId

C#
public int GetId();

Возвращает ID, назначенный этому каналу во время создания (или автоматически назначенный во время согласования). Если канал не согласован вне диапазона, ID будет доступен только после установления соединения (до этого момента будет возвращать 65535).

Возвращает int

GetLabelstring

# GetLabel

C#
public string GetLabel();

Возвращает метку (label), назначенную данному каналу при создании.

Возвращает string

GetMaxPacketLifeTimeint

# GetMaxPacketLifeTime

C#
public int GetMaxPacketLifeTime();

Возвращает значение maxPacketLifeTime, назначенное этому каналу при создании. Будет 65535, если не указано.

Возвращает int

GetMaxRetransmitsint

# GetMaxRetransmits

C#
public int GetMaxRetransmits();

Возвращает значение maxRetransmits, назначенное этому каналу при создании. Будет 65535, если не указано.

Возвращает int

GetProtocolstring

# GetProtocol

C#
public string GetProtocol();

Возвращает подпротокол, назначенный этому каналу во время создания. Пустая строка, если не указано.

Возвращает string

GetReadyStateWebRtcDataChannel.ChannelState

# GetReadyState

C#
public WebRtcDataChannel.ChannelState GetReadyState();

Возвращает текущее состояние этого канала.

Возвращает WebRtcDataChannel.ChannelState

GetWriteModeWebRtcDataChannel.WriteModeEnum

# GetWriteMode

C#
public WebRtcDataChannel.WriteModeEnum GetWriteMode();

Возвращает WebRtcDataChannel.WriteModeEnum

IsNegotiatedbool

# IsNegotiated

C#
public bool IsNegotiated();

Возвращает true, если этот канал был создан с использованием внеполосной конфигурации.

Возвращает bool

IsOrderedbool

# IsOrdered

C#
public bool IsOrdered();

Возвращает true, если этот канал был создан с включенным упорядочиванием (по умолчанию).

Возвращает bool

PollError

# Poll

C#
public Error Poll();

Зарезервировано, в данный момент не используется.

Возвращает Error

SetWriteModevoid

# SetWriteMode

C#
public void SetWriteMode(WebRtcDataChannel.WriteModeEnum writeMode);

Параметры
Имя	Тип	По умолчанию
`writeMode`	`WebRtcDataChannel.WriteModeEnum`	—

WasStringPacketbool

# WasStringPacket

C#
public bool WasStringPacket();

Возвращает true, если последний полученный пакет был передан как текст. См. WebRtcDataChannel.WriteMode.

Возвращает bool

WebRtcDataChannel.ChannelState

Значение	Описание
`Closed = 3`	Канал был закрыт или соединение не удалось.
`Closing = 2`	Канал закрывается, новые сообщения приниматься не будут, но те, которые уже находятся в очереди, будут очищены.
`Connecting = 0`	Канал создан, но он все еще пытается подключиться.
`Open = 1`	В настоящее время канал открыт, и по нему могут передаваться данные. Что-то закрывается

WebRtcDataChannel.WriteModeEnum

Значение	Описание
`Binary = 1`	Сообщает каналу отправлять данные по этому каналу в двоичном виде. Внешний пир (не Reckfell) получит это как массив буфера или blob.
`Text = 0`	Сообщает каналу отправлять данные по этому каналу как текст. Внешний пир (не Reckfell) получит это как строку.