concurrent_queue.hpp

Go to the documentation of this file.

#pragma once
 
#include <chrono>  // For std::chrono::microseconds
#include <cstddef>  // For size_t
#include <functional>  // Needed for std::function template instantiation
#include <memory>  // For std::unique_ptr
#include <optional>
 
#include "cpp-toolbox/base/detail/task_base.hpp"
// Assuming export macros are defined elsewhere if needed
#include <cpp-toolbox/cpp-toolbox_export.hpp>
// Assuming disable copy/move macros are defined elsewhere
#include <cpp-toolbox/macro.hpp>
 
namespace toolbox::container
{
 
template<typename T>
class CPP_TOOLBOX_EXPORT concurrent_queue_t
{
public:
  concurrent_queue_t();
 
  ~concurrent_queue_t();
 
  // --- 标准队列操作/Standard Queue Operations ---
 
  void enqueue(T&& value);
 
  bool try_dequeue(T& item);
 
  std::optional<T> try_dequeue();
 
  bool wait_dequeue_timed(T& item, std::chrono::microseconds timeout);
 
  // --- 额外工具函数/Additional Utility Functions ---
 
  size_t size_approx() const;
 
  // --- 资源管理/Resource Management ---
 
  // 为简化起见禁用拷贝和移动/Disable copying and moving for simplicity
  // 如果需要移动语义，移动构造函数/赋值运算符必须在cpp文件中定义/If move
  // semantics are desired, the move constructor/assignment must also be defined
  // in the .cpp file
  CPP_TOOLBOX_DISABLE_COPY_AND_MOVE(concurrent_queue_t)
 
private:
  // 实现类的前向声明(PIMPL)/Forward declaration of the implementation class
  // (Pimpl)
  class Impl;
 
  // 指向实现细节的指针/Pointer to the implementation details
  // std::unique_ptr要求Impl在调用析构函数的地方定义/std::unique_ptr requires
  // Impl to be defined where the destructor is called
  std::unique_ptr<Impl> impl_;
};
 
#if defined(CPP_TOOLBOX_COMPILER_MSVC)
extern template class concurrent_queue_t<
    std::unique_ptr<toolbox::base::detail::task_base,
                    std::default_delete<toolbox::base::detail::task_base>>>;
extern template class concurrent_queue_t<std::function<void()>>;
 
#else
extern template class CPP_TOOLBOX_EXPORT concurrent_queue_t<
    std::unique_ptr<toolbox::base::detail::task_base,
                    std::default_delete<toolbox::base::detail::task_base>>>;
extern template class CPP_TOOLBOX_EXPORT
    concurrent_queue_t<std::function<void()>>;
// extern template class /* CPP_TOOLBOX_EXPORT */
//     concurrent_queue_t<
//         std::pair<toolbox::logger::thread_logger_t::Level, std::string>>;
#endif
}  // namespace toolbox::container