Skip to content

Quick Reference Cheat Sheet

This page provides a quick lookup for common headers, template declarations, methods, compilation flags, and usage snippets.

Headers & Includes

#include "siddiqsoft/simple_worker.hpp"   // Single-threaded worker
#include "siddiqsoft/simple_pool.hpp"     // Multi-threaded shared-queue pool
#include "siddiqsoft/roundrobin_pool.hpp" // Multi-threaded per-thread queue pool
#include "siddiqsoft/periodic_worker.hpp" // Periodic timer executor

Component Overview Table

Class Template Signature Thread Count Queue Structure Use Case
simple_worker simple_worker<T, Priority = 0> 1 Single std::deque Sequential async background task
simple_pool simple_pool<T, Threads = 0> N (hardware_concurrency) Single std::deque Parallel execution with shared queue
roundrobin_pool roundrobin_pool<T, Threads = 0> N (hardware_concurrency) Per-thread std::deque Parallel execution with reduced lock contention
periodic_worker periodic_worker<Priority = 0> 1 N/A (loop) Recurring interval task

Common Operations

Queueing Tasks

// Rvalue move into worker/pool queue
worker.queue(std::move(task));

Graceful Worker Shutdown

// Explicit shutdown with 1-second timeout
bool drained = worker.shutdown(std::chrono::seconds(1));

Diagnostics & Telemetry

#include <nlohmann/json.hpp>

// Obtain JSON snapshot (itemsSize, itemsQueued, itemsPopped, etc.)
nlohmann::json info = worker.to_json();
std::println(info.dump(2));

Compiler Flags & Configuration

include(FetchContent)
FetchContent_Declare(asynchrony
    GIT_REPOSITORY https://github.com/SiddiqSoft/asynchrony.git
    GIT_TAG main
)
FetchContent_MakeAvailable(asynchrony)

target_link_libraries(your_target PRIVATE asynchrony::asynchrony)

g++ -std=c++23 -pthread main.cpp -o main

clang++ -std=c++23 -fexperimental-library -pthread main.cpp -o main

cl /std:c++23 main.cpp