Class ServerInfo
details about the server
Inherited Members
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class ServerInfo : IMessage<ServerInfo>, IEquatable<ServerInfo>, IDeepCloneable<ServerInfo>, IBufferMessage, IMessage
Constructors
ServerInfo()
Declaration
public ServerInfo()
ServerInfo(ServerInfo)
Declaration
public ServerInfo(ServerInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| ServerInfo | other |
Fields
AgentProtocolFieldNumber
Field number for the "agent_protocol" field.
Declaration
public const int AgentProtocolFieldNumber = 7
Field Value
| Type | Description |
|---|---|
| int |
DebugInfoFieldNumber
Field number for the "debug_info" field.
Declaration
public const int DebugInfoFieldNumber = 6
Field Value
| Type | Description |
|---|---|
| int |
EditionFieldNumber
Field number for the "edition" field.
Declaration
public const int EditionFieldNumber = 1
Field Value
| Type | Description |
|---|---|
| int |
NodeIdFieldNumber
Field number for the "node_id" field.
Declaration
public const int NodeIdFieldNumber = 5
Field Value
| Type | Description |
|---|---|
| int |
ProtocolFieldNumber
Field number for the "protocol" field.
Declaration
public const int ProtocolFieldNumber = 3
Field Value
| Type | Description |
|---|---|
| int |
RegionFieldNumber
Field number for the "region" field.
Declaration
public const int RegionFieldNumber = 4
Field Value
| Type | Description |
|---|---|
| int |
VersionFieldNumber
Field number for the "version" field.
Declaration
public const int VersionFieldNumber = 2
Field Value
| Type | Description |
|---|---|
| int |
Properties
AgentProtocol
Declaration
public int AgentProtocol { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
DebugInfo
additional debugging information. sent only if server is in development mode
Declaration
public string DebugInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
| Type | Description |
|---|---|
| MessageDescriptor |
Edition
Declaration
public ServerInfo.Types.Edition Edition { get; set; }
Property Value
| Type | Description |
|---|---|
| ServerInfo.Types.Edition |
NodeId
Declaration
public string NodeId { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Parser
Declaration
public static MessageParser<ServerInfo> Parser { get; }
Property Value
| Type | Description |
|---|---|
| MessageParser<ServerInfo> |
Protocol
Declaration
public int Protocol { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Region
Declaration
public string Region { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Version
Declaration
public string Version { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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 ServerInfo Clone()
Returns
| Type | Description |
|---|---|
| ServerInfo | A deep clone of this object. |
Equals(ServerInfo)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(ServerInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| ServerInfo | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the |
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
GetHashCode()
Serves as the default hash function.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | A hash code for the current object. |
Overrides
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(ServerInfo)
Merges the given message into this one.
Declaration
public void MergeFrom(ServerInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| ServerInfo | 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
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. |