-
Notifications
You must be signed in to change notification settings - Fork 58
Expand file tree
/
Copy pathCallOptions.php
More file actions
160 lines (143 loc) · 5.94 KB
/
CallOptions.php
File metadata and controls
160 lines (143 loc) · 5.94 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?php
/*
* Copyright 2023 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\Options;
use ArrayAccess;
use Google\ApiCore\CredentialsWrapper;
use Google\ApiCore\RetrySettings;
/**
* The CallOptions class provides typing to the associative array of options
* passed to transport RPC methods. See
* {@see \Google\ApiCore\Transport\TransportInterface::startUnaryCall()},
* {@see \Google\ApiCore\Transport\TransportInterface::startBidiStreamingCall()},
* {@see \Google\ApiCore\Transport\TransportInterface::startClientStreamingCall()}, and
* {@see \Google\ApiCore\Transport\TransportInterface::startServerStreamingCall()}.
*/
class CallOptions implements ArrayAccess, OptionsInterface
{
use OptionsTrait;
private array $headers;
private ?int $timeoutMillis;
private array $transportOptions;
/** @var RetrySettings|array|null $retrySettings */
private $retrySettings;
/**
* @param array $options {
* Call options
*
* @type array<string, array<string>> $headers
* Key-value array containing headers.
* @type int $timeoutMillis
* The timeout in milliseconds for the call.
* @type array $transportOptions
* Transport-specific call options. See {@see CallOptions::setTransportOptions}.
* @type RetrySettings|array $retrySettings
* A retry settings override for the call. If $retrySettings is an
* array, the settings will be merged with the method's default
* retry settings. If $retrySettings is a RetrySettings object,
* that object will be used instead of the method defaults.
* }
*/
public function __construct(array $options)
{
$this->fromArray($options);
}
/**
* Sets the array of options as class properites.
*
* @param array $arr See the constructor for the list of supported options.
*/
private function fromArray(array $arr): void
{
$this->setHeaders($arr['headers'] ?? []);
$this->setTimeoutMillis($arr['timeoutMillis'] ?? null);
$this->setTransportOptions($arr['transportOptions'] ?? []);
$this->setRetrySettings($arr['retrySettings'] ?? null);
}
/**
* @param array $headers
*/
public function setHeaders(array $headers): self
{
$this->headers = $headers;
return $this;
}
/**
* @param int|null $timeoutMillis
*/
public function setTimeoutMillis(?int $timeoutMillis): self
{
$this->timeoutMillis = $timeoutMillis;
return $this;
}
/**
* @param array $transportOptions {
* Transport-specific call-time options.
*
* @type array $grpcOptions
* Key-value pairs for gRPC-specific options passed as the `$options` argument to {@see \Grpc\BaseStub}
* request methods. Current options are `call_credentials_callback` and `timeout`.
* **NOTE**: This library sets `call_credentials_callback` using {@see CredentialsWrapper}, and `timeout`
* using the `timeoutMillis` call option, so these options are not very useful.
* @type array $grpcFallbackOptions
* Key-value pairs for gRPC fallback specific options passed as the `$options` argument to the
* `$httpHandler` callable. By default these are passed to {@see \GuzzleHttp\Client} as request options.
* See {@link https://docs.guzzlephp.org/en/stable/request-options.html}.
* @type array $restOptions
* Key-value pairs for REST-specific options passed as the `$options` argument to the `$httpHandler`
* callable. By default these are passed to {@see \GuzzleHttp\Client} as request options.
* See {@link https://docs.guzzlephp.org/en/stable/request-options.html}.
* }
*/
public function setTransportOptions(array $transportOptions): self
{
$this->transportOptions = $transportOptions;
return $this;
}
/**
* @deprecated use CallOptions::setTransportOptions
*/
public function setTransportSpecificOptions(array $transportSpecificOptions): self
{
$this->setTransportOptions($transportSpecificOptions);
return $this;
}
/**
* @param RetrySettings|array|null $retrySettings
*
* @return $this
*/
public function setRetrySettings($retrySettings): self
{
$this->retrySettings = $retrySettings;
return $this;
}
}