Skip to content

Commit 5064662

Browse files
committed
comments
1 parent 8f0c4b8 commit 5064662

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

src/Client.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -796,7 +796,10 @@ public function getUrl($component = null)
796796
* will be used. If that is 0, a platform specific timeout will apply.
797797
* This timeout value is passed to fsockopen(). It is also used for detecting server
798798
* timeouts during communication (i.e. if the server does not send anything to the client
799-
* for $timeout seconds, the connection will be closed).
799+
* for $timeout seconds, the connection will be closed). When in CURL mode, this is the
800+
* CURL timeout.
801+
* NB: in both CURL and Socket modes, some conditions might lead to the client not
802+
* respecting the given timeout. Eg. if the network is not connected
800803
* @param string $method deprecated. Use the same value in the constructor instead.
801804
* Valid values are 'http', 'http11', 'https', 'h2' and 'h2c'. If left empty,
802805
* the http protocol chosen during creation of the object will be used.
@@ -1378,7 +1381,7 @@ protected function createCURLHandle($req, $method, $server, $port, $path, $opts)
13781381

13791382
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
13801383
// previous note: "timeout is borked" (on some old php/curl versions? It seems to work on 8.1. Maybe the issue
1381-
// hsa to do with dns resolution...)
1384+
// has to do with dns resolution...)
13821385
if ($opts['timeout']) {
13831386
curl_setopt($curl, CURLOPT_TIMEOUT, $opts['timeout']);
13841387
}
@@ -1509,7 +1512,7 @@ protected function createCURLHandle($req, $method, $server, $port, $path, $opts)
15091512
* docs for the send() method". Please use setOption instead to set a timeout
15101513
* @param string $method deprecated. Was: "the http protocol variant to be used. See the details in the docs for the send() method."
15111514
* Please use the constructor to set an http protocol variant.
1512-
* @param boolean $fallback deprecated. Was: "w"hen true, upon receiving an error during multicall, multiple single
1515+
* @param boolean $fallback deprecated. Was: "when true, upon receiving an error during multicall, multiple single
15131516
* calls will be attempted"
15141517
* @return Response[]
15151518
*/

0 commit comments

Comments
 (0)