MessageStorageInterface.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_CERTIFIEDSENDER_INCLUDE_CERTIFIEDSENDER_MESSAGESTORAGEINTERFACE_H_
#define ALEXA_CLIENT_SDK_CERTIFIEDSENDER_INCLUDE_CERTIFIEDSENDER_MESSAGESTORAGEINTERFACE_H_

#include <memory>
#include <string>
#include <queue>

namespace alexaClientSDK {
namespace certifiedSender {

class MessageStorageInterface {
public:
    struct StoredMessage {
        StoredMessage() : id{0} {
        }

        StoredMessage(int id, const std::string& message, const std::string& uriPathExtension = "") :
                id{id},
                message{message},
                uriPathExtension{uriPathExtension} {
        }

        int id;
        std::string message;
        std::string uriPathExtension;
    };

    virtual ~MessageStorageInterface() = default;

    virtual bool createDatabase() = 0;

    virtual bool open() = 0;

    virtual void close() = 0;

    virtual bool store(const std::string& message, int* id) = 0;

    virtual bool store(const std::string& message, const std::string& uriPathExtension, int* id) = 0;

    virtual bool load(std::queue<StoredMessage>* messageContainer) = 0;

    virtual bool erase(int messageId) = 0;

    virtual bool clearDatabase() = 0;
};

}  // namespace certifiedSender
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CERTIFIEDSENDER_INCLUDE_CERTIFIEDSENDER_MESSAGESTORAGEINTERFACE_H_