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.

87 lines
1.9 KiB

3 years ago
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2019, Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Lock;
  25. /**
  26. * Class ManuallyLockedException
  27. *
  28. * @since 18.0.0
  29. */
  30. class ManuallyLockedException extends LockedException {
  31. /**
  32. * owner of the lock
  33. *
  34. * @var string|null
  35. */
  36. private $owner = null;
  37. /**
  38. * estimated timeout for the lock
  39. *
  40. * @var int
  41. * @since 18.0.0
  42. */
  43. private $timeout = -1;
  44. /**
  45. * ManuallyLockedException constructor.
  46. *
  47. * @param string $path locked path
  48. * @param \Exception|null $previous previous exception for cascading
  49. * @param string $existingLock
  50. * @param string|null $owner
  51. * @param int $timeout
  52. *
  53. * @since 18.0.0
  54. */
  55. public function __construct(string $path, \Exception $previous = null, ?string $existingLock = null, ?string $owner = null, int $timeout = -1) {
  56. parent::__construct($path, $previous, $existingLock);
  57. $this->owner = $owner;
  58. $this->timeout = $timeout;
  59. }
  60. /**
  61. * @return int
  62. * @since 18.0.0
  63. */
  64. public function getTimeout(): int {
  65. return $this->timeout;
  66. }
  67. /**
  68. * @return string|null
  69. * @since 18.0.0
  70. */
  71. public function getOwner(): ?string {
  72. return $this->owner;
  73. }
  74. }