TimerDelegateInterface.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_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_TIMING_TIMERDELEGATEINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_TIMING_TIMERDELEGATEINTERFACE_H_

#include <chrono>
#include <functional>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace timing {

class TimerDelegateInterface {
public:
    virtual ~TimerDelegateInterface() = default;

    static const size_t FOREVER = 0;

    static size_t getForever() {
        return FOREVER;
    }

    enum class PeriodType {
        ABSOLUTE,

        RELATIVE
    };

    virtual void start(
        std::chrono::nanoseconds delay,
        std::chrono::nanoseconds period,
        PeriodType periodType,
        size_t maxCount,
        std::function<void()> task) = 0;

    virtual void stop() = 0;

    virtual bool activate() = 0;

    virtual bool isActive() const = 0;
};

}  // namespace timing
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_TIMING_TIMERDELEGATEINTERFACE_H_