RetryPolicy.html 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>RetryPolicy Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/RetryPolicy" class="dashAnchor"></a>
  16. <a title="RetryPolicy Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.4.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. RetryPolicy Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  464. </li>
  465. </ul>
  466. </li>
  467. <li class="nav-group-name">
  468. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  469. <ul class="nav-group-tasks">
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  490. </li>
  491. </ul>
  492. </li>
  493. </ul>
  494. </nav>
  495. <article class="main-content">
  496. <section class="section">
  497. <div class="section-content top-matter">
  498. <h1>RetryPolicy</h1>
  499. <div class="declaration">
  500. <div class="language">
  501. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">RetryPolicy</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span></code></pre>
  502. </div>
  503. </div>
  504. <p>A retry policy that retries requests using an exponential backoff for allowed HTTP methods and HTTP status codes
  505. as well as certain types of networking errors.</p>
  506. </div>
  507. </section>
  508. <section class="section">
  509. <div class="section-content">
  510. <div class="task-group">
  511. <ul class="item-container">
  512. <li class="item">
  513. <div>
  514. <code>
  515. <a name="/s:9Alamofire11RetryPolicyC07defaultB5LimitSuvpZ"></a>
  516. <a name="//apple_ref/swift/Variable/defaultRetryLimit" class="dashAnchor"></a>
  517. <a class="token" href="#/s:9Alamofire11RetryPolicyC07defaultB5LimitSuvpZ">defaultRetryLimit</a>
  518. </code>
  519. </div>
  520. <div class="height-container">
  521. <div class="pointer-container"></div>
  522. <section class="section">
  523. <div class="pointer"></div>
  524. <div class="abstract">
  525. <p>The default retry limit for retry policies.</p>
  526. </div>
  527. <div class="declaration">
  528. <h4>Declaration</h4>
  529. <div class="language">
  530. <p class="aside-title">Swift</p>
  531. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultRetryLimit</span><span class="p">:</span> <span class="kt">UInt</span></code></pre>
  532. </div>
  533. </div>
  534. </section>
  535. </div>
  536. </li>
  537. <li class="item">
  538. <div>
  539. <code>
  540. <a name="/s:9Alamofire11RetryPolicyC29defaultExponentialBackoffBaseSuvpZ"></a>
  541. <a name="//apple_ref/swift/Variable/defaultExponentialBackoffBase" class="dashAnchor"></a>
  542. <a class="token" href="#/s:9Alamofire11RetryPolicyC29defaultExponentialBackoffBaseSuvpZ">defaultExponentialBackoffBase</a>
  543. </code>
  544. </div>
  545. <div class="height-container">
  546. <div class="pointer-container"></div>
  547. <section class="section">
  548. <div class="pointer"></div>
  549. <div class="abstract">
  550. <p>The default exponential backoff base for retry policies (must be a minimum of 2).</p>
  551. </div>
  552. <div class="declaration">
  553. <h4>Declaration</h4>
  554. <div class="language">
  555. <p class="aside-title">Swift</p>
  556. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultExponentialBackoffBase</span><span class="p">:</span> <span class="kt">UInt</span></code></pre>
  557. </div>
  558. </div>
  559. </section>
  560. </div>
  561. </li>
  562. <li class="item">
  563. <div>
  564. <code>
  565. <a name="/s:9Alamofire11RetryPolicyC30defaultExponentialBackoffScaleSdvpZ"></a>
  566. <a name="//apple_ref/swift/Variable/defaultExponentialBackoffScale" class="dashAnchor"></a>
  567. <a class="token" href="#/s:9Alamofire11RetryPolicyC30defaultExponentialBackoffScaleSdvpZ">defaultExponentialBackoffScale</a>
  568. </code>
  569. </div>
  570. <div class="height-container">
  571. <div class="pointer-container"></div>
  572. <section class="section">
  573. <div class="pointer"></div>
  574. <div class="abstract">
  575. <p>The default exponential backoff scale for retry policies.</p>
  576. </div>
  577. <div class="declaration">
  578. <h4>Declaration</h4>
  579. <div class="language">
  580. <p class="aside-title">Swift</p>
  581. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultExponentialBackoffScale</span><span class="p">:</span> <span class="kt">Double</span></code></pre>
  582. </div>
  583. </div>
  584. </section>
  585. </div>
  586. </li>
  587. <li class="item">
  588. <div>
  589. <code>
  590. <a name="/s:9Alamofire11RetryPolicyC27defaultRetryableHTTPMethodsShyAA10HTTPMethodVGvpZ"></a>
  591. <a name="//apple_ref/swift/Variable/defaultRetryableHTTPMethods" class="dashAnchor"></a>
  592. <a class="token" href="#/s:9Alamofire11RetryPolicyC27defaultRetryableHTTPMethodsShyAA10HTTPMethodVGvpZ">defaultRetryableHTTPMethods</a>
  593. </code>
  594. </div>
  595. <div class="height-container">
  596. <div class="pointer-container"></div>
  597. <section class="section">
  598. <div class="pointer"></div>
  599. <div class="abstract">
  600. <p>The default HTTP methods to retry.
  601. See <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">RFC 2616 - Section 9.1.2</a> for more information.</p>
  602. </div>
  603. <div class="declaration">
  604. <h4>Declaration</h4>
  605. <div class="language">
  606. <p class="aside-title">Swift</p>
  607. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultRetryableHTTPMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span></code></pre>
  608. </div>
  609. </div>
  610. </section>
  611. </div>
  612. </li>
  613. <li class="item">
  614. <div>
  615. <code>
  616. <a name="/s:9Alamofire11RetryPolicyC31defaultRetryableHTTPStatusCodesShySiGvpZ"></a>
  617. <a name="//apple_ref/swift/Variable/defaultRetryableHTTPStatusCodes" class="dashAnchor"></a>
  618. <a class="token" href="#/s:9Alamofire11RetryPolicyC31defaultRetryableHTTPStatusCodesShySiGvpZ">defaultRetryableHTTPStatusCodes</a>
  619. </code>
  620. </div>
  621. <div class="height-container">
  622. <div class="pointer-container"></div>
  623. <section class="section">
  624. <div class="pointer"></div>
  625. <div class="abstract">
  626. <p>The default HTTP status codes to retry.
  627. See <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10">RFC 2616 - Section 10</a> for more information.</p>
  628. </div>
  629. <div class="declaration">
  630. <h4>Declaration</h4>
  631. <div class="language">
  632. <p class="aside-title">Swift</p>
  633. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultRetryableHTTPStatusCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span></code></pre>
  634. </div>
  635. </div>
  636. </section>
  637. </div>
  638. </li>
  639. <li class="item">
  640. <div>
  641. <code>
  642. <a name="/s:9Alamofire11RetryPolicyC29defaultRetryableURLErrorCodesShy10Foundation0F0V4CodeVGvpZ"></a>
  643. <a name="//apple_ref/swift/Variable/defaultRetryableURLErrorCodes" class="dashAnchor"></a>
  644. <a class="token" href="#/s:9Alamofire11RetryPolicyC29defaultRetryableURLErrorCodesShy10Foundation0F0V4CodeVGvpZ">defaultRetryableURLErrorCodes</a>
  645. </code>
  646. </div>
  647. <div class="height-container">
  648. <div class="pointer-container"></div>
  649. <section class="section">
  650. <div class="pointer"></div>
  651. <div class="abstract">
  652. <p>The default URL error codes to retry.</p>
  653. </div>
  654. <div class="declaration">
  655. <h4>Declaration</h4>
  656. <div class="language">
  657. <p class="aside-title">Swift</p>
  658. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultRetryableURLErrorCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">URLError</span><span class="o">.</span><span class="kt">Code</span><span class="o">&gt;</span></code></pre>
  659. </div>
  660. </div>
  661. </section>
  662. </div>
  663. </li>
  664. <li class="item">
  665. <div>
  666. <code>
  667. <a name="/s:9Alamofire11RetryPolicyC10retryLimitSuvp"></a>
  668. <a name="//apple_ref/swift/Property/retryLimit" class="dashAnchor"></a>
  669. <a class="token" href="#/s:9Alamofire11RetryPolicyC10retryLimitSuvp">retryLimit</a>
  670. </code>
  671. </div>
  672. <div class="height-container">
  673. <div class="pointer-container"></div>
  674. <section class="section">
  675. <div class="pointer"></div>
  676. <div class="abstract">
  677. <p>The total number of times the request is allowed to be retried.</p>
  678. </div>
  679. <div class="declaration">
  680. <h4>Declaration</h4>
  681. <div class="language">
  682. <p class="aside-title">Swift</p>
  683. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">retryLimit</span><span class="p">:</span> <span class="kt">UInt</span></code></pre>
  684. </div>
  685. </div>
  686. </section>
  687. </div>
  688. </li>
  689. <li class="item">
  690. <div>
  691. <code>
  692. <a name="/s:9Alamofire11RetryPolicyC22exponentialBackoffBaseSuvp"></a>
  693. <a name="//apple_ref/swift/Property/exponentialBackoffBase" class="dashAnchor"></a>
  694. <a class="token" href="#/s:9Alamofire11RetryPolicyC22exponentialBackoffBaseSuvp">exponentialBackoffBase</a>
  695. </code>
  696. </div>
  697. <div class="height-container">
  698. <div class="pointer-container"></div>
  699. <section class="section">
  700. <div class="pointer"></div>
  701. <div class="abstract">
  702. <p>The base of the exponential backoff policy (should always be greater than or equal to 2).</p>
  703. </div>
  704. <div class="declaration">
  705. <h4>Declaration</h4>
  706. <div class="language">
  707. <p class="aside-title">Swift</p>
  708. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">exponentialBackoffBase</span><span class="p">:</span> <span class="kt">UInt</span></code></pre>
  709. </div>
  710. </div>
  711. </section>
  712. </div>
  713. </li>
  714. <li class="item">
  715. <div>
  716. <code>
  717. <a name="/s:9Alamofire11RetryPolicyC23exponentialBackoffScaleSdvp"></a>
  718. <a name="//apple_ref/swift/Property/exponentialBackoffScale" class="dashAnchor"></a>
  719. <a class="token" href="#/s:9Alamofire11RetryPolicyC23exponentialBackoffScaleSdvp">exponentialBackoffScale</a>
  720. </code>
  721. </div>
  722. <div class="height-container">
  723. <div class="pointer-container"></div>
  724. <section class="section">
  725. <div class="pointer"></div>
  726. <div class="abstract">
  727. <p>The scale of the exponential backoff.</p>
  728. </div>
  729. <div class="declaration">
  730. <h4>Declaration</h4>
  731. <div class="language">
  732. <p class="aside-title">Swift</p>
  733. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">exponentialBackoffScale</span><span class="p">:</span> <span class="kt">Double</span></code></pre>
  734. </div>
  735. </div>
  736. </section>
  737. </div>
  738. </li>
  739. <li class="item">
  740. <div>
  741. <code>
  742. <a name="/s:9Alamofire11RetryPolicyC20retryableHTTPMethodsShyAA10HTTPMethodVGvp"></a>
  743. <a name="//apple_ref/swift/Property/retryableHTTPMethods" class="dashAnchor"></a>
  744. <a class="token" href="#/s:9Alamofire11RetryPolicyC20retryableHTTPMethodsShyAA10HTTPMethodVGvp">retryableHTTPMethods</a>
  745. </code>
  746. </div>
  747. <div class="height-container">
  748. <div class="pointer-container"></div>
  749. <section class="section">
  750. <div class="pointer"></div>
  751. <div class="abstract">
  752. <p>The HTTP methods that are allowed to be retried.</p>
  753. </div>
  754. <div class="declaration">
  755. <h4>Declaration</h4>
  756. <div class="language">
  757. <p class="aside-title">Swift</p>
  758. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">retryableHTTPMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span></code></pre>
  759. </div>
  760. </div>
  761. </section>
  762. </div>
  763. </li>
  764. <li class="item">
  765. <div>
  766. <code>
  767. <a name="/s:9Alamofire11RetryPolicyC24retryableHTTPStatusCodesShySiGvp"></a>
  768. <a name="//apple_ref/swift/Property/retryableHTTPStatusCodes" class="dashAnchor"></a>
  769. <a class="token" href="#/s:9Alamofire11RetryPolicyC24retryableHTTPStatusCodesShySiGvp">retryableHTTPStatusCodes</a>
  770. </code>
  771. </div>
  772. <div class="height-container">
  773. <div class="pointer-container"></div>
  774. <section class="section">
  775. <div class="pointer"></div>
  776. <div class="abstract">
  777. <p>The HTTP status codes that are automatically retried by the policy.</p>
  778. </div>
  779. <div class="declaration">
  780. <h4>Declaration</h4>
  781. <div class="language">
  782. <p class="aside-title">Swift</p>
  783. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">retryableHTTPStatusCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span></code></pre>
  784. </div>
  785. </div>
  786. </section>
  787. </div>
  788. </li>
  789. <li class="item">
  790. <div>
  791. <code>
  792. <a name="/s:9Alamofire11RetryPolicyC22retryableURLErrorCodesShy10Foundation0E0V4CodeVGvp"></a>
  793. <a name="//apple_ref/swift/Property/retryableURLErrorCodes" class="dashAnchor"></a>
  794. <a class="token" href="#/s:9Alamofire11RetryPolicyC22retryableURLErrorCodesShy10Foundation0E0V4CodeVGvp">retryableURLErrorCodes</a>
  795. </code>
  796. </div>
  797. <div class="height-container">
  798. <div class="pointer-container"></div>
  799. <section class="section">
  800. <div class="pointer"></div>
  801. <div class="abstract">
  802. <p>The URL error codes that are automatically retried by the policy.</p>
  803. </div>
  804. <div class="declaration">
  805. <h4>Declaration</h4>
  806. <div class="language">
  807. <p class="aside-title">Swift</p>
  808. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">retryableURLErrorCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">URLError</span><span class="o">.</span><span class="kt">Code</span><span class="o">&gt;</span></code></pre>
  809. </div>
  810. </div>
  811. </section>
  812. </div>
  813. </li>
  814. <li class="item">
  815. <div>
  816. <code>
  817. <a name="/s:9Alamofire11RetryPolicyC10retryLimit22exponentialBackoffBase0fG5Scale20retryableHTTPMethods0J15HTTPStatusCodes0j8URLErrorM0ACSu_SuSdShyAA10HTTPMethodVGShySiGShy10Foundation0N0V4CodeVGtcfc"></a>
  818. <a name="//apple_ref/swift/Method/init(retryLimit:exponentialBackoffBase:exponentialBackoffScale:retryableHTTPMethods:retryableHTTPStatusCodes:retryableURLErrorCodes:)" class="dashAnchor"></a>
  819. <a class="token" href="#/s:9Alamofire11RetryPolicyC10retryLimit22exponentialBackoffBase0fG5Scale20retryableHTTPMethods0J15HTTPStatusCodes0j8URLErrorM0ACSu_SuSdShyAA10HTTPMethodVGShySiGShy10Foundation0N0V4CodeVGtcfc">init(retryLimit:<wbr>exponentialBackoffBase:<wbr>exponentialBackoffScale:<wbr>retryableHTTPMethods:<wbr>retryableHTTPStatusCodes:<wbr>retryableURLErrorCodes:<wbr>)</a>
  820. </code>
  821. </div>
  822. <div class="height-container">
  823. <div class="pointer-container"></div>
  824. <section class="section">
  825. <div class="pointer"></div>
  826. <div class="abstract">
  827. <p>Creates an <code>ExponentialBackoffRetryPolicy</code> from the specified parameters.</p>
  828. </div>
  829. <div class="declaration">
  830. <h4>Declaration</h4>
  831. <div class="language">
  832. <p class="aside-title">Swift</p>
  833. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">retryLimit</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="kt">RetryPolicy</span><span class="o">.</span><span class="n"><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC07defaultB5LimitSuvpZ">defaultRetryLimit</a></span><span class="p">,</span>
  834. <span class="nv">exponentialBackoffBase</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="kt">RetryPolicy</span><span class="o">.</span><span class="n"><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC29defaultExponentialBackoffBaseSuvpZ">defaultExponentialBackoffBase</a></span><span class="p">,</span>
  835. <span class="nv">exponentialBackoffScale</span><span class="p">:</span> <span class="kt">Double</span> <span class="o">=</span> <span class="kt">RetryPolicy</span><span class="o">.</span><span class="n"><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC30defaultExponentialBackoffScaleSdvpZ">defaultExponentialBackoffScale</a></span><span class="p">,</span>
  836. <span class="nv">retryableHTTPMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt">RetryPolicy</span><span class="o">.</span><span class="n"><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC27defaultRetryableHTTPMethodsShyAA10HTTPMethodVGvpZ">defaultRetryableHTTPMethods</a></span><span class="p">,</span>
  837. <span class="nv">retryableHTTPStatusCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt">RetryPolicy</span><span class="o">.</span><span class="n"><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC31defaultRetryableHTTPStatusCodesShySiGvpZ">defaultRetryableHTTPStatusCodes</a></span><span class="p">,</span>
  838. <span class="nv">retryableURLErrorCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">URLError</span><span class="o">.</span><span class="kt">Code</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt">RetryPolicy</span><span class="o">.</span><span class="n"><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC29defaultRetryableURLErrorCodesShy10Foundation0F0V4CodeVGvpZ">defaultRetryableURLErrorCodes</a></span><span class="p">)</span></code></pre>
  839. </div>
  840. </div>
  841. <div>
  842. <h4>Parameters</h4>
  843. <table class="graybox">
  844. <tbody>
  845. <tr>
  846. <td>
  847. <code>
  848. <em>retryLimit</em>
  849. </code>
  850. </td>
  851. <td>
  852. <div>
  853. <p>The total number of times the request is allowed to be retried. <code>2</code> by default.</p>
  854. </div>
  855. </td>
  856. </tr>
  857. <tr>
  858. <td>
  859. <code>
  860. <em>exponentialBackoffBase</em>
  861. </code>
  862. </td>
  863. <td>
  864. <div>
  865. <p>The base of the exponential backoff policy. <code>2</code> by default.</p>
  866. </div>
  867. </td>
  868. </tr>
  869. <tr>
  870. <td>
  871. <code>
  872. <em>exponentialBackoffScale</em>
  873. </code>
  874. </td>
  875. <td>
  876. <div>
  877. <p>The scale of the exponential backoff. <code>0.5</code> by default.</p>
  878. </div>
  879. </td>
  880. </tr>
  881. <tr>
  882. <td>
  883. <code>
  884. <em>retryableHTTPMethods</em>
  885. </code>
  886. </td>
  887. <td>
  888. <div>
  889. <p>The HTTP methods that are allowed to be retried.
  890. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC27defaultRetryableHTTPMethodsShyAA10HTTPMethodVGvpZ">RetryPolicy.defaultRetryableHTTPMethods</a></code> by default.</p>
  891. </div>
  892. </td>
  893. </tr>
  894. <tr>
  895. <td>
  896. <code>
  897. <em>retryableHTTPStatusCodes</em>
  898. </code>
  899. </td>
  900. <td>
  901. <div>
  902. <p>The HTTP status codes that are automatically retried by the policy.
  903. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC31defaultRetryableHTTPStatusCodesShySiGvpZ">RetryPolicy.defaultRetryableHTTPStatusCodes</a></code> by default.</p>
  904. </div>
  905. </td>
  906. </tr>
  907. <tr>
  908. <td>
  909. <code>
  910. <em>retryableURLErrorCodes</em>
  911. </code>
  912. </td>
  913. <td>
  914. <div>
  915. <p>The URL error codes that are automatically retried by the policy.
  916. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC29defaultRetryableURLErrorCodesShy10Foundation0F0V4CodeVGvpZ">RetryPolicy.defaultRetryableURLErrorCodes</a></code> by default.</p>
  917. </div>
  918. </td>
  919. </tr>
  920. </tbody>
  921. </table>
  922. </div>
  923. </section>
  924. </div>
  925. </li>
  926. <li class="item">
  927. <div>
  928. <code>
  929. <a name="/s:9Alamofire14RequestRetrierP5retry_3for5dueTo10completionyAA0B0C_AA7SessionCs5Error_pyAA11RetryResultOctF"></a>
  930. <a name="//apple_ref/swift/Method/retry(_:for:dueTo:completion:)" class="dashAnchor"></a>
  931. <a class="token" href="#/s:9Alamofire14RequestRetrierP5retry_3for5dueTo10completionyAA0B0C_AA7SessionCs5Error_pyAA11RetryResultOctF">retry(_:<wbr>for:<wbr>dueTo:<wbr>completion:<wbr>)</a>
  932. </code>
  933. </div>
  934. <div class="height-container">
  935. <div class="pointer-container"></div>
  936. <section class="section">
  937. <div class="pointer"></div>
  938. <div class="abstract">
  939. </div>
  940. <div class="declaration">
  941. <h4>Declaration</h4>
  942. <div class="language">
  943. <p class="aside-title">Swift</p>
  944. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">retry</span><span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="p">,</span>
  945. <span class="k">for</span> <span class="nv">session</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html">Session</a></span><span class="p">,</span>
  946. <span class="n">dueTo</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">,</span>
  947. <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Enums/RetryResult.html">RetryResult</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  948. </div>
  949. </div>
  950. </section>
  951. </div>
  952. </li>
  953. <li class="item">
  954. <div>
  955. <code>
  956. <a name="/s:9Alamofire11RetryPolicyC06shouldB07request5dueToSbAA7RequestC_s5Error_ptF"></a>
  957. <a name="//apple_ref/swift/Method/shouldRetry(request:dueTo:)" class="dashAnchor"></a>
  958. <a class="token" href="#/s:9Alamofire11RetryPolicyC06shouldB07request5dueToSbAA7RequestC_s5Error_ptF">shouldRetry(request:<wbr>dueTo:<wbr>)</a>
  959. </code>
  960. </div>
  961. <div class="height-container">
  962. <div class="pointer-container"></div>
  963. <section class="section">
  964. <div class="pointer"></div>
  965. <div class="abstract">
  966. <p>Determines whether or not to retry the provided <code><a href="../Classes/Request.html">Request</a></code>.</p>
  967. </div>
  968. <div class="declaration">
  969. <h4>Declaration</h4>
  970. <div class="language">
  971. <p class="aside-title">Swift</p>
  972. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">shouldRetry</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="p">,</span> <span class="n">dueTo</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  973. </div>
  974. </div>
  975. <div>
  976. <h4>Parameters</h4>
  977. <table class="graybox">
  978. <tbody>
  979. <tr>
  980. <td>
  981. <code>
  982. <em>request</em>
  983. </code>
  984. </td>
  985. <td>
  986. <div>
  987. <p><code><a href="../Classes/Request.html">Request</a></code> that failed due to the provided <code>Error</code>.</p>
  988. </div>
  989. </td>
  990. </tr>
  991. <tr>
  992. <td>
  993. <code>
  994. <em>error</em>
  995. </code>
  996. </td>
  997. <td>
  998. <div>
  999. <p><code>Error</code> encountered while executing the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  1000. </div>
  1001. </td>
  1002. </tr>
  1003. </tbody>
  1004. </table>
  1005. </div>
  1006. <div>
  1007. <h4>Return Value</h4>
  1008. <p><code>Bool</code> determining whether or not to retry the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  1009. </div>
  1010. </section>
  1011. </div>
  1012. </li>
  1013. </ul>
  1014. </div>
  1015. </div>
  1016. </section>
  1017. </article>
  1018. </div>
  1019. <section class="footer">
  1020. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-12-20)</p>
  1021. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1022. </section>
  1023. </body>
  1024. </div>
  1025. </html>