Struct WaitOpts 

pub struct WaitOpts {
    pub timeout: Duration,
    pub poll_interval: Duration,
    pub stall_grace: Duration,
}

How long to wait and how often to poll.

Fields

timeout: Duration

The client-side deadline.

poll_interval: Duration

The gap between polls.

stall_grace: Duration

How long CREATING is tolerated before the stall probe runs (TRAP-2).

Only meaningful for the image wait; the launch wait has no equivalent, because a launch has no build list to probe.

Implementations

impl WaitOpts

pub fn for_launch() -> WaitOpts

Options for the launch wait: crate::sandbox::DEFAULT_LIFECYCLE_TIMEOUT at crate::sandbox::LIFECYCLE_POLL_INTERVAL, five minutes at five-second polls.

pub fn for_lifecycle(timeout: Duration) -> WaitOpts

Options for a lifecycle wait (a launch, suspend, resume or terminate) with the caller’s deadline: core’s crate::sandbox::LIFECYCLE_POLL_INTERVAL, and no stall probe.

Every surface’s lifecycle wait starts here, so what a lifecycle wait is lives in one place (#266); a caller that polls at another rate sets poll_interval on the result. stall_grace is set past any deadline rather than to zero, since a zero grace would read as “probe immediately”, and a lifecycle transition has no build list to probe (TRAP-2 is the image build’s).

Trait Implementations

impl Clone for WaitOpts

fn clone(&self) -> WaitOpts

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for WaitOpts

impl Debug for WaitOpts

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

Formats the value using the given formatter.

impl Default for WaitOpts

fn default() -> WaitOpts

Returns the “default value” for a type.