ContextRequesterInterface.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_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CONTEXTREQUESTERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CONTEXTREQUESTERINTERFACE_H_

#include <cstdint>
#include <string>
#include <ostream>

#include <AVSCommon/AVS/AVSContext.h>
#include <AVSCommon/Utils/Logger/Logger.h>
#include <AVSCommon/Utils/Logger/LogEntry.h>

#include "AVSCommon/SDKInterfaces/ContextRequestToken.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointIdentifier.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

enum class ContextRequestError {
    STATE_PROVIDER_TIMEDOUT,

    BUILD_CONTEXT_ERROR,

    ENDPOINT_UNREACHABLE
};

class ContextRequesterInterface {
public:
    virtual ~ContextRequesterInterface() = default;

    virtual void onContextAvailable(const std::string& jsonContext);

    virtual void onContextAvailable(
        const endpoints::EndpointIdentifier& endpointId,
        const avs::AVSContext& endpointContext,
        ContextRequestToken requestToken);

    virtual void onContextFailure(const ContextRequestError error);

    virtual void onContextFailure(const ContextRequestError error, ContextRequestToken token);
};

inline std::ostream& operator<<(std::ostream& stream, const ContextRequestError& error) {
    switch (error) {
        case ContextRequestError::STATE_PROVIDER_TIMEDOUT:
            stream << "STATE_PROVIDER_TIMEDOUT";
            break;
        case ContextRequestError::BUILD_CONTEXT_ERROR:
            stream << "BUILD_CONTEXT_ERROR";
            break;
        case ContextRequestError::ENDPOINT_UNREACHABLE:
            stream << "ENDPOINT_UNREACHABLE";
            break;
    }
    return stream;
}

inline void ContextRequesterInterface::onContextAvailable(const std::string& jsonContext) {
    utils::logger::acsdkError(
        utils::logger::LogEntry("ContextRequesterInterface", __func__).d("reason", "methodDeprecated"));
}

inline void ContextRequesterInterface::onContextAvailable(
    const endpoints::EndpointIdentifier& endpointId,
    const avs::AVSContext& endpointContext,
    ContextRequestToken requestToken) {
    onContextAvailable(endpointContext.toJson());
}

inline void ContextRequesterInterface::onContextFailure(const ContextRequestError error) {
    utils::logger::acsdkError(
        utils::logger::LogEntry("ContextRequesterInterface", __func__).d("reason", "methodDeprecated"));
}

inline void ContextRequesterInterface::onContextFailure(const ContextRequestError error, ContextRequestToken token) {
    onContextFailure(error);
}

}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CONTEXTREQUESTERINTERFACE_H_