diff options
Diffstat (limited to 'lib/public/Files/Lock/ILockProvider.php')
-rw-r--r-- | lib/public/Files/Lock/ILockProvider.php | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/public/Files/Lock/ILockProvider.php b/lib/public/Files/Lock/ILockProvider.php new file mode 100644 index 00000000000..be0306e3188 --- /dev/null +++ b/lib/public/Files/Lock/ILockProvider.php @@ -0,0 +1,40 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ + +namespace OCP\Files\Lock; + +use OCP\PreConditionNotMetException; + +/** + * @since 24.0.0 + */ +interface ILockProvider { + /** + * @throws PreConditionNotMetException + * @throws NoLockProviderException + * @psalm-return list<ILock> + * @since 24.0.0 + */ + public function getLocks(int $fileId): array; + + /** + * @throws PreConditionNotMetException + * @throws OwnerLockedException + * @throws NoLockProviderException + * @since 24.0.0 + */ + public function lock(LockContext $lockInfo): ILock; + + /** + * @throws PreConditionNotMetException + * @throws NoLockProviderException + * @since 24.0.0 + */ + public function unlock(LockContext $lockInfo): void; +} |