1
0

IEventSource.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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. * wrapper for server side events (http://en.wikipedia.org/wiki/Server-sent_events)
  26. * includes a fallback for older browsers and IE
  27. *
  28. * use server side events with caution, to many open requests can hang the server
  29. *
  30. * The event source will initialize the connection to the client when the first data is sent
  31. * @since 8.0.0
  32. */
  33. interface IEventSource {
  34. /**
  35. * send a message to the client
  36. *
  37. * @param string $type
  38. * @param mixed $data
  39. *
  40. * if only one parameter is given, a typeless message will be send with that parameter as data
  41. * @since 8.0.0
  42. */
  43. public function send($type, $data = null);
  44. /**
  45. * close the connection of the event source
  46. * @since 8.0.0
  47. */
  48. public function close();
  49. }