Class MetricsBatch

Inheritance

object

MetricsBatch

Implements

IMessage<MetricsBatch>

IEquatable<MetricsBatch>

IDeepCloneable<MetricsBatch>

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 MetricsBatch : IMessage<MetricsBatch>, IEquatable<MetricsBatch>, IDeepCloneable<MetricsBatch>, IBufferMessage, IMessage

Constructors

MetricsBatch()

Declaration

public MetricsBatch()

MetricsBatch(MetricsBatch)

Declaration

public MetricsBatch(MetricsBatch other)

Parameters

Type	Name	Description
MetricsBatch	other

Fields

EventsFieldNumber

Field number for the "events" field.

Declaration

public const int EventsFieldNumber = 5

Field Value

Type	Description
int

NormalizedTimestampFieldNumber

Field number for the "normalized_timestamp" field.

Declaration

public const int NormalizedTimestampFieldNumber = 2

Field Value

Type	Description
int

StrDataFieldNumber

Field number for the "str_data" field.

Declaration

public const int StrDataFieldNumber = 3

Field Value

Type	Description
int

TimeSeriesFieldNumber

Field number for the "time_series" field.

Declaration

public const int TimeSeriesFieldNumber = 4

Field Value

Type	Description
int

TimestampMsFieldNumber

Field number for the "timestamp_ms" field.

Declaration

public const int TimestampMsFieldNumber = 1

Field Value

Type	Description
int

Properties

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Events

Declaration

public RepeatedField<EventMetric> Events { get; }

Property Value

Type	Description
RepeatedField<EventMetric>

NormalizedTimestamp

Declaration

public Timestamp NormalizedTimestamp { get; set; }

Property Value

Type	Description
Timestamp

Parser

Declaration

public static MessageParser<MetricsBatch> Parser { get; }

Property Value

Type	Description
MessageParser<MetricsBatch>

StrData

To avoid repeating string values, we store them in a separate list and reference them by index This is useful for storing participant identities, track names, etc. There is also a predefined list of labels that can be used to reference common metrics. They have reserved indices from 0 to (METRIC_LABEL_PREDEFINED_MAX_VALUE - 1). Indexes pointing at str_data should start from METRIC_LABEL_PREDEFINED_MAX_VALUE, such that str_data[0] == index of METRIC_LABEL_PREDEFINED_MAX_VALUE.

Declaration

public RepeatedField<string> StrData { get; }

Property Value

Type	Description
RepeatedField<string>

TimeSeries

Declaration

public RepeatedField<TimeSeriesMetric> TimeSeries { get; }

Property Value

Type	Description
RepeatedField<TimeSeriesMetric>

TimestampMs

time at which this batch is sent based on a monotonic clock (millisecond resolution)

Declaration

public long TimestampMs { get; set; }

Property Value

Type	Description
long

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 MetricsBatch Clone()

Returns

Type	Description
MetricsBatch	A deep clone of this object.

Equals(MetricsBatch)

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

Declaration

public bool Equals(MetricsBatch other)

Parameters

Type	Name	Description
MetricsBatch	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(MetricsBatch)

Merges the given message into this one.

Declaration

public void MergeFrom(MetricsBatch other)

Parameters

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