Documentation

ServerMessage extends Message
in package

from Server to Worker

Generated from protobuf message livekit.ServerMessage

Table of Contents

Properties

$message  : mixed

Methods

__construct()  : mixed
Constructor.
getAssignment()  : JobAssignment|null
Generated from protobuf field <code>.livekit.JobAssignment assignment = 3;</code>
getAvailability()  : AvailabilityRequest|null
server asks worker to confirm availability for a job
getMessage()  : string
getPong()  : WorkerPong|null
Generated from protobuf field <code>.livekit.WorkerPong pong = 4;</code>
getRegister()  : RegisterWorkerResponse|null
server confirms the registration, from this moment on, the worker is considered active
getTermination()  : JobTermination|null
Generated from protobuf field <code>.livekit.JobTermination termination = 5;</code>
hasAssignment()  : mixed
hasAvailability()  : mixed
hasPong()  : mixed
hasRegister()  : mixed
hasTermination()  : mixed
setAssignment()  : $this
Generated from protobuf field <code>.livekit.JobAssignment assignment = 3;</code>
setAvailability()  : $this
server asks worker to confirm availability for a job
setPong()  : $this
Generated from protobuf field <code>.livekit.WorkerPong pong = 4;</code>
setRegister()  : $this
server confirms the registration, from this moment on, the worker is considered active
setTermination()  : $this
Generated from protobuf field <code>.livekit.JobTermination termination = 5;</code>

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\RegisterWorkerResponse $register
      server confirms the registration, from this moment on, the worker is considered active
@type \Livekit\AvailabilityRequest $availability
      server asks worker to confirm availability for a job
@type \Livekit\JobAssignment $assignment
@type \Livekit\JobTermination $termination
@type \Livekit\WorkerPong $pong

}

getMessage()

public getMessage() : string
Return values
string

setAssignment()

Generated from protobuf field <code>.livekit.JobAssignment assignment = 3;</code>

public setAssignment(JobAssignment $var) : $this
Parameters
$var : JobAssignment
Return values
$this

setAvailability()

server asks worker to confirm availability for a job

public setAvailability(AvailabilityRequest $var) : $this

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

Parameters
$var : AvailabilityRequest
Return values
$this

setPong()

Generated from protobuf field <code>.livekit.WorkerPong pong = 4;</code>

public setPong(WorkerPong $var) : $this
Parameters
$var : WorkerPong
Return values
$this

setRegister()

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

public setRegister(RegisterWorkerResponse $var) : $this

Generated from protobuf field .livekit.RegisterWorkerResponse register = 1;

Parameters
$var : RegisterWorkerResponse
Return values
$this

setTermination()

Generated from protobuf field <code>.livekit.JobTermination termination = 5;</code>

public setTermination(JobTermination $var) : $this
Parameters
$var : JobTermination
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results