MockTimerFactory.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_AVS_SHARED_PRESENTATIONORCHESTRATOR_VISUALTIMEOUTMANAGER_TEST_MOCKTIMERFACTORY_H_
#define ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_VISUALTIMEOUTMANAGER_TEST_MOCKTIMERFACTORY_H_

#include <chrono>
#include <functional>

#include <AVSCommon/SDKInterfaces/Timing/TimerDelegateFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/Timing/TimerDelegateInterface.h>

namespace alexaClientSDK {
namespace visualTimeoutManager {
namespace test {

class WarpTimer : public alexaClientSDK::avsCommon::sdkInterfaces::timing::TimerDelegateInterface {
public:
    void start(
        std::chrono::nanoseconds delay,
        std::chrono::nanoseconds period,
        PeriodType periodType,
        size_t maxCount,
        std::function<void()> task) override {
        m_task = task;
        m_delay = delay;
    }
    void stop() override {
        m_active = false;
    }
    bool activate() override {
        assert(!m_active);
        m_active = true;
        return m_active;
    }
    bool isActive() const override {
        return m_active;
    }

    bool warpForward(std::chrono::nanoseconds step) {
        bool dispatched = (step >= m_delay);
        if (dispatched) {
            m_task();
        }

        return dispatched;
    }

    std::chrono::nanoseconds getDelay() {
        return m_delay;
    }

protected:
    std::function<void()> m_task;
    std::chrono::nanoseconds m_delay;
    bool m_active{false};
};

class MockTimerFactory : public alexaClientSDK::avsCommon::sdkInterfaces::timing::TimerDelegateFactoryInterface {
public:
    bool supportsLowPowerMode() override {
        return true;
    }
    std::unique_ptr<alexaClientSDK::avsCommon::sdkInterfaces::timing::TimerDelegateInterface> getTimerDelegate()
        override {
        if (m_timer) {
            assert(false);  // does not support multiple instances
        }
        m_timer = new WarpTimer();
        std::unique_ptr<alexaClientSDK::avsCommon::sdkInterfaces::timing::TimerDelegateInterface> ptr{m_timer};

        return ptr;
    }

    WarpTimer* getTimer() {
        return m_timer;
    }

protected:
    WarpTimer* m_timer{nullptr};
};

}  // namespace test
}  // namespace visualTimeoutManager
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_VISUALTIMEOUTMANAGER_TEST_MOCKTIMERFACTORY_H_