/* * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with this program. If not, see . */ #ifndef __EVENTPROCESSOR_H #define __EVENTPROCESSOR_H #include "Define.h" #include "Duration.h" #include "Random.h" #include class EventProcessor; // Note. All times are in milliseconds here. class BasicEvent { friend class EventProcessor; enum class AbortState : uint8 { STATE_RUNNING, STATE_ABORT_SCHEDULED, STATE_ABORTED }; public: BasicEvent() = default; virtual ~BasicEvent() = default; // override destructor to perform some actions on event removal // this method executes when the event is triggered // return false if event does not want to be deleted // e_time is execution time, p_time is update interval [[nodiscard]] virtual bool Execute(uint64 /*e_time*/, uint32 /*p_time*/) { return true; } [[nodiscard]] virtual bool IsDeletable() const { return true; } // this event can be safely deleted virtual void Abort(uint64 /*e_time*/) { } // this method executes when the event is aborted // Aborts the event at the next update tick void ScheduleAbort(); private: void SetAborted(); [[nodiscard]] bool IsRunning() const { return (m_abortState == AbortState::STATE_RUNNING); } [[nodiscard]] bool IsAbortScheduled() const { return (m_abortState == AbortState::STATE_ABORT_SCHEDULED); } [[nodiscard]] bool IsAborted() const { return (m_abortState == AbortState::STATE_ABORTED); } AbortState m_abortState{AbortState::STATE_RUNNING}; // set by externals when the event is aborted, aborted events don't execute // these can be used for time offset control uint64 m_addTime{0}; // time when the event was added to queue, filled by event handler uint64 m_execTime{0}; // planned time of next execution, filled by event handler uint8 m_eventGroup{0}; }; template class LambdaBasicEvent : public BasicEvent { public: LambdaBasicEvent(T&& callback) : BasicEvent(), _callback(std::move(callback)) { } bool Execute(uint64, uint32) override { _callback(); return true; } private: T _callback; }; template using is_lambda_event = std::enable_if_t>>>; typedef std::multimap EventList; class EventProcessor { public: EventProcessor() = default; ~EventProcessor(); void Update(uint32 p_time); void KillAllEvents(bool force); void AddEvent(BasicEvent* Event, uint64 e_time, bool set_addtime = true, uint8 eventGroup = 0); template is_lambda_event AddEvent(T&& event, Milliseconds e_time, bool set_addtime = true, uint8 eventGroup = 0) { AddEvent(new LambdaBasicEvent(std::move(event)), e_time.count(), set_addtime, eventGroup); } void AddEventAtOffset(BasicEvent* event, Milliseconds offset, uint8 eventGroup = 0) { AddEvent(event, CalculateTime(offset.count()), true, eventGroup); } template is_lambda_event AddEventAtOffset(T&& event, Milliseconds offset, uint8 eventGroup = 0) { AddEventAtOffset(new LambdaBasicEvent(std::move(event)), offset, eventGroup); }; void AddEventAtOffset(BasicEvent* event, Milliseconds offset, Milliseconds offset2, uint8 eventGroup = 0) { AddEvent(event, CalculateTime(randtime(offset, offset2).count()), true, eventGroup); } template is_lambda_event AddEventAtOffset(T&& event, Milliseconds offset, Milliseconds offset2, uint8 eventGroup = 0) { AddEventAtOffset(new LambdaBasicEvent(std::move(event)), offset, offset2, eventGroup); }; void ModifyEventTime(BasicEvent* event, Milliseconds newTime); [[nodiscard]] uint64 CalculateTime(uint64 t_offset) const; //calculates next queue tick time [[nodiscard]] uint64 CalculateQueueTime(uint64 delay) const; void CancelEventGroup(uint8 group); bool HasEvents() const { return !m_events.empty(); } protected: uint64 m_time{0}; EventList m_events; bool m_aborting; }; #endif