Class ServerMessage

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

from Server to Worker

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

Inheritance

object

ServerMessage

Implements

IMessage<ServerMessage>

IEquatable<ServerMessage>

IDeepCloneable<ServerMessage>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ServerMessage()

public ServerMessage()

ServerMessage(ServerMessage)

public ServerMessage(ServerMessage other)

Parameters

other ServerMessage

Fields

AssignmentFieldNumber

Field number for the "assignment" field.

public const int AssignmentFieldNumber = 3

Field Value

int

AvailabilityFieldNumber

Field number for the "availability" field.

public const int AvailabilityFieldNumber = 2

Field Value

int

PongFieldNumber

Field number for the "pong" field.

public const int PongFieldNumber = 4

Field Value

int

RegisterFieldNumber

Field number for the "register" field.

public const int RegisterFieldNumber = 1

Field Value

int

TerminationFieldNumber

Field number for the "termination" field.

public const int TerminationFieldNumber = 5

Field Value

int

Properties

Assignment

public JobAssignment Assignment { get; set; }

Property Value

JobAssignment

Availability

server asks worker to confirm availability for a job

public AvailabilityRequest Availability { get; set; }

Property Value

AvailabilityRequest

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

MessageCase

public ServerMessage.MessageOneofCase MessageCase { get; }

Property Value

ServerMessage.MessageOneofCase

Parser

public static MessageParser<ServerMessage> Parser { get; }

Property Value

MessageParser<ServerMessage>

Pong

public WorkerPong Pong { get; set; }

Property Value

WorkerPong

Register

server confirms the registration, from this moment on, the worker is considered active

public RegisterWorkerResponse Register { get; set; }

Property Value

RegisterWorkerResponse

Termination

public JobTermination Termination { get; set; }

Property Value

JobTermination

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.

ClearMessage()

public void ClearMessage()

Clone()

Creates a deep clone of this object.

public ServerMessage Clone()

Returns

ServerMessage

A deep clone of this object.

Equals(ServerMessage)

public bool Equals(ServerMessage other)

Parameters

other ServerMessage

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(ServerMessage)

Merges the given message into this one.

public void MergeFrom(ServerMessage other)

Parameters

other ServerMessage

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.