#include <PowerResource.h>

Public Member Functions
	~PowerResource ()

std::string	getId () const

bool	isRefCounted () const

bool	isFrozen () const

sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel	getLevel () const

void	acquire ()

void	release ()

void	freeze ()

void	thaw ()

Static Public Member Functions
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)

Static Public Attributes
static constexpr const char *	PREFIX = "ACSDK_"

Detailed Description

An object representing a configuration of power level preferences.

Behavior is undefined if direct calls are made to PowerResourceManagerInterface using the same component identifier as one associated with a PowerResource object.

Constructor & Destructor Documentation

◆ ~PowerResource()

alexaClientSDK::avsCommon::utils::power::PowerResource::~PowerResource ( )

Destructor. This will release all acquired instances.

Member Function Documentation

◆ acquire()

void alexaClientSDK::avsCommon::utils::power::PowerResource::acquire ( )

Acquire a count of the resource.

◆ create()

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

static

Creates an instance of the PowerResource.

Parameters

identifier	The identifier. This identifier must be unique across all instances, as it will be used to call the underlying `PowerResourceManagerInterface`. This will be prefixed internally with ACSDK_ to maintain uniqueness within `PowerResourceManagerInterface`.
powerManager	A pointer to the underlying `PowerResourceManagerInterface`.
level	The level to create this resource with.
refCounted	Whether refcounting is enabled.

Returns: An instance.

◆ freeze()

void alexaClientSDK::avsCommon::utils::power::PowerResource::freeze ( )

Freezes the resource, and caches the current refcount. Any calls to acquire or release will no-op while the PowerResource is frozen.

◆ getId()

std::string alexaClientSDK::avsCommon::utils::power::PowerResource::getId ( ) const

Returns the id. This will equal the identifier passed into the constructor without the internal prefix.

Returns: A string representing the id.

◆ getLevel()

sdkInterfaces::PowerResourceManagerInterface::PowerResourceLevel alexaClientSDK::avsCommon::utils::power::PowerResource::getLevel ( ) const

Get the current level.

Returns: The current level.

◆ isFrozen()

bool alexaClientSDK::avsCommon::utils::power::PowerResource::isFrozen ( ) const

Returns whether the current resource is frozen.

Returns: A bool indicating frozen state.

◆ isRefCounted()

bool alexaClientSDK::avsCommon::utils::power::PowerResource::isRefCounted ( ) const

Returns whether the current resource is refCounted.

Returns: A bool indicating refCount state.

◆ release()

void alexaClientSDK::avsCommon::utils::power::PowerResource::release ( )

Release a count of the resource.

◆ thaw()

void alexaClientSDK::avsCommon::utils::power::PowerResource::thaw ( )

Thaws the resource, and re-acquires the amount of times the resource has been acquired.

Member Data Documentation

◆ PREFIX

constexpr const char* alexaClientSDK::avsCommon::utils::power::PowerResource::PREFIX = "ACSDK_"