DownloadChunkQueue.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 ACSDKASSETSCOMMON_DOWNLOADCHUNKQUEUE_H_
#define ACSDKASSETSCOMMON_DOWNLOADCHUNKQUEUE_H_

#include <condition_variable>
#include <memory>
#include <mutex>
#include <queue>

#include "DataChunk.h"

namespace alexaClientSDK {
namespace acsdkAssets {
namespace common {

enum class StreamingStatus { INPROGRESS, COMPLETED, ABORTED };

/*
 * Consumer Producer queue with blocking wait and pop operation to store downloaded data chunks.
 * It comes with downloaded file size validation.
 */
class DownloadChunkQueue {
public:
    explicit DownloadChunkQueue(size_t expectedSize);

    virtual ~DownloadChunkQueue();

    size_t size();

    bool push(char* data, size_t size);

    bool pushComplete(bool succeeded);

    std::shared_ptr<DataChunk> waitAndPop();

    bool popComplete(bool succeeded);

private:
    inline bool isSizeCheckingEnabled() const {
        return m_expectedSize > 0;
    }

private:
    std::condition_variable m_cond;

    std::mutex m_mutex;

    std::queue<std::shared_ptr<DataChunk>> m_queue;

    size_t m_expectedSize;

    size_t m_downloadedSize;

    StreamingStatus m_downloadStatus;

    StreamingStatus m_unpackStatus;

    std::shared_ptr<DataChunk> m_activeChunk;

    size_t m_maxQueueSizeReached;

    size_t m_bytesToReport;

    size_t m_reportIncrement;
};

}  // namespace common
}  // namespace acsdkAssets
}  // namespace alexaClientSDK

#endif  // ACSDKASSETSCOMMON_DOWNLOADCHUNKQUEUE_H_