ILockingStorage.php 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Morris Jobke <hey@morrisjobke.de>
  6. * @author Robin Appelman <robin@icewind.nl>
  7. *
  8. * @license AGPL-3.0
  9. *
  10. * This code is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License, version 3,
  12. * as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License, version 3,
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>
  21. *
  22. */
  23. namespace OCP\Files\Storage;
  24. use OCP\Lock\ILockingProvider;
  25. /**
  26. * Storage backends that require explicit locking
  27. *
  28. * Storage backends implementing this interface do not need to implement their own locking implementation but should use the provided lockingprovider instead
  29. * The implementation of the locking methods only need to map internal storage paths to "lock keys"
  30. *
  31. * @since 9.0.0
  32. */
  33. interface ILockingStorage {
  34. /**
  35. * @param string $path The path of the file to acquire the lock for
  36. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  37. * @param \OCP\Lock\ILockingProvider $provider
  38. * @throws \OCP\Lock\LockedException
  39. * @since 9.0.0
  40. */
  41. public function acquireLock($path, $type, ILockingProvider $provider);
  42. /**
  43. * @param string $path The path of the file to acquire the lock for
  44. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  45. * @param \OCP\Lock\ILockingProvider $provider
  46. * @throws \OCP\Lock\LockedException
  47. * @since 9.0.0
  48. */
  49. public function releaseLock($path, $type, ILockingProvider $provider);
  50. /**
  51. * @param string $path The path of the file to change the lock for
  52. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  53. * @param \OCP\Lock\ILockingProvider $provider
  54. * @throws \OCP\Lock\LockedException
  55. * @since 9.0.0
  56. */
  57. public function changeLock($path, $type, ILockingProvider $provider);
  58. }