media-cloud-sync / includes / sdk / google / google / gax / src / ServerStreamingCallInterface.php

ServerStreamingCallInterface.php in Media Cloud Sync 1.0.3, at includes/sdk/google/google/gax/src/ServerStreamingCallInterface.php

88 lines 2.9 KB

Raw Download Zip

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