Documentation

UpdateWorkerStatus extends Message
in package

Generated from protobuf message <code>livekit.UpdateWorkerStatus</code>

Table of Contents

Properties

$job_count  : mixed
Generated from protobuf field <code>uint32 job_count = 4;</code>
$load  : mixed
optional string metadata = 2 [deprecated=true];
$status  : mixed
Generated from protobuf field <code>optional .livekit.WorkerStatus status = 1;</code>

Methods

__construct()  : mixed
Constructor.
clearStatus()  : mixed
getJobCount()  : int
Generated from protobuf field <code>uint32 job_count = 4;</code>
getLoad()  : float
optional string metadata = 2 [deprecated=true];
getStatus()  : int
Generated from protobuf field <code>optional .livekit.WorkerStatus status = 1;</code>
hasStatus()  : mixed
setJobCount()  : $this
Generated from protobuf field <code>uint32 job_count = 4;</code>
setLoad()  : $this
optional string metadata = 2 [deprecated=true];
setStatus()  : $this
Generated from protobuf field <code>optional .livekit.WorkerStatus status = 1;</code>

Properties

$job_count

Generated from protobuf field <code>uint32 job_count = 4;</code>

protected mixed $job_count = 0

$load

optional string metadata = 2 [deprecated=true];

protected mixed $load = 0.0

Generated from protobuf field float load = 3;

$status

Generated from protobuf field <code>optional .livekit.WorkerStatus status = 1;</code>

protected mixed $status = null

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 int $status
@type float $load
      optional string metadata = 2 [deprecated=true];
@type int $job_count

}

getJobCount()

Generated from protobuf field <code>uint32 job_count = 4;</code>

public getJobCount() : int
Return values
int

getLoad()

optional string metadata = 2 [deprecated=true];

public getLoad() : float

Generated from protobuf field float load = 3;

Return values
float

getStatus()

Generated from protobuf field <code>optional .livekit.WorkerStatus status = 1;</code>

public getStatus() : int
Return values
int

setJobCount()

Generated from protobuf field <code>uint32 job_count = 4;</code>

public setJobCount(int $var) : $this
Parameters
$var : int
Return values
$this

setLoad()

optional string metadata = 2 [deprecated=true];

public setLoad(float $var) : $this

Generated from protobuf field float load = 3;

Parameters
$var : float
Return values
$this

setStatus()

Generated from protobuf field <code>optional .livekit.WorkerStatus status = 1;</code>

public setStatus(int $var) : $this
Parameters
$var : int
Return values
$this

        
On this page

Search results