TaskScheduler Class Reference

#include "TaskScheduler.h"

Classes
struct	Compare
	Container which provides Task order, insert and reschedule operations. More...
class	Task
class	TaskQueue

Public Member Functions
	TaskScheduler ()
template<typename P >
	TaskScheduler (P &&predicate)
	TaskScheduler (TaskScheduler const &)=delete
	TaskScheduler (TaskScheduler &&)=delete
TaskScheduler &	operator= (TaskScheduler const &)=delete
TaskScheduler &	operator= (TaskScheduler &&)=delete
template<typename P >
TaskScheduler &	SetValidator (P &&predicate)
	Sets a validator which is asked if tasks are allowed to be executed.
TaskScheduler &	ClearValidator ()
	Clears the validator which is asked if tasks are allowed to be executed.
TaskScheduler &	Update (success_t const &callback=EmptyCallback)
TaskScheduler &	Update (size_t const milliseconds, success_t const &callback=EmptyCallback)
template<class _Rep , class _Period >
TaskScheduler &	Update (std::chrono::duration< _Rep, _Period > const &difftime, success_t const &callback=EmptyCallback)
TaskScheduler &	Async (std::function< void()> const &callable)
template<class _Rep , class _Period >
TaskScheduler &	Schedule (std::chrono::duration< _Rep, _Period > const &time, task_handler_t const &task)
template<class _Rep , class _Period >
TaskScheduler &	Schedule (std::chrono::duration< _Rep, _Period > const &time, group_t const group, task_handler_t const &task)
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
TaskScheduler &	Schedule (std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max, task_handler_t const &task)
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
TaskScheduler &	Schedule (std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max, group_t const group, task_handler_t const &task)
TaskScheduler &	CancelAll ()
TaskScheduler &	CancelGroup (group_t const group)
TaskScheduler &	CancelGroupsOf (std::vector< group_t > const &groups)
template<class _Rep , class _Period >
TaskScheduler &	DelayAll (std::chrono::duration< _Rep, _Period > const &duration)
	Delays all tasks with the given duration.
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
TaskScheduler &	DelayAll (std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max)
	Delays all tasks with a random duration between min and max.
template<class _Rep , class _Period >
TaskScheduler &	DelayGroup (group_t const group, std::chrono::duration< _Rep, _Period > const &duration)
	Delays all tasks of a group with the given duration.
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
TaskScheduler &	DelayGroup (group_t const group, std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max)
	Delays all tasks of a group with a random duration between min and max.
template<class _Rep , class _Period >
TaskScheduler &	RescheduleAll (std::chrono::duration< _Rep, _Period > const &duration)
	Reschedule all tasks with a given duration.
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
TaskScheduler &	RescheduleAll (std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max)
	Reschedule all tasks with a random duration between min and max.
template<class _Rep , class _Period >
TaskScheduler &	RescheduleGroup (group_t const group, std::chrono::duration< _Rep, _Period > const &duration)
	Reschedule all tasks of a group with the given duration.
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
TaskScheduler &	RescheduleGroup (group_t const group, std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max)
	Reschedule all tasks of a group with a random duration between min and max.

Private Types
typedef std::chrono::steady_clock	clock_t
typedef clock_t::time_point	timepoint_t
typedef clock_t::duration	duration_t
typedef uint32	group_t
typedef uint32	repeated_t
typedef std::function< void(TaskContext)>	task_handler_t
typedef std::function< bool()>	predicate_t
typedef std::function< void()>	success_t
typedef std::shared_ptr< Task >	TaskContainer
typedef std::queue< std::function< void()> >	AsyncHolder

Private Member Functions
TaskScheduler &	InsertTask (TaskContainer task)
	Insert a new task to the enqueued tasks.
template<class _Rep , class _Period >
TaskScheduler &	ScheduleAt (timepoint_t const &end, std::chrono::duration< _Rep, _Period > const &time, task_handler_t const &task)
template<class _Rep , class _Period >
TaskScheduler &	ScheduleAt (timepoint_t const &end, std::chrono::duration< _Rep, _Period > const &time, group_t const group, task_handler_t const &task)
void	Dispatch (success_t const &callback)
	Dispatch remaining tasks.

Static Private Member Functions
static bool	EmptyValidator ()
static void	EmptyCallback ()
template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >
static std::chrono::milliseconds	RandomDurationBetween (std::chrono::duration< _RepLeft, _PeriodLeft > const &min, std::chrono::duration< _RepRight, _PeriodRight > const &max)

Private Attributes
std::shared_ptr< TaskScheduler >	self_reference
	Contains a self reference to track if this object was deleted or not.
timepoint_t	_now
	The current time point (now)
TaskQueue	_task_holder
	The Task Queue which contains all task objects.
AsyncHolder	_asyncHolder
predicate_t	_predicate

Friends
class	TaskContext

Detailed Description

The TaskScheduler class provides the ability to schedule std::function's in the near future. Use TaskScheduler::Update to update the scheduler. Popular methods are:

• Schedule (Schedules a std::function which will be executed in the near future).
• Schedules an asynchronous function which will be executed at the next update tick.
• Cancel, Delay & Reschedule (Methods to manipulate already scheduled tasks). Tasks are organized in groups (uint), multiple tasks can have the same group id, you can provide a group or not, but keep in mind that you can only manipulate specific tasks through its group id! Tasks callbacks use the function signature void(TaskContext) where TaskContext provides access to the function schedule plan which makes it possible to repeat the task with the same duration or a new one. It also provides access to the repeat counter which is useful for task that repeat itself often but behave different every time (spoken event dialogs for example).

Member Typedef Documentation

AsyncHolder

typedef std::queue<std::function<void()> > TaskScheduler::AsyncHolder

private

clock_t

typedef std::chrono::steady_clock TaskScheduler::clock_t

private

duration_t

typedef clock_t::duration TaskScheduler::duration_t

private

group_t

typedef uint32 TaskScheduler::group_t

private

predicate_t

typedef std::function<bool()> TaskScheduler::predicate_t

private

repeated_t

typedef uint32 TaskScheduler::repeated_t

private

success_t

typedef std::function<void()> TaskScheduler::success_t

private

task_handler_t

typedef std::function<void(TaskContext)> TaskScheduler::task_handler_t

private

TaskContainer

typedef std::shared_ptr<Task> TaskScheduler::TaskContainer

private

timepoint_t

typedef clock_t::time_point TaskScheduler::timepoint_t

private

Constructor & Destructor Documentation

TaskScheduler() [1/4]

TaskScheduler::TaskScheduler ( )

inline

        : self_reference(this, [](TaskScheduler const*) { }), _now(clock_t::now()), _predicate(EmptyValidator) { }

TaskScheduler() [2/4]

template<typename P >

TaskScheduler::TaskScheduler ( P &&  predicate )

inline

        : self_reference(this, [](TaskScheduler const*) { }), _now(clock_t::now()), _predicate(std::forward<P>(predicate)) { }

TaskScheduler() [3/4]

TaskScheduler::TaskScheduler ( TaskScheduler const &  )

delete

TaskScheduler() [4/4]

TaskScheduler::TaskScheduler ( TaskScheduler &&  )

delete

Member Function Documentation

Async()

TaskScheduler & TaskScheduler::Async

(

std::function< void()> const &

callable

)

Schedule an callable function that is executed at the next update tick. Its safe to modify the TaskScheduler from within the callable.

{
    _asyncHolder.push(callable);
    return *this;
}

References _asyncHolder.

Referenced by TaskContext::Async().

CancelAll()

TaskScheduler & TaskScheduler::CancelAll

(

)

Cancels all tasks. Never call this from within a task context! Use TaskContext::CancelAll instead!

Clear the task holder

{
    _task_holder.Clear();
    _asyncHolder = AsyncHolder();
    return *this;
}

References _asyncHolder, _task_holder, and TaskScheduler::TaskQueue::Clear().

Referenced by BossAI::_JustDied(), BossAI::_Reset(), TaskContext::CancelAll(), instance_the_black_morass::instance_the_black_morass_InstanceMapScript::CleanupInstance(), boss_bug_trio::DamageTaken(), npc_drakonid_spawner::DoAction(), boss_twinemperorsAI::EnterEvadeMode(), boss_glob_of_viscidus::InitializeAI(), boss_thekal::boss_thekalAI::JustEngagedWith(), npc_anubisath_guardian::JustEngagedWith(), npc_ahnqiraji_critter::JustEngagedWith(), boss_high_botanist_freywinn::JustEngagedWith(), boss_jindo::JustEngagedWith(), boss_fankriss::JustEngagedWith(), instance_ruins_of_ahnqiraj::instance_ruins_of_ahnqiraj_InstanceMapScript::OnUnitDeath(), boss_mor_grayhoof::Reset(), npc_corrupted_totem::Reset(), npc_lava_spawn::Reset(), boss_kormok::Reset(), npc_apothecary_baxter::Reset(), boss_baroness_anastari::boss_baroness_anastariAI::Reset(), boss_jarien::Reset(), boss_sothos::Reset(), boss_twilight_corrupter::Reset(), npc_batrider::Reset(), npc_healing_ward::Reset(), npc_shade_of_jindo::Reset(), npc_ohgan::npc_ohganAI::Reset(), npc_vilebranch_speaker::Reset(), npc_spawn_of_marli::Reset(), npc_zealot_lorkhan::npc_zealot_lorkhanAI::Reset(), npc_zealot_zath::npc_zealot_zathAI::Reset(), boss_azuregos::boss_azuregosAI::Reset(), boss_isalien::Reset(), boss_ayamiss::Reset(), npc_hivezara_stinger::Reset(), npc_obsidian_destroyer::Reset(), boss_bug_trio::Reset(), boss_eye_of_cthun::Reset(), boss_cthun::Reset(), boss_fankriss::Reset(), boss_ouro::Reset(), boss_viscidus::Reset(), npc_anubisath_defender::Reset(), npc_vekniss_stinger::Reset(), npc_obsidian_eradicator::Reset(), npc_anubisath_warder::Reset(), npc_obsidian_nullifier::Reset(), npc_ahnqiraji_critter::Reset(), npc_steamrigger_mechanic::Reset(), boss_hungarfen::Reset(), npc_raliq_the_drunk::npc_raliq_the_drunkAI::Reset(), instance_ruins_of_ahnqiraj::instance_ruins_of_ahnqiraj_InstanceMapScript::ResetRajaxxWaves(), npc_dream_fog::npc_dream_fogAI::ScheduleEvents(), World::ShutdownServ(), boss_attumen::boss_attumenAI::SpellHit(), and boss_cthun::SummonedCreatureDies().

CancelGroup()

TaskScheduler & TaskScheduler::CancelGroup

(

group_t const

group

)

Cancel all tasks of a single group. Never call this from within a task context! Use TaskContext::CancelGroup instead!

{
    _task_holder.RemoveIf([group](TaskContainer const & task) -> bool
    {
        return task->IsInGroup(group);
    });
    return *this;
}

References _task_holder, and TaskScheduler::TaskQueue::RemoveIf().

Referenced by TaskContext::CancelGroup(), CancelGroupsOf(), boss_mor_grayhoof::DamageTaken(), boss_malchezaar::DamageTaken(), boss_ayamiss::DamageTaken(), boss_ouro::DamageTaken(), boss_twinemperorsAI::DoAction(), instance_the_black_morass::instance_the_black_morass_InstanceMapScript::ScheduleNextPortal(), instance_ruins_of_ahnqiraj::instance_ruins_of_ahnqiraj_InstanceMapScript::SetData(), and boss_ouro::Submerge().

CancelGroupsOf()

TaskScheduler & TaskScheduler::CancelGroupsOf

(

std::vector< group_t > const &

groups

)

Cancels all groups in the given std::vector. Hint: Use std::initializer_list for this: "{1, 2, 3, 4}"

{
    std::for_each(groups.begin(), groups.end(),
                  std::bind(&TaskScheduler::CancelGroup, this, std::placeholders::_1));
 
    return *this;
}

References CancelGroup().

Referenced by TaskContext::CancelGroupsOf().

ClearValidator()

TaskScheduler & TaskScheduler::ClearValidator

(

)

Clears the validator which is asked if tasks are allowed to be executed.

{
    _predicate = EmptyValidator;
    return *this;
}

References _predicate, and EmptyValidator().

DelayAll() [1/2]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::DelayAll ( std::chrono::duration< _Rep, _Period > const &  duration )

inline

Delays all tasks with the given duration.

    {
        _task_holder.ModifyIf([&duration](TaskContainer const & task) -> bool
        {
            task->_end += duration;
            return true;
        });
        return *this;
    }

References _task_holder, and TaskScheduler::TaskQueue::ModifyIf().

Referenced by boss_hungarfen::DamageTaken(), DelayAll(), boss_bug_trio::DoAction(), and boss_twinemperorsAI::DoAction().

DelayAll() [2/2]

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

TaskScheduler & TaskScheduler::DelayAll ( std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max  )

inline

Delays all tasks with a random duration between min and max.

    {
        return DelayAll(RandomDurationBetween(min, max));
    }

References DelayAll(), and RandomDurationBetween().

DelayGroup() [1/2]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::DelayGroup ( group_t const  group, std::chrono::duration< _Rep, _Period > const &  duration  )

inline

Delays all tasks of a group with the given duration.

    {
        _task_holder.ModifyIf([&duration, group](TaskContainer const & task) -> bool
        {
            if (task->IsInGroup(group))
            {
                task->_end += duration;
                return true;
            }
            else
            {
                return false;
            }
        });
        return *this;
    }

References _task_holder, and TaskScheduler::TaskQueue::ModifyIf().

Referenced by boss_mor_grayhoof::DamageTaken(), DelayGroup(), and boss_malchezaar::JustEngagedWith().

DelayGroup() [2/2]

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

TaskScheduler & TaskScheduler::DelayGroup ( group_t const  group, std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max  )

inline

Delays all tasks of a group with a random duration between min and max.

    {
        return DelayGroup(group, RandomDurationBetween(min, max));
    }

References DelayGroup(), and RandomDurationBetween().

Dispatch()

void TaskScheduler::Dispatch ( success_t const &  callback )

private

Dispatch remaining tasks.

{
    // If the validation failed abort the dispatching here.
    if (!_predicate())
    {
        return;
    }
 
    // Process all asyncs
    while (!_asyncHolder.empty())
    {
        _asyncHolder.front()();
        _asyncHolder.pop();
 
        // If the validation failed abort the dispatching here.
        if (!_predicate())
        {
            return;
        }
    }
 
    while (!_task_holder.IsEmpty())
    {
        if (_task_holder.First()->_end > _now)
        {
            break;
        }
 
        // Perfect forward the context to the handler
        // Use weak references to catch destruction before callbacks.
        TaskContext context(_task_holder.Pop(), std::weak_ptr<TaskScheduler>(self_reference));
 
        // Invoke the context
        context.Invoke();
 
        // If the validation failed abort the dispatching here.
        if (!_predicate())
        {
            return;
        }
    }
 
    // On finish call the final callback
    callback();
}

References _asyncHolder, _now, _predicate, _task_holder, TaskScheduler::TaskQueue::First(), TaskContext::Invoke(), TaskScheduler::TaskQueue::IsEmpty(), TaskScheduler::TaskQueue::Pop(), and self_reference.

Referenced by TaskContext::Async(), TaskContext::CancelAll(), TaskContext::CancelGroup(), TaskContext::CancelGroupsOf(), and Update().

EmptyCallback()

static void TaskScheduler::EmptyCallback ( )

inlinestaticprivate

    {
    }

EmptyValidator()

static bool TaskScheduler::EmptyValidator ( )

inlinestaticprivate

    {
        return true;
    }

Referenced by ClearValidator().

InsertTask()

TaskScheduler & TaskScheduler::InsertTask ( TaskContainer  task )

private

Insert a new task to the enqueued tasks.

{
    _task_holder.Push(std::move(task));
    return *this;
}

References _task_holder, and TaskScheduler::TaskQueue::Push().

Referenced by TaskContext::Repeat(), and ScheduleAt().

operator=() [1/2]

TaskScheduler & TaskScheduler::operator= ( TaskScheduler &&  )

delete

operator=() [2/2]

TaskScheduler & TaskScheduler::operator= ( TaskScheduler const &  )

delete

RandomDurationBetween()

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

static std::chrono::milliseconds TaskScheduler::RandomDurationBetween ( std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max  )

inlinestaticprivate

    {
        auto const milli_min = std::chrono::duration_cast<std::chrono::milliseconds>(min);
        auto const milli_max = std::chrono::duration_cast<std::chrono::milliseconds>(max);
 
        // TC specific: use SFMT URandom
        return std::chrono::milliseconds(urand(uint32(milli_min.count()), uint32(milli_max.count())));
    }

References urand().

Referenced by DelayAll(), TaskContext::DelayAll(), DelayGroup(), TaskContext::DelayGroup(), TaskContext::Repeat(), RescheduleAll(), TaskContext::RescheduleAll(), RescheduleGroup(), TaskContext::RescheduleGroup(), Schedule(), and TaskContext::Schedule().

RescheduleAll() [1/2]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::RescheduleAll ( std::chrono::duration< _Rep, _Period > const &  duration )

inline

Reschedule all tasks with a given duration.

    {
        auto const end = _now + duration;
        _task_holder.ModifyIf([end](TaskContainer const & task) -> bool
        {
            task->_end = end;
            return true;
        });
        return *this;
    }

References _now, _task_holder, and TaskScheduler::TaskQueue::ModifyIf().

Referenced by TaskContext::RescheduleAll(), and RescheduleAll().

RescheduleAll() [2/2]

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

TaskScheduler & TaskScheduler::RescheduleAll ( std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max  )

inline

Reschedule all tasks with a random duration between min and max.

    {
        return RescheduleAll(RandomDurationBetween(min, max));
    }

References RandomDurationBetween(), and RescheduleAll().

RescheduleGroup() [1/2]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::RescheduleGroup ( group_t const  group, std::chrono::duration< _Rep, _Period > const &  duration  )

inline

Reschedule all tasks of a group with the given duration.

    {
        auto const end = _now + duration;
        _task_holder.ModifyIf([end, group](TaskContainer const & task) -> bool
        {
            if (task->IsInGroup(group))
            {
                task->_end = end;
                return true;
            }
            else
            {
                return false;
            }
        });
        return *this;
    }

References _now, _task_holder, and TaskScheduler::TaskQueue::ModifyIf().

Referenced by RescheduleGroup().

RescheduleGroup() [2/2]

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

TaskScheduler & TaskScheduler::RescheduleGroup ( group_t const  group, std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max  )

inline

Reschedule all tasks of a group with a random duration between min and max.

    {
        return RescheduleGroup(group, RandomDurationBetween(min, max));
    }

References RandomDurationBetween(), and RescheduleGroup().

Schedule() [1/4]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::Schedule ( std::chrono::duration< _Rep, _Period > const &  time, group_t const  group, task_handler_t const &  task  )

inline

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::Schedule instead!

    {
        return ScheduleAt(_now, time, group, task);
    }

References _now, and ScheduleAt().

Schedule() [2/4]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::Schedule ( std::chrono::duration< _Rep, _Period > const &  time, task_handler_t const &  task  )

inline

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::Schedule instead!

    {
        return ScheduleAt(_now, time, task);
    }

References _now, and ScheduleAt().

Referenced by boss_mor_grayhoof::CastRandomSpell(), boss_thekal::boss_thekalAI::CheckPhaseTransition(), boss_mor_grayhoof::DamageTaken(), boss_isalien::DamageTaken(), boss_malchezaar::DamageTaken(), boss_ouro::DamageTaken(), boss_hungarfen::DamageTaken(), boss_viscidus::DamageTaken(), boss_apothecary_hummel::boss_apothecary_hummelAI::DoAction(), boss_twinemperorsAI::DoAction(), npc_thrall_warchief::npc_thrall_warchiefAI::DoAction(), boss_broggok::DoAction(), boss_ouro::Emerge(), boss_jindo::EnterEvadeMode(), boss_glob_of_viscidus::InitializeAI(), npc_underbog_mushroom::InitializeAI(), npc_corrupted_totem::IsSummonedBy(), boss_kormok::IsSummonedBy(), boss_jarien::IsSummonedBy(), boss_sothos::IsSummonedBy(), npc_drakonid_spawner::IsSummonedBy(), boss_attumen::boss_attumenAI::IsSummonedBy(), boss_mor_grayhoof::JustEngagedWith(), npc_lava_spawn::JustEngagedWith(), boss_malchezaar::JustEngagedWith(), npc_malchezaar_axe::JustEngagedWith(), boss_kormok::JustEngagedWith(), boss_baroness_anastari::boss_baroness_anastariAI::JustEngagedWith(), boss_jarien::JustEngagedWith(), boss_sothos::JustEngagedWith(), boss_twilight_corrupter::JustEngagedWith(), npc_batrider::JustEngagedWith(), npc_vilebranch_speaker::JustEngagedWith(), npc_spawn_of_marli::JustEngagedWith(), boss_thekal::boss_thekalAI::JustEngagedWith(), npc_zealot_lorkhan::npc_zealot_lorkhanAI::JustEngagedWith(), npc_zealot_zath::npc_zealot_zathAI::JustEngagedWith(), npc_hallows_end_soh::JustEngagedWith(), boss_azuregos::boss_azuregosAI::JustEngagedWith(), boss_aeonus::JustEngagedWith(), boss_chrono_lord_deja::JustEngagedWith(), boss_temporus::JustEngagedWith(), boss_isalien::JustEngagedWith(), npc_anubisath_guardian::JustEngagedWith(), npc_obsidian_destroyer::JustEngagedWith(), npc_claw_tentacle::JustEngagedWith(), npc_dirt_mound::JustEngagedWith(), npc_anubisath_defender::JustEngagedWith(), npc_obsidian_eradicator::JustEngagedWith(), npc_anubisath_warder::JustEngagedWith(), npc_obsidian_nullifier::JustEngagedWith(), npc_ahnqiraji_critter::JustEngagedWith(), boss_talon_king_ikiss::JustEngagedWith(), boss_dalliah_the_doomsayer::JustEngagedWith(), boss_zereketh_the_unbound::JustEngagedWith(), boss_commander_sarannis::JustEngagedWith(), boss_high_botanist_freywinn::JustEngagedWith(), boss_laj::JustEngagedWith(), boss_thorngrin_the_tender::JustEngagedWith(), boss_warp_splinter::JustEngagedWith(), npc_raliq_the_drunk::npc_raliq_the_drunkAI::JustEngagedWith(), npc_steamrigger_mechanic::JustEngagedWith(), boss_midnight::boss_midnightAI::JustEngagedWith(), npc_ohgan::npc_ohganAI::JustEngagedWith(), npc_hivezara_stinger::JustEngagedWith(), boss_kri::JustEngagedWith(), boss_vem::JustEngagedWith(), boss_yauj::JustEngagedWith(), boss_fankriss::JustEngagedWith(), boss_twinemperorsAI::JustEngagedWith(), boss_veknilash::JustEngagedWith(), boss_veklor::JustEngagedWith(), npc_vekniss_stinger::JustEngagedWith(), boss_hungarfen::JustEngagedWith(), boss_ayamiss::MovementInform(), boss_bug_trio::MovementInform(), instance_ruins_of_ahnqiraj::instance_ruins_of_ahnqiraj_InstanceMapScript::OnUnitDeath(), instance_temple_of_ahnqiraj::instance_temple_of_ahnqiraj_InstanceMapScript::OnUnitDeath(), npc_apothecary_baxter::Reset(), go_direbrew_mole_machine::go_direbrew_mole_machineAI::Reset(), go_sand_trap::Reset(), npc_eye_tentacle::Reset(), npc_claw_tentacle::Reset(), npc_giant_claw_tentacle::Reset(), npc_giant_eye_tentacle::Reset(), npc_ahnqiraji_critter::Reset(), npc_raliq_the_drunk::npc_raliq_the_drunkAI::Reset(), Schedule(), npc_dream_fog::npc_dream_fogAI::ScheduleEvents(), instance_the_black_morass::instance_the_black_morass_InstanceMapScript::ScheduleNextPortal(), boss_baroness_anastari::boss_baroness_anastariAI::SchedulePossession(), boss_commander_sarannis::ScheduleReinforcements(), boss_eye_of_cthun::ScheduleTask(), npc_giant_claw_tentacle::ScheduleTasks(), boss_attumen::boss_attumenAI::ScheduleTasks(), boss_ayamiss::ScheduleTasks(), boss_cthun::ScheduleTasks(), instance_the_black_morass::instance_the_black_morass_InstanceMapScript::SetBossState(), instance_ruins_of_ahnqiraj::instance_ruins_of_ahnqiraj_InstanceMapScript::SetData(), boss_thekal::boss_thekalAI::SetData(), World::ShutdownServ(), npc_netherspite_infernal::SpellHit(), boss_attumen::boss_attumenAI::SpellHit(), boss_cthun::SummonedCreatureDies(), and npc_drakonid_spawner::SummonedCreatureDies().

Schedule() [3/4]

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

TaskScheduler & TaskScheduler::Schedule ( std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max, group_t const  group, task_handler_t const &  task  )

inline

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::Schedule instead!

    {
        return Schedule(RandomDurationBetween(min, max), group, task);
    }

References RandomDurationBetween(), and Schedule().

Schedule() [4/4]

template<class _RepLeft , class _PeriodLeft , class _RepRight , class _PeriodRight >

TaskScheduler & TaskScheduler::Schedule ( std::chrono::duration< _RepLeft, _PeriodLeft > const &  min, std::chrono::duration< _RepRight, _PeriodRight > const &  max, task_handler_t const &  task  )

inline

Schedule an event with a randomized rate between min and max rate. Never call this from within a task context! Use TaskContext::Schedule instead!

    {
        return Schedule(RandomDurationBetween(min, max), task);
    }

References RandomDurationBetween(), and Schedule().

ScheduleAt() [1/2]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::ScheduleAt ( timepoint_t const &  end, std::chrono::duration< _Rep, _Period > const &  time, group_t const  group, task_handler_t const &  task  )

inlineprivate

Schedule an event with a fixed rate. Never call this from within a task context! Use TaskContext::schedule instead!

    {
        static repeated_t const DEFAULT_REPEATED = 0;
        return InsertTask(TaskContainer(new Task(end + time, time, group, DEFAULT_REPEATED, task)));
    }

References InsertTask().

ScheduleAt() [2/2]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::ScheduleAt ( timepoint_t const &  end, std::chrono::duration< _Rep, _Period > const &  time, task_handler_t const &  task  )

inlineprivate

    {
        return InsertTask(TaskContainer(new Task(end + time, time, task)));
    }

References InsertTask().

Referenced by Schedule(), and TaskContext::Schedule().

SetValidator()

template<typename P >

TaskScheduler & TaskScheduler::SetValidator ( P &&  predicate )

inline

Sets a validator which is asked if tasks are allowed to be executed.

    {
        _predicate = std::forward<P>(predicate);
        return *this;
    }

References _predicate.

Referenced by boss_apothecary_hummel::boss_apothecary_hummelAI::boss_apothecary_hummelAI(), boss_azuregos::boss_azuregosAI::boss_azuregosAI(), boss_jarien::boss_jarien(), boss_mor_grayhoof::boss_mor_grayhoof(), boss_ouro::boss_ouro(), boss_sothos::boss_sothos(), boss_talon_king_ikiss::boss_talon_king_ikiss(), boss_thorngrin_the_tender::boss_thorngrin_the_tender(), boss_twinemperorsAI::boss_twinemperorsAI(), boss_zereketh_the_unbound::boss_zereketh_the_unbound(), npc_coren_direbrew_sisters::JustEngagedWith(), npc_apothecary_baxter::npc_apothecary_baxter(), npc_batrider::npc_batrider(), boss_kormok::Reset(), boss_baroness_anastari::boss_baroness_anastariAI::Reset(), npc_ohgan::npc_ohganAI::Reset(), boss_thekal::boss_thekalAI::Reset(), npc_zealot_lorkhan::npc_zealot_lorkhanAI::Reset(), npc_zealot_zath::npc_zealot_zathAI::Reset(), boss_isalien::Reset(), and npc_anubisath_guardian::Reset().

Update() [1/3]

TaskScheduler & TaskScheduler::Update	(	size_t const	milliseconds,
		success_t const &	callback = EmptyCallback
	)

Update the scheduler with a difftime in ms. Calls the optional callback on successfully finish.

{
    return Update(std::chrono::milliseconds(milliseconds), callback);
}

References Update().

Update() [2/3]

template<class _Rep , class _Period >

TaskScheduler & TaskScheduler::Update ( std::chrono::duration< _Rep, _Period > const &  difftime, success_t const &  callback = EmptyCallback  )

inline

Update the scheduler with a difftime. Calls the optional callback on successfully finish.

    {
        _now += difftime;
        Dispatch(callback);
        return *this;
    }

References _now, and Dispatch().

Update() [3/3]

TaskScheduler & TaskScheduler::Update

(

success_t const &

callback = EmptyCallback

)

Update the scheduler to the current time. Calls the optional callback on successfully finish.

{
    _now = clock_t::now();
    Dispatch(callback);
    return *this;
}

References _now, and Dispatch().

Referenced by Update(), World::Update(), instance_ruins_of_ahnqiraj::instance_ruins_of_ahnqiraj_InstanceMapScript::Update(), go_sand_trap::UpdateAI(), BossAI::UpdateAI(), boss_mor_grayhoof::UpdateAI(), npc_drakonid_spawner::UpdateAI(), npc_lava_spawn::UpdateAI(), boss_attumen::boss_attumenAI::UpdateAI(), boss_midnight::boss_midnightAI::UpdateAI(), npc_netherspite_infernal::UpdateAI(), npc_malchezaar_axe::UpdateAI(), boss_kormok::UpdateAI(), boss_apothecary_hummel::boss_apothecary_hummelAI::UpdateAI(), npc_apothecary_baxter::UpdateAI(), boss_baroness_anastari::boss_baroness_anastariAI::UpdateAI(), boss_jarien::UpdateAI(), boss_sothos::UpdateAI(), boss_twilight_corrupter::UpdateAI(), npc_batrider::UpdateAI(), boss_jindo::UpdateAI(), npc_healing_ward::UpdateAI(), npc_shade_of_jindo::UpdateAI(), npc_ohgan::npc_ohganAI::UpdateAI(), npc_vilebranch_speaker::UpdateAI(), npc_spawn_of_marli::UpdateAI(), boss_thekal::boss_thekalAI::UpdateAI(), npc_zealot_lorkhan::npc_zealot_lorkhanAI::UpdateAI(), npc_zealot_zath::npc_zealot_zathAI::UpdateAI(), npc_coren_direbrew_sisters::UpdateAI(), go_direbrew_mole_machine::go_direbrew_mole_machineAI::UpdateAI(), npc_hallows_end_soh::UpdateAI(), boss_azuregos::boss_azuregosAI::UpdateAI(), boss_isalien::UpdateAI(), boss_ayamiss::UpdateAI(), npc_anubisath_guardian::UpdateAI(), npc_hivezara_stinger::UpdateAI(), npc_obsidian_destroyer::UpdateAI(), boss_bug_trio::UpdateAI(), boss_cthun::UpdateAI(), npc_eye_tentacle::UpdateAI(), npc_claw_tentacle::UpdateAI(), npc_giant_eye_tentacle::UpdateAI(), boss_fankriss::UpdateAI(), boss_ouro::UpdateAI(), npc_dirt_mound::UpdateAI(), boss_twinemperorsAI::UpdateAI(), boss_viscidus::UpdateAI(), boss_glob_of_viscidus::UpdateAI(), npc_anubisath_defender::UpdateAI(), npc_vekniss_stinger::UpdateAI(), npc_anubisath_warder::UpdateAI(), npc_obsidian_nullifier::UpdateAI(), npc_ahnqiraji_critter::UpdateAI(), boss_hungarfen::UpdateAI(), npc_underbog_mushroom::UpdateAI(), npc_raliq_the_drunk::npc_raliq_the_drunkAI::UpdateAI(), and npc_dream_fog::npc_dream_fogAI::UpdateAI().

Friends And Related Function Documentation

TaskContext

friend class TaskContext

friend

Member Data Documentation

_asyncHolder

AsyncHolder TaskScheduler::_asyncHolder

private

Contains all asynchronous tasks which will be invoked at the next update tick.

Referenced by Async(), CancelAll(), and Dispatch().

_now

timepoint_t TaskScheduler::_now

private

The current time point (now)

Referenced by Dispatch(), RescheduleAll(), RescheduleGroup(), Schedule(), and Update().

_predicate

predicate_t TaskScheduler::_predicate

private

Referenced by ClearValidator(), Dispatch(), and SetValidator().

_task_holder

TaskQueue TaskScheduler::_task_holder

private

The Task Queue which contains all task objects.

Referenced by CancelAll(), CancelGroup(), DelayAll(), DelayGroup(), Dispatch(), InsertTask(), RescheduleAll(), and RescheduleGroup().

self_reference

std::shared_ptr<TaskScheduler> TaskScheduler::self_reference

private

Contains a self reference to track if this object was deleted or not.

Referenced by Dispatch().