AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Protected Member Functions | List of all members
alexaClientSDK::integration::test::testStateProvider Class Reference
Inheritance diagram for alexaClientSDK::integration::test::testStateProvider:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::integration::test::testStateProvider:
Collaboration graph
[legend]

Public Member Functions

 testStateProvider (std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager)
 
 ~testStateProvider ()
 
void provideState (const NamespaceAndName &nsname, const unsigned int stateRequestToken) override
 
bool checkStateRequested ()
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface
virtual ~StateProviderInterface ()=default
 
virtual void provideState (const avs::CapabilityTag &stateProviderName, const ContextRequestToken stateRequestToken)
 
virtual bool canStateBeRetrieved ()
 
virtual bool hasReportableStateProperties ()
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
 
virtual ~RequiresShutdown ()
 Destructor. More...
 
const std::string & name () const
 
void shutdown ()
 
bool isShutdown () const
 

Protected Member Functions

void doShutdown () override
 

Constructor & Destructor Documentation

◆ testStateProvider()

alexaClientSDK::integration::test::testStateProvider::testStateProvider ( std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface contextManager)
inline

◆ ~testStateProvider()

alexaClientSDK::integration::test::testStateProvider::~testStateProvider ( )
inline

Member Function Documentation

◆ checkStateRequested()

bool alexaClientSDK::integration::test::testStateProvider::checkStateRequested ( )
inline

◆ doShutdown()

void alexaClientSDK::integration::test::testStateProvider::doShutdown ( )
inlineoverrideprotectedvirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning
  • Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
  • Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ provideState()

void alexaClientSDK::integration::test::testStateProvider::provideState ( const NamespaceAndName stateProviderName,
const unsigned int  stateRequestToken 
)
inlineoverridevirtual

A request to a StateProvider to provide the state. The StateProvider should perform minimum processing and return quickly, otherwise it will block the processing of updating the states of other StateProviders. The ContextManager specifies a token which it uses to track the getContext request associated with this provideState request. The stateProviderInterface must use the same token when it updates its state via the setState call.

: The setState method MUST be called from a different thread from where the provideState method is being called from.

Parameters
stateProviderNameThe name of the state provider.
stateRequestTokenThe token to use in the setState call.
Deprecated:
NamespaceAndName is being deprecated. Use the CapabilityMessageIdentifier version instead.

Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface.


The documentation for this class was generated from the following file:

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0