Documentation

WorkerMessage extends Message
in package

from Worker to Server

Generated from protobuf message livekit.WorkerMessage

Table of Contents

Properties

$message  : mixed

Methods

__construct()  : mixed
Constructor.
getAvailability()  : AvailabilityResponse|null
worker confirms to server that it's available for a job, or declines it
getMessage()  : string
getMigrateJob()  : MigrateJobRequest|null
Generated from protobuf field <code>.livekit.MigrateJobRequest migrate_job = 7;</code>
getPing()  : WorkerPing|null
Generated from protobuf field <code>.livekit.WorkerPing ping = 5;</code>
getRegister()  : RegisterWorkerRequest|null
agent workers need to register themselves with the server first
getSimulateJob()  : SimulateJobRequest|null
Generated from protobuf field <code>.livekit.SimulateJobRequest simulate_job = 6;</code>
getUpdateJob()  : UpdateJobStatus|null
job can send status updates to the server, useful for tracking progress
getUpdateWorker()  : UpdateWorkerStatus|null
worker can update its status to the server, including taking itself out of the pool
hasAvailability()  : mixed
hasMigrateJob()  : mixed
hasPing()  : mixed
hasRegister()  : mixed
hasSimulateJob()  : mixed
hasUpdateJob()  : mixed
hasUpdateWorker()  : mixed
setAvailability()  : $this
worker confirms to server that it's available for a job, or declines it
setMigrateJob()  : $this
Generated from protobuf field <code>.livekit.MigrateJobRequest migrate_job = 7;</code>
setPing()  : $this
Generated from protobuf field <code>.livekit.WorkerPing ping = 5;</code>
setRegister()  : $this
agent workers need to register themselves with the server first
setSimulateJob()  : $this
Generated from protobuf field <code>.livekit.SimulateJobRequest simulate_job = 6;</code>
setUpdateJob()  : $this
job can send status updates to the server, useful for tracking progress
setUpdateWorker()  : $this
worker can update its status to the server, including taking itself out of the pool

Properties

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type \Livekit\RegisterWorkerRequest $register
      agent workers need to register themselves with the server first
@type \Livekit\AvailabilityResponse $availability
      worker confirms to server that it's available for a job, or declines it
@type \Livekit\UpdateWorkerStatus $update_worker
      worker can update its status to the server, including taking itself out of the pool
@type \Livekit\UpdateJobStatus $update_job
      job can send status updates to the server, useful for tracking progress
@type \Livekit\WorkerPing $ping
@type \Livekit\SimulateJobRequest $simulate_job
@type \Livekit\MigrateJobRequest $migrate_job

}

getAvailability()

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

public getAvailability() : AvailabilityResponse|null

Generated from protobuf field .livekit.AvailabilityResponse availability = 2;

Return values
AvailabilityResponse|null

getMessage()

public getMessage() : string
Return values
string

getUpdateJob()

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

public getUpdateJob() : UpdateJobStatus|null

Generated from protobuf field .livekit.UpdateJobStatus update_job = 4;

Return values
UpdateJobStatus|null

getUpdateWorker()

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

public getUpdateWorker() : UpdateWorkerStatus|null

Generated from protobuf field .livekit.UpdateWorkerStatus update_worker = 3;

Return values
UpdateWorkerStatus|null

setAvailability()

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

public setAvailability(AvailabilityResponse $var) : $this

Generated from protobuf field .livekit.AvailabilityResponse availability = 2;

Parameters
$var : AvailabilityResponse
Return values
$this

setPing()

Generated from protobuf field <code>.livekit.WorkerPing ping = 5;</code>

public setPing(WorkerPing $var) : $this
Parameters
$var : WorkerPing
Return values
$this

setUpdateJob()

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

public setUpdateJob(UpdateJobStatus $var) : $this

Generated from protobuf field .livekit.UpdateJobStatus update_job = 4;

Parameters
$var : UpdateJobStatus
Return values
$this

setUpdateWorker()

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

public setUpdateWorker(UpdateWorkerStatus $var) : $this

Generated from protobuf field .livekit.UpdateWorkerStatus update_worker = 3;

Parameters
$var : UpdateWorkerStatus
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results