Struct TimerHandle 

pub struct TimerHandle(/* private fields */);

A timer handle.

This handle is used to interact with timers created by the driver implementation.

Implementations

impl TimerHandle

pub unsafe fn new( function: unsafe extern "C" fn(*mut c_void), data: *mut c_void, ) -> Self

Creates a new timer instance from the given callback.

Safety

• The callback and its data must be valid for the lifetime of the timer.
• The callback and its data need to be able to be sent across threads.

pub fn leak(self) -> TimerPtr

Converts this object into a pointer without dropping it.

pub unsafe fn from_ptr(ptr: TimerPtr) -> Self

Recovers the object from a leaked pointer.

Safety

• The caller must only use pointers created using Self::leak.
• The caller must ensure the pointer is not shared.

pub unsafe fn ref_from_ptr(ptr: &TimerPtr) -> &Self

Creates a reference to this object from a leaked pointer.

This function is used in the esp-radio code to interact with the timer.

Safety

• The caller must only use pointers created using Self::leak.

pub fn arm(&self, timeout: u64, periodic: bool)

Configures the timer to be triggered after the given timeout.

The timeout is specified in microsecond. If the timer is set to be periodic, the timer will be triggered with a constant frequency.

pub fn is_active(&self) -> bool

Checks if the timer is currently active.

pub fn disarm(&self)

Stops the timer.

Trait Implementations

impl Drop for TimerHandle

fn drop(&mut self)

Executes the destructor for this type.