server/lib/public/BackgroundJob/IParallelAwareJob.php

48 lines
1.2 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023, Marcel Klehr <mklehr@gmx.net>
*
* @author Marcel Klehr <mklehr@gmx.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
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;
}