combine finish_write and commit_write to a single function

odygrd · Sep 22, 2024 · a03e9c0 · a03e9c0
1 parent a39d257
commit a03e9c0
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/include/quill/Logger.h b/include/quill/Logger.h
@@ -205,8 +205,7 @@ class LoggerImpl : public detail::LoggerBase
            "The committed write bytes must be equal to the total_size requested bytes");
 #endif
 
-    thread_context->get_spsc_queue<frontend_options_t::queue_type>().finish_write(total_size);
-    thread_context->get_spsc_queue<frontend_options_t::queue_type>().commit_write();
+    thread_context->get_spsc_queue<frontend_options_t::queue_type>().finish_and_commit_write(total_size);
 
     if constexpr (immediate_flush)
     {

diff --git a/include/quill/core/BoundedSPSCQueue.h b/include/quill/core/BoundedSPSCQueue.h
@@ -150,6 +150,15 @@ class BoundedSPSCQueueImpl
 #endif
   }
 
+  /**
+   * Finish and commit write as a single function
+   */
+  QUILL_ATTRIBUTE_HOT void finish_and_commit_write(integer_type n) noexcept
+  {
+    finish_write(n);
+    commit_write();
+  }
+
   QUILL_NODISCARD QUILL_ATTRIBUTE_HOT std::byte* prepare_read() noexcept
   {
     if (empty())

diff --git a/include/quill/core/UnboundedSPSCQueue.h b/include/quill/core/UnboundedSPSCQueue.h
@@ -134,6 +134,15 @@ class UnboundedSPSCQueue
    */
   QUILL_ATTRIBUTE_HOT void commit_write() noexcept { _producer->bounded_queue.commit_write(); }
 
+  /**
+   * Finish and commit write as a single function
+   */
+  QUILL_ATTRIBUTE_HOT void finish_and_commit_write(size_t nbytes) noexcept
+  {
+    finish_write(nbytes);
+    commit_write();
+  }
+
   /**
    * Prepare to read from the buffer
    * @error_notifier a callback used for notifications to the user