1
0

INotifyHandler.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
  4. *
  5. * @author Robin Appelman <robin@icewind.nl>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  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
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Files\Notify;
  24. /**
  25. * Provides access to detected changes in the storage by either actively listening
  26. * or getting the list of changes that happened in the background
  27. *
  28. * @since 12.0.0
  29. */
  30. interface INotifyHandler {
  31. /**
  32. * Start listening for update notifications
  33. *
  34. * The provided callback will be called for every incoming notification with the following parameters
  35. * - IChange|IRenameChange $change
  36. *
  37. * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
  38. *
  39. * @param callable $callback
  40. *
  41. * @since 12.0.0
  42. */
  43. public function listen(callable $callback);
  44. /**
  45. * Get all changes detected since the start of the notify process or the last call to getChanges
  46. *
  47. * @return IChange[]
  48. *
  49. * @since 12.0.0
  50. */
  51. public function getChanges();
  52. /**
  53. * Stop listening for changes
  54. *
  55. * Note that any pending changes will be discarded
  56. *
  57. * @since 12.0.0
  58. */
  59. public function stop();
  60. }