Merge pull request #22 from connectivecpp/develop

Merging develop to main

Author: cliffg-softwarelibre

.github/workflows/build_run_unit_test_cmake.yml

@@ -28,7 +28,7 @@ jobs:
       - name: create-build-dir
         run: mkdir build
       - name: configure-cmake
-        run: cd build && cmake -D WAIT_QUEUE_BUILD_TESTS:BOOL=ON -D WAIT_QUEUE_BUILD_EXAMPLES:BOOL=ON -D JM_CIRCULAR_BUFFER_BUILD_TESTS:BOOL=OFF ..
+        run: cd build && cmake -D CMAKE_POLICY_VERSION_MINIMUM=3.5 -D WAIT_QUEUE_BUILD_TESTS:BOOL=ON -D WAIT_QUEUE_BUILD_EXAMPLES:BOOL=ON -D JM_CIRCULAR_BUFFER_BUILD_TESTS:BOOL=OFF ..
       - name: build
         run: cd build && cmake --build . --config $BUILD_TYPE
       - name: run-unit-test

.github/workflows/gen_docs.yml

@@ -18,7 +18,7 @@ jobs:
       - name: checkout
         uses: actions/checkout@v4
       - name: run-doxygen
-        uses: mattnotmitt/doxygen-action@v1.9.8
+        uses: mattnotmitt/doxygen-action@v1.12.0
         with:
           working-directory: doc
       - name: deploy-pages

CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2024 by Cliff Green
+# Copyright (c) 2024-2025 by Cliff Green
 #
 # https://github.com/connectivecpp/wait-queue
 #

README.md

@@ -18,6 +18,8 @@
 
 Shutdown semantics are available through `std::stop_token` facilities. A `std::stop_token` can be passed in through the constructors, allowing shutdown to be requested externally to the `wait_queue`, or shutdown can be requested through the `wait_queue request_stop` method.
 
+[P0260R15 - C++ Concurrent Queues](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2025/p0260r15.html) has recently (February 2025) been accepted by the standards committee for C++ 26. This proposal has more features than `wait_queue`, but much of the API is similar.
+
 Thanks go to [Louis Langholtz](https://github.com/louis-langholtz) for adding DBC (Design by Contract) asserts and comments.
 
 Concepts and various type constraints have been added. Enhancements are always appreciated.

cmake/download_cpm.cmake

@@ -4,7 +4,7 @@
 
 file(
   DOWNLOAD
-  https://github.com/cpm-cmake/CPM.cmake/releases/download/v0.39.0/CPM.cmake
+  https://github.com/cpm-cmake/CPM.cmake/releases/download/v0.40.8/CPM.cmake
   ${CMAKE_CURRENT_BINARY_DIR}/cmake/CPM.cmake
 )
 include(${CMAKE_CURRENT_BINARY_DIR}/cmake/CPM.cmake)

example/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2024 by Cliff Green
+# Copyright (c) 2024-2025 by Cliff Green
 #
 # Distributed under the Boost Software License, Version 1.0.
 # (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
@@ -8,15 +8,23 @@ cmake_minimum_required ( VERSION 3.14 FATAL_ERROR )
 # create project
 project ( wait_queue_example LANGUAGES CXX )
 
-# add executable
+# add dependencies
+CPMAddPackage ( "gh:connectivecpp/[email protected]" )
+
+# add executables
 add_executable ( wait_queue_example wait_queue_example.cpp )
 target_compile_features ( wait_queue_example PRIVATE cxx_std_20 )
 
+add_executable ( threaded_queue_buffer_demo threaded_queue_buffer_demo.cpp )
+target_compile_features ( threaded_queue_buffer_demo PRIVATE cxx_std_20 )
+
 set ( CMAKE_THREAD_PREFER_PTHREAD TRUE )
 set ( THREADS_PREFER_PTHREAD_FLAG TRUE )
 find_package ( Threads REQUIRED )
 
 # link dependencies
 target_link_libraries ( wait_queue_example PRIVATE 
 	Threads::Threads wait_queue )
+target_link_libraries ( threaded_queue_buffer_demo PRIVATE 
+	Threads::Threads shared_buffer wait_queue )
 

example/threaded_queue_buffer_demo.cpp

@@ -7,6 +7,8 @@
  * Copyright (c)2019 by Thurman Gillespy
  * 3/22/19
  *
+ * Minor changes Apr 2025 by Cliff Green to match changed APIs.
+ *
  * Distributed under the Boost Software License, Version 1.0. 
  * (See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  * 
@@ -26,7 +28,7 @@
 #include <ctime> // std::time
 
 #include "queue/wait_queue.hpp"
-#include "marshall/shared_buffer.hpp"
+#include "buffer/shared_buffer.hpp"
 
 
 /** Project Overview

test/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2024 by Cliff Green
+# Copyright (c) 2024-2025 by Cliff Green
 #
 # Distributed under the Boost Software License, Version 1.0.
 # (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)

test/wait_queue_test.cpp

@@ -19,6 +19,7 @@
 #include <set>
 #include <optional>
 #include <chrono>
+#include <ranges> // std::views::iota
 #include <type_traits> // std::is_arithmetic
 
 #include <thread>
@@ -45,12 +46,12 @@ void non_threaded_push_test(Q& wq, const typename Q::value_type& val, int count)
   REQUIRE (wq.empty());
   REQUIRE (wq.size() == 0);
 
-  for (int i {0}; i < count; ++i) {
+  for (int i : std::ranges::iota_view{0, count}) {
     REQUIRE(wq.push(val));
   }
   REQUIRE_FALSE (wq.empty());
   REQUIRE (wq.size() == count);
-  for (int i {0}; i < count; ++i) {
+  for (int i : std::ranges::iota_view{0, count}) {
     auto ret = wq.try_pop();
     REQUIRE(*ret == val);
   }
@@ -69,22 +70,22 @@ void non_threaded_arithmetic_test(Q& wq, int count) {
 
   REQUIRE (wq.empty());
 
-  for (int i {0}; i < count; ++i) {
+  for (int i : std::ranges::iota_view{0, count}) {
     REQUIRE(wq.push(base_val));
   }
   val_type sum { 0 };
   wq.apply( [&sum] (const val_type& x) { sum += x; } );
   REQUIRE (sum == expected_sum);
 
-  for (int i {0}; i < count; ++i) {
+  for (int i : std::ranges::iota_view{0, count}) {
     REQUIRE(*(wq.try_pop()) == base_val);
   }
   REQUIRE (wq.empty());
 
-  for (int i {0}; i < count; ++i) {
+  for (int i : std::ranges::iota_view{0, count}) {
     wq.push(base_val+i);
   }
-  for (int i {0}; i < count; ++i) {
+  for (int i : std::ranges::iota_view{0, count}) {
     REQUIRE(*(wq.try_pop()) == (base_val+i));
   }
   REQUIRE (wq.size() == 0);
@@ -389,25 +390,25 @@ TEST_CASE ( "Fixed size ring_span, testing wrap around with int type",
   constexpr int Answer = 42;
   constexpr int AnswerPlus = 42+5;
 
-  for (int i {0}; i < N; ++i) {
+  for (int i : std::ranges::iota_view{0, N}) {
       wq.push(Answer);
   }
   REQUIRE (wq.size() == N);
   wq.apply([Answer] (const int& i) { REQUIRE(i == Answer); } );
 
-  for (int i {0}; i < N; ++i) {
+  for (int i : std::ranges::iota_view{0, N}) {
     wq.push(Answer);
   }
-  for (int i {0}; i < (N/2); ++i) {
+  for (int i : std::ranges::iota_view{0, N/2}) {
     wq.push(AnswerPlus);
   }
   // the size is full but half match answer and half answer plus, since there's been wrap
   REQUIRE (wq.size() == N);
   // wait_pop should immediately return if the queue is non empty
-  for (int i {0}; i < (N/2); ++i) {
+  for (int i : std::ranges::iota_view{0, N/2}) {
     REQUIRE (wq.wait_and_pop() == Answer);
   }
-  for (int i {0}; i < (N/2); ++i) {
+  for (int i : std::ranges::iota_view{0, N/2}) {
     REQUIRE (wq.wait_and_pop() == AnswerPlus);
   }
   REQUIRE (wq.empty());