queue.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#pragma once
 
#include <ove/queue.h>
#include <ove/types.hpp>
 
#ifdef CONFIG_OVE_QUEUE
 
namespace ove {
 
template <typename T, size_t MaxItems = 0>
class Queue {
public:
    Queue() requires (MaxItems > 0) {
#ifdef CONFIG_OVE_ZERO_HEAP
        static_assert(MaxItems > 0,
                  "MaxItems must be > 0 in zero-heap mode");
        int err = ove_queue_init(&handle_, &storage_,
                          buffer_, sizeof(T), MaxItems);
#else
        int err = ove_queue_create(&handle_, sizeof(T), MaxItems);
#endif
        OVE_STATIC_INIT_ASSERT(err == OVE_OK);
    }
 
    ~Queue() {
        if (!handle_) return;
#ifdef CONFIG_OVE_ZERO_HEAP
        ove_queue_deinit(handle_);
#else
        ove_queue_destroy(handle_);
#endif
    }
 
    Queue(const Queue &) = delete;
    Queue &operator=(const Queue &) = delete;
 
#ifdef CONFIG_OVE_ZERO_HEAP
    Queue(Queue &&) = delete;
    Queue &operator=(Queue &&) = delete;
#else
    Queue(Queue &&other) noexcept : handle_(other.handle_) {
        other.handle_ = nullptr;
    }
 
    Queue &operator=(Queue &&other) noexcept {
        if (this != &other) {
            if (handle_) ove_queue_destroy(handle_);
            handle_ = other.handle_;
            other.handle_ = nullptr;
        }
        return *this;
    }
#endif
 
    [[nodiscard]] int send(const T &item,
                   uint32_t timeout_ms = OVE_WAIT_FOREVER) {
        return ove_queue_send(handle_, &item, timeout_ms);
    }
 
    [[nodiscard]] int receive(T *item,
                  uint32_t timeout_ms = OVE_WAIT_FOREVER) {
        return ove_queue_receive(handle_, item, timeout_ms);
    }
 
    [[nodiscard]] int send_from_isr(const T &item) {
        return ove_queue_send_from_isr(handle_, &item);
    }
 
    [[nodiscard]] int receive_from_isr(T *item) {
        return ove_queue_receive_from_isr(handle_, item);
    }
 
    bool valid() const { return handle_ != nullptr; }
 
    ove_queue_t handle() const { return handle_; }
 
private:
    ove_queue_t handle_ = nullptr;
#ifdef CONFIG_OVE_ZERO_HEAP
    ove_queue_storage_t storage_ = {};
    T buffer_[MaxItems > 0 ? MaxItems : 1];
#endif
};
 
} // namespace ove
 
#endif /* CONFIG_OVE_QUEUE */