blob: 454f7621ae4b0c92b1541f68a89aa226ec354feb [file] [log] [blame]
mlumishb892a272014-12-09 16:28:23 -08001<?php
Craig Tiller2e498aa2015-02-16 12:09:31 -08002/*
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 */
mlumishb892a272014-12-09 16:28:23 -080034namespace Grpc;
35
36/**
murgatroid999140a062015-03-26 11:27:58 -070037 * Represents an active call that allows for sending and recieving messages in
38 * streams in any order.
mlumishb892a272014-12-09 16:28:23 -080039 */
murgatroid999140a062015-03-26 11:27:58 -070040class BidiStreamingCall extends AbstractCall {
mlumishb892a272014-12-09 16:28:23 -080041 /**
murgatroid999140a062015-03-26 11:27:58 -070042 * Start the call
mlumishb892a272014-12-09 16:28:23 -080043 * @param array $metadata Metadata to send with the call, if applicable
mlumishb892a272014-12-09 16:28:23 -080044 */
murgatroid999140a062015-03-26 11:27:58 -070045 public function start($metadata) {
46 $event = $this->call->start_batch([
47 OP_SEND_INITIAL_METADATA => $metadata,
48 OP_RECV_INITIAL_METADATA => true]);
murgatroid993f101602015-03-11 16:36:14 -070049 $this->metadata = $event->metadata;
mlumishb892a272014-12-09 16:28:23 -080050 }
51
52 /**
murgatroid999140a062015-03-26 11:27:58 -070053 * Reads the next value from the server.
54 * @return The next value from the server, or null if there is none
mlumishb892a272014-12-09 16:28:23 -080055 */
56 public function read() {
murgatroid993f101602015-03-11 16:36:14 -070057 $read_event = $this->call->start_batch([OP_RECV_MESSAGE => true]);
murgatroid999140a062015-03-26 11:27:58 -070058 return $this->deserializeResponse($read_event->message);
mlumishb892a272014-12-09 16:28:23 -080059 }
60
61 /**
62 * Write a single message to the server. This cannot be called after
63 * writesDone is called.
64 * @param ByteBuffer $data The data to write
65 */
66 public function write($data) {
murgatroid999140a062015-03-26 11:27:58 -070067 $this->call->start_batch([OP_SEND_MESSAGE => $data->serialize()]);
mlumishb892a272014-12-09 16:28:23 -080068 }
69
70 /**
71 * Indicate that no more writes will be sent.
72 */
73 public function writesDone() {
murgatroid993f101602015-03-11 16:36:14 -070074 $this->call->start_batch([OP_SEND_CLOSE_FROM_CLIENT => true]);
mlumishb892a272014-12-09 16:28:23 -080075 }
76
77 /**
78 * Wait for the server to send the status, and return it.
mlumisha7baac52014-12-16 09:23:51 -080079 * @return object The status object, with integer $code, string $details,
80 * and array $metadata members
mlumishb892a272014-12-09 16:28:23 -080081 */
82 public function getStatus() {
murgatroid99685e4d92015-03-24 18:28:28 -070083 $status_event = $this->call->start_batch([
84 OP_RECV_STATUS_ON_CLIENT => true
85 ]);
86 return $status_event->status;
mlumishb892a272014-12-09 16:28:23 -080087 }
murgatroid999140a062015-03-26 11:27:58 -070088}