V1Beta1.WorkerCapacity Class

Namespace: Improbable.SpatialOS.Deployment

If you use the GDK for Unreal version 0.10 or later, this class is not compatible with the Standard Runtime variant. If you want to use this class, you must use the Compatibility Mode Runtime variant.

Inheritance

pb::IMessage<WorkerCapacity>


Const Fields

WorkerTypeFieldNumber
const int WorkerTypeFieldNumber = 1

Field number for the "worker_type" field.

MaxCapacityFieldNumber
const int MaxCapacityFieldNumber = 2

Field number for the "max_capacity" field.

RemainingCapacityFieldNumber
const int RemainingCapacityFieldNumber = 3

Field number for the "remaining_capacity" field.


Static Properties

Parser
pb::MessageParser<WorkerCapacity> Parser { get; }


Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

WorkerType
string WorkerType { get; set; }

The type of worker that this capacity limit applies to.

MaxCapacity
int MaxCapacity { get; set; }

Mutable.

Notes:
  • The maximum number of workers of the specified type that are allowed to connect to a SpatialOS deployment. Setting it to a lower number than the number of already connected workers does not drop their connections.
  • It must not be a negative number.

RemainingCapacity
int RemainingCapacity { get; set; }

Read-only.

Notes:
  • The available capacity for connection.
  • Note: it can go negative when you set max_capacity lower than the connection capacity already used.


Constructors

WorkerCapacity
WorkerCapacity()


WorkerCapacity
WorkerCapacity(WorkerCapacity other)

Parameters


Methods

Clone
WorkerCapacity Clone()


Equals
bool Equals(WorkerCapacity other)

Parameters

WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :

CalculateSize
int CalculateSize()


MergeFrom
void MergeFrom(WorkerCapacity other)

Parameters

MergeFrom
void MergeFrom(pb::CodedInputStream input)

Parameters
  • pb::CodedInputStream input :


Overrides

Equals
override bool Equals(object other)

Parameters
  • object other :

GetHashCode
override int GetHashCode()


ToString
override string ToString()

Updated 11 months ago


V1Beta1.WorkerCapacity Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.