aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/BackgroundJob/IParallelAwareJob.php
blob: d69d897cb0c8a66cd05a432e01b13a862ebd5d4f (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
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\BackgroundJob;

/**
 * @since 27.0.0
 */
interface IParallelAwareJob {
	/**
	 * Set this to false to prevent two Jobs from the same class from running in parallel
	 *
	 * @param bool $allow
	 * @return void
	 * @since 27.0.0
	 */
	public function setAllowParallelRuns(bool $allow): void;

	/**
	 * @return bool
	 * @since 27.0.0
	 */
	public function getAllowParallelRuns(): bool;
}