Class LeaveRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class LeaveRequest : IMessage<LeaveRequest>, IEquatable<LeaveRequest>, IDeepCloneable<LeaveRequest>, IBufferMessage, IMessage

Inheritance

object

LeaveRequest

Implements

IMessage<LeaveRequest>

IEquatable<LeaveRequest>

IDeepCloneable<LeaveRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

LeaveRequest()

public LeaveRequest()

LeaveRequest(LeaveRequest)

public LeaveRequest(LeaveRequest other)

Parameters

other LeaveRequest

Fields

ActionFieldNumber

Field number for the "action" field.

public const int ActionFieldNumber = 3

Field Value

int

CanReconnectFieldNumber

Field number for the "can_reconnect" field.

public const int CanReconnectFieldNumber = 1

Field Value

int

ReasonFieldNumber

Field number for the "reason" field.

public const int ReasonFieldNumber = 2

Field Value

int

RegionsFieldNumber

Field number for the "regions" field.

public const int RegionsFieldNumber = 4

Field Value

int

Properties

Action

public LeaveRequest.Types.Action Action { get; set; }

Property Value

LeaveRequest.Types.Action

CanReconnect

sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: can_reconnect obsoleted by action starting in protocol version 13

public bool CanReconnect { get; set; }

Property Value

bool

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<LeaveRequest> Parser { get; }

Property Value

MessageParser<LeaveRequest>

Reason

public DisconnectReason Reason { get; set; }

Property Value

DisconnectReason

Regions

public RegionSettings Regions { get; set; }

Property Value

RegionSettings

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public LeaveRequest Clone()

Returns

LeaveRequest

A deep clone of this object.

Equals(LeaveRequest)

public bool Equals(LeaveRequest other)

Parameters

other LeaveRequest

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(LeaveRequest)

Merges the given message into this one.

public void MergeFrom(LeaveRequest other)

Parameters

other LeaveRequest

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.