ReXGlue SDK
Loading...
Searching...
No Matches
rex::platform::TimerQueueWaitItem Struct Reference

#include <rex/platform/timer.h>

Public Types

using clock = std::chrono::steady_clock

Public Member Functions

 TimerQueueWaitItem (std::function< void(void *)> callback, void *userdata, TimerQueue *parent_queue, clock::time_point due, clock::duration interval)
void Disarm ()

Public Attributes

friend TimerQueue

Detailed Description

Pending timer in the process timer queue.

Constructor & Destructor Documentation

◆ TimerQueueWaitItem()

rex::platform::TimerQueueWaitItem::TimerQueueWaitItem ( std::function< void(void *)> callback,
void * userdata,
TimerQueue * parent_queue,
clock::time_point due,
clock::duration interval )
inline

Creates a wait item. Use QueueTimerOnce or QueueTimerRecurring instead.

Parameters
callbackFunction called on the dispatch thread.
parent_queueQueue that owns the item.
intervalRepeat interval, 0 for a single run.

Member Function Documentation

◆ Disarm()

void rex::platform::TimerQueueWaitItem::Disarm ( )

Cancels the item. No callback runs after it returns. Blocks while the callback runs unless called from that callback. Holding a lock the callback also takes can deadlock.


The documentation for this struct was generated from the following file: