mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 1 | <?php |
Craig Tiller | 2e498aa | 2015-02-16 12:09:31 -0800 | [diff] [blame] | 2 | /* |
| 3 | * |
| 4 | * Copyright 2015, Google Inc. |
| 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 | */ |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 34 | |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 35 | namespace Grpc; |
| 36 | |
| 37 | /** |
thinkerou | 0c3e8db | 2016-12-15 00:27:03 +0800 | [diff] [blame] | 38 | * Represents an active call that allows for sending and recieving messages |
| 39 | * in streams in any order. |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 40 | */ |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 41 | class BidiStreamingCall extends AbstractCall |
| 42 | { |
| 43 | /** |
| 44 | * Start the call. |
| 45 | * |
| 46 | * @param array $metadata Metadata to send with the call, if applicable |
thinkerou | 0c3e8db | 2016-12-15 00:27:03 +0800 | [diff] [blame] | 47 | * (optional) |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 48 | */ |
Stanislav Pavlovichev | d58199b | 2016-08-23 23:20:34 +0700 | [diff] [blame] | 49 | public function start(array $metadata = []) |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 50 | { |
| 51 | $this->call->startBatch([ |
| 52 | OP_SEND_INITIAL_METADATA => $metadata, |
| 53 | ]); |
murgatroid99 | d8cc6b8 | 2015-04-01 11:14:16 -0700 | [diff] [blame] | 54 | } |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 55 | |
| 56 | /** |
| 57 | * Reads the next value from the server. |
| 58 | * |
Stanislav Pavlovichev | d58199b | 2016-08-23 23:20:34 +0700 | [diff] [blame] | 59 | * @return mixed The next value from the server, or null if there is none |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 60 | */ |
| 61 | public function read() |
| 62 | { |
| 63 | $batch = [OP_RECV_MESSAGE => true]; |
| 64 | if ($this->metadata === null) { |
| 65 | $batch[OP_RECV_INITIAL_METADATA] = true; |
| 66 | } |
| 67 | $read_event = $this->call->startBatch($batch); |
| 68 | if ($this->metadata === null) { |
| 69 | $this->metadata = $read_event->metadata; |
| 70 | } |
| 71 | |
| 72 | return $this->deserializeResponse($read_event->message); |
murgatroid99 | d8cc6b8 | 2015-04-01 11:14:16 -0700 | [diff] [blame] | 73 | } |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 74 | |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 75 | /** |
| 76 | * Write a single message to the server. This cannot be called after |
| 77 | * writesDone is called. |
| 78 | * |
| 79 | * @param ByteBuffer $data The data to write |
thinkerou | 0c3e8db | 2016-12-15 00:27:03 +0800 | [diff] [blame] | 80 | * @param array $options An array of options, possible keys: |
| 81 | * 'flags' => a number (optional) |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 82 | */ |
thinkerou | 0c3e8db | 2016-12-15 00:27:03 +0800 | [diff] [blame] | 83 | public function write($data, array $options = []) |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 84 | { |
Stanley Cheung | 881f4ff | 2016-09-22 16:15:58 -0700 | [diff] [blame] | 85 | $message_array = ['message' => $this->serializeMessage($data)]; |
Stanislav Pavlovichev | d58199b | 2016-08-23 23:20:34 +0700 | [diff] [blame] | 86 | if (array_key_exists('flags', $options)) { |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 87 | $message_array['flags'] = $options['flags']; |
| 88 | } |
| 89 | $this->call->startBatch([ |
| 90 | OP_SEND_MESSAGE => $message_array, |
| 91 | ]); |
Stanley Cheung | 3ab8e79 | 2015-08-24 16:58:42 -0700 | [diff] [blame] | 92 | } |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 93 | |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 94 | /** |
| 95 | * Indicate that no more writes will be sent. |
| 96 | */ |
| 97 | public function writesDone() |
| 98 | { |
| 99 | $this->call->startBatch([ |
| 100 | OP_SEND_CLOSE_FROM_CLIENT => true, |
| 101 | ]); |
| 102 | } |
mlumish | b892a27 | 2014-12-09 16:28:23 -0800 | [diff] [blame] | 103 | |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 104 | /** |
| 105 | * Wait for the server to send the status, and return it. |
| 106 | * |
thinkerou | 0c3e8db | 2016-12-15 00:27:03 +0800 | [diff] [blame] | 107 | * @return \stdClass The status object, with integer $code, string |
| 108 | * $details, and array $metadata members |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 109 | */ |
| 110 | public function getStatus() |
| 111 | { |
| 112 | $status_event = $this->call->startBatch([ |
| 113 | OP_RECV_STATUS_ON_CLIENT => true, |
| 114 | ]); |
| 115 | |
Stanley Cheung | 6668d51 | 2016-05-18 14:05:09 -0700 | [diff] [blame] | 116 | $this->trailing_metadata = $status_event->status->metadata; |
thinkerou | a3730b7 | 2016-07-20 16:59:54 +0800 | [diff] [blame] | 117 | |
Stanley Cheung | d5b2056 | 2015-10-27 13:27:05 -0700 | [diff] [blame] | 118 | return $status_event->status; |
| 119 | } |
| 120 | } |