Skip to content

Commit c758803

Browse files
committed
Merge branch '6.4' into 7.3
* 6.4: Move http_client.retry_failed config inside retry_failed section
2 parents a68147c + 9aedb6e commit c758803

File tree

1 file changed

+73
-71
lines changed

1 file changed

+73
-71
lines changed

reference/configuration/framework.rst

Lines changed: 73 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1687,25 +1687,6 @@ crypto_method
16871687
The minimum version of TLS to accept. The value must be one of the
16881688
``STREAM_CRYPTO_METHOD_TLSv*_CLIENT`` constants defined by PHP.
16891689

1690-
.. _reference-http-client-retry-delay:
1691-
1692-
delay
1693-
.....
1694-
1695-
**type**: ``integer`` **default**: ``1000``
1696-
1697-
The initial delay in milliseconds used to compute the waiting time between retries.
1698-
1699-
.. _reference-http-client-retry-enabled:
1700-
1701-
enabled
1702-
.......
1703-
1704-
**type**: ``boolean`` **default**: ``false``
1705-
1706-
Whether to enable the support for retry failed HTTP request or not.
1707-
This setting is automatically set to true when one of the child settings is configured.
1708-
17091690
extra
17101691
.....
17111692

@@ -1724,15 +1705,6 @@ headers
17241705
An associative array of the HTTP headers added before making the request. This
17251706
value must use the format ``['header-name' => 'value0, value1, ...']``.
17261707

1727-
.. _reference-http-client-retry-http-codes:
1728-
1729-
http_codes
1730-
..........
1731-
1732-
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1733-
1734-
The list of HTTP status codes that triggers a retry of the request.
1735-
17361708
http_version
17371709
............
17381710

@@ -1741,18 +1713,6 @@ http_version
17411713
The HTTP version to use, typically ``'1.1'`` or ``'2.0'``. Leave it to ``null``
17421714
to let Symfony select the best version automatically.
17431715

1744-
.. _reference-http-client-retry-jitter:
1745-
1746-
jitter
1747-
......
1748-
1749-
**type**: ``float`` **default**: ``0.1`` (must be between 0.0 and 1.0)
1750-
1751-
This option adds some randomness to the delay. It's useful to avoid sending
1752-
multiple requests to the server at the exact same time. The randomness is
1753-
calculated as ``delay * jitter``. For example: if delay is ``1000ms`` and jitter
1754-
is ``0.2``, the actual delay will be a number between ``800`` and ``1200`` (1000 +/- 20%).
1755-
17561716
local_cert
17571717
..........
17581718

@@ -1770,16 +1730,6 @@ local_pk
17701730
The path of a file that contains the `PEM formatted`_ private key of the
17711731
certificate defined in the ``local_cert`` option.
17721732

1773-
.. _reference-http-client-retry-max-delay:
1774-
1775-
max_delay
1776-
.........
1777-
1778-
**type**: ``integer`` **default**: ``0``
1779-
1780-
The maximum amount of milliseconds initial to wait between retries.
1781-
Use ``0`` to not limit the duration.
1782-
17831733
max_duration
17841734
............
17851735

@@ -1808,26 +1758,6 @@ max_redirects
18081758
The maximum number of redirects to follow. Use ``0`` to not follow any
18091759
redirection.
18101760

1811-
.. _reference-http-client-retry-max-retries:
1812-
1813-
max_retries
1814-
...........
1815-
1816-
**type**: ``integer`` **default**: ``3``
1817-
1818-
The maximum number of retries for failing requests. When the maximum is reached,
1819-
the client returns the last received response.
1820-
1821-
.. _reference-http-client-retry-multiplier:
1822-
1823-
multiplier
1824-
..........
1825-
1826-
**type**: ``float`` **default**: ``2``
1827-
1828-
This value is multiplied to the delay each time a retry occurs, to distribute
1829-
retries in time instead of making all of them sequentially.
1830-
18311761
no_proxy
18321762
........
18331763

@@ -1912,11 +1842,13 @@ including which types of requests to retry and how many times. The behavior is
19121842
defined with the following options:
19131843

19141844
* :ref:`delay <reference-http-client-retry-delay>`
1845+
* :ref:`enabled <reference-http-client-retry-enabled>`
19151846
* :ref:`http_codes <reference-http-client-retry-http-codes>`
19161847
* :ref:`jitter <reference-http-client-retry-jitter>`
19171848
* :ref:`max_delay <reference-http-client-retry-max-delay>`
19181849
* :ref:`max_retries <reference-http-client-retry-max-retries>`
19191850
* :ref:`multiplier <reference-http-client-retry-multiplier>`
1851+
* :ref:`retry_strategy <reference-http-client-retry-retry-strategy>`
19201852

19211853
.. code-block:: yaml
19221854
@@ -1944,8 +1876,78 @@ defined with the following options:
19441876
retry_failed:
19451877
max_retries: 4
19461878
1879+
.. _reference-http-client-retry-delay:
1880+
1881+
delay
1882+
"""""
1883+
1884+
**type**: ``integer`` **default**: ``1000``
1885+
1886+
The initial delay in milliseconds used to compute the waiting time between retries.
1887+
1888+
.. _reference-http-client-retry-enabled:
1889+
1890+
enabled
1891+
"""""""
1892+
1893+
**type**: ``boolean`` **default**: ``false``
1894+
1895+
Whether to enable the support for retry failed HTTP request or not.
1896+
This setting is automatically set to true when one of the child settings is configured.
1897+
1898+
.. _reference-http-client-retry-http-codes:
1899+
1900+
http_codes
1901+
""""""""""
1902+
1903+
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1904+
1905+
The list of HTTP status codes that triggers a retry of the request.
1906+
1907+
.. _reference-http-client-retry-jitter:
1908+
1909+
jitter
1910+
""""""
1911+
1912+
**type**: ``float`` **default**: ``0.1`` (must be between 0.0 and 1.0)
1913+
1914+
This option adds some randomness to the delay. It's useful to avoid sending
1915+
multiple requests to the server at the exact same time. The randomness is
1916+
calculated as ``delay * jitter``. For example: if delay is ``1000ms`` and jitter
1917+
is ``0.2``, the actual delay will be a number between ``800`` and ``1200`` (1000 +/- 20%).
1918+
1919+
.. _reference-http-client-retry-max-delay:
1920+
1921+
max_delay
1922+
"""""""""
1923+
1924+
**type**: ``integer`` **default**: ``0``
1925+
1926+
The maximum amount of milliseconds initial to wait between retries.
1927+
Use ``0`` to not limit the duration.
1928+
1929+
.. _reference-http-client-retry-max-retries:
1930+
1931+
max_retries
1932+
"""""""""""
1933+
1934+
**type**: ``integer`` **default**: ``3``
1935+
1936+
The maximum number of retries for failing requests. When the maximum is reached,
1937+
the client returns the last received response.
1938+
1939+
.. _reference-http-client-retry-multiplier:
1940+
1941+
multiplier
1942+
""""""""""
1943+
1944+
**type**: ``float`` **default**: ``2``
1945+
1946+
This value is multiplied to the delay each time a retry occurs, to distribute
1947+
retries in time instead of making all of them sequentially.
1948+
19471949
retry_strategy
1948-
..............
1950+
""""""""""""""
19491951

19501952
**type**: ``string``
19511953

0 commit comments

Comments
 (0)