blob: 28a7df1c3771f3a610dc573f85406e79084e0f5c (
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
87
88
89
90
91
92
93
94
95
96
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\BackgroundJob;
use OCP\ILogger;
/**
* This interface represents a background job run with cron
*
* To implement a background job, you must extend either \OCP\BackgroundJob\Job,
* \OCP\BackgroundJob\TimedJob or \OCP\BackgroundJob\QueuedJob
*
* @since 7.0.0
*/
interface IJob {
/**
* @since 24.0.0
*/
public const TIME_INSENSITIVE = 0;
/**
* @since 24.0.0
*/
public const TIME_SENSITIVE = 1;
/**
* Run the background job with the registered argument
*
* @param IJobList $jobList The job list that manages the state of this job
* @param ILogger|null $logger
* @since 7.0.0
* @deprecated 25.0.0 Use start() instead. This method will be removed
* with the ILogger interface
*/
public function execute(IJobList $jobList, ?ILogger $logger = null);
/**
* Start the background job with the registered argument
*
* This methods will take care of running the background job, of initializing
* the state and cleaning up the job list after running the job.
*
* For common background job scenario, you will want to use TimedJob or QueuedJob
* instead of overwritting this method.
*
* @param IJobList $jobList The job list that manages the state of this job
* @since 25.0.0
*/
public function start(IJobList $jobList): void;
/**
* @since 7.0.0
*/
public function setId(int $id);
/**
* @since 7.0.0
*/
public function setLastRun(int $lastRun);
/**
* @param mixed $argument
* @since 7.0.0
*/
public function setArgument($argument);
/**
* Get the id of the background job
* This id is determined by the job list when a job is added to the list
*
* @return int
* @since 7.0.0
*/
public function getId();
/**
* Get the last time this job was run as unix timestamp
*
* @return int
* @since 7.0.0
*/
public function getLastRun();
/**
* Get the argument associated with the background job
* This is the argument that will be passed to the background job
*
* @return mixed
* @since 7.0.0
*/
public function getArgument();
}
|
