众所周知,一个rpc框架除了处理网络请求以外,还有一类任务就是定时任务。因此,rpc框架通常会直接提供定时任务的功能。今天,我将讨论brpc中的定时任务。
当然,由于RPC框架中的定时任务并不是刚需,所以brpc中的定时任务接口设计得比较轻量化。之所以说轻量化,一是因为接口函数足够简单,二是因为它的定时任务不支持周期性定时,也就是说,它的定时任务只能生效一次。
如果要实现周期性定时,需要在定时器的回调函数执行完成,返回之前重新注册这个任务,从而达到周期性定时的效果。可以参考这个官方issue:
https://www.php.cn/link/0226aa5193c66d9906300c6cf2bc45df
如图所示,戈君大神已经做出回复。
好的,说完介绍,接下来就直接讲解如何使用吧。主要函数只有一个,那就是bthread_timer_add。通过它来设置定时任务的回调函数和执行时间。它的头文件比较特殊,是:#include <bthread></bthread>
函数声明如下:
bthread_timer_add(bthread_timer_t* id, timespec abstime, void (*on_timer)(void*), void* arg);
第一个参数id是一个输出参数,调用时无需事先初始化。
第二个参数abstime表示任务执行的时间,这个参数初学者很容易弄错。因为它需要传入的并不是时间间隔,而是实际的时钟时间。比如你需要一个任务在五分钟后执行,那么这里传入的是当前时间加上5分钟,然后再将结果转换成timespec结构。幸运的是,brpc也为你提供了工具函数butil::seconds_from_now()来方便你进行时间累加和类型转换。
第三个参数on_timer是定时任务的回调函数,也就是你编写具体处理逻辑的地方。当任务时间到,这个函数指针就会被回调执行。它接收一个void*类型的参数,值为void。
最后一个参数arg是第三个参数表示的函数指针的执行参数。不多解释了,总体来说和pthread_create或者bthread_start_background很相似。
函数参数介绍完了,来个例子吧,这个是在echo_server代码基础上进行的修改。
#include <gflags>
#include <brpc>
#include <bthread> // bthread_timer_add
#include <iostream>
#include "echo.pb.h"
using namespace std;
DEFINE_int32(port, 8000, "TCP Port of this server");
class EchoServiceImpl : public EchoService {
public:
EchoServiceImpl() {};
virtual ~EchoServiceImpl() {};
virtual void Echo(google::protobuf::RpcController* cntl_base,
const EchoRequest* request,
EchoResponse* response,
google::protobuf::Closure* done) {
brpc::ClosureGuard done_guard(done);
response->set_message(request->message());
done->Run();
}
};
// 定时任务的回调函数
static void timer_func(void* arg) {
cout << "Timer function executed!" << endl;
}这个例子比较简单,前面我说过了brpc的定时器默认不能周期性执行,所以如果要周期性执行,只能在回调函数末尾重新注册,比如:
static void timer_func(void* arg) {
cout << "Timer function executed!" << endl;
bthread_timer_t timer;
bthread_timer_add(&timer, butil::seconds_from_now(60), timer_func, NULL);
}但是这样有个问题,那就是在回调函数中,可能并不是“一镜到底”。里面可能有一堆复杂的逻辑,会有很多中间return的地方。
if (exp1) {
return;
}
...
if (exp2) {
return;
}如果你要做周期性任务,岂不是每个return前面都要写一坨bthread_timer_add()?那也太丑了,也难以维护,很容易遗漏。这时候就要上演RAII的拿手好戏了。RAII在无GC的C++语言中使用广泛,比如前面代码中的:
brpc::ClosureGuard done_guard(done);
C++标准库中还有std::lock_guard用以自动释放互斥锁:
std::mutex _m; ... std::lock_guard<std::mutex> lg(_m);
我们来写个TimerGuard:
class TimerGuard {
typedef void (*on_timer_t)(void*);
public:
TimerGuard(on_timer_t timer_func, int interval_s):_timer_func(timer_func), _interval_s(interval_s) {}
~TimerGuard() {
bthread_timer_t timer;
if (bthread_timer_add(&timer, butil::seconds_from_now(_interval_s), _timer_func, NULL) != 0) {
cerr << "Failed to add timer" << endl;
}
}
private:
on_timer_t _timer_func;
int _interval_s;
};在定义定时任务回调函数的地方,这样即可:
static void timer_func(void* arg) {
TimerGuard tg(timer_func, 60);
cout << "Timer function executed!" << endl;
}以上就是brpc中的定时任务使用介绍的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号