Skip to main content

TimerHandle

Type Alias TimerHandle 

Source
pub type TimerHandle = *const c_void;
Expand description

FreeRTOS opaque handle types for OS primitives.

These handles are opaque pointers used to reference FreeRTOS objects. They should not be dereferenced directly; instead, use the safe wrappers provided by this crate (e.g., Thread, Queue, Semaphore, etc.).

§Handle Types

  • ThreadHandle: Handle to a FreeRTOS task/thread
  • QueueHandle: Handle to a message queue for inter-thread communication
  • SemaphoreHandle: Handle to a counting or binary semaphore
  • MutexHandle: Handle to a recursive mutex with priority inheritance
  • EventGroupHandle: Handle to an event group for multi-bit synchronization
  • TimerHandle: Handle to a software timer

§Safety

These are raw pointers to FreeRTOS internal structures. Always use the safe Rust wrappers instead of manipulating handles directly.

§Examples

use osal_rs::os::{Thread, types::ThreadHandle};

// Typically you get handles from wrapper constructors
let thread = Thread::new("worker", 2048, 5).unwrap();
// The handle is managed internally by the Thread wrapper

Opaque handle to a FreeRTOS timer