JobObjectCpuHardCap Struct

Represents the CPU rate control settings of a job object.

public readonly struct JobObjectCpuHardCap : IEquatable<JobObjectCpuHardCap>

Remarks

Only the members that belong to JobObjectCpuHardCap.Mode carry a meaningful value; the others are zero. Check JobObjectCpuHardCap.Mode before reading JobObjectCpuHardCap.Rate, JobObjectCpuHardCap.Weight, JobObjectCpuHardCap.MinRate or JobObjectCpuHardCap.MaxRate.

Implements

Properties

NameDescription
EnabledGets a value indicating whether CPU rate control is enabled for the job.
MaxRateGets the maximum portion of processor cycles the job may use, as a percentage times 100. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.MinMaxRate.
MinRateGets the minimum portion of processor cycles reserved for the job, as a percentage times 100. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.MinMaxRate.
ModeGets the CPU rate control policy the job is using.
RateGets the portion of processor cycles the job may use, as a percentage times 100. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.HardCap.
WeightGets the scheduling weight of the job, from 1 to 9. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.Weight.

Gets a value indicating whether CPU rate control is enabled for the job.

public bool Enabled { get; init; }

Property value

bool

Gets the maximum portion of processor cycles the job may use, as a percentage times 100. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.MinMaxRate.

public int MaxRate { get; init; }

Property value

int

Gets the minimum portion of processor cycles reserved for the job, as a percentage times 100. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.MinMaxRate.

public int MinRate { get; init; }

Property value

int

Gets the CPU rate control policy the job is using.

public JobObjectCpuRateControlMode Mode { get; init; }

Gets the portion of processor cycles the job may use, as a percentage times 100. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.HardCap.

public int Rate { get; init; }

Property value

int

Gets the scheduling weight of the job, from 1 to 9. Meaningful when JobObjectCpuHardCap.Mode is JobObjectCpuRateControlMode.Weight.

public int Weight { get; init; }

Property value

int

Methods

NameDescription
Equals(JobObjectCpuHardCap)
Equals(object)
GetHashCode()
ToString()

Equals overloads

Equals(JobObjectCpuHardCap)

public bool Equals(JobObjectCpuHardCap other)
Parameters
other JobObjectCpuHardCap
Returns

bool

No documentation is available.

Equals(object)

public override bool Equals(object obj)
Parameters
obj object
Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(JobObjectCpuHardCap, JobObjectCpuHardCap)
operator !=(JobObjectCpuHardCap, JobObjectCpuHardCap)

operator ==(JobObjectCpuHardCap, JobObjectCpuHardCap)

public static bool operator ==(JobObjectCpuHardCap left, JobObjectCpuHardCap right)

Parameters

left JobObjectCpuHardCap
right JobObjectCpuHardCap

Returns

bool

No documentation is available.

operator !=(JobObjectCpuHardCap, JobObjectCpuHardCap)

public static bool operator !=(JobObjectCpuHardCap left, JobObjectCpuHardCap right)

Parameters

left JobObjectCpuHardCap
right JobObjectCpuHardCap

Returns

bool

No documentation is available.