@@ -792,6 +792,10 @@ will automaticaly retry failed HTTP requests.
792
792
retry_failed :
793
793
max_retries : 4
794
794
795
+ .. versionadded :: 5.2
796
+
797
+ The ``retry_failed `` option was introduced in Symfony 5.2.
798
+
795
799
auth_basic
796
800
..........
797
801
@@ -824,13 +828,15 @@ backoff_service
824
828
825
829
**type **: ``string ``
826
830
831
+ .. versionadded :: 5.2
832
+
833
+ The ``backoff_service `` option was introduced in Symfony 5.2.
834
+
827
835
The service id used to compute the time to wait between retries. By default, it
828
836
uses an instance of
829
837
:class: `Symfony\\ Component\\ HttpClient\\ Retry\\ ExponentialBackOff ` configured
830
838
with ``delay ``, ``max_delay `` and ``multiplier `` options. This class has to
831
839
implement :class: `Symfony\\ Component\\ HttpClient\\ Retry\\ RetryBackOffInterface `.
832
- This options cannot be used along `delay `_, `max_delay `_ or `multiplier `_
833
- options.
834
840
835
841
base_uri
836
842
........
@@ -905,20 +911,26 @@ decider_service
905
911
906
912
**type **: ``string ``
907
913
914
+ .. versionadded :: 5.2
915
+
916
+ The ``decider_service `` option was introduced in Symfony 5.2.
917
+
908
918
The service id used to decide if a request should be retried. By default, it
909
919
uses an instance of
910
920
:class: `Symfony\\ Component\\ HttpClient\\ Retry\\ HttpStatusCodeDecider ` configured
911
- with ``http_codes `` options. This class has to
912
- implement :class: `Symfony\\ Component\\ HttpClient\\ Retry\\ RetryDeciderInterface `.
913
- This options cannot be used along `http_codes `_ option.
921
+ with the ``http_codes `` option. This class has to implement
922
+ :class: `Symfony\\ Component\\ HttpClient\\ Retry\\ RetryDeciderInterface `.
914
923
915
924
delay
916
925
.....
917
926
918
927
**type **: ``integer `` **default **: ``1000 ``
919
928
920
- The initial delay in milliseconds used to compute the waiting time between
921
- retries. This options cannot be used along `backoff_service `_ option.
929
+ .. versionadded :: 5.2
930
+
931
+ The ``delay `` option was introduced in Symfony 5.2.
932
+
933
+ The initial delay in milliseconds used to compute the waiting time between retries.
922
934
923
935
.. _reference-http-client-retry-enabled :
924
936
@@ -943,8 +955,11 @@ http_codes
943
955
944
956
**type **: ``array `` **default **: ``[423, 425, 429, 500, 502, 503, 504, 507, 510] ``
945
957
958
+ .. versionadded :: 5.2
959
+
960
+ The ``http_codes `` option was introduced in Symfony 5.2.
961
+
946
962
The list of HTTP status codes that triggers a retry of the request.
947
- This options cannot be used along `decider_service `_ option.
948
963
949
964
http_version
950
965
............
@@ -976,9 +991,12 @@ max_delay
976
991
977
992
**type **: ``integer `` **default **: ``0 ``
978
993
994
+ .. versionadded :: 5.2
995
+
996
+ The ``max_delay `` option was introduced in Symfony 5.2.
997
+
979
998
The maximum amount of milliseconds initial to wait between retries.
980
999
Use ``0 `` to not limit the duration.
981
- This options cannot be used along `backoff_service `_ option.
982
1000
983
1001
max_duration
984
1002
............
@@ -1011,16 +1029,24 @@ max_retries
1011
1029
1012
1030
**type **: ``integer `` **default **: ``3 ``
1013
1031
1014
- The maximum number of retries before aborting. When the maximum is reach, the
1015
- client returns the last received responses.
1032
+ .. versionadded :: 5.2
1033
+
1034
+ The ``max_retries `` option was introduced in Symfony 5.2.
1035
+
1036
+ The maximum number of retries for failing requests. When the maximum is reached,
1037
+ the client returns the last received response.
1016
1038
1017
1039
multiplier
1018
1040
..........
1019
1041
1020
1042
**type **: ``float `` **default **: ``2 ``
1021
1043
1022
- Multiplier to apply to the delay each time a retry occurs.
1023
- This options cannot be used along `backoff_service `_ option.
1044
+ .. versionadded :: 5.2
1045
+
1046
+ The ``multiplier `` option was introduced in Symfony 5.2.
1047
+
1048
+ This value is multiplied to the delay each time a retry occurs, to distribute
1049
+ retries in time instead of making all of them sequentially.
1024
1050
1025
1051
no_proxy
1026
1052
........
0 commit comments