8000 [HttpClient] use "idle" instead of "inactivity" when telling about th… · symfony/symfony@d2c4bf0 · GitHub
[go: up one dir, main page]
Skip to content

Commit d2c4bf0

Browse files
nicolas-grekasnicolas-grekas
committed
[HttpClient] use "idle" instead of "inactivity" when telling about the timeout option
1 parent 69ef436 commit d2c4bf0

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode)
13481348
->info('A comma separated list of hosts that do not require a proxy to be reached.')
13491349
->end()
13501350
->floatNode('timeout')
1351-
->info('Defaults to "default_socket_timeout" ini parameter.')
1351+
->info('The idle timeout, defaults to the "default_socket_timeout" ini parameter.')
13521352
->end()
13531353
->scalarNode('bindto')
13541354
->info('A network interface name, IP address, a host name or a UNIX socket to bind to.')

‎src/Symfony/Component/HttpClient/Chunk/ErrorChunk.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public function __construct(int $offset, \Throwable $error = null)
3030
{
3131
$this->offset = $offset;
3232
$this->error = $error;
33-
$this->errorMessage = null !== $error ? $error->getMessage() : 'Reading from the response stream reached the inactivity timeout.';
33+
$this->errorMessage = null !== $error ? $error->getMessage() : 'Reading from the response stream reached the idle timeout.';
3434
}
3535

3636
/**

‎src/Symfony/Contracts/HttpClient/ChunkInterface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
interface ChunkInterface
2828
{
2929
/**
30-
* Tells when the inactivity timeout has been reached.
30+
* Tells when the idle timeout has been reached.
3131
*
3232
* @throws TransportExceptionInterface on a network error
3333
*/
@@ -36,21 +36,21 @@ public function isTimeout(): bool;
3636
/**
3737
* Tells when headers just arrived.
3838
*
39-
* @throws TransportExceptionInterface on a network error or when the inactivity timeout is reached
39+
* @throws TransportExceptionInterface on a network error or when the idle timeout is reached
4040
*/
4141
public function isFirst(): bool;
4242

4343
/**
4444
* Tells when the body just completed.
4545
*
46-
* @throws TransportExceptionInterface on a network error or when the inactivity timeout is reached
46+
* @throws TransportExceptionInterface on a network error or when the idle timeout is reached
4747
*/
4848
public function isLast(): bool;
4949

5050
/**
5151
* Returns the content of the response chunk.
5252
*
53-
* @throws TransportExceptionInterface on a network error or when the inactivity timeout is reached
53+
* @throws TransportExceptionInterface on a network error or when the idle timeout is reached
5454
*/
5555
public function getContent(): string;
5656

‎src/Symfony/Contracts/HttpClient/HttpClientInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface HttpClientInterface
5252
'resolve' => [], // string[] - a map of host to IP address that SHOULD replace DNS resolution
5353
'proxy' => null, // string - by default, the proxy-related env vars handled by curl SHOULD be honored
5454
'no_proxy' => null, // string - a comma separated list of hosts that do not require a proxy to be reached
55-
'timeout' => null, // float - the inactivity timeout - defaults to ini_get('default_socket_timeout')
55+
'timeout' => null, // float - the idle timeout - defaults to ini_get('default_socket_timeout')
5656
'bindto' => '0', // string - the interface or the local socket to bind to
5757
'verify_peer' => true, // see https://php.net/context.ssl for the following options
5858
'verify_host' => true,
@@ -85,7 +85,7 @@ public function request(string $method, string $url, array $options = []): Respo
8585
* Yields responses chunk by chunk as they complete.
8686
*
8787
* @param ResponseInterface|ResponseInterface[]|iterable $responses One or more responses created by the current HTTP client
88-
* @param float|null $timeout The inactivity timeout before exiting the iterator
88+
* @param float|null $timeout The idle timeout before yielding timeout chunks
8989
*/
9090
public function stream($responses, float $timeout = null): ResponseStreamInterface;
9191
}

0 commit comments

Comments
 (0)
0