BoundedBlockingQueue Class Reference

A thread-safe queue with a fixed capacity that supports blocking operations. More...

Collaboration diagram for BoundedBlockingQueue:

Public Member Functions
	BoundedBlockingQueue (size_t capacity)
	Constructs a new BoundedBlockingQueue.
void	shut_down ()
	Shuts down the queue and wakes up all blocked threads.
bool	push (int val)
	Adds an element to the back of the queue.
bool	pop (int &output_val)
	Removes an element from the front of the queue.

Detailed Description

A thread-safe queue with a fixed capacity that supports blocking operations.

• This class ensures that:
• Producers block when the queue is full.
• Consumers block when the queue is empty.
• All threads can be gracefully shut down.

Definition at line 23 of file BoundedBlockingQueue.cpp.

Constructor & Destructor Documentation

BoundedBlockingQueue()

BoundedBlockingQueue::BoundedBlockingQueue ( size_t  capacity )

inline

Constructs a new BoundedBlockingQueue.

Parameters

capacity

The maximum number of elements the queue can hold.

Definition at line 39 of file BoundedBlockingQueue.cpp.

: max_capacity(capacity) {};

Member Function Documentation

pop()

bool BoundedBlockingQueue::pop ( int &  output_val )

inline

Removes an element from the front of the queue.

Parameters

[out]

output_val

Reference where the consumed value will be stored.

Returns

true if an item was successfully consumed.

false if the queue is empty and shut down.

Definition at line 82 of file BoundedBlockingQueue.cpp.

                              {
        std::unique_lock<std::mutex> lock(mtx);
 
        // Wait while empty AND not shutting down
        while(buffer.empty() && !is_shutdown) {
            not_empty.wait(lock);
        }
 
        // Return false only if empty AND shut down
        if(buffer.empty() && is_shutdown) return false;
 
        output_val = buffer.front();
        buffer.pop();
        std::cout << "[Consumer] : Consumed " << output_val << " | Size : " << buffer.size() << std::endl;
 
        not_full.notify_one();
        return true;
    }

Referenced by consumerTask().

Here is the caller graph for this function:

push()

bool BoundedBlockingQueue::push ( int  val )

inline

Adds an element to the back of the queue.

Parameters

val	The integer to add.

Returns

true if the item was successfully pushed.

false if the queue was shut down before or during the push.

Definition at line 59 of file BoundedBlockingQueue.cpp.

                       {
        std::unique_lock<std::mutex> lock(mtx);
 
        // Wait while full AND not shutting down
        while(buffer.size() >= max_capacity && !is_shutdown) {
            not_full.wait(lock);
        }
 
        if(is_shutdown) return false;
 
        buffer.push(val);
        std::cout << "[Producer] Pushed : " << val << " | Size: " << buffer.size() << std::endl;
        
        not_empty.notify_one(); 
        return true;
    }

Referenced by producerTask().

Here is the caller graph for this function:

shut_down()

void BoundedBlockingQueue::shut_down ( )

inline

Shuts down the queue and wakes up all blocked threads.

• Sets the shutdown flag and notifies all waiting producers and consumers to prevent deadlocks during program termination.

Definition at line 46 of file BoundedBlockingQueue.cpp.

                     {
        is_shutdown = true;
        not_full.notify_all();
        not_empty.notify_all();
        return;
    }

Referenced by consumerTask(), and producerTask().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• Bounded-Blocking-Queue/BoundedBlockingQueue.cpp