Skip to content

Commit 5ff9f06

Browse files
committed
Merge branch '7.3' into 7.4
* 7.3: Move http_client.retry_failed config inside retry_failed section
2 parents 57eca76 + c758803 commit 5ff9f06

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

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

@@ -1729,15 +1710,6 @@ headers
17291710
An associative array of the HTTP headers added before making the request. This
17301711
value must use the format ``['header-name' => 'value0, value1, ...']``.
17311712

1732-
.. _reference-http-client-retry-http-codes:
1733-
1734-
http_codes
1735-
..........
1736-
1737-
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1738-
1739-
The list of HTTP status codes that triggers a retry of the request.
1740-
17411713
http_version
17421714
............
17431715

@@ -1746,18 +1718,6 @@ http_version
17461718
The HTTP version to use, typically ``'1.1'`` or ``'2.0'``. Leave it to ``null``
17471719
to let Symfony select the best version automatically.
17481720

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

@@ -1775,16 +1735,6 @@ local_pk
17751735
The path of a file that contains the `PEM formatted`_ private key of the
17761736
certificate defined in the ``local_cert`` option.
17771737

1778-
.. _reference-http-client-retry-max-delay:
1779-
1780-
max_delay
1781-
.........
1782-
1783-
**type**: ``integer`` **default**: ``0``
1784-
1785-
The maximum amount of milliseconds initial to wait between retries.
1786-
Use ``0`` to not limit the duration.
1787-
17881738
max_duration
17891739
............
17901740

@@ -1813,26 +1763,6 @@ max_redirects
18131763
The maximum number of redirects to follow. Use ``0`` to not follow any
18141764
redirection.
18151765

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

@@ -1917,11 +1847,13 @@ including which types of requests to retry and how many times. The behavior is
19171847
defined with the following options:
19181848

19191849
* :ref:`delay <reference-http-client-retry-delay>`
1850+
* :ref:`enabled <reference-http-client-retry-enabled>`
19201851
* :ref:`http_codes <reference-http-client-retry-http-codes>`
19211852
* :ref:`jitter <reference-http-client-retry-jitter>`
19221853
* :ref:`max_delay <reference-http-client-retry-max-delay>`
19231854
* :ref:`max_retries <reference-http-client-retry-max-retries>`
19241855
* :ref:`multiplier <reference-http-client-retry-multiplier>`
1856+
* :ref:`retry_strategy <reference-http-client-retry-retry-strategy>`
19251857

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

19551957
**type**: ``string``
19561958

0 commit comments

Comments
 (0)