D++ (DPP)
C++ Discord API Bot Library
dpp::oneshot_timer Class Reference

Trigger a timed event once. The provided callback is called only once. More...

Public Member Functions

 oneshot_timer (class cluster *cl, uint64_t duration, timer_callback_t callback)
 Construct a new oneshot timer object. More...
 
timer get_handle ()
 Get the handle for the created one-shot timer. More...
 
void cancel ()
 Cancel the one shot timer immediately. Callback function is not called. More...
 
 ~oneshot_timer ()
 Destroy the oneshot timer object. More...
 

Detailed Description

Trigger a timed event once. The provided callback is called only once.

Constructor & Destructor Documentation

◆ oneshot_timer()

dpp::oneshot_timer::oneshot_timer ( class cluster cl,
uint64_t  duration,
timer_callback_t  callback 
)

Construct a new oneshot timer object.

Parameters
clcluster owner
durationduration before firing
callbackcallback to call on firing

◆ ~oneshot_timer()

dpp::oneshot_timer::~oneshot_timer ( )

Destroy the oneshot timer object.

Member Function Documentation

◆ cancel()

void dpp::oneshot_timer::cancel ( )

Cancel the one shot timer immediately. Callback function is not called.

◆ get_handle()

timer dpp::oneshot_timer::get_handle ( )

Get the handle for the created one-shot timer.

Returns
timer handle for use with stop_timer
D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0