diff options
Diffstat (limited to 'lib/public/Files/Lock/ILockProvider.php')
-rw-r--r-- | lib/public/Files/Lock/ILockProvider.php | 58 |
1 files changed, 58 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..5df28aaef44 --- /dev/null +++ b/lib/public/Files/Lock/ILockProvider.php @@ -0,0 +1,58 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net> + * + * @author Julius Härtl <jus@bitgrid.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\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(LockScope $lockInfo): ILock; + + /** + * @throws PreConditionNotMetException + * @throws NoLockProviderException + * @since 24.0.0 + */ + public function unlock(LockScope $lockInfo): void; +} |