yamc 项目教程

yamc 项目教程

yamc C++ mutex collections, cross-platform header-only C++11 (or later) library. 项目地址: https://gitcode.com/gh_mirrors/ya/yamc

1. 项目的目录结构及介绍

yamc/
├── include/
│   ├── yamc/
│   │   ├── checked/
│   │   ├── fair/
│   │   ├── spin/
│   │   ├── alternate/
│   │   ├── posix/
│   │   ├── win/
│   │   ├── apple/
│   │   ├── backoff/
│   │   ├── semaphore/
│   │   ├── latch/
│   │   ├── barrier/
│   │   └── ...
├── tests/
│   ├── test_checked_mutex.cpp
│   ├── test_fair_mutex.cpp
│   ├── test_spin_mutex.cpp
│   └── ...
├── .gitignore
├── .travis.yml
├── CMakeLists.txt
├── LICENSE
├── README.md
└── appveyor.yml

目录结构介绍

• include/: 包含所有头文件，是 yamc 库的核心部分。
  • yamc/: 包含各种类型的互斥锁和同步原语的实现。
    • checked/: 包含用于调试的互斥锁，如 checked::mutex。
    • fair/: 包含支持公平调度的互斥锁，如 fair::mutex。
    • spin/: 包含自旋锁的实现，如 spin::mutex。
    • alternate/: 包含与标准库互斥锁语义相同的互斥锁。
    • posix/: 包含 POSIX 平台原生互斥锁的封装。
    • win/: 包含 Windows 平台原生互斥锁的封装。
    • apple/: 包含 macOS/iOS 平台原生互斥锁的封装。
    • backoff/: 包含自旋锁的回退算法实现。
    • semaphore/: 包含 C++20 计数信号量的实现。
    • latch/: 包含 C++20 倒计时锁的实现。
    • barrier/: 包含 C++20 循环屏障的实现。
• tests/: 包含项目的单元测试文件，用于验证各种互斥锁和同步原语的正确性。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CMakeLists.txt: CMake 构建配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• appveyor.yml: AppVeyor CI 配置文件。

2. 项目的启动文件介绍

yamc 是一个头文件库，没有传统的启动文件。用户只需包含相应的头文件即可使用库中的功能。例如，要使用自旋锁，可以包含 ttas_spin_mutex.hpp 头文件：

#include "ttas_spin_mutex.hpp"

3. 项目的配置文件介绍

yamc 是一个头文件库，没有传统的配置文件。用户在使用时，只需根据需要包含相应的头文件即可。如果需要自定义自旋锁的回退算法，可以通过定义宏来实现：

#define YAMC_BACKOFF_SPIN_DEFAULT yamc::backoff::exponential<>

这个宏定义了自旋锁的默认回退算法为指数回退。

---

通过以上内容，您可以了解 yamc 项目的目录结构、启动文件和配置文件的使用方法。希望这份教程对您有所帮助！

yamc C++ mutex collections, cross-platform header-only C++11 (or later) library. 项目地址: https://gitcode.com/gh_mirrors/ya/yamc