MessageRequestObserverInterface.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_MESSAGEREQUESTOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MESSAGEREQUESTOBSERVERINTERFACE_H_

#include <iostream>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class MessageRequestObserverInterface {
public:
    enum class Status {
        PENDING,

        SUCCESS,

        SUCCESS_ACCEPTED,

        SUCCESS_NO_CONTENT,

        NOT_CONNECTED,

        NOT_SYNCHRONIZED,

        TIMEDOUT,

        PROTOCOL_ERROR,

        INTERNAL_ERROR,

        SERVER_INTERNAL_ERROR_V2,

        REFUSED,

        CANCELED,

        THROTTLED,

        INVALID_AUTH,

        BAD_REQUEST,

        SERVER_OTHER_ERROR
    };

    /*
     * Destructor
     */
    virtual ~MessageRequestObserverInterface() = default;

    virtual void onResponseStatusReceived(MessageRequestObserverInterface::Status status){};

    /*
     * Called when a message request has been processed by AVS.
     *
     * @param status The status of the response that was received.
     */
    virtual void onSendCompleted(MessageRequestObserverInterface::Status status) = 0;

    /*
     * Called when an exception is thrown when trying to send a message to AVS.
     */
    virtual void onExceptionReceived(const std::string& exceptionMessage) = 0;
};

inline std::ostream& operator<<(std::ostream& stream, MessageRequestObserverInterface::Status status) {
    switch (status) {
        case MessageRequestObserverInterface::Status::PENDING:
            return stream << "PENDING";
        case MessageRequestObserverInterface::Status::SUCCESS:
            return stream << "SUCCESS";
        case MessageRequestObserverInterface::Status::SUCCESS_ACCEPTED:
            return stream << "SUCCESS_ACCEPTED";
        case MessageRequestObserverInterface::Status::SUCCESS_NO_CONTENT:
            return stream << "SUCCESS_NO_CONTENT";
        case MessageRequestObserverInterface::Status::NOT_CONNECTED:
            return stream << "NOT_CONNECTED";
        case MessageRequestObserverInterface::Status::NOT_SYNCHRONIZED:
            return stream << "NOT_SYNCHRONIZED";
        case MessageRequestObserverInterface::Status::TIMEDOUT:
            return stream << "TIMEDOUT";
        case MessageRequestObserverInterface::Status::PROTOCOL_ERROR:
            return stream << "PROTOCOL_ERROR";
        case MessageRequestObserverInterface::Status::INTERNAL_ERROR:
            return stream << "INTERNAL_ERROR";
        case MessageRequestObserverInterface::Status::SERVER_INTERNAL_ERROR_V2:
            return stream << "SERVER_INTERNAL_ERROR_V2";
        case MessageRequestObserverInterface::Status::REFUSED:
            return stream << "REFUSED";
        case MessageRequestObserverInterface::Status::CANCELED:
            return stream << "CANCELED";
        case MessageRequestObserverInterface::Status::THROTTLED:
            return stream << "THROTTLED";
        case MessageRequestObserverInterface::Status::INVALID_AUTH:
            return stream << "INVALID_AUTH";
        case MessageRequestObserverInterface::Status::BAD_REQUEST:
            return stream << "CLIENT_ERROR_BAD_REQUEST";
        case MessageRequestObserverInterface::Status::SERVER_OTHER_ERROR:
            return stream << "SERVER_OTHER_ERROR";
    }
    return stream << "Unknown MessageRequestObserverInterface::Status";
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_MESSAGEREQUESTOBSERVERINTERFACE_H_