dpp::oneshot_timer Class Reference

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

#include <timer.h>

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

cl	cluster owner
duration	duration before firing
callback	callback 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