update doxygen comments for concurrent logger

This commit is contained in:
Aaron Po
2026-05-14 21:21:28 -04:00
parent 74f11b57e2
commit a4968eb043
6 changed files with 161 additions and 88 deletions

View File

@@ -1,7 +1,3 @@
//
// Created by aaronpo on 29/04/2026.
//
#ifndef BIERGARTEN_PIPELINE_INCLUDES_CONCURRENCY_BOUNDED_CHANNEL_H_
#define BIERGARTEN_PIPELINE_INCLUDES_CONCURRENCY_BOUNDED_CHANNEL_H_
@@ -13,17 +9,19 @@
/**
* @file bounded_channel.h
* @brief A thread-safe, bounded multi-producer/multi-consumer channel.
* @brief Thread-safe, bounded multi-producer/multi-consumer synchronous channel.
*
* Intent: Enables asynchronous inter-thread communication with backpressure.
* Models a synchronous channel where producers/consumers block on capacity limits.
*/
// ---------------------------------------------------------------------------
// BoundedChannel<T>
//
// Models a synchronous channel with a fixed-capacity internal buffer.
// Producers block when the buffer is full (backpressure).
// Consumers block when the buffer be empty.
// Calling close() unblocks all waiting threads and signals exhaustion.
// ---------------------------------------------------------------------------
/**
* @class BoundedChannel
* @brief MPMC channel with fixed capacity and blocking semantics.
*
* Producers block when buffer is full; consumers block when empty.
* Close() unblocks all waiters and signals channel exhaustion.
*/
template <typename T>
class BoundedChannel {
// -------------------------------------------------------------------------