Struct windows_win::raw::timer::TimerQueue

pub struct TimerQueue { /* fields omitted */ }

Queue for timer

By default Drop implementation deletes timer without waiting for queue to finish currently executing callbacks. If you want to wait then you can use delete method.

Alternatively you can use default system queue by accessing DEFAULT_TIMER_QUEUE In this case it is impossible to delete queue and delete always returns Ok

Methods

impl TimerQueue

pub fn new() -> Result<Self>

Creates new instance of queue

pub fn delete<T: CompleteEvent>(self, _event: T) -> Result<()>

Deletes queue and consumes it.

Note that it invalidates all timers produced by it.

pub fn timer(
    &self,
    cb: WAITORTIMERCALLBACK,
    param: *mut c_void,
    due_time: c_ulong,
    period: c_ulong,
    flags: TimerFlags
) -> Result<QueueTimer>

Creates new timer on queue.

Parameters

• cb - C function to be executed.
• param - Pointer to callback parameter.
• due_time - The amount of time in milliseconds relative to the current time that must elapse before the timer is signaled for the first time.
• period - The period of the timer, in milliseconds. If this parameter is zero, the timer is signaled once. If this parameter is greater than zero, the timer is periodic. A periodic timer automatically reactivates each time the period elapses, until the timer is canceled.
• flags - Timer flags

Trait Implementations

impl Drop for TimerQueue

fn drop(&mut self)

Executes the destructor for this type.

impl Default for TimerQueue

fn default() -> Self

Returns the "default value" for a type.

impl Sync for TimerQueue

impl Send for TimerQueue