RWLContainer

Class API & Structure

A thread-safe dictionary with reader-writer locking for efficient concurrent access.

Multiple concurrent readers
Exclusive writer access
Automatic memory management
JSON serialization support

Configuration:

ReplaceExisting - Replace on collision
FailOnCollission - Fail on collision

Methods:

add(key, value) - Add by value
add(key, shared_ptr) - Add by pointer
add(key, callback) - Add via callback
remove(key) - Remove and return
find(key) - Find without removing
size() - Get element count
scan(callback) - Iterate and find
toJson() - Serialize metadata

📖 Full API Reference

WaitableQueue

A thread-safe queue for producer-consumer patterns with timeout support.

Efficient producer-consumer
Timeout-based waiting
Atomic counters
JSON serialization support

Characteristics:

FIFO ordering
Non-copyable, non-movable
Efficient waiting with semaphore
Timeout support

Methods:

push(value) - Add to queue
emplace(value) - Construct in-place
tryWaitItem(timeout) - Wait for item
waitUntilEmpty(timeout) - Wait until empty
size() - Get queue size
addCounter() - Total adds
removeCounter() - Total removes
toJson() - Serialize metadata

📖 Full API Reference

Quick Start

Installation:

# Using NuGet (Windows)
nuget install SiddiqSoft.RWLContainer

# Using CPM (CMake)
CPMAddPackage("gh:SiddiqSoft/RWLContainer@1.5.3")

RWLContainer Example:

#include "siddiqsoft/RWLContainer.hpp"

int main() {
    siddiqsoft::RWLContainer<std::string, int> cache;
    
    cache.add("key1", 42);
    if (auto value = cache.find("key1")) {
        std::cout << "Value: " << *value << std::endl;
    }
    cache.remove("key1");
    
    return 0;
}

WaitableQueue Example:

#include "siddiqsoft/WaitableQueue.hpp"

int main() {
    siddiqsoft::WaitableQueue<std::string> queue;
    
    std::thread producer([&]() {
        queue.push("item1");
        queue.push("item2");
    });
    
    std::thread consumer([&]() {
        while (auto item = queue.tryWaitItem(std::chrono::milliseconds(500))) {
            std::cout << "Got: " << *item << std::endl;
        }
    });
    
    producer.join();
    consumer.join();
    
    return 0;
}

📖 More Examples: See Examples.md and Getting-Started.md for detailed usage patterns.