InputControllerCapabilityAgent.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 ACSDKINPUTCONTROLLER_SRC_INPUTCONTROLLERCAPABILITYAGENT_H_
#define ACSDKINPUTCONTROLLER_SRC_INPUTCONTROLLERCAPABILITYAGENT_H_
 
#include <memory>
#include <string>
#include <unordered_set>
 
#include <acsdkInputControllerInterfaces/InputControllerHandlerInterface.h>
#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/SDKInterfaces/CapabilityConfigurationInterface.h>
#include <AVSCommon/Utils/Threading/Executor.h>
 
namespace alexaClientSDK {
namespace acsdkInputController {
 
class InputControllerCapabilityAgent
        : public avsCommon::avs::CapabilityAgent
        , public avsCommon::sdkInterfaces::CapabilityConfigurationInterface {
public:
    using InputFriendlyNameConfigurations =
        acsdkInputControllerInterfaces::InputControllerHandlerInterface::InputFriendlyNameType;
 
    virtual ~InputControllerCapabilityAgent() = default;
 
    static std::shared_ptr<InputControllerCapabilityAgent> create(
        const std::shared_ptr<acsdkInputControllerInterfaces::InputControllerHandlerInterface>& handler,
        const std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>& exceptionSender);
 
    avsCommon::avs::DirectiveHandlerConfiguration getConfiguration() const override;
    void handleDirectiveImmediately(std::shared_ptr<avsCommon::avs::AVSDirective> directive) override;
    void preHandleDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    void handleDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    void cancelDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
 
    std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration>> getCapabilityConfigurations() override;
 
private:
    InputControllerCapabilityAgent(
        const std::shared_ptr<acsdkInputControllerInterfaces::InputControllerHandlerInterface>& handler,
        const std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>& exceptionSender);
 
    bool executeHandleDirectiveHelper(
        std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info,
        std::string* errMessage,
        avsCommon::avs::ExceptionErrorType* type);
 
    std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration>> m_capabilityConfigurations;
 
    const std::shared_ptr<acsdkInputControllerInterfaces::InputControllerHandlerInterface> m_inputControllerHandler;
 
    InputFriendlyNameConfigurations m_inputConfigurations;
 
    avsCommon::utils::threading::Executor m_executor;
};
 
}  // namespace acsdkInputController
}  // namespace alexaClientSDK
 
#endif  // ACSDKINPUTCONTROLLER_SRC_INPUTCONTROLLERCAPABILITYAGENT_H_