MessageRequestQueueInterface.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_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEREQUESTQUEUEINTERFACE_H_
#define ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEREQUESTQUEUEINTERFACE_H_

#include <chrono>
#include <deque>
#include <memory>
#include <unordered_map>

#include <AVSCommon/AVS/MessageRequest.h>
#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace acl {

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

    virtual void enqueueRequest(std::shared_ptr<avsCommon::avs::MessageRequest> messageRequest) = 0;

    virtual avsCommon::utils::Optional<std::chrono::time_point<std::chrono::steady_clock>> peekRequestTime() = 0;

    virtual std::shared_ptr<avsCommon::avs::MessageRequest> dequeueOldestRequest() = 0;

    virtual std::shared_ptr<avsCommon::avs::MessageRequest> dequeueSendableRequest() = 0;

    virtual bool isMessageRequestAvailable() const = 0;

    virtual void setWaitingForSendAcknowledgement() = 0;

    virtual void clearWaitingForSendAcknowledgement() = 0;

    virtual bool empty() const = 0;

    virtual void clear() = 0;
};

}  // namespace acl
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACL_INCLUDE_ACL_TRANSPORT_MESSAGEREQUESTQUEUEINTERFACE_H_