From e1fa314b18b8606ddfe219ee66b43e586b7d8651 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 14 Jul 2016 14:46:01 +0200 Subject: add notify support to smb storage --- lib/public/Files/Storage/INotifyStorage.php | 47 +++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 lib/public/Files/Storage/INotifyStorage.php (limited to 'lib/public') diff --git a/lib/public/Files/Storage/INotifyStorage.php b/lib/public/Files/Storage/INotifyStorage.php new file mode 100644 index 00000000000..0bf9b2a87fb --- /dev/null +++ b/lib/public/Files/Storage/INotifyStorage.php @@ -0,0 +1,47 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Files\Storage; + +/** + * Storage backend that support active notifications + */ +interface INotifyStorage { + const NOTIFY_ADDED = 1; + const NOTIFY_REMOVED = 2; + const NOTIFY_MODIFIED = 3; + const NOTIFY_RENAMED = 4; + + /** + * Start listening for update notifications + * + * The provided callback will be called for every incoming notification with the following parameters + * - int $type the type of update, one of the INotifyStorage::NOTIFY_* constants + * - string $path the path of the update + * - string $renameTarget the target of the rename operation, only provided for rename updates + * + * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback + * + * @param string $path + * @param callable $callback + */ + public function listen($path, callable $callback); +} -- cgit v1.2.3