You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
1.9 KiB
81 lines
1.9 KiB
<?php |
|
declare(strict_types=1); |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Robin Appelman <robin@icewind.nl> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* This code is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License, version 3, |
|
* as published by the Free Software Foundation. |
|
* |
|
* 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, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
namespace OCP\Lock; |
|
|
|
/** |
|
* Interface ILockingProvider |
|
* |
|
* @package OCP\Lock |
|
* @since 8.1.0 |
|
*/ |
|
interface ILockingProvider { |
|
/** |
|
* @since 8.1.0 |
|
*/ |
|
const LOCK_SHARED = 1; |
|
/** |
|
* @since 8.1.0 |
|
*/ |
|
const LOCK_EXCLUSIVE = 2; |
|
|
|
/** |
|
* @param string $path |
|
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @return bool |
|
* @since 8.1.0 |
|
*/ |
|
public function isLocked(string $path, int $type): bool; |
|
|
|
/** |
|
* @param string $path |
|
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @throws \OCP\Lock\LockedException |
|
* @since 8.1.0 |
|
*/ |
|
public function acquireLock(string $path, int $type); |
|
|
|
/** |
|
* @param string $path |
|
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @since 8.1.0 |
|
*/ |
|
public function releaseLock(string $path, int $type); |
|
|
|
/** |
|
* Change the type of an existing lock |
|
* |
|
* @param string $path |
|
* @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @throws \OCP\Lock\LockedException |
|
* @since 8.1.0 |
|
*/ |
|
public function changeLock(string $path, int $targetType); |
|
|
|
/** |
|
* release all lock acquired by this instance |
|
* @since 8.1.0 |
|
*/ |
|
public function releaseAll(); |
|
}
|
|
|