IPropagator.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Robin Appelman <robin@icewind.nl>
  6. *
  7. * @license AGPL-3.0
  8. *
  9. * This code is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License, version 3,
  11. * as published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License, version 3,
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>
  20. *
  21. */
  22. namespace OCP\Files\Cache;
  23. /**
  24. * Propagate etags and mtimes within the storage
  25. *
  26. * @since 9.0.0
  27. */
  28. interface IPropagator {
  29. /**
  30. * Mark the beginning of a propagation batch
  31. *
  32. * Note that not all cache setups support propagation in which case this will be a noop
  33. *
  34. * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent
  35. * before the batch is committed.
  36. *
  37. * @since 9.1.0
  38. */
  39. public function beginBatch();
  40. /**
  41. * Commit the active propagation batch
  42. *
  43. * @since 9.1.0
  44. */
  45. public function commitBatch();
  46. /**
  47. * @param string $internalPath
  48. * @param int $time
  49. * @param int $sizeDifference
  50. * @since 9.0.0
  51. */
  52. public function propagateChange($internalPath, $time, $sizeDifference = 0);
  53. }