Skip to content

Scheduler

[Source]

Provides functions that expose information about runtime schedulers.

primitive val Scheduler

Constructors

create

[Source]

new val create()
: Scheduler val^

Returns

Public Functions

schedulers

[Source]

Returns the maximum number of schedulers available to run actors.

fun box schedulers(
  auth: SchedulerInfoAuth val)
: U32 val

Parameters

Returns

active_schedulers

[Source]

Returns the number of schedulers currently available to run actors.

fun box active_schedulers(
  auth: SchedulerInfoAuth val)
: U32 val

Parameters

Returns

minimum_schedulers

[Source]

Returns the minimum number of schedulers. The active number of schedulers is guaranteed to never drop below this number.

fun box minimum_schedulers(
  auth: SchedulerInfoAuth val)
: U32 val

Parameters

Returns

sleeping_schedulers

[Source]

Returns the number of schedulers that are currently sleeping and not available run actors. Schedulers are put to sleep if there isn't enough work to keep all of the possible schedulers busy.

fun box sleeping_schedulers(
  auth: SchedulerInfoAuth val)
: U32 val

Parameters

Returns

scaling_is_active

[Source]

Returns true is scheduler scaling is on and the number of active schedulers can change while the program is running based on load.

fun box scaling_is_active(
  auth: SchedulerInfoAuth val)
: Bool val

Parameters

Returns

will_yield_cpu

[Source]

Returns true if schedulers without work will yield the CPU allowing other processes to have access.

fun box will_yield_cpu(
  auth: SchedulerInfoAuth val)
: Bool val

Parameters

Returns

scheduler_index

[Source]

Returns the index of the current scheduler thread

fun box scheduler_index(
  auth: SchedulerInfoAuth val)
: I32 val

Parameters

Returns

eq

[Source]

fun box eq(
  that: Scheduler val)
: Bool val

Parameters

Returns

ne

[Source]

fun box ne(
  that: Scheduler val)
: Bool val

Parameters

Returns