MultiTimer.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_TIMING_MULTITIMER_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_TIMING_MULTITIMER_H_

#include <cstdint>
#include <chrono>
#include <condition_variable>
#include <functional>
#include <map>
#include <memory>
#include <mutex>

#include "AVSCommon/Utils/Threading/Executor.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace timing {

class MultiTimer {
public:
    using Token = uint64_t;

    static std::shared_ptr<MultiTimer> createMultiTimer() noexcept;

    MultiTimer() noexcept;

    ~MultiTimer() noexcept;

    Token submitTask(const std::chrono::milliseconds& delay, std::function<void()> task) noexcept;

    void cancelTask(Token token) noexcept;

private:
    bool executeTimer() noexcept;

    bool hasNextLocked(std::unique_lock<std::mutex>& lock) noexcept;

    using TimePoint = std::chrono::time_point<std::chrono::steady_clock>;

    const std::string m_timerMoniker;

    std::condition_variable m_waitCondition;

    std::mutex m_waitMutex;

    threading::TaskThread m_timerThread;

    std::multimap<TimePoint, Token> m_timers;

    std::map<Token, std::pair<TimePoint, std::function<void()>>> m_tasks;

    bool m_isRunning;

    bool m_isBeingDestroyed;

    Token m_nextToken;
};

}  // namespace timing
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_TIMING_MULTITIMER_H_