Merge pull request #16 from connectivecpp/develop

cliffg-softwarelibre · web-flow · commit 96ec6b5700c2 · 2024-06-19T19:07:33.000-06:00
Merging develop to main
diff --git a/README.md b/README.md
@@ -16,6 +16,8 @@
 
 `wait_queue` is a multi-reader, multi-writer FIFO thread-safe wait queue (often called MPMC for multiple producer / multiple consumer) for transferring data between threads. It is templatized on the type of data passed through the queue as well as the queue container type. Data is passed with value semantics, either by copying or by moving (as opposed to a queue that transfers data by pointer or reference). The wait queue has both wait and no-wait pop semantics. A fixed size container (e.g. a `ring_span`) can be used, eliminating any and all dynamic memory management (useful in embedded or deterministic environments). Similarly, a circular buffer that only allocates on construction can be used, which eliminates dynamic memory management when pushing or popping values on or off the queue.
 
+Thanks go to [Louis Langholtz](https://github.com/louis-langholtz) for adding DBC (Design by Contract) asserts and comments.
+
 ## Generated Documentation
 
 The generated Doxygen documentation for `wait_queue` is [here](https://connectivecpp.github.io/wait-queue/).
diff --git a/include/queue/wait_queue.hpp b/include/queue/wait_queue.hpp
@@ -192,8 +192,7 @@ class wait_queue {
    */
   wait_queue()
     // noexcept(std::is_nothrow_constructible<Container>::value)
-      : m_stop_src(std::stop_source{}), m_stop_tok((*m_stop_src).get_token())
-  {
+      : m_stop_src(std::stop_source{}), m_stop_tok((*m_stop_src).get_token()) {
     assert(empty());
     assert(size() == size_type(0));
     assert(!stop_requested());
@@ -210,8 +209,7 @@ class wait_queue {
    */
   wait_queue(std::stop_token stop_tok)
     // noexcept(std::is_nothrow_constructible<Container>::value)
-      : m_stop_tok(stop_tok)
-  {
+      : m_stop_tok(stop_tok) {
     assert(empty());
     assert(size() == size_type(0));
   }
@@ -242,8 +240,7 @@ class wait_queue {
   wait_queue(Iter beg, Iter end)
     // noexcept(std::is_nothrow_constructible<Container, Iter, Iter>::value)
       : m_stop_src(std::stop_source{}), m_stop_tok((*m_stop_src).get_token()),
-	m_data_queue(beg, end)
-  {
+	m_data_queue(beg, end) {
     assert(empty() == (beg == end));
     assert((size() == size_type(0)) == (beg == end)); // std::distance constrains beg, end.
   }
@@ -264,8 +261,7 @@ class wait_queue {
   template <typename Iter>
   wait_queue(std::stop_token stop_tok, Iter beg, Iter end)
     // noexcept(std::is_nothrow_constructible<Container, Iter, Iter>::value)
-      : m_stop_tok(stop_tok), m_data_queue(beg, end)
-  {
+      : m_stop_tok(stop_tok), m_data_queue(beg, end) {
     assert(empty() == (beg == end));
     assert((size() == size_type(0)) == (beg == end)); // std::distance constrains beg, end.
   }
@@ -295,8 +291,7 @@ class wait_queue {
   wait_queue(size_type sz)
     // noexcept(std::is_nothrow_constructible<Container, size_type>::value)
       : m_stop_src(std::stop_source{}), m_stop_tok((*m_stop_src).get_token()),
-	m_data_queue(sz)
-  {
+	m_data_queue(sz) {
     assert((sz != size_type(0)) || empty());
     assert((size() == size_type(0)) || (size() == sz));
   }
@@ -315,8 +310,7 @@ class wait_queue {
    */
   wait_queue(std::stop_token stop_tok, size_type sz)
     // noexcept(std::is_nothrow_constructible<Container, size_type>::value)
-      : m_stop_tok((*m_stop_src).get_token()), m_data_queue(sz)
-  {
+      : m_stop_tok((*m_stop_src).get_token()), m_data_queue(sz) {
     assert((sz != size_type(0)) || empty());
     assert((size() == size_type(0)) || (size() == sz));
   }
