Class LeaveRequest

Inheritance

object

LeaveRequest

Implements

IMessage<LeaveRequest>

IEquatable<LeaveRequest>

IDeepCloneable<LeaveRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: LiveKit.Proto

Assembly: Uniform.LiveKit.Protocol.dll

Syntax

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

Constructors

LeaveRequest()

Declaration

public LeaveRequest()

LeaveRequest(LeaveRequest)

Declaration

public LeaveRequest(LeaveRequest other)

Parameters

Type	Name	Description
LeaveRequest	other

Fields

ActionFieldNumber

Field number for the "action" field.

Declaration

public const int ActionFieldNumber = 3

Field Value

Type	Description
int

CanReconnectFieldNumber

Field number for the "can_reconnect" field.

Declaration

public const int CanReconnectFieldNumber = 1

Field Value

Type	Description
int

ReasonFieldNumber

Field number for the "reason" field.

Declaration

public const int ReasonFieldNumber = 2

Field Value

Type	Description
int

RegionsFieldNumber

Field number for the "regions" field.

Declaration

public const int RegionsFieldNumber = 4

Field Value

Type	Description
int

Properties

Action

Declaration

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

Property Value

Type	Description
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

Declaration

public bool CanReconnect { get; set; }

Property Value

Type	Description
bool

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Parser

Declaration

public static MessageParser<LeaveRequest> Parser { get; }

Property Value

Type	Description
MessageParser<LeaveRequest>

Reason

Declaration

public DisconnectReason Reason { get; set; }

Property Value

Type	Description
DisconnectReason

Regions

Declaration

public RegionSettings Regions { get; set; }

Property Value

Type	Description
RegionSettings

Methods

CalculateSize()

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

Declaration

public int CalculateSize()

Returns

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

Clone()

Creates a deep clone of this object.

Declaration

public LeaveRequest Clone()

Returns

Type	Description
LeaveRequest	A deep clone of this object.

Equals(LeaveRequest)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(LeaveRequest other)

Parameters

Type	Name	Description
LeaveRequest	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

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

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Remarks

See the user guide for precise merge semantics.

MergeFrom(LeaveRequest)

Merges the given message into this one.

Declaration

public void MergeFrom(LeaveRequest other)

Parameters

Type	Name	Description
LeaveRequest	other

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output	Coded output stream to write the data to. Must not be null.

Implements

Google.Protobuf.IMessage<T>

IEquatable<T>

Google.Protobuf.IDeepCloneable<T>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage