Struct kernel::deferred_call::DeferredCall

pub struct DeferredCall { /* private fields */ }

Implementations

impl DeferredCall

pub fn new() -> Self

Create a new deferred call with a unique ID.

pub fn register<DC: DeferredCallClient>(&self, client: &'static DC)

This function registers the passed client with this deferred call, such that calls to DeferredCall::set() will schedule a callback on the handle_deferred_call() method of the passed client.

pub fn set(&self)

Schedule a deferred callback on the client associated with this deferred call.

pub fn is_pending(&self) -> bool

Check if a deferred callback has been set and not yet serviced on this deferred call.

pub fn service_next_pending() -> Option<usize>

Services and clears the next pending DeferredCall, returns which index was serviced.

pub fn has_tasks() -> bool

Returns true if any deferred calls are waiting to be serviced, false otherwise.

pub fn verify_setup()

This function should be called at the beginning of the kernel loop to verify that deferred calls have been correctly initialized. This function verifies two things:

1. That <= [DEFCALLS.len()] deferred calls have been created, which is the maximum this interface supports.

2. That exactly as many deferred calls were registered as were created, which helps to catch bugs if board maintainers forget to call register() on a created DeferredCall.

Neither of these checks are necessary for soundness, but they are necessary for confirming that DeferredCalls will actually be delivered as expected. This function costs about 300 bytes, so you can remove it if you are confident your setup will not exceed 32 deferred calls, and that all of your components register their deferred calls.