CapabilitiesDelegateObserverInterface.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_CAPABILITIESDELEGATEOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CAPABILITIESDELEGATEOBSERVERINTERFACE_H_

#include <ostream>
#include <vector>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class CapabilitiesDelegateObserverInterface {
public:
    enum class State {
        UNINITIALIZED,
        SUCCESS,
        FATAL_ERROR,
        RETRIABLE_ERROR,
    };

    enum class Error {
        UNINITIALIZED,
        SUCCESS,
        UNKNOWN_ERROR,
        CANCELED,
        FORBIDDEN,
        SERVER_INTERNAL_ERROR,
        BAD_REQUEST
    };

    virtual ~CapabilitiesDelegateObserverInterface() = default;

    virtual void onCapabilitiesStateChange(
        State newState,
        Error newError,
        const std::vector<std::string>& addedOrUpdatedEndpointIds,
        const std::vector<std::string>& deletedEndpointIds) = 0;
};

inline std::ostream& operator<<(std::ostream& stream, const CapabilitiesDelegateObserverInterface::State& state) {
    switch (state) {
        case CapabilitiesDelegateObserverInterface::State::UNINITIALIZED:
            return stream << "UNINITIALIZED";
        case CapabilitiesDelegateObserverInterface::State::SUCCESS:
            return stream << "SUCCESS";
        case CapabilitiesDelegateObserverInterface::State::FATAL_ERROR:
            return stream << "FATAL_ERROR";
        case CapabilitiesDelegateObserverInterface::State::RETRIABLE_ERROR:
            return stream << "RETRIABLE_ERROR";
    }
    return stream << "Unknown CapabilitiesDelegateObserverInterface::State!: " << state;
}

inline std::ostream& operator<<(std::ostream& stream, const CapabilitiesDelegateObserverInterface::Error& error) {
    switch (error) {
        case CapabilitiesDelegateObserverInterface::Error::UNINITIALIZED:
            return stream << "UNINITIALIZED";
        case CapabilitiesDelegateObserverInterface::Error::SUCCESS:
            return stream << "SUCCESS";
        case CapabilitiesDelegateObserverInterface::Error::UNKNOWN_ERROR:
            return stream << "UNKNOWN_ERROR";
        case CapabilitiesDelegateObserverInterface::Error::FORBIDDEN:
            return stream << "FORBIDDEN";
        case CapabilitiesDelegateObserverInterface::Error::SERVER_INTERNAL_ERROR:
            return stream << "SERVER_INTERNAL_ERROR";
        case CapabilitiesDelegateObserverInterface::Error::BAD_REQUEST:
            return stream << "CLIENT_ERROR_BAD_REQUEST";
        case CapabilitiesDelegateObserverInterface::Error::CANCELED:
            return stream << "CANCELED";
    }
    return stream << "Unknown CapabilitiesDelegateObserverInterface::Error!: " << error;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CAPABILITIESDELEGATEOBSERVERINTERFACE_H_