PowerResource.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_POWERRESOURCE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_POWER_POWERRESOURCE_H_

#include <memory>
#include <mutex>
#include <string>
#include <utility>

#include <AVSCommon/SDKInterfaces/PowerResourceManagerInterface.h>

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

class PowerResource {
public:
    ~PowerResource();

    static constexpr const char* PREFIX = "ACSDK_";

    static std::shared_ptr<PowerResource> create(
        const std::string& identifier,
        std::shared_ptr<sdkInterfaces::PowerResourceManagerInterface> powerManager,
        sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel level =
            sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel::STANDBY_MED,
        bool refCounted = true);

    std::string getId() const;

    bool isRefCounted() const;

    bool isFrozen() const;

    sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel getLevel() const;

    void acquire();

    void release();

    void freeze();

    void thaw();

private:
    PowerResource(
        const std::string& identifier,
        std::shared_ptr<sdkInterfaces::PowerResourceManagerInterface> powerManager,
        sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel level,
        bool refCounted,
        std::shared_ptr<sdkInterfaces::PowerResourceManagerInterface::PowerResourceId> powerResourceId);

    const std::string m_identifier;

    const bool m_isRefCounted;

    std::shared_ptr<sdkInterfaces::PowerResourceManagerInterface::PowerResourceId> m_powerResourceId;

    mutable std::mutex m_mutex;

    uint64_t m_refCount;

    sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel m_level;

    bool m_isFrozen;

    std::shared_ptr<sdkInterfaces::PowerResourceManagerInterface> m_powerManager;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_POWER_POWERRESOURCE_H_