EventMonitor.swift 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
  1. //
  2. // EventMonitor.swift
  3. //
  4. // Copyright (c) 2014-2018 Alamofire Software Foundation (http://alamofire.org/)
  5. //
  6. // Permission is hereby granted, free of charge, to any person obtaining a copy
  7. // of this software and associated documentation files (the "Software"), to deal
  8. // in the Software without restriction, including without limitation the rights
  9. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. // copies of the Software, and to permit persons to whom the Software is
  11. // furnished to do so, subject to the following conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be included in
  14. // all copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. // THE SOFTWARE.
  23. //
  24. import Foundation
  25. /// Protocol outlining the lifetime events inside Alamofire. It includes both events received from the various
  26. /// `URLSession` delegate protocols as well as various events from the lifetime of `Request` and its subclasses.
  27. public protocol EventMonitor {
  28. /// The `DispatchQueue` onto which Alamofire's root `CompositeEventMonitor` will dispatch events. Defaults to `.main`.
  29. var queue: DispatchQueue { get }
  30. // MARK: - URLSession Events
  31. // MARK: URLSessionDelegate Events
  32. /// Event called during `URLSessionDelegate`'s `urlSession(_:didBecomeInvalidWithError:)` method.
  33. func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?)
  34. // MARK: URLSessionTaskDelegate Events
  35. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didReceive:completionHandler:)` method.
  36. func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge)
  37. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` method.
  38. func urlSession(_ session: URLSession,
  39. task: URLSessionTask,
  40. didSendBodyData bytesSent: Int64,
  41. totalBytesSent: Int64,
  42. totalBytesExpectedToSend: Int64)
  43. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:needNewBodyStream:)` method.
  44. func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask)
  45. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)` method.
  46. func urlSession(_ session: URLSession,
  47. task: URLSessionTask,
  48. willPerformHTTPRedirection response: HTTPURLResponse,
  49. newRequest request: URLRequest)
  50. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didFinishCollecting:)` method.
  51. func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics)
  52. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didCompleteWithError:)` method.
  53. func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
  54. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:taskIsWaitingForConnectivity:)` method.
  55. @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
  56. func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask)
  57. // MARK: URLSessionDataDelegate Events
  58. /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:didReceive:)` method.
  59. func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)
  60. /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:willCacheResponse:completionHandler:)` method.
  61. func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse)
  62. // MARK: URLSessionDownloadDelegate Events
  63. /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)` method.
  64. func urlSession(_ session: URLSession,
  65. downloadTask: URLSessionDownloadTask,
  66. didResumeAtOffset fileOffset: Int64,
  67. expectedTotalBytes: Int64)
  68. /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)` method.
  69. func urlSession(_ session: URLSession,
  70. downloadTask: URLSessionDownloadTask,
  71. didWriteData bytesWritten: Int64,
  72. totalBytesWritten: Int64,
  73. totalBytesExpectedToWrite: Int64)
  74. /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didFinishDownloadingTo:)` method.
  75. func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)
  76. // MARK: - Request Events
  77. /// Event called when a `URLRequest` is first created for a `Request`.
  78. func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest)
  79. /// Event called when the attempt to create a `URLRequest` from a `Request`'s original `URLRequestConvertible` value fails.
  80. func request(_ request: Request, didFailToCreateURLRequestWithError error: Error)
  81. /// Event called when a `RequestAdapter` adapts the `Request`'s initial `URLRequest`.
  82. func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest)
  83. /// Event called when a `RequestAdapter` fails to adapt the `Request`'s initial `URLRequest`.
  84. func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: Error)
  85. /// Event called when a `URLSessionTask` subclass instance is created for a `Request`.
  86. func request(_ request: Request, didCreateTask task: URLSessionTask)
  87. /// Event called when a `Request` receives a `URLSessionTaskMetrics` value.
  88. func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics)
  89. /// Event called when a `Request` fails due to an error created by Alamofire. e.g. When certificat pinning fails.
  90. func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: Error)
  91. /// Event called when a `Request`'s task completes, possibly with an error. A `Request` may recieve this event
  92. /// multiple times if it is retried.
  93. func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: Error?)
  94. /// Event called when a `Request` is about to be retried.
  95. func requestIsRetrying(_ request: Request)
  96. /// Event called when a `Request` finishes and response serializers are being called.
  97. func requestDidFinish(_ request: Request)
  98. /// Event called when a `Request` receives a `resume` call.
  99. func requestDidResume(_ request: Request)
  100. /// Event called when a `Request` receives a `suspend` call.
  101. func requestDidSuspend(_ request: Request)
  102. /// Event called when a `Request` receives a `cancel` call.
  103. func requestDidCancel(_ request: Request)
  104. // MARK: DataRequest Events
  105. /// Event called when a `DataRequest` calls a `Validation`.
  106. func request(_ request: DataRequest,
  107. didValidateRequest urlRequest: URLRequest?,
  108. response: HTTPURLResponse,
  109. data: Data?,
  110. withResult result: Request.ValidationResult)
  111. /// Event called when a `DataRequest` creates a `DataResponse<Data?>` value without calling a `ResponseSerializer`.
  112. func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?>)
  113. /// Event called when a `DataRequest` calls a `ResponseSerializer` and creates a generic `DataResponse<Value>`.
  114. func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value>)
  115. // MARK: UploadRequest Events
  116. /// Event called when an `UploadRequest` creates its `Uploadable` value, indicating the type of upload it represents.
  117. func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable)
  118. /// Event called when an `UploadRequest` failes to create its `Uploadable` value due to an error.
  119. func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: Error)
  120. /// Event called when an `UploadRequest` provides the `InputStream` from its `Uploadable` value. This only occurs if
  121. /// the `InputStream` does not wrap a `Data` value.
  122. func request(_ request: UploadRequest, didProvideInputStream stream: InputStream)
  123. // MARK: DownloadRequest Events
  124. /// Event called when a `DownloadRequest`'s `URLSessionDownloadTask` finishes with a temporary URL.
  125. func request(_ request: DownloadRequest, didCompleteTask task: URLSessionTask, with url: URL)
  126. /// Event called when a `DownloadRequest`'s `Destination` closure is called and creates the destination URL the
  127. /// downloaded file will be moved to.
  128. func request(_ request: DownloadRequest, didCreateDestinationURL url: URL)
  129. /// Event called when a `DownloadRequest` calls a `Validation`.
  130. func request(_ request: DownloadRequest,
  131. didValidateRequest urlRequest: URLRequest?,
  132. response: HTTPURLResponse,
  133. temporaryURL: URL?,
  134. destinationURL: URL?,
  135. withResult result: Request.ValidationResult)
  136. /// Event called when a `DownloadRequest` creates a `DownloadResponse<URL?>` without calling a `ResponseSerializer`.
  137. func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?>)
  138. /// Event called when a `DownloadRequest` calls a `DownloadResponseSerializer` and creates a generic `DownloadResponse<Value>`
  139. func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value>)
  140. }
  141. extension EventMonitor {
  142. /// The default queue on which `CompositeEventMonitor`s will call the `EventMonitor` methods. Defaults to `.main`.
  143. public var queue: DispatchQueue { return .main }
  144. }
  145. /// An `EventMonitor` which can contain multiple `EventMonitor`s and calls their methods on their queues.
  146. public final class CompositeEventMonitor: EventMonitor {
  147. public let queue = DispatchQueue(label: "org.alamofire.componsiteEventMonitor", qos: .background)
  148. let monitors: [EventMonitor]
  149. init(monitors: [EventMonitor]) {
  150. self.monitors = monitors
  151. }
  152. func performEvent(_ event: @escaping (EventMonitor) -> Void) {
  153. queue.async {
  154. for monitor in self.monitors {
  155. monitor.queue.async { event(monitor) }
  156. }
  157. }
  158. }
  159. public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {
  160. performEvent { $0.urlSession(session, didBecomeInvalidWithError: error) }
  161. }
  162. public func urlSession(_ session: URLSession,
  163. task: URLSessionTask,
  164. didReceive challenge: URLAuthenticationChallenge) {
  165. performEvent { $0.urlSession(session, task: task, didReceive: challenge) }
  166. }
  167. public func urlSession(_ session: URLSession,
  168. task: URLSessionTask,
  169. didSendBodyData bytesSent: Int64,
  170. totalBytesSent: Int64,
  171. totalBytesExpectedToSend: Int64) {
  172. performEvent {
  173. $0.urlSession(session,
  174. task: task,
  175. didSendBodyData: bytesSent,
  176. totalBytesSent: totalBytesSent,
  177. totalBytesExpectedToSend: totalBytesExpectedToSend)
  178. }
  179. }
  180. public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
  181. performEvent {
  182. $0.urlSession(session, taskNeedsNewBodyStream: task)
  183. }
  184. }
  185. public func urlSession(_ session: URLSession,
  186. task: URLSessionTask,
  187. willPerformHTTPRedirection response: HTTPURLResponse,
  188. newRequest request: URLRequest) {
  189. performEvent {
  190. $0.urlSession(session,
  191. task: task,
  192. willPerformHTTPRedirection: response,
  193. newRequest: request)
  194. }
  195. }
  196. public func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
  197. performEvent { $0.urlSession(session, task: task, didFinishCollecting: metrics) }
  198. }
  199. public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
  200. performEvent { $0.urlSession(session, task: task, didCompleteWithError: error) }
  201. }
  202. @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
  203. public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
  204. performEvent { $0.urlSession(session, taskIsWaitingForConnectivity: task) }
  205. }
  206. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
  207. performEvent { $0.urlSession(session, dataTask: dataTask, didReceive: data) }
  208. }
  209. public func urlSession(_ session: URLSession,
  210. dataTask: URLSessionDataTask,
  211. willCacheResponse proposedResponse: CachedURLResponse) {
  212. performEvent { $0.urlSession(session, dataTask: dataTask, willCacheResponse: proposedResponse) }
  213. }
  214. public func urlSession(_ session: URLSession,
  215. downloadTask: URLSessionDownloadTask,
  216. didResumeAtOffset fileOffset: Int64,
  217. expectedTotalBytes: Int64) {
  218. performEvent {
  219. $0.urlSession(session,
  220. downloadTask: downloadTask,
  221. didResumeAtOffset: fileOffset,
  222. expectedTotalBytes: expectedTotalBytes)
  223. }
  224. }
  225. public func urlSession(_ session: URLSession,
  226. downloadTask: URLSessionDownloadTask,
  227. didWriteData bytesWritten: Int64,
  228. totalBytesWritten: Int64,
  229. totalBytesExpectedToWrite: Int64) {
  230. performEvent {
  231. $0.urlSession(session,
  232. downloadTask: downloadTask,
  233. didWriteData: bytesWritten,
  234. totalBytesWritten: totalBytesWritten,
  235. totalBytesExpectedToWrite: totalBytesExpectedToWrite)
  236. }
  237. }
  238. public func urlSession(_ session: URLSession,
  239. downloadTask: URLSessionDownloadTask,
  240. didFinishDownloadingTo location: URL) {
  241. performEvent { $0.urlSession(session, downloadTask: downloadTask, didFinishDownloadingTo: location) }
  242. }
  243. public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
  244. performEvent { $0.request(request, didCreateURLRequest: urlRequest) }
  245. }
  246. public func request(_ request: Request, didFailToCreateURLRequestWithError error: Error) {
  247. performEvent { $0.request(request, didFailToCreateURLRequestWithError: error) }
  248. }
  249. public func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
  250. performEvent { $0.request(request, didAdaptInitialRequest: initialRequest, to: adaptedRequest) }
  251. }
  252. public func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: Error) {
  253. performEvent { $0.request(request, didFailToAdaptURLRequest: initialRequest, withError: error) }
  254. }
  255. public func request(_ request: Request, didCreateTask task: URLSessionTask) {
  256. performEvent { $0.request(request, didCreateTask: task) }
  257. }
  258. public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
  259. performEvent { $0.request(request, didGatherMetrics: metrics) }
  260. }
  261. public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: Error) {
  262. performEvent { $0.request(request, didFailTask: task, earlyWithError: error) }
  263. }
  264. public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: Error?) {
  265. performEvent { $0.request(request, didCompleteTask: task, with: error) }
  266. }
  267. public func requestIsRetrying(_ request: Request) {
  268. performEvent { $0.requestIsRetrying(request) }
  269. }
  270. public func requestDidFinish(_ request: Request) {
  271. performEvent { $0.requestDidFinish(request) }
  272. }
  273. public func requestDidResume(_ request: Request) {
  274. performEvent { $0.requestDidResume(request) }
  275. }
  276. public func requestDidSuspend(_ request: Request) {
  277. performEvent { $0.requestDidSuspend(request) }
  278. }
  279. public func requestDidCancel(_ request: Request) {
  280. performEvent { $0.requestDidCancel(request) }
  281. }
  282. public func request(_ request: DataRequest,
  283. didValidateRequest urlRequest: URLRequest?,
  284. response: HTTPURLResponse,
  285. data: Data?,
  286. withResult result: Request.ValidationResult) {
  287. performEvent { $0.request(request,
  288. didValidateRequest: urlRequest,
  289. response: response,
  290. data: data,
  291. withResult: result)
  292. }
  293. }
  294. public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?>) {
  295. performEvent { $0.request(request, didParseResponse: response) }
  296. }
  297. public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value>) {
  298. performEvent { $0.request(request, didParseResponse: response) }
  299. }
  300. public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
  301. performEvent { $0.request(request, didCreateUploadable: uploadable) }
  302. }
  303. public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: Error) {
  304. performEvent { $0.request(request, didFailToCreateUploadableWithError: error) }
  305. }
  306. public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
  307. performEvent { $0.request(request, didProvideInputStream: stream) }
  308. }
  309. public func request(_ request: DownloadRequest, didCompleteTask task: URLSessionTask, with url: URL) {
  310. performEvent { $0.request(request, didCompleteTask: task, with: url) }
  311. }
  312. public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
  313. performEvent { $0.request(request, didCreateDestinationURL: url) }
  314. }
  315. public func request(_ request: DownloadRequest,
  316. didValidateRequest urlRequest: URLRequest?,
  317. response: HTTPURLResponse,
  318. temporaryURL: URL?,
  319. destinationURL: URL?,
  320. withResult result: Request.ValidationResult) {
  321. performEvent { $0.request(request,
  322. didValidateRequest: urlRequest,
  323. response: response,
  324. temporaryURL: temporaryURL,
  325. destinationURL: destinationURL,
  326. withResult: result) }
  327. }
  328. public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?>) {
  329. performEvent { $0.request(request, didParseResponse: response) }
  330. }
  331. public func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value>) {
  332. performEvent { $0.request(request, didParseResponse: response) }
  333. }
  334. }
  335. /// `EventMonitor` that allows optional closures to be set to receive events.
  336. open class ClosureEventMonitor: EventMonitor {
  337. /// Closure that recieves the `urlSession(_:didBecomeInvalidWithError:)` event.
  338. open var sessionDidBecomeInvalidWithError: ((URLSession, Error?) -> Void)?
  339. /// Closure that receives the `urlSession(_:task:didReceive:completionHandler:)`.
  340. open var taskDidReceiveChallenge: ((URLSession, URLSessionTask, URLAuthenticationChallenge) -> Void)?
  341. /// Closure that receives `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` event.
  342. open var taskDidSendBodyData: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?
  343. /// Closure that receives the `urlSession(_:task:needNewBodyStream:)` event.
  344. open var taskNeedNewBodyStream: ((URLSession, URLSessionTask) -> Void)?
  345. /// Overrides default behavior for URLSessionTaskDelegate method `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)`.
  346. open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> Void)?
  347. open var taskDidFinishCollectingMetrics: ((URLSession, URLSessionTask, URLSessionTaskMetrics) -> Void)?
  348. /// Overrides default behavior for URLSessionTaskDelegate method `urlSession(_:task:didCompleteWithError:)`.
  349. open var taskDidComplete: ((URLSession, URLSessionTask, Error?) -> Void)?
  350. open var taskIsWaitingForConnectivity: ((URLSession, URLSessionTask) -> Void)?
  351. /// Overrides default behavior for URLSessionDataDelegate method `urlSession(_:dataTask:didReceive:)`.
  352. open var dataTaskDidReceiveData: ((URLSession, URLSessionDataTask, Data) -> Void)?
  353. /// Overrides default behavior for URLSessionDataDelegate method `urlSession(_:dataTask:willCacheResponse:completionHandler:)`.
  354. open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> Void)?
  355. // MARK: URLSessionDownloadDelegate Overrides
  356. /// Overrides default behavior for URLSessionDownloadDelegate method `urlSession(_:downloadTask:didFinishDownloadingTo:)`.
  357. open var downloadTaskDidFinishDownloadingToURL: ((URLSession, URLSessionDownloadTask, URL) -> Void)?
  358. /// Overrides default behavior for URLSessionDownloadDelegate method `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)`.
  359. open var downloadTaskDidWriteData: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?
  360. /// Overrides default behavior for URLSessionDownloadDelegate method `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)`.
  361. open var downloadTaskDidResumeAtOffset: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?
  362. open var requestDidCreateURLRequest: ((Request, URLRequest) -> Void)?
  363. open var requestDidFailToCreateURLRequestWithError: ((Request, Error) -> Void)?
  364. open var requestDidAdaptInitialRequestToAdaptedRequest: ((Request, URLRequest, URLRequest) -> Void)?
  365. open var requestDidFailToAdaptURLRequestWithError: ((Request, URLRequest, Error) -> Void)?
  366. open var requestDidCreateTask: ((Request, URLSessionTask) -> Void)?
  367. open var requestDidGatherMetrics: ((Request, URLSessionTaskMetrics) -> Void)?
  368. open var requestDidFailTaskEarlyWithError: ((Request, URLSessionTask, Error) -> Void)?
  369. open var requestDidCompleteTaskWithError: ((Request, URLSessionTask, Error?) -> Void)?
  370. open var requestIsRetrying: ((Request) -> Void)?
  371. open var requestDidFinish: ((Request) -> Void)?
  372. open var requestDidResume: ((Request) -> Void)?
  373. open var requestDidSuspend: ((Request) -> Void)?
  374. open var requestDidCancel: ((Request) -> Void)?
  375. open var requestDidValidateRequestResponseDataWithResult: ((DataRequest, URLRequest?, HTTPURLResponse, Data?, Request.ValidationResult) -> Void)?
  376. open var requestDidParseResponse: ((DataRequest, DataResponse<Data?>) -> Void)?
  377. open var requestDidParseAnyResponse: ((DataRequest, DataResponse<Any>) -> Void)?
  378. open var requestDidCreateUploadable: ((UploadRequest, UploadRequest.Uploadable) -> Void)?
  379. open var requestDidFailToCreateUploadableWithError: ((UploadRequest, Error) -> Void)?
  380. open var requestDidProvideInputStream: ((UploadRequest, InputStream) -> Void)?
  381. open var requestDidCompleteTaskWithURL: ((DownloadRequest, URLSessionTask, URL) -> Void)?
  382. open var requestDidCreateDestinationURL: ((DownloadRequest, URL) -> Void)?
  383. open var requestDidValidateRequestResponseTemporaryURLDestinationURLWithResult: ((DownloadRequest, URLRequest?, HTTPURLResponse, URL?, URL?, Request.ValidationResult) -> Void)?
  384. open var requestDidParseDownloadResponse: ((DownloadRequest, DownloadResponse<URL?>) -> Void)?
  385. public let queue: DispatchQueue
  386. public init(queue: DispatchQueue = .main) {
  387. self.queue = queue
  388. }
  389. public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {
  390. sessionDidBecomeInvalidWithError?(session, error)
  391. }
  392. public func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge) {
  393. taskDidReceiveChallenge?(session, task, challenge)
  394. }
  395. public func urlSession(_ session: URLSession,
  396. task: URLSessionTask,
  397. didSendBodyData bytesSent: Int64,
  398. totalBytesSent: Int64,
  399. totalBytesExpectedToSend: Int64) {
  400. taskDidSendBodyData?(session, task, bytesSent, totalBytesSent, totalBytesExpectedToSend)
  401. }
  402. public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
  403. taskNeedNewBodyStream?(session, task)
  404. }
  405. public func urlSession(_ session: URLSession,
  406. task: URLSessionTask,
  407. willPerformHTTPRedirection response: HTTPURLResponse,
  408. newRequest request: URLRequest) {
  409. taskWillPerformHTTPRedirection?(session, task, response, request)
  410. }
  411. public func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
  412. taskDidFinishCollectingMetrics?(session, task, metrics)
  413. }
  414. public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
  415. taskDidComplete?(session, task, error)
  416. }
  417. public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
  418. taskIsWaitingForConnectivity?(session, task)
  419. }
  420. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
  421. dataTaskDidReceiveData?(session, dataTask, data)
  422. }
  423. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse) {
  424. dataTaskWillCacheResponse?(session, dataTask, proposedResponse)
  425. }
  426. public func urlSession(_ session: URLSession,
  427. downloadTask: URLSessionDownloadTask,
  428. didResumeAtOffset fileOffset: Int64,
  429. expectedTotalBytes: Int64) {
  430. downloadTaskDidResumeAtOffset?(session, downloadTask, fileOffset, expectedTotalBytes)
  431. }
  432. public func urlSession(_ session: URLSession,
  433. downloadTask: URLSessionDownloadTask,
  434. didWriteData bytesWritten: Int64,
  435. totalBytesWritten: Int64,
  436. totalBytesExpectedToWrite: Int64) {
  437. downloadTaskDidWriteData?(session, downloadTask, bytesWritten, totalBytesWritten, totalBytesExpectedToWrite)
  438. }
  439. public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
  440. downloadTaskDidFinishDownloadingToURL?(session, downloadTask, location)
  441. }
  442. // MARK: Request Events
  443. public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
  444. requestDidCreateURLRequest?(request, urlRequest)
  445. }
  446. public func request(_ request: Request, didFailToCreateURLRequestWithError error: Error) {
  447. requestDidFailToCreateURLRequestWithError?(request, error)
  448. }
  449. public func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
  450. requestDidAdaptInitialRequestToAdaptedRequest?(request, initialRequest, adaptedRequest)
  451. }
  452. public func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: Error) {
  453. requestDidFailToAdaptURLRequestWithError?(request, initialRequest, error)
  454. }
  455. public func request(_ request: Request, didCreateTask task: URLSessionTask) {
  456. requestDidCreateTask?(request, task)
  457. }
  458. public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
  459. requestDidGatherMetrics?(request, metrics)
  460. }
  461. public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: Error) {
  462. requestDidFailTaskEarlyWithError?(request, task, error)
  463. }
  464. public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: Error?) {
  465. requestDidCompleteTaskWithError?(request, task, error)
  466. }
  467. public func requestIsRetrying(_ request: Request) {
  468. requestIsRetrying?(request)
  469. }
  470. public func requestDidFinish(_ request: Request) {
  471. requestDidFinish?(request)
  472. }
  473. public func requestDidResume(_ request: Request) {
  474. requestDidResume?(request)
  475. }
  476. public func requestDidSuspend(_ request: Request) {
  477. requestDidSuspend?(request)
  478. }
  479. public func requestDidCancel(_ request: Request) {
  480. requestDidCancel?(request)
  481. }
  482. public func request(_ request: DataRequest,
  483. didValidateRequest urlRequest: URLRequest?,
  484. response: HTTPURLResponse,
  485. data: Data?,
  486. withResult result: Request.ValidationResult) {
  487. requestDidValidateRequestResponseDataWithResult?(request, urlRequest, response, data, result)
  488. }
  489. public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?>) {
  490. requestDidParseResponse?(request, response)
  491. }
  492. public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value>) {
  493. // TODO: Make all methods optional so this isn't required.
  494. requestDidParseAnyResponse?(request, response as! DataResponse<Any>)
  495. }
  496. public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
  497. requestDidCreateUploadable?(request, uploadable)
  498. }
  499. public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: Error) {
  500. requestDidFailToCreateUploadableWithError?(request, error)
  501. }
  502. public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
  503. requestDidProvideInputStream?(request, stream)
  504. }
  505. public func request(_ request: DownloadRequest, didCompleteTask task: URLSessionTask, with url: URL) {
  506. requestDidCompleteTaskWithURL?(request, task, url)
  507. }
  508. public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
  509. requestDidCreateDestinationURL?(request, url)
  510. }
  511. public func request(_ request: DownloadRequest,
  512. didValidateRequest urlRequest: URLRequest?,
  513. response: HTTPURLResponse,
  514. temporaryURL: URL?,
  515. destinationURL: URL?,
  516. withResult result: Request.ValidationResult) {
  517. requestDidValidateRequestResponseTemporaryURLDestinationURLWithResult?(request,
  518. urlRequest,
  519. response,
  520. temporaryURL,
  521. destinationURL,
  522. result)
  523. }
  524. public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?>) {
  525. requestDidParseDownloadResponse?(request, response)
  526. }
  527. public func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value>) {
  528. // TODO: Make all methods optional so this isn't required.
  529. }
  530. }