Class WorkerMessage

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

from Worker to Server

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

Inheritance

object

WorkerMessage

Implements

IMessage<WorkerMessage>

IEquatable<WorkerMessage>

IDeepCloneable<WorkerMessage>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkerMessage()

public WorkerMessage()

WorkerMessage(WorkerMessage)

public WorkerMessage(WorkerMessage other)

Parameters

other WorkerMessage

Fields

AvailabilityFieldNumber

Field number for the "availability" field.

public const int AvailabilityFieldNumber = 2

Field Value

int

MigrateJobFieldNumber

Field number for the "migrate_job" field.

public const int MigrateJobFieldNumber = 7

Field Value

int

PingFieldNumber

Field number for the "ping" field.

public const int PingFieldNumber = 5

Field Value

int

RegisterFieldNumber

Field number for the "register" field.

public const int RegisterFieldNumber = 1

Field Value

int

SimulateJobFieldNumber

Field number for the "simulate_job" field.

public const int SimulateJobFieldNumber = 6

Field Value

int

UpdateJobFieldNumber

Field number for the "update_job" field.

public const int UpdateJobFieldNumber = 4

Field Value

int

UpdateWorkerFieldNumber

Field number for the "update_worker" field.

public const int UpdateWorkerFieldNumber = 3

Field Value

int

Properties

Availability

worker confirms to server that it's available for a job, or declines it

public AvailabilityResponse Availability { get; set; }

Property Value

AvailabilityResponse

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

MessageCase

public WorkerMessage.MessageOneofCase MessageCase { get; }

Property Value

WorkerMessage.MessageOneofCase

MigrateJob

public MigrateJobRequest MigrateJob { get; set; }

Property Value

MigrateJobRequest

Parser

public static MessageParser<WorkerMessage> Parser { get; }

Property Value

MessageParser<WorkerMessage>

Ping

public WorkerPing Ping { get; set; }

Property Value

WorkerPing

Register

agent workers need to register themselves with the server first

public RegisterWorkerRequest Register { get; set; }

Property Value

RegisterWorkerRequest

SimulateJob

public SimulateJobRequest SimulateJob { get; set; }

Property Value

SimulateJobRequest

UpdateJob

job can send status updates to the server, useful for tracking progress

public UpdateJobStatus UpdateJob { get; set; }

Property Value

UpdateJobStatus

UpdateWorker

worker can update its status to the server, including taking itself out of the pool

public UpdateWorkerStatus UpdateWorker { get; set; }

Property Value

UpdateWorkerStatus

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

Returns

WorkerMessage

A deep clone of this object.

Equals(WorkerMessage)

public bool Equals(WorkerMessage other)

Parameters

other WorkerMessage

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

Merges the given message into this one.

public void MergeFrom(WorkerMessage other)

Parameters

other WorkerMessage

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.