API Reference Overview

The siddiqsoft::asynchrony library is organized into header-only class templates in the siddiqsoft namespace.

API Navigation

siddiqsoft::simple_worker

Single-threaded asynchronous worker class template.

View Class Reference →

siddiqsoft::simple_pool

Multi-threaded pool with a shared task queue.

View Class Reference →

siddiqsoft::roundrobin_pool

Multi-threaded pool with per-thread task queues.

View Class Reference →

siddiqsoft::periodic_worker

Periodic interval timer worker class template.

View Class Reference →

---

Common Concepts & Conventions

• Move Semantics: All queue methods accept rvalue references T&& item.
• Thread Safety: Method invocations on queue(), shutdown(), forceCleanupTerminate(), and to_json() are thread-safe.
• Exceptions: Callback exceptions are caught locally without terminating background worker threads.
• Diagnostics: .to_json() methods return nlohmann::json objects containing snapshot telemetry.