Timeline.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Timeline Structure 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/Struct/Timeline" class="dashAnchor"></a>
  16. <a title="Timeline Structure Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (86% 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%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  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. Timeline Structure 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/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>Timeline</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Timeline</span></code></pre>
  304. </div>
  305. </div>
  306. <p>Responsible for computing the timing metrics for the complete lifecycle of a <code><a href="../Classes/Request.html">Request</a></code>.</p>
  307. </div>
  308. </section>
  309. <section class="section">
  310. <div class="section-content">
  311. <div class="task-group">
  312. <ul class="item-container">
  313. <li class="item">
  314. <div>
  315. <code>
  316. <a name="/s:9Alamofire8TimelineV16requestStartTimeSdvp"></a>
  317. <a name="//apple_ref/swift/Property/requestStartTime" class="dashAnchor"></a>
  318. <a class="token" href="#/s:9Alamofire8TimelineV16requestStartTimeSdvp">requestStartTime</a>
  319. </code>
  320. </div>
  321. <div class="height-container">
  322. <div class="pointer-container"></div>
  323. <section class="section">
  324. <div class="pointer"></div>
  325. <div class="abstract">
  326. <p>The time the request was initialized.</p>
  327. </div>
  328. <div class="declaration">
  329. <h4>Declaration</h4>
  330. <div class="language">
  331. <p class="aside-title">Swift</p>
  332. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">requestStartTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span></code></pre>
  333. </div>
  334. </div>
  335. </section>
  336. </div>
  337. </li>
  338. <li class="item">
  339. <div>
  340. <code>
  341. <a name="/s:9Alamofire8TimelineV19initialResponseTimeSdvp"></a>
  342. <a name="//apple_ref/swift/Property/initialResponseTime" class="dashAnchor"></a>
  343. <a class="token" href="#/s:9Alamofire8TimelineV19initialResponseTimeSdvp">initialResponseTime</a>
  344. </code>
  345. </div>
  346. <div class="height-container">
  347. <div class="pointer-container"></div>
  348. <section class="section">
  349. <div class="pointer"></div>
  350. <div class="abstract">
  351. <p>The time the first bytes were received from or sent to the server.</p>
  352. </div>
  353. <div class="declaration">
  354. <h4>Declaration</h4>
  355. <div class="language">
  356. <p class="aside-title">Swift</p>
  357. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">initialResponseTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span></code></pre>
  358. </div>
  359. </div>
  360. </section>
  361. </div>
  362. </li>
  363. <li class="item">
  364. <div>
  365. <code>
  366. <a name="/s:9Alamofire8TimelineV20requestCompletedTimeSdvp"></a>
  367. <a name="//apple_ref/swift/Property/requestCompletedTime" class="dashAnchor"></a>
  368. <a class="token" href="#/s:9Alamofire8TimelineV20requestCompletedTimeSdvp">requestCompletedTime</a>
  369. </code>
  370. </div>
  371. <div class="height-container">
  372. <div class="pointer-container"></div>
  373. <section class="section">
  374. <div class="pointer"></div>
  375. <div class="abstract">
  376. <p>The time when the request was completed.</p>
  377. </div>
  378. <div class="declaration">
  379. <h4>Declaration</h4>
  380. <div class="language">
  381. <p class="aside-title">Swift</p>
  382. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">requestCompletedTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span></code></pre>
  383. </div>
  384. </div>
  385. </section>
  386. </div>
  387. </li>
  388. <li class="item">
  389. <div>
  390. <code>
  391. <a name="/s:9Alamofire8TimelineV26serializationCompletedTimeSdvp"></a>
  392. <a name="//apple_ref/swift/Property/serializationCompletedTime" class="dashAnchor"></a>
  393. <a class="token" href="#/s:9Alamofire8TimelineV26serializationCompletedTimeSdvp">serializationCompletedTime</a>
  394. </code>
  395. </div>
  396. <div class="height-container">
  397. <div class="pointer-container"></div>
  398. <section class="section">
  399. <div class="pointer"></div>
  400. <div class="abstract">
  401. <p>The time when the response serialization was completed.</p>
  402. </div>
  403. <div class="declaration">
  404. <h4>Declaration</h4>
  405. <div class="language">
  406. <p class="aside-title">Swift</p>
  407. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationCompletedTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span></code></pre>
  408. </div>
  409. </div>
  410. </section>
  411. </div>
  412. </li>
  413. <li class="item">
  414. <div>
  415. <code>
  416. <a name="/s:9Alamofire8TimelineV7latencySdvp"></a>
  417. <a name="//apple_ref/swift/Property/latency" class="dashAnchor"></a>
  418. <a class="token" href="#/s:9Alamofire8TimelineV7latencySdvp">latency</a>
  419. </code>
  420. </div>
  421. <div class="height-container">
  422. <div class="pointer-container"></div>
  423. <section class="section">
  424. <div class="pointer"></div>
  425. <div class="abstract">
  426. <p>The time interval in seconds from the time the request started to the initial response from the server.</p>
  427. </div>
  428. <div class="declaration">
  429. <h4>Declaration</h4>
  430. <div class="language">
  431. <p class="aside-title">Swift</p>
  432. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">latency</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>
  433. </div>
  434. </div>
  435. </section>
  436. </div>
  437. </li>
  438. <li class="item">
  439. <div>
  440. <code>
  441. <a name="/s:9Alamofire8TimelineV15requestDurationSdvp"></a>
  442. <a name="//apple_ref/swift/Property/requestDuration" class="dashAnchor"></a>
  443. <a class="token" href="#/s:9Alamofire8TimelineV15requestDurationSdvp">requestDuration</a>
  444. </code>
  445. </div>
  446. <div class="height-container">
  447. <div class="pointer-container"></div>
  448. <section class="section">
  449. <div class="pointer"></div>
  450. <div class="abstract">
  451. <p>The time interval in seconds from the time the request started to the time the request completed.</p>
  452. </div>
  453. <div class="declaration">
  454. <h4>Declaration</h4>
  455. <div class="language">
  456. <p class="aside-title">Swift</p>
  457. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">requestDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>
  458. </div>
  459. </div>
  460. </section>
  461. </div>
  462. </li>
  463. <li class="item">
  464. <div>
  465. <code>
  466. <a name="/s:9Alamofire8TimelineV21serializationDurationSdvp"></a>
  467. <a name="//apple_ref/swift/Property/serializationDuration" class="dashAnchor"></a>
  468. <a class="token" href="#/s:9Alamofire8TimelineV21serializationDurationSdvp">serializationDuration</a>
  469. </code>
  470. </div>
  471. <div class="height-container">
  472. <div class="pointer-container"></div>
  473. <section class="section">
  474. <div class="pointer"></div>
  475. <div class="abstract">
  476. <p>The time interval in seconds from the time the request completed to the time response serialization completed.</p>
  477. </div>
  478. <div class="declaration">
  479. <h4>Declaration</h4>
  480. <div class="language">
  481. <p class="aside-title">Swift</p>
  482. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>
  483. </div>
  484. </div>
  485. </section>
  486. </div>
  487. </li>
  488. <li class="item">
  489. <div>
  490. <code>
  491. <a name="/s:9Alamofire8TimelineV13totalDurationSdvp"></a>
  492. <a name="//apple_ref/swift/Property/totalDuration" class="dashAnchor"></a>
  493. <a class="token" href="#/s:9Alamofire8TimelineV13totalDurationSdvp">totalDuration</a>
  494. </code>
  495. </div>
  496. <div class="height-container">
  497. <div class="pointer-container"></div>
  498. <section class="section">
  499. <div class="pointer"></div>
  500. <div class="abstract">
  501. <p>The time interval in seconds from the time the request started to the time response serialization completed.</p>
  502. </div>
  503. <div class="declaration">
  504. <h4>Declaration</h4>
  505. <div class="language">
  506. <p class="aside-title">Swift</p>
  507. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">totalDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>
  508. </div>
  509. </div>
  510. </section>
  511. </div>
  512. </li>
  513. <li class="item">
  514. <div>
  515. <code>
  516. <a name="/s:9Alamofire8TimelineVACSd16requestStartTime_Sd015initialResponseE0Sd0c9CompletedE0Sd013serializationhE0tcfc"></a>
  517. <a name="//apple_ref/swift/Method/init(requestStartTime:initialResponseTime:requestCompletedTime:serializationCompletedTime:)" class="dashAnchor"></a>
  518. <a class="token" href="#/s:9Alamofire8TimelineVACSd16requestStartTime_Sd015initialResponseE0Sd0c9CompletedE0Sd013serializationhE0tcfc">init(requestStartTime:initialResponseTime:requestCompletedTime:serializationCompletedTime:)</a>
  519. </code>
  520. </div>
  521. <div class="height-container">
  522. <div class="pointer-container"></div>
  523. <section class="section">
  524. <div class="pointer"></div>
  525. <div class="abstract">
  526. <p>Creates a new <code>Timeline</code> instance with the specified request times.</p>
  527. </div>
  528. <div class="declaration">
  529. <h4>Declaration</h4>
  530. <div class="language">
  531. <p class="aside-title">Swift</p>
  532. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span>
  533. <span class="nv">requestStartTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">,</span>
  534. <span class="nv">initialResponseTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">,</span>
  535. <span class="nv">requestCompletedTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">,</span>
  536. <span class="nv">serializationCompletedTime</span><span class="p">:</span> <span class="kt">CFAbsoluteTime</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">)</span></code></pre>
  537. </div>
  538. </div>
  539. <div>
  540. <h4>Parameters</h4>
  541. <table class="graybox">
  542. <tbody>
  543. <tr>
  544. <td>
  545. <code>
  546. <em>requestStartTime</em>
  547. </code>
  548. </td>
  549. <td>
  550. <div>
  551. <p>The time the request was initialized. Defaults to <code>0.0</code>.</p>
  552. </div>
  553. </td>
  554. </tr>
  555. <tr>
  556. <td>
  557. <code>
  558. <em>initialResponseTime</em>
  559. </code>
  560. </td>
  561. <td>
  562. <div>
  563. <p>The time the first bytes were received from or sent to the server.
  564. Defaults to <code>0.0</code>.</p>
  565. </div>
  566. </td>
  567. </tr>
  568. <tr>
  569. <td>
  570. <code>
  571. <em>requestCompletedTime</em>
  572. </code>
  573. </td>
  574. <td>
  575. <div>
  576. <p>The time when the request was completed. Defaults to <code>0.0</code>.</p>
  577. </div>
  578. </td>
  579. </tr>
  580. <tr>
  581. <td>
  582. <code>
  583. <em>serializationCompletedTime</em>
  584. </code>
  585. </td>
  586. <td>
  587. <div>
  588. <p>The time when the response serialization was completed. Defaults
  589. to <code>0.0</code>.</p>
  590. </div>
  591. </td>
  592. </tr>
  593. </tbody>
  594. </table>
  595. </div>
  596. <div>
  597. <h4>Return Value</h4>
  598. <p>The new <code>Timeline</code> instance.</p>
  599. </div>
  600. </section>
  601. </div>
  602. </li>
  603. </ul>
  604. </div>
  605. <div class="task-group">
  606. <ul class="item-container">
  607. <li class="item">
  608. <div>
  609. <code>
  610. <a name="/s:9Alamofire8TimelineV11descriptionSSvp"></a>
  611. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  612. <a class="token" href="#/s:9Alamofire8TimelineV11descriptionSSvp">description</a>
  613. </code>
  614. </div>
  615. <div class="height-container">
  616. <div class="pointer-container"></div>
  617. <section class="section">
  618. <div class="pointer"></div>
  619. <div class="abstract">
  620. <p>The textual representation used when written to an output stream, which includes the latency, the request
  621. duration and the total duration.</p>
  622. </div>
  623. <div class="declaration">
  624. <h4>Declaration</h4>
  625. <div class="language">
  626. <p class="aside-title">Swift</p>
  627. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  628. </div>
  629. </div>
  630. </section>
  631. </div>
  632. </li>
  633. </ul>
  634. </div>
  635. <div class="task-group">
  636. <ul class="item-container">
  637. <li class="item">
  638. <div>
  639. <code>
  640. <a name="/s:9Alamofire8TimelineV16debugDescriptionSSvp"></a>
  641. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  642. <a class="token" href="#/s:9Alamofire8TimelineV16debugDescriptionSSvp">debugDescription</a>
  643. </code>
  644. </div>
  645. <div class="height-container">
  646. <div class="pointer-container"></div>
  647. <section class="section">
  648. <div class="pointer"></div>
  649. <div class="abstract">
  650. <p>The textual representation used when written to an output stream, which includes the request start time, the
  651. initial response time, the request completed time, the serialization completed time, the latency, the request
  652. duration and the total duration.</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="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  659. </div>
  660. </div>
  661. </section>
  662. </div>
  663. </li>
  664. </ul>
  665. </div>
  666. </div>
  667. </section>
  668. </article>
  669. </div>
  670. <section class="footer">
  671. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-03-31)</p>
  672. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  673. </section>
  674. </body>
  675. </div>
  676. </html>