AggregatedPowerResourceManager.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_POWER_AGGREGATEDPOWERRESOURCEMANAGER_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_POWER_AGGREGATEDPOWERRESOURCEMANAGER_H_

#include <memory>
#include <mutex>
#include <string>
#include <unordered_map>

#include <AVSCommon/Utils/functional/hash.h>
#include <AVSCommon/Utils/Logger/LogStringFormatter.h>
#include <AVSCommon/Utils/Timing/Timer.h>
#include <AVSCommon/SDKInterfaces/PowerResourceManagerInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace power {

class AggregatedPowerResourceManager : public avsCommon::sdkInterfaces::PowerResourceManagerInterface {
public:
    static std::shared_ptr<AggregatedPowerResourceManager> create(
        std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface> powerResourceManager);

    virtual ~AggregatedPowerResourceManager();

    /**********************************Deprecated Legacy APIs**********************************************/
    void acquirePowerResource(
        const std::string& component,
        const PowerResourceLevel level = PowerResourceLevel::STANDBY_MED) override;
    void releasePowerResource(const std::string& component) override;
    bool isPowerResourceAcquired(const std::string& component) override;
    /******************************************************************************************************/
    std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceId> create(
        const std::string& resourceId,
        bool isRefCounted = true,
        const PowerResourceLevel level = PowerResourceLevel::STANDBY_MED) override;
    bool acquire(
        const std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceId>& id,
        const std::chrono::milliseconds autoReleaseTimeout = std::chrono::milliseconds::zero()) override;
    bool release(
        const std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceId>& id) override;
    bool close(
        const std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceId>& id) override;

private:
    using AggregatedPowerResourceMap = std::unordered_map<
        avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel,
        std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceId>,
        avsCommon::utils::functional::EnumClassHash>;

    struct PowerResourceInfo {
        PowerResourceInfo(
            bool isRefCounted,
            avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel level);

        void updateLastAcquiredTimepoint();

        const bool isRefCounted;

        const avsCommon::sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel level;

        uint64_t refCount;

        std::chrono::system_clock::time_point lastAcquired;
    };

    AggregatedPowerResourceManager(
        std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface> powerResourceManager);

    void logActivePowerResources();

    std::shared_ptr<PowerResourceId> getAggregatedPowerResourceIdLocked(
        const PowerResourceManagerInterface::PowerResourceLevel level);

    std::mutex m_mutex;

    std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface> m_appPowerResourceManager;

    std::unordered_map<std::string, PowerResourceInfo> m_ids;

    AggregatedPowerResourceMap m_aggregatedPowerResources;

    avsCommon::utils::timing::Timer m_timer;

    avsCommon::utils::logger::LogStringFormatter m_logFormatter;
};

}  // namespace power
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_POWER_AGGREGATEDPOWERRESOURCEMANAGER_H_