blob: 5b28417a0df479d442fd4e91f81bbdc2b5b35547 [file] [log] [blame]
mlumish156e67d2015-01-02 14:59:16 -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 */
mlumish156e67d2015-01-02 14:59:16 -080034namespace Grpc;
murgatroid999140a062015-03-26 11:27:58 -070035
murgatroid999140a062015-03-26 11:27:58 -070036abstract class AbstractCall {
37
38 protected $call;
39 protected $deserialize;
40 protected $metadata;
mlumish156e67d2015-01-02 14:59:16 -080041
42 /**
murgatroid999140a062015-03-26 11:27:58 -070043 * Create a new Call wrapper object.
44 * @param Channel $channel The channel to communicate on
45 * @param string $method The method to call on the remote server
Stanley Cheungcc019af2015-06-15 11:45:00 -070046 * @param callback $deserialize A callback function to deserialize
47 * the response
48 * @param (optional) long $timeout Timeout in microseconds
mlumish156e67d2015-01-02 14:59:16 -080049 */
Stanley Cheungcc019af2015-06-15 11:45:00 -070050 public function __construct(Channel $channel, $method, $deserialize, $timeout = false) {
51 if ($timeout) {
52 $now = Timeval::now();
53 $delta = new Timeval($timeout);
54 $deadline = $now->add($delta);
55 } else {
56 $deadline = Timeval::infFuture();
57 }
58 $this->call = new Call($channel, $method, $deadline);
murgatroid999140a062015-03-26 11:27:58 -070059 $this->deserialize = $deserialize;
murgatroid99d8cc6b82015-04-01 11:14:16 -070060 $this->metadata = null;
mlumish156e67d2015-01-02 14:59:16 -080061 }
62
63 /**
murgatroid999140a062015-03-26 11:27:58 -070064 * @return The metadata sent by the server.
mlumish156e67d2015-01-02 14:59:16 -080065 */
murgatroid999140a062015-03-26 11:27:58 -070066 public function getMetadata() {
67 return $this->metadata;
mlumish156e67d2015-01-02 14:59:16 -080068 }
69
70 /**
murgatroid999140a062015-03-26 11:27:58 -070071 * Cancels the call
mlumish156e67d2015-01-02 14:59:16 -080072 */
murgatroid999140a062015-03-26 11:27:58 -070073 public function cancel() {
74 $this->call->cancel();
mlumish156e67d2015-01-02 14:59:16 -080075 }
76
77 /**
murgatroid999140a062015-03-26 11:27:58 -070078 * Deserialize a response value to an object.
79 * @param string $value The binary value to deserialize
80 * @return The deserialized value
mlumish156e67d2015-01-02 14:59:16 -080081 */
murgatroid999140a062015-03-26 11:27:58 -070082 protected function deserializeResponse($value) {
83 if ($value === null) {
84 return null;
85 }
86 return call_user_func($this->deserialize, $value);
mlumish156e67d2015-01-02 14:59:16 -080087 }
murgatroid999140a062015-03-26 11:27:58 -070088}