Struct Scheduler

#[repr(C)]
pub struct Scheduler<'s> { /* private fields */ }

The scheduler impls.

Implementations

impl<'s> Scheduler<'s>

pub fn current<'current>() -> Option<&'current Self>

Get the current if has.

impl<'s> Scheduler<'s>

pub fn new(name: String, stack_size: usize) -> Self

Creates a new scheduler.

pub fn name(&self) -> &str

Get the name of this scheduler.

pub fn stack_size(&self) -> usize

Get the default stack size for the coroutines in this scheduler. If it has not been set, it will be crate::common::constants::DEFAULT_STACK_SIZE.

pub fn submit_co( &self, f: impl FnOnce(&Suspender<'_, (), ()>, ()) -> Option<usize> + 'static, stack_size: Option<usize>, priority: Option<c_longlong>, ) -> Result<String>

Submit a closure to create new coroutine, then the coroutine will be push into ready queue.

Allow multiple threads to concurrently submit coroutine to the scheduler, but only allow one thread to execute scheduling.

Errors

if create coroutine fails.

pub fn add_listener(&mut self, listener: impl Listener<(), Option<usize>> + 's)

Add a listener to this scheduler.

pub fn submit_raw_co(&self, co: SchedulableCoroutine<'s>) -> Result<String>

Submit a raw coroutine, then the coroutine will be push into ready queue.

Allow multiple threads to concurrently submit coroutine to the scheduler, but only allow one thread to execute scheduling.

pub fn try_resume(&self, co_name: &'s str)

Resume a coroutine from the syscall table to the ready queue, it’s generally only required for framework level crates.

If we can’t find the coroutine, nothing happens.

Errors

if change to ready fails.

pub fn try_schedule( &mut self, ) -> Result<HashMap<&str, Result<Option<usize>, &str>>>

Schedule the coroutines.

Allow multiple threads to concurrently submit coroutine to the scheduler, but only allow one thread to execute scheduling.

Errors

see try_timeout_schedule.

pub fn try_timed_schedule( &mut self, dur: Duration, ) -> Result<(u64, HashMap<&str, Result<Option<usize>, &str>>)>

Try scheduling the coroutines for up to dur.

Allow multiple threads to concurrently submit coroutine to the scheduler, but only allow one thread to execute scheduling.

Errors

see try_timeout_schedule.

pub fn try_timeout_schedule( &mut self, timeout_time: u64, ) -> Result<(u64, HashMap<&str, Result<Option<usize>, &str>>)>

Attempt to schedule the coroutines before the timeout_time timestamp.

Allow multiple threads to concurrently submit coroutine to the scheduler, but only allow one thread to schedule.

Returns the left time in ns.

Errors

if change to ready fails.

pub fn try_cancel_coroutine(co_name: &str)

Cancel the coroutine by name.

pub fn get_scheduling_thread(co_name: &str) -> Option<Pthread>

Get the scheduling thread of the coroutine.

Trait Implementations

impl<'s> Debug for Scheduler<'s>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Scheduler<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'s> Display for Scheduler<'s>

where Scheduler<'s>: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Scheduler<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'s> Hash for Scheduler<'s>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'s> Ord for Scheduler<'s>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'s> PartialEq for Scheduler<'s>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'s> PartialOrd for Scheduler<'s>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'s> Eq for Scheduler<'s>