API::Timer Class Reference

#include <Timer.h>

Classes
struct	TimerFunc

Public Member Functions
	Timer (const Timer &)=delete
	Timer (Timer &&)=delete
Timer &	operator= (const Timer &)=delete
Timer &	operator= (Timer &&)=delete
template<typename Func , typename... Args>
void	DelayExecute (const Func &callback, int delay, Args &&... args)
	Executes function after X seconds.
template<typename Func , typename... Args>
void	RecurringExecute (const Func &callback, int execution_interval, int execution_counter, bool async, Args &&... args)
	Executes function every X seconds.

Static Public Member Functions
static ARK_API Timer &	Get ()

Private Member Functions
	Timer ()
	~Timer ()
ARK_API void	DelayExecuteInternal (const std::function< void()> &callback, int delay_seconds)
ARK_API void	RecurringExecuteInternal (const std::function< void()> &callback, int execution_interval, int execution_counter, bool async)
void	Update ()

Private Attributes
std::vector< std::unique_ptr< TimerFunc > >	timer_funcs_

Detailed Description

Definition at line 10 of file Timer.h.

Constructor & Destructor Documentation

Timer() [1/3]

API::Timer::Timer ( const Timer &  )

delete

Timer() [2/3]

API::Timer::Timer ( Timer &&  )

delete

Timer() [3/3]

API::Timer::Timer ( )

private

Definition at line 7 of file Timer.cpp.

References API::game_api, and Update().

~Timer()

API::Timer::~Timer ( )

private

Definition at line 12 of file Timer.cpp.

References API::game_api.

Member Function Documentation

DelayExecute()

template<typename Func , typename... Args>

void API::Timer::DelayExecute ( const Func &  callback, int  delay, Args &&...  args  )

inline

Executes function after X seconds.

Template Parameters

Func	Callback function type
Args	Callback arguments types

Parameters

callback	Callback function
delay	Delay in seconds
args	Callback arguments

Definition at line 29 of file Timer.h.

References callback, and DelayExecuteInternal().

DelayExecuteInternal()

void API::Timer::DelayExecuteInternal ( const std::function< void()> &  callback, int  delay_seconds  )

private

Definition at line 23 of file Timer.cpp.

References callback, and timer_funcs_.

Referenced by DelayExecute().

Get()

Timer & API::Timer::Get ( )

static

Definition at line 17 of file Timer.cpp.

operator=() [1/2]

Timer & API::Timer::operator= ( const Timer &  )

delete

operator=() [2/2]

Timer & API::Timer::operator= ( Timer &&  )

delete

RecurringExecute()

template<typename Func , typename... Args>

void API::Timer::RecurringExecute ( const Func &  callback, int  execution_interval, int  execution_counter, bool  async, Args &&...  args  )

inline

Executes function every X seconds.

Template Parameters

Func	Callback function type
Args	Callback arguments types

Parameters

callback	Callback function
execution_interval	Delay between executions in seconds
execution_counter	Amount of times to execute function, -1 for unlimited
async	If true, function will be executed in the new thread
args	Callback arguments

Definition at line 45 of file Timer.h.

References callback, and RecurringExecuteInternal().

RecurringExecuteInternal()

void API::Timer::RecurringExecuteInternal ( const std::function< void()> &  callback, int  execution_interval, int  execution_counter, bool  async  )

private

Definition at line 31 of file Timer.cpp.

References callback, and timer_funcs_.

Referenced by RecurringExecute().

Update()

void API::Timer::Update ( )

private

Definition at line 62 of file Timer.cpp.

References timer_funcs_.

Referenced by Timer().

Member Data Documentation

timer_funcs_

std::vector<std::unique_ptr<TimerFunc> > API::Timer::timer_funcs_

private

Definition at line 82 of file Timer.h.

Referenced by DelayExecuteInternal(), RecurringExecuteInternal(), and Update().

---

The documentation for this class was generated from the following files:

• H:/ArkServerAPI/version/Core/Public/Timer.h
• H:/ArkServerAPI/version/Core/Private/Tools/Timer.cpp