1
0

IMemcacheTTL.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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;
  24. /**
  25. * Interface for memcache backends that support setting ttl after the value is set
  26. *
  27. * @since 8.2.2
  28. */
  29. interface IMemcacheTTL extends IMemcache {
  30. /**
  31. * Set the ttl for an existing value
  32. *
  33. * @param string $key
  34. * @param int $ttl time to live in seconds
  35. * @since 8.2.2
  36. */
  37. public function setTTL(string $key, int $ttl);
  38. /**
  39. * Get the ttl for an existing value, in seconds till expiry
  40. *
  41. * @return int|false
  42. * @since 27
  43. */
  44. public function getTTL(string $key): int|false;
  45. /**
  46. * Set the ttl for an existing value if the value matches
  47. *
  48. * @param string $key
  49. * @param mixed $value
  50. * @param int $ttl time to live in seconds
  51. * @since 27
  52. */
  53. public function compareSetTTL(string $key, $value, int $ttl): bool;
  54. }