Struct zircon_object::task::Job

pub struct Job { /* fields omitted */ }

Control a group of processes

SYNOPSIS

A job is a group of processes and possibly other (child) jobs. Jobs are used to track privileges to perform kernel operations (i.e., make various syscalls, with various options), and track and limit basic resource (e.g., memory, CPU) consumption. Every process belongs to a single job. Jobs can also be nested, and every job except the root job also belongs to a single (parent) job.

DESCRIPTION

A job is an object consisting of the following:

• a reference to a parent job
• a set of child jobs (each of whom has this job as parent)
• a set of member processes
• a set of policies

Jobs control “applications” that are composed of more than one process to be controlled as a single entity.

Implementations

impl Job

pub fn root() -> Arc<Self>

Create the root job.

pub fn create_child(self: &Arc<Self>) -> ZxResult<Arc<Self>>

Create a new child job object.

pub fn policy(&self) -> JobPolicy

Get the policy of the job.

pub fn parent(&self) -> Option<Arc<Self>>

Get the parent job.

pub fn set_policy_basic(
    &self,
    options: SetPolicyOptions,
    policies: &[BasicPolicy]
) -> ZxResult

Sets one or more security and/or resource policies to an empty job.

The job’s effective policies is the combination of the parent’s effective policies and the policies specified in policy.

After this call succeeds any new child process or child job will have the new effective policy applied to it.

pub fn set_policy_timer_slack(&self, policy: TimerSlackPolicy) -> ZxResult

Sets timer slack policy to an empty job.

pub fn get_info(&self) -> JobInfo

Get information of this job.

pub fn check_root_job(&self) -> ZxResult

Check whether this job is root job.

pub fn process_ids(&self) -> Vec<KoID>

Get KoIDs of Processes.

pub fn children_ids(&self) -> Vec<KoID>

Get KoIDs of children Jobs.

pub fn is_empty(&self) -> bool

Return true if this job has no processes and no child jobs.

Trait Implementations

impl Debug for Job

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

Formats the value using the given formatter.

impl Drop for Job

fn drop(&mut self)

Executes the destructor for this type.

impl KernelObject for Job

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 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 peer(&self) -> ZxResult<Arc<dyn KernelObject>>

Attempt to get the object’s peer.

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.

impl Task for Job

fn kill(&self)

Kill the job. The job do not terminate immediately when killed. It will terminate after all its children and processes are terminated.

fn suspend(&self)

Suspend the task. Currently only thread or process handles may be suspended.

fn resume(&self)

Resume the task

fn exceptionate(&self) -> Arc<Exceptionate>

Get the exceptionate.

fn debug_exceptionate(&self) -> Arc<Exceptionate>

Get the debug exceptionate.