SDKClientRegistry.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 ACSDK_SDKCLIENT_INCLUDE_ACSDK_SDKCLIENT_SDKCLIENTREGISTRY_H_
#define ACSDK_SDKCLIENT_INCLUDE_ACSDK_SDKCLIENT_SDKCLIENTREGISTRY_H_

#include <memory>
#include <unordered_map>

#include <acsdkShutdownManagerInterfaces/ShutdownManagerInterface.h>
#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <AVSCommon/Utils/PlatformDefinitions.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/TypeIndex.h>

#include "Annotated.h"
#include "FeatureClientInterface.h"
#include "internal/Utils.h"

namespace alexaClientSDK {
namespace sdkClient {

class SDKClientRegistry
        : public std::enable_shared_from_this<SDKClientRegistry>
        , public avsCommon::utils::RequiresShutdown {
public:
    template <
        typename ClientType,
        typename std::enable_if<std::is_base_of<FeatureClientInterface, ClientType>::value>::type* = nullptr>
    ACSDK_INLINE_VISIBILITY inline std::shared_ptr<ClientType> get();

    template <typename ComponentType>
    ACSDK_INLINE_VISIBILITY inline std::shared_ptr<typename internal::UnderlyingComponentType<ComponentType>::type>
    getComponent();

    template <typename ComponentType>
    ACSDK_INLINE_VISIBILITY inline bool registerComponent(std::shared_ptr<ComponentType> component);

    template <typename AnnotatedName, typename ComponentType>
    ACSDK_INLINE_VISIBILITY inline bool registerComponent(Annotated<AnnotatedName, ComponentType> component);

    template <typename FeatureClientBuilderType>
    ACSDK_INLINE_VISIBILITY inline bool addFeature(std::unique_ptr<FeatureClientBuilderType> featureBuilder);

    void doShutdown() override;

private:
    SDKClientRegistry();

    bool initialize();

    bool registerClient(
        const avsCommon::utils::TypeIndex& clientTypeId,
        std::shared_ptr<FeatureClientInterface> client);

    bool registerComponent(const avsCommon::utils::TypeIndex& clientTypeId, std::shared_ptr<void> component);

    bool addFeature(
        const avsCommon::utils::TypeIndex& clientTypeId,
        std::unique_ptr<FeatureClientBuilderInterface> featureBuilder,
        std::function<std::shared_ptr<FeatureClientInterface>(const std::shared_ptr<SDKClientRegistry>&)>
            constructorFn);

    std::unordered_map<avsCommon::utils::TypeIndex, std::shared_ptr<FeatureClientInterface>> m_clientMapping;

    std::unordered_map<avsCommon::utils::TypeIndex, std::shared_ptr<void>> m_componentMapping;

    std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> m_shutdownManager;

    std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> m_shutdownNotifier;

    friend class SDKClientBuilder;
};
}  // namespace sdkClient
}  // namespace alexaClientSDK

#include "acsdk/SDKClient/internal/SDKClientRegistry_impl.h"
#endif  // ACSDK_SDKCLIENT_INCLUDE_ACSDK_SDKCLIENT_SDKCLIENTREGISTRY_H_