Struct zircon_object::task::SuspendToken

pub struct SuspendToken { /* fields omitted */ }

Suspend the given task.

Currently only thread or process handles may be suspended.

Example

let job = Job::root();
let proc = Process::create(&job, "proc").unwrap();
let thread = Thread::create(&proc, "thread").unwrap();

// start the thread and never terminate
thread.start(0, 0, 0, 0, |thread| Box::pin(async move {
    loop { async_std::task::yield_now().await }
    let _ = thread;
})).unwrap();

// wait for the thread running
let object: Arc<dyn KernelObject> = thread.clone();
async_std::task::block_on(object.wait_signal(Signal::THREAD_RUNNING));
assert_eq!(thread.state(), ThreadState::Running);

// suspend the thread
{
    let task: Arc<dyn Task> = thread.clone();
    let suspend_token = SuspendToken::create(&task);
    assert_eq!(thread.state(), ThreadState::Suspended);
}
// suspend token dropped, resume the thread
assert_eq!(thread.state(), ThreadState::Running);

Implementations

impl SuspendToken

pub fn create(task: &Arc<dyn Task>) -> Arc<Self>

Create a SuspendToken which can suspend the given task.

Trait Implementations

impl Debug for SuspendToken

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

Formats the value using the given formatter.

impl Drop for SuspendToken

fn drop(&mut self)

Executes the destructor for this type.

impl KernelObject for SuspendToken

fn id(&self) -> KoID

Get object’s KoID.

fn type_name(&self) -> &str

Get the name of the type of the kernel object.

fn name(&self) -> String

Get object’s name.

fn set_name(&self, name: &str)

Set object’s name.

fn signal(&self) -> Signal

Get the signal status.

fn signal_set(&self, signal: Signal)

Assert signal.

fn signal_clear(&self, signal: Signal)

Deassert signal.

fn signal_change(&self, clear: Signal, set: Signal)

Change signal status: first clear then set indicated bits.

fn add_signal_callback(&self, callback: SignalHandler)

Add callback for signal status changes.

fn get_child(&self, _id: KoID) -> ZxResult<Arc<dyn KernelObject>>

Attempt to find a child of the object with given KoID.

fn peer(&self) -> ZxResult<Arc<dyn KernelObject>>

Attempt to get the object’s peer.

fn related_koid(&self) -> KoID

If the object is related to another (such as the other end of a channel, or the parent of a job), returns the KoID of that object, otherwise returns zero.

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.