Skip to content

Commit cabb787

Browse files
committed
Merge branch '7.4' into 8.0
* 7.4: Move http_client.retry_failed config inside retry_failed section
2 parents c3c9585 + 5ff9f06 commit cabb787

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
@@ -1628,25 +1628,6 @@ crypto_method
16281628
The minimum version of TLS to accept. The value must be one of the
16291629
``STREAM_CRYPTO_METHOD_TLSv*_CLIENT`` constants defined by PHP.
16301630

1631-
.. _reference-http-client-retry-delay:
1632-
1633-
delay
1634-
.....
1635-
1636-
**type**: ``integer`` **default**: ``1000``
1637-
1638-
The initial delay in milliseconds used to compute the waiting time between retries.
1639-
1640-
.. _reference-http-client-retry-enabled:
1641-
1642-
enabled
1643-
.......
1644-
1645-
**type**: ``boolean`` **default**: ``false``
1646-
1647-
Whether to enable the support for retry failed HTTP request or not.
1648-
This setting is automatically set to true when one of the child settings is configured.
1649-
16501631
extra
16511632
.....
16521633

@@ -1665,15 +1646,6 @@ headers
16651646
An associative array of the HTTP headers added before making the request. This
16661647
value must use the format ``['header-name' => 'value0, value1, ...']``.
16671648

1668-
.. _reference-http-client-retry-http-codes:
1669-
1670-
http_codes
1671-
..........
1672-
1673-
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1674-
1675-
The list of HTTP status codes that triggers a retry of the request.
1676-
16771649
http_version
16781650
............
16791651

@@ -1682,18 +1654,6 @@ http_version
16821654
The HTTP version to use, typically ``'1.1'`` or ``'2.0'``. Leave it to ``null``
16831655
to let Symfony select the best version automatically.
16841656

1685-
.. _reference-http-client-retry-jitter:
1686-
1687-
jitter
1688-
......
1689-
1690-
**type**: ``float`` **default**: ``0.1`` (must be between 0.0 and 1.0)
1691-
1692-
This option adds some randomness to the delay. It's useful to avoid sending
1693-
multiple requests to the server at the exact same time. The randomness is
1694-
calculated as ``delay * jitter``. For example: if delay is ``1000ms`` and jitter
1695-
is ``0.2``, the actual delay will be a number between ``800`` and ``1200`` (1000 +/- 20%).
1696-
16971657
local_cert
16981658
..........
16991659

@@ -1711,16 +1671,6 @@ local_pk
17111671
The path of a file that contains the `PEM formatted`_ private key of the
17121672
certificate defined in the ``local_cert`` option.
17131673

1714-
.. _reference-http-client-retry-max-delay:
1715-
1716-
max_delay
1717-
.........
1718-
1719-
**type**: ``integer`` **default**: ``0``
1720-
1721-
The maximum amount of milliseconds initial to wait between retries.
1722-
Use ``0`` to not limit the duration.
1723-
17241674
max_duration
17251675
............
17261676

@@ -1749,26 +1699,6 @@ max_redirects
17491699
The maximum number of redirects to follow. Use ``0`` to not follow any
17501700
redirection.
17511701

1752-
.. _reference-http-client-retry-max-retries:
1753-
1754-
max_retries
1755-
...........
1756-
1757-
**type**: ``integer`` **default**: ``3``
1758-
1759-
The maximum number of retries for failing requests. When the maximum is reached,
1760-
the client returns the last received response.
1761-
1762-
.. _reference-http-client-retry-multiplier:
1763-
1764-
multiplier
1765-
..........
1766-
1767-
**type**: ``float`` **default**: ``2``
1768-
1769-
This value is multiplied to the delay each time a retry occurs, to distribute
1770-
retries in time instead of making all of them sequentially.
1771-
17721702
no_proxy
17731703
........
17741704

@@ -1849,11 +1779,13 @@ including which types of requests to retry and how many times. The behavior is
18491779
defined with the following options:
18501780

18511781
* :ref:`delay <reference-http-client-retry-delay>`
1782+
* :ref:`enabled <reference-http-client-retry-enabled>`
18521783
* :ref:`http_codes <reference-http-client-retry-http-codes>`
18531784
* :ref:`jitter <reference-http-client-retry-jitter>`
18541785
* :ref:`max_delay <reference-http-client-retry-max-delay>`
18551786
* :ref:`max_retries <reference-http-client-retry-max-retries>`
18561787
* :ref:`multiplier <reference-http-client-retry-multiplier>`
1788+
* :ref:`retry_strategy <reference-http-client-retry-retry-strategy>`
18571789

18581790
.. code-block:: yaml
18591791
@@ -1881,8 +1813,78 @@ defined with the following options:
18811813
retry_failed:
18821814
max_retries: 4
18831815
1816+
.. _reference-http-client-retry-delay:
1817+
1818+
delay
1819+
"""""
1820+
1821+
**type**: ``integer`` **default**: ``1000``
1822+
1823+
The initial delay in milliseconds used to compute the waiting time between retries.
1824+
1825+
.. _reference-http-client-retry-enabled:
1826+
1827+
enabled
1828+
"""""""
1829+
1830+
**type**: ``boolean`` **default**: ``false``
1831+
1832+
Whether to enable the support for retry failed HTTP request or not.
1833+
This setting is automatically set to true when one of the child settings is configured.
1834+
1835+
.. _reference-http-client-retry-http-codes:
1836+
1837+
http_codes
1838+
""""""""""
1839+
1840+
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1841+
1842+
The list of HTTP status codes that triggers a retry of the request.
1843+
1844+
.. _reference-http-client-retry-jitter:
1845+
1846+
jitter
1847+
""""""
1848+
1849+
**type**: ``float`` **default**: ``0.1`` (must be between 0.0 and 1.0)
1850+
1851+
This option adds some randomness to the delay. It's useful to avoid sending
1852+
multiple requests to the server at the exact same time. The randomness is
1853+
calculated as ``delay * jitter``. For example: if delay is ``1000ms`` and jitter
1854+
is ``0.2``, the actual delay will be a number between ``800`` and ``1200`` (1000 +/- 20%).
1855+
1856+
.. _reference-http-client-retry-max-delay:
1857+
1858+
max_delay
1859+
"""""""""
1860+
1861+
**type**: ``integer`` **default**: ``0``
1862+
1863+
The maximum amount of milliseconds initial to wait between retries.
1864+
Use ``0`` to not limit the duration.
1865+
1866+
.. _reference-http-client-retry-max-retries:
1867+
1868+
max_retries
1869+
"""""""""""
1870+
1871+
**type**: ``integer`` **default**: ``3``
1872+
1873+
The maximum number of retries for failing requests. When the maximum is reached,
1874+
the client returns the last received response.
1875+
1876+
.. _reference-http-client-retry-multiplier:
1877+
1878+
multiplier
1879+
""""""""""
1880+
1881+
**type**: ``float`` **default**: ``2``
1882+
1883+
This value is multiplied to the delay each time a retry occurs, to distribute
1884+
retries in time instead of making all of them sequentially.
1885+
18841886
retry_strategy
1885-
..............
1887+
""""""""""""""
18861888

18871889
**type**: ``string``
18881890

0 commit comments

Comments
 (0)