queue_helpers.hpp

#pragma once
 
#include <memory>
 
#include <userver/engine/deadline.hpp>
#include <userver/engine/task/current_task.hpp>
#include <userver/utils/assert.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace concurrent {
 
namespace impl {
 
struct NoToken final {
    template <typename LockFreeQueue>
    explicit NoToken(LockFreeQueue& /*unused*/) {}
};
 
struct MultiToken final {
    template <typename LockFreeQueue>
    explicit MultiToken(LockFreeQueue& /*unused*/) {}
};
 
}  // namespace impl
 
/// @brief Producer side of concurrent queues
///
/// @warning A single Producer must not be used from multiple threads concurrently
///
/// @see @ref concurrent_queues
template <typename QueueType, typename ProducerToken, typename EmplaceEnablerType>
class Producer final {
    static_assert(
        std::is_same_v<EmplaceEnablerType, typename QueueType::EmplaceEnabler>,
        "Do not instantiate Producer on your own. Use Producer type alias "
        "from queue"
    );
 
    using ValueType = typename QueueType::ValueType;
 
public:
    Producer(const Producer&) = delete;
    Producer(Producer&&) noexcept = default;
    Producer& operator=(const Producer&) = delete;
    Producer& operator=(Producer&& other) noexcept {
        queue_.swap(other.queue_);
        std::swap(token_, other.token_);
        return *this;
    }
 
    ~Producer() {
        if (queue_) {
            queue_->MarkProducerIsDead();
        }
    }
 
    /// Push an element into queue. May wait asynchronously if the queue is full.
    /// Leaves the `value` unmodified if the operation does not succeed.
    /// @returns whether push succeeded before the deadline and before the task
    /// was canceled.
    [[nodiscard]] bool Push(ValueType&& value, engine::Deadline deadline = {}) const {
        UASSERT_MSG(queue_, "Trying to use a moved-from queue Producer");
        UASSERT_MSG(engine::current_task::IsTaskProcessorThread(), "Use PushNoblock for non-coroutine producers");
        return queue_->Push(token_, std::move(value), deadline);
    }
 
    /// Try to push an element into queue without blocking. May be used in
    /// non-coroutine environment. Leaves the `value` unmodified if the operation
    /// does not succeed.
    /// @returns whether push succeeded.
    [[nodiscard]] bool PushNoblock(ValueType&& value) const {
        UASSERT_MSG(queue_, "Trying to use a moved-from queue Producer");
        return queue_->PushNoblock(token_, std::move(value));
    }
 
    void Reset() && noexcept {
        if (queue_) {
            queue_->MarkProducerIsDead();
        }
        queue_.reset();
        [[maybe_unused]] ProducerToken for_destruction = std::move(token_);
    }
 
    /// Const access to source queue.
    [[nodiscard]] std::shared_ptr<const QueueType> Queue() const { return {queue_}; }
 
    /// @cond
    // For internal use only
    Producer(std::shared_ptr<QueueType> queue, EmplaceEnablerType /*unused*/)
        : queue_(std::move(queue)),
          token_(queue_->queue_)
    {}
    /// @endcond
 
private:
    std::shared_ptr<QueueType> queue_;
    mutable ProducerToken token_;
};
 
/// @brief Consumer side of concurrent queues
///
/// @warning A single Consumer must not be used from multiple threads concurrently
///
/// @see @ref concurrent_queues
template <typename QueueType, typename ConsumerToken, typename EmplaceEnablerType>
class Consumer final {
    static_assert(
        std::is_same_v<EmplaceEnablerType, typename QueueType::EmplaceEnabler>,
        "Do not instantiate Consumer on your own. Use Consumer type alias "
        "from queue"
    );
 
    using ValueType = typename QueueType::ValueType;
 
public:
    Consumer(const Consumer&) = delete;
    Consumer(Consumer&&) noexcept = default;
    Consumer& operator=(const Consumer&) = delete;
    Consumer& operator=(Consumer&& other) noexcept {
        queue_.swap(other.queue_);
        std::swap(token_, other.token_);
        return *this;
    }
 
    ~Consumer() {
        if (queue_) {
            queue_->MarkConsumerIsDead();
        }
    }
 
    /// @brief Pop an element from queue.
    /// May wait asynchronously if the queue is empty, but the producer is alive.
    ///
    /// @returns whether something was popped before the deadline or before a task cancellation.
    /// `false` can be returned before the deadline when the producer is no longer alive.
    /// @warning Be careful when using a method in a loop. The
    /// `engine::Deadline` is a wrapper over `std::chrono::time_point`, not
    /// `duration`! If you need a timeout, you must reconstruct the deadline in the loop.
    [[nodiscard]] bool Pop(ValueType& value, engine::Deadline deadline = {}) const {
        UASSERT_MSG(queue_, "Trying to use a moved-from queue Consumer");
        UASSERT_MSG(engine::current_task::IsTaskProcessorThread(), "Use PopNoblock for non-coroutine consumers");
        return queue_->Pop(token_, value, deadline);
    }
 
    /// @brief Try to pop an element from queue without blocking.
    /// May be used in non-coroutine environment.
    ///
    /// @returns whether something was popped.
    [[nodiscard]] bool PopNoblock(ValueType& value) const {
        UASSERT_MSG(queue_, "Trying to use a moved-from queue Consumer");
        return queue_->PopNoblock(token_, value);
    }
 
    void Reset() && {
        if (queue_) {
            queue_->MarkConsumerIsDead();
        }
        queue_.reset();
        [[maybe_unused]] ConsumerToken for_destruction = std::move(token_);
    }
 
    /// Const access to source queue.
    [[nodiscard]] std::shared_ptr<const QueueType> Queue() const { return {queue_}; }
 
    /// @cond
    // For internal use only
    Consumer(std::shared_ptr<QueueType> queue, EmplaceEnablerType /*unused*/)
        : queue_(std::move(queue)),
          token_(queue_->queue_)
    {}
    /// @endcond
 
private:
    std::shared_ptr<QueueType> queue_{};
    mutable ConsumerToken token_;
};
 
}  // namespace concurrent
 
USERVER_NAMESPACE_END