blob: bec3f21fe16dfa65c6791644968c628839d5121d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\BackgroundJob;
use OCP\ILogger;
/**
* Simple base class to extend to run periodic background jobs.
* Call setInterval with your desired interval in seconds from the constructor.
*
* @since 15.0.0
*/
abstract class TimedJob extends Job {
protected int $interval = 0;
protected int $timeSensitivity = IJob::TIME_SENSITIVE;
/**
* Set the interval for the job
*
* @param int $seconds the time to pass between two runs of the same job in seconds
*
* @since 15.0.0
*/
public function setInterval(int $seconds) {
$this->interval = $seconds;
}
/**
* Whether the background job is time sensitive and needs to run soon after
* the scheduled interval, of if it is okay to be delayed until a later time.
*
* @return bool
* @since 24.0.0
*/
public function isTimeSensitive(): bool {
return $this->timeSensitivity === IJob::TIME_SENSITIVE;
}
/**
* If your background job is not time sensitive (sending instant email
* notifications, etc.) it would be nice to set it to IJob::TIME_INSENSITIVE
* This way the execution can be delayed during high usage times.
*
* @param int $sensitivity
* @psalm-param IJob::TIME_* $sensitivity
* @return void
* @since 24.0.0
*/
public function setTimeSensitivity(int $sensitivity): void {
if ($sensitivity !== IJob::TIME_SENSITIVE &&
$sensitivity !== IJob::TIME_INSENSITIVE) {
throw new \InvalidArgumentException('Invalid sensitivity');
}
$this->timeSensitivity = $sensitivity;
}
/**
* Run the job if the last run is more than the interval ago
*
* @param IJobList $jobList
* @param ILogger|null $logger
*
* @since 15.0.0
* @deprecated 25.0.0 Use start() instead
*/
final public function execute(IJobList $jobList, ?ILogger $logger = null) {
$this->start($jobList);
}
/**
* Run the job if the last run is more than the interval ago
*
* @since 25.0.0
*/
final public function start(IJobList $jobList): void {
if (($this->time->getTime() - $this->lastRun) > $this->interval) {
parent::start($jobList);
}
}
}
|
