<?php /* * Copyright 2018 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; /** * @internal */ trait PollingTrait { /** * @param callable $pollCallable The call to poll. Must return a boolean indicating whether the * operation has completed, and the polling loop can be terminated. * @param array $options { * Options for configuring the polling behaviour. * * @type int $initialPollDelayMillis The initial polling interval to use, in milliseconds. * @type int $pollDelayMultiplier Multiplier applied to the polling interval on each retry. * @type int $maxPollDelayMillis The maximum polling interval to use, in milliseconds. * @type int $totalPollTimeoutMillis The maximum amount of time to continue polling, in milliseconds. * } * @return bool */ private function poll(callable $pollCallable, array $options) { $currentPollDelayMillis = $options['initialPollDelayMillis']; $pollDelayMultiplier = $options['pollDelayMultiplier']; $maxPollDelayMillis = $options['maxPollDelayMillis']; $totalPollTimeoutMillis = $options['totalPollTimeoutMillis']; $hasTotalPollTimeout = $totalPollTimeoutMillis > 0.0; $endTime = $this->getCurrentTimeMillis() + $totalPollTimeoutMillis; while (true) { if ($hasTotalPollTimeout && $this->getCurrentTimeMillis() > $endTime) { return false; } $this->sleepMillis($currentPollDelayMillis); if ($pollCallable()) { return true; } $currentPollDelayMillis = (int) min([ $currentPollDelayMillis * $pollDelayMultiplier, $maxPollDelayMillis ]); } } /** * Protected to allow overriding for tests * * @return float Current time in milliseconds */ protected function getCurrentTimeMillis() { return microtime(true) * 1000.0; } /** * Protected to allow overriding for tests * * @param int $millis */ protected function sleepMillis(int $millis) { usleep($millis * 1000); } }
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 |
|