ManuallyLockedException.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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. * @package OCP\Lock
  29. * @since 18.0.0
  30. */
  31. class ManuallyLockedException extends LockedException {
  32. /**
  33. * owner of the lock
  34. *
  35. * @var string|null
  36. */
  37. private $owner = null;
  38. /**
  39. * estimated timeout for the lock
  40. *
  41. * @var int
  42. * @since 18.0.0
  43. */
  44. private $timeout = -1;
  45. /**
  46. * ManuallyLockedException constructor.
  47. *
  48. * @param string $path locked path
  49. * @param \Exception|null $previous previous exception for cascading
  50. * @param string $existingLock
  51. * @param string|null $owner
  52. * @param int $timeout
  53. *
  54. * @since 18.0.0
  55. */
  56. public function __construct(string $path, \Exception $previous = null, ?string $existingLock = null, ?string $owner = null, int $timeout = -1) {
  57. parent::__construct($path, $previous, $existingLock);
  58. $this->owner = $owner;
  59. $this->timeout = $timeout;
  60. }
  61. /**
  62. * @return int
  63. * @since 18.0.0
  64. */
  65. public function getTimeout(): int {
  66. return $this->timeout;
  67. }
  68. /**
  69. * @return string|null
  70. * @since 18.0.0
  71. */
  72. public function getOwner(): ?string {
  73. return $this->owner;
  74. }
  75. }