TimerCPP 项目使用教程

TimerCPP 项目使用教程

timercpp项目地址:https://gitcode.com/gh_mirrors/ti/timercpp

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

TimerCPP 是一个用于 C++ 的定时器库，提供了类似于 JavaScript 的 setTimeout 和 setInterval 功能。以下是项目的目录结构及其介绍：

timercpp/
├── .gitignore
├── LICENSE
├── README.md
├── sample.cpp
└── timercpp.h

• .gitignore: Git 版本控制忽略文件。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• README.md: 项目说明文档。
• sample.cpp: 示例程序文件，展示了如何使用 timercpp.h 中的定时器功能。
• timercpp.h: 定时器库的头文件，包含了 setTimeout 和 setInterval 的实现。

2. 项目的启动文件介绍

项目的启动文件是 sample.cpp，它展示了如何使用 timercpp.h 中的定时器功能。以下是 sample.cpp 的代码示例：

#include <iostream>
#include "timercpp.h"

using namespace std;

int main() {
    Timer t = Timer();

    t.setTimeout([&]() {
        cout << "Hey, after 1s" << endl;
    }, 1000);

    t.setInterval([&]() {
        cout << "Hey, every 1s" << endl;
    }, 1000);

    // 防止程序立即退出
    while (true) {
        // 保持程序运行
    }

    return 0;
}

在这个示例中，main 函数创建了一个 Timer 对象，并使用 setTimeout 和 setInterval 方法来设置定时任务。

3. 项目的配置文件介绍

TimerCPP 项目没有专门的配置文件，所有的配置和功能实现都包含在 timercpp.h 头文件中。用户只需包含这个头文件并按照示例代码的方式使用即可。

timercpp.h 头文件包含了定时器类的定义和实现，提供了 setTimeout 和 setInterval 方法，用户可以通过这些方法来设置延迟执行和周期性执行的任务。

#include <iostream>
#include <thread>
#include <chrono>
#include <functional>

class Timer {
    bool clear = false;

public:
    void setTimeout(auto function, int delay);
    void setInterval(auto function, int interval);
    void stop();
};

void Timer::setTimeout(auto function, int delay) {
    this->clear = false;
    std::thread t([=]() {
        if(this->clear) return;
        std::this_thread::sleep_for(std::chrono::milliseconds(delay));
        if(this->clear) return;
        function();
    });
    t.detach();
}

void Timer::setInterval(auto function, int interval) {
    this->clear = false;
    std::thread t([=]() {
        while(true) {
            if(this->clear) return;
            std::this_thread::sleep_for(std::chrono::milliseconds(interval));
            if(this->clear) return;
            function();
        }
    });
    t.detach();
}

void Timer::stop() {
    this->clear = true;
}

以上是 timercpp.h 头文件的主要内容，定义了 Timer 类及其方法，用户可以通过这些方法来实现定时任务。

timercpp项目地址:https://gitcode.com/gh_mirrors/ti/timercpp