erpc_static_queue.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
 * Copyright 2021 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef __embedded_rpc__static_queue__
#define __embedded_rpc__static_queue__

#include <cstring>
#include <cstdint>

// Classes

namespace erpc {
template <class T, uint32_t elementCount>
class StaticQueue
{
public:
    StaticQueue(void)
    {
        m_capacity = elementCount;
        m_head = 0;
        m_tail = 0;
        (void)memset(m_storage, 0, sizeof(m_storage));
    }

    ~StaticQueue(void) {}
    bool add(T element)
    {
        if ((m_head + 1U) % m_capacity != m_tail)
        {
            (void)std::memcpy(m_storage[m_head], &element, sizeof(T));
            m_head = (m_head + 1U) % m_capacity;
            return true;
        }
        return false;
    }

    bool get(T *element)
    {
        if (m_tail != m_head)
        {
            (void)std::memcpy(element, m_storage[m_tail], sizeof(T));
            m_tail = (m_tail + 1U) % m_capacity;
            return true;
        }
        return false;
    }

    uint32_t size(void)
    {
        if (m_head >= m_tail)
        {
            return m_head - m_tail;
        }
        return (m_capacity - m_tail + m_head);
    }

protected:
    uint64_t m_storage[elementCount]
                      [(sizeof(T) + sizeof(uint64_t) - 1U) / sizeof(uint64_t)]; 
    uint32_t m_capacity;                                                        
    uint32_t volatile m_head;                                                   
    uint32_t volatile m_tail;                                                   
};

} // namespace erpc

#endif // defined(__embedded_rpc__static_queue__)