SiddiqSoft.WinProcessInfo 2.5.2

ProcessInfo : Cross-Platform Process Information

Overview

A header-only C++23 library providing cross-platform process information with minimal footprint. Captures CPU, memory, and system details for the current process.

Features:

• Minimal footprint - header-only library
• Cross-platform support (Windows, Linux, macOS, Unix)
• JSON serialization via nlohmann::json
• std::format support for easy output
• Single ownership semantics

Quick Start

Installation

<details> <summary><b>CMake with CPM (Recommended)</b></summary>

CPMAddPackage("gh:SiddiqSoft/GenProcessInfo#main") // replace main with specific version
target_link_libraries(${PROJECT_NAME} INTERFACE GenProcessInfo::GenProcessInfo)

</details>

<details> <summary><b>NuGet (Windows)</b></summary>

Install-Package SiddiqSoft.WinProcessInfo

</details>

<details> <summary><b>Manual</b></summary>

Copy include/siddiqsoft/GenProcessInfo.hpp to your project. </details>

Basic Usage

#include "siddiqsoft/GenProcessInfo.hpp"

int main() {
    siddiqsoft::GenProcessInfo procInfo;
    
    // Basic info available immediately
    std::cout << "Process ID: " << procInfo.processId << "\n";
    std::cout << "CPU Cores: " << procInfo.cpuCores << "\n";
    
    // Expensive operation - call sparingly
    procInfo.snapshot();
    std::cout << "Memory: " << procInfo.memWorkingSet << " KB\n";
    std::cout << "Threads: " << procInfo.cpuThreads << "\n";
    
    return 0;
}

<details> <summary><b>JSON Output Example</b></summary>

#include <format>
#include "nlohmann/json.hpp"
#include "siddiqsoft/GenProcessInfo.hpp"

int main() {
    siddiqsoft::GenProcessInfo procInfo;
    procInfo.snapshot();
    
    nlohmann::json j = procInfo;
    std::cout << j.dump(2) << "\n";
    
    return 0;
}

</details>

Requirements

• C++23 or later (MSVC 2022+, GCC 13+, Clang 17+)
• Windows 7+, Linux (with /proc), macOS 10.5+, or POSIX-compliant systems
• Optional: nlohmann::json for JSON serialization

Platform Support

API Reference

See API.md for comprehensive documentation including:

• All public members and methods
• Detailed parameter descriptions
• Platform-specific behavior
• Performance considerations
• Complete usage examples
• Thread safety notes

Key Methods

Key Members

See API.md for complete member documentation.

<details> <summary><b>Performance Tips</b></summary>

1. Reuse instances - Create once, call snapshot() periodically
2. Background thread - Call snapshot() in a low-priority background thread
3. Cache results - Store values if frequent access is needed
4. Avoid copies - Copy/move operations are deleted (single ownership) </details>

<details> <summary><b>Backward Compatibility</b></summary>

The library provides WinProcessInfo as an alias for GenProcessInfo:

siddiqsoft::WinProcessInfo procInfo;  // Legacy name still works

</details>

<details> <summary><b>License</b></summary>

BSD 3-Clause License - See LICENSE file </details>

<small align="right">

© 2021 Siddiq Software LLC. All rights reserved.

</small>