abuisine / php-resque-scheduler
php-resque-scheduler 是 resque-scheduler 的 PHP 版本,为 Resque 添加了对未来调度项的支持。
This package is not auto-updated.
Last update: 2024-09-20 20:26:21 UTC
README
php-resque-scheduler 是 resque-scheduler 的 PHP 版本,它增加了对 Resque 中未来调度项的支持。
resque-scheduler 的 PHP 版本被设计成几乎与 Ruby 插件完全相同,并且设计为与 php-resque 的 PHP 版本一起工作。
目前,php-resque-scheduler 仅支持延迟作业,即能够在某个特定时间戳或若干秒后将作业推送到队列中。计划在未来的版本中支持重复作业(类似于 CRON)。
由于 PHP 版本几乎是 Ruby 版本的直接 API 复制,因此它与 Ruby 版本的 Web 界面也兼容,这提供了查看和管理延迟作业的能力。
延迟作业
以下是 Ruby resque-scheduler 文档的引用
延迟作业是指你想在未来某个时间点将其放入队列的一次性作业。一个经典的例子是发送电子邮件
require 'Resque/Resque.php';
require 'ResqueScheduler/ResqueScheduler.php';
$in = 3600;
$args = array('id' => $user->id);
ResqueScheduler::enqueueIn($in, 'email', 'SendFollowUpEmail', $args);
上述代码将在延迟队列中存储作业 1 小时,然后一旦有可用的工作者,就将作业从队列中取出并提交给 Resque 的 email
队列进行处理。
除了传递以秒为单位的相对时间外,还可以将 DateTime 对象或包含 UNIX 时间戳的整数作为时间戳提供给 enqueueAt
方法
require 'Resque/Resque.php';
require 'ResqueScheduler/ResqueScheduler.php';
$time = 1332067214;
ResqueScheduler::enqueueAt($time, 'email', 'SendFollowUpEmail', $args);
$datetime = new DateTime('2012-03-18 13:21:49');
ResqueScheduler::enqueueAt($datetime, 'email', 'SendFollowUpEmail', $args);
注意:resque-scheduler 不保证作业会在指定的时间触发。在指定的时间,resque-scheduler 将从延迟队列中取出作业并将其推送到 Resque 中的相应队列。下一个可用的 Resque 工作者将获取该作业。为了尽可能快地处理,请尽可能保持队列为空。
工作者
与 resque 一样,resque-scheduler 包含一个在后台运行的工作者。这个工作者负责从调度/延迟队列中取出项目并将其添加到 Resque 的队列中。这意味着为了执行延迟或计划中的作业,工作者需要运行。
在根目录中包含了一个基本的 "up-and-running" resque-scheduler.php 文件,该文件设置了一个运行的工作者环境。它接受与 php-resque 相同的许多环境变量
REDIS_BACKEND
- 要连接的 Redis 服务器LOGGING
- 启用输出到 STDOUT 的日志记录VERBOSE
- 启用详细日志记录VVERBOSE
- 启用非常详细的日志记录INTERVAL
- 在检查调度/延迟队列之前睡眠此时间APP_INCLUDE
- 启动时包含此文件(以启动您的应用程序)PIDFILE
- 将工作者的 PID 写入此文件
resque-scheduler 工作者需要 resque 才能运行。示例 resque-scheduler.php 工作者允许您使用 RESQUE_PHP
环境变量提供 Resque.php 的路径。如果没有提供且 resque 未经加载,resque-scheduler 将尝试从您的包含路径中加载它(《require_once 'Resque/Resque.php';')
使用 resque-scheduler.php 很容易启动 resque-scheduler 工作者:$ RESQUE_PHP=../resque/lib/Resque/Resque.php php resque-scheduler.php
事件/钩子系统
php-resque-scheduler 使用与 php-resque 相同的事件系统,并公开以下事件。
afterSchedule
在任务被添加到调度列表后调用。传递的参数包括时间戳、任务队列、任务类名以及任务的参数。
beforeDelayedEnqueue
在任务从延迟队列中取出后立即调用,并在任务添加到resque队列之前。传递的参数包括任务队列、任务类名以及任务的参数。
贡献者
- chrisboulton
- rayward
- atorres757
- tonypiper
- biinari
- cballou