<?php /* * Copyright 2016 Google LLC * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following disclaimer * in the documentation and/or other materials provided with the * distribution. * * Neither the name of Google Inc. nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ namespace Google\ApiCore; use Google\Rpc\Code; use Grpc\ClientStreamingCall; /** * ClientStream is the response object from a gRPC client streaming API call. */ class ClientStream { private $call; /** * ClientStream constructor. * * @param ClientStreamingCall $clientStreamingCall The gRPC client streaming call object * @param array $streamingDescriptor */ public function __construct( // @phpstan-ignore-line ClientStreamingCall $clientStreamingCall, array $streamingDescriptor = [] ) { $this->call = $clientStreamingCall; } /** * Write request to the server. * * @param mixed $request The request to write */ public function write($request) { $this->call->write($request); } /** * Read the response from the server, completing the streaming call. * * @throws ApiException * @return mixed The response object from the server */ public function readResponse() { list($response, $status) = $this->call->wait(); if ($status->code == Code::OK) { return $response; } else { throw ApiException::createFromStdClass($status); } } /** * Write all data in $dataArray and read the response from the server, completing the streaming * call. * * @param mixed[] $requests An iterator of request objects to write to the server * @return mixed The response object from the server */ public function writeAllAndReadResponse(array $requests) { foreach ($requests as $request) { $this->write($request); } return $this->readResponse(); } /** * Return the underlying gRPC call object * * @return \Grpc\ClientStreamingCall|mixed */ public function getClientStreamingCall() { return $this->call; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Middleware | Folder | 0755 |
|
|
ResourceTemplate | Folder | 0755 |
|
|
Testing | Folder | 0755 |
|
|
Transport | Folder | 0755 |
|
|
AgentHeader.php | File | 6.47 KB | 0644 |
|
ApiException.php | File | 10.94 KB | 0644 |
|
ApiStatus.php | File | 6.51 KB | 0644 |
|
ArrayTrait.php | File | 3.64 KB | 0644 |
|
BidiStream.php | File | 5.83 KB | 0644 |
|
Call.php | File | 3.45 KB | 0644 |
|
ClientStream.php | File | 3.41 KB | 0644 |
|
CredentialsWrapper.php | File | 11.39 KB | 0644 |
|
FixedSizeCollection.php | File | 6.26 KB | 0644 |
|
GPBLabel.php | File | 1.82 KB | 0644 |
|
GPBType.php | File | 2.19 KB | 0644 |
|
GapicClientTrait.php | File | 39.25 KB | 0644 |
|
GrpcSupportTrait.php | File | 2.24 KB | 0644 |
|
OperationResponse.php | File | 18.41 KB | 0644 |
|
Page.php | File | 9.22 KB | 0644 |
|
PageStreamingDescriptor.php | File | 6.18 KB | 0644 |
|
PagedListResponse.php | File | 6.78 KB | 0644 |
|
PathTemplate.php | File | 4.06 KB | 0644 |
|
PollingTrait.php | File | 3.65 KB | 0644 |
|
RequestBuilder.php | File | 9.75 KB | 0644 |
|
RequestParamsHeaderDescriptor.php | File | 2.57 KB | 0644 |
|
ResourceHelperTrait.php | File | 3.73 KB | 0644 |
|
RetrySettings.php | File | 20 KB | 0644 |
|
Serializer.php | File | 17.03 KB | 0644 |
|
ServerStream.php | File | 3.43 KB | 0644 |
|
ServerStreamingCallInterface.php | File | 2.94 KB | 0644 |
|
ServiceAddressTrait.php | File | 2.48 KB | 0644 |
|
UriTrait.php | File | 2.33 KB | 0644 |
|
ValidationException.php | File | 1.7 KB | 0644 |
|
ValidationTrait.php | File | 2.93 KB | 0644 |
|
Version.php | File | 2.49 KB | 0644 |
|