diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-19 09:00:09 +0300 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-19 10:43:33 +0300 |
commit | d666725fa783c21235eec79fa6dbe8ba1881fec3 (patch) | |
tree | 98914481ca4218c9af2c04db17c6d8f281b0094d /lib/public/IEventSource.php | |
parent | 4a94203492e3b475ee26b65d5992796152c645bd (diff) |
Move \OCP to PSR-4
Diffstat (limited to 'lib/public/IEventSource.php')
-rw-r--r-- | lib/public/IEventSource.php | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/lib/public/IEventSource.php b/lib/public/IEventSource.php new file mode 100644 index 00000000000..b643d1c9da7 --- /dev/null +++ b/lib/public/IEventSource.php @@ -0,0 +1,51 @@ +<?php +/** + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin Appelman <icewind@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP; + +/** + * wrapper for server side events (http://en.wikipedia.org/wiki/Server-sent_events) + * includes a fallback for older browsers and IE + * + * use server side events with caution, to many open requests can hang the server + * + * The event source will initialize the connection to the client when the first data is sent + * @since 8.0.0 + */ +interface IEventSource { + /** + * send a message to the client + * + * @param string $type + * @param mixed $data + * + * if only one parameter is given, a typeless message will be send with that parameter as data + * @since 8.0.0 + */ + public function send($type, $data = null); + + /** + * close the connection of the event source + * @since 8.0.0 + */ + public function close(); +} |