ServerStreamingCallInterface.php 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <?php
  2. /*
  3. * Copyright 2021 Google LLC
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without
  7. * modification, are permitted provided that the following conditions are
  8. * met:
  9. *
  10. * * Redistributions of source code must retain the above copyright
  11. * notice, this list of conditions and the following disclaimer.
  12. * * Redistributions in binary form must reproduce the above
  13. * copyright notice, this list of conditions and the following disclaimer
  14. * in the documentation and/or other materials provided with the
  15. * distribution.
  16. * * Neither the name of Google Inc. nor the names of its
  17. * contributors may be used to endorse or promote products derived from
  18. * this software without specific prior written permission.
  19. *
  20. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. */
  32. namespace Google\ApiCore;
  33. /**
  34. * @internal
  35. */
  36. interface ServerStreamingCallInterface
  37. {
  38. /**
  39. * Start the call.
  40. *
  41. * @param mixed $data The data to send
  42. * @param array<mixed> $metadata Metadata to send with the call, if applicable
  43. * (optional)
  44. * @param array<mixed> $options An array of options, possible keys:
  45. * 'flags' => a number (optional)
  46. * @return void
  47. */
  48. public function start($data, array $metadata = [], array $options = []);
  49. /**
  50. * @return mixed An iterator of response values.
  51. */
  52. public function responses();
  53. /**
  54. * Return the status of the server stream.
  55. *
  56. * @return \stdClass The API status.
  57. */
  58. public function getStatus();
  59. /**
  60. * @return mixed The metadata sent by the server.
  61. */
  62. public function getMetadata();
  63. /**
  64. * @return mixed The trailing metadata sent by the server.
  65. */
  66. public function getTrailingMetadata();
  67. /**
  68. * @return string The URI of the endpoint.
  69. */
  70. public function getPeer();
  71. /**
  72. * Cancels the call.
  73. *
  74. * @return void
  75. */
  76. public function cancel();
  77. /**
  78. * Set the CallCredentials for the underlying Call.
  79. *
  80. * @param mixed $call_credentials The CallCredentials object
  81. *
  82. * @return void
  83. */
  84. public function setCallCredentials($call_credentials);
  85. }