Class WorkerMessage

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.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.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WorkerMessage()

public WorkerMessage()

WorkerMessage(WorkerMessage)

public WorkerMessage(WorkerMessage other)

Parameters

other WorkerMessage

Properties

Availability

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

public AvailabilityResponse Availability { get; set; }

Property Value

AvailabilityResponse

MessageCase

public WorkerMessage.MessageOneofCase MessageCase { get; }

Property Value

WorkerMessage.MessageOneofCase

MigrateJob

public MigrateJobRequest MigrateJob { get; set; }

Property Value

MigrateJobRequest

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

ClearMessage()

public void ClearMessage()