EventMonitor.swift 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844
  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. `.main` by default.
  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`. If a `RequestAdapter` is active, the
  78. /// `URLRequest` will be adapted before being issued.
  79. func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest)
  80. /// Event called when the attempt to create a `URLRequest` from a `Request`'s original `URLRequestConvertible` value fails.
  81. func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError)
  82. /// Event called when a `RequestAdapter` adapts the `Request`'s initial `URLRequest`.
  83. func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest)
  84. /// Event called when a `RequestAdapter` fails to adapt the `Request`'s initial `URLRequest`.
  85. func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError)
  86. /// Event called when a final `URLRequest` is created for a `Request`.
  87. func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest)
  88. /// Event called when a `URLSessionTask` subclass instance is created for a `Request`.
  89. func request(_ request: Request, didCreateTask task: URLSessionTask)
  90. /// Event called when a `Request` receives a `URLSessionTaskMetrics` value.
  91. func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics)
  92. /// Event called when a `Request` fails due to an error created by Alamofire. e.g. When certificate pinning fails.
  93. func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError)
  94. /// Event called when a `Request`'s task completes, possibly with an error. A `Request` may receive this event
  95. /// multiple times if it is retried.
  96. func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?)
  97. /// Event called when a `Request` is about to be retried.
  98. func requestIsRetrying(_ request: Request)
  99. /// Event called when a `Request` finishes and response serializers are being called.
  100. func requestDidFinish(_ request: Request)
  101. /// Event called when a `Request` receives a `resume` call.
  102. func requestDidResume(_ request: Request)
  103. /// Event called when a `Request`'s associated `URLSessionTask` is resumed.
  104. func request(_ request: Request, didResumeTask task: URLSessionTask)
  105. /// Event called when a `Request` receives a `suspend` call.
  106. func requestDidSuspend(_ request: Request)
  107. /// Event called when a `Request`'s associated `URLSessionTask` is suspended.
  108. func request(_ request: Request, didSuspendTask task: URLSessionTask)
  109. /// Event called when a `Request` receives a `cancel` call.
  110. func requestDidCancel(_ request: Request)
  111. /// Event called when a `Request`'s associated `URLSessionTask` is cancelled.
  112. func request(_ request: Request, didCancelTask task: URLSessionTask)
  113. // MARK: DataRequest Events
  114. /// Event called when a `DataRequest` calls a `Validation`.
  115. func request(_ request: DataRequest,
  116. didValidateRequest urlRequest: URLRequest?,
  117. response: HTTPURLResponse,
  118. data: Data?,
  119. withResult result: Request.ValidationResult)
  120. /// Event called when a `DataRequest` creates a `DataResponse<Data?>` value without calling a `ResponseSerializer`.
  121. func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>)
  122. /// Event called when a `DataRequest` calls a `ResponseSerializer` and creates a generic `DataResponse<Value, AFError>`.
  123. func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>)
  124. // MARK: UploadRequest Events
  125. /// Event called when an `UploadRequest` creates its `Uploadable` value, indicating the type of upload it represents.
  126. func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable)
  127. /// Event called when an `UploadRequest` failed to create its `Uploadable` value due to an error.
  128. func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError)
  129. /// Event called when an `UploadRequest` provides the `InputStream` from its `Uploadable` value. This only occurs if
  130. /// the `InputStream` does not wrap a `Data` value or file `URL`.
  131. func request(_ request: UploadRequest, didProvideInputStream stream: InputStream)
  132. // MARK: DownloadRequest Events
  133. /// Event called when a `DownloadRequest`'s `URLSessionDownloadTask` finishes and the temporary file has been moved.
  134. func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>)
  135. /// Event called when a `DownloadRequest`'s `Destination` closure is called and creates the destination URL the
  136. /// downloaded file will be moved to.
  137. func request(_ request: DownloadRequest, didCreateDestinationURL url: URL)
  138. /// Event called when a `DownloadRequest` calls a `Validation`.
  139. func request(_ request: DownloadRequest,
  140. didValidateRequest urlRequest: URLRequest?,
  141. response: HTTPURLResponse,
  142. fileURL: URL?,
  143. withResult result: Request.ValidationResult)
  144. /// Event called when a `DownloadRequest` creates a `DownloadResponse<URL?, AFError>` without calling a `ResponseSerializer`.
  145. func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>)
  146. /// Event called when a `DownloadRequest` calls a `DownloadResponseSerializer` and creates a generic `DownloadResponse<Value, AFError>`
  147. func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>)
  148. }
  149. extension EventMonitor {
  150. /// The default queue on which `CompositeEventMonitor`s will call the `EventMonitor` methods. `.main` by default.
  151. public var queue: DispatchQueue { return .main }
  152. // MARK: Default Implementations
  153. public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {}
  154. public func urlSession(_ session: URLSession,
  155. task: URLSessionTask,
  156. didReceive challenge: URLAuthenticationChallenge) {}
  157. public func urlSession(_ session: URLSession,
  158. task: URLSessionTask,
  159. didSendBodyData bytesSent: Int64,
  160. totalBytesSent: Int64,
  161. totalBytesExpectedToSend: Int64) {}
  162. public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {}
  163. public func urlSession(_ session: URLSession,
  164. task: URLSessionTask,
  165. willPerformHTTPRedirection response: HTTPURLResponse,
  166. newRequest request: URLRequest) {}
  167. public func urlSession(_ session: URLSession,
  168. task: URLSessionTask,
  169. didFinishCollecting metrics: URLSessionTaskMetrics) {}
  170. public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {}
  171. public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {}
  172. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {}
  173. public func urlSession(_ session: URLSession,
  174. dataTask: URLSessionDataTask,
  175. willCacheResponse proposedResponse: CachedURLResponse) {}
  176. public func urlSession(_ session: URLSession,
  177. downloadTask: URLSessionDownloadTask,
  178. didResumeAtOffset fileOffset: Int64,
  179. expectedTotalBytes: Int64) {}
  180. public func urlSession(_ session: URLSession,
  181. downloadTask: URLSessionDownloadTask,
  182. didWriteData bytesWritten: Int64,
  183. totalBytesWritten: Int64,
  184. totalBytesExpectedToWrite: Int64) {}
  185. public func urlSession(_ session: URLSession,
  186. downloadTask: URLSessionDownloadTask,
  187. didFinishDownloadingTo location: URL) {}
  188. public func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {}
  189. public func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {}
  190. public func request(_ request: Request,
  191. didAdaptInitialRequest initialRequest: URLRequest,
  192. to adaptedRequest: URLRequest) {}
  193. public func request(_ request: Request,
  194. didFailToAdaptURLRequest initialRequest: URLRequest,
  195. withError error: AFError) {}
  196. public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {}
  197. public func request(_ request: Request, didCreateTask task: URLSessionTask) {}
  198. public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {}
  199. public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {}
  200. public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {}
  201. public func requestIsRetrying(_ request: Request) {}
  202. public func requestDidFinish(_ request: Request) {}
  203. public func requestDidResume(_ request: Request) {}
  204. public func request(_ request: Request, didResumeTask task: URLSessionTask) {}
  205. public func requestDidSuspend(_ request: Request) {}
  206. public func request(_ request: Request, didSuspendTask task: URLSessionTask) {}
  207. public func requestDidCancel(_ request: Request) {}
  208. public func request(_ request: Request, didCancelTask task: URLSessionTask) {}
  209. public func request(_ request: DataRequest,
  210. didValidateRequest urlRequest: URLRequest?,
  211. response: HTTPURLResponse,
  212. data: Data?,
  213. withResult result: Request.ValidationResult) {}
  214. public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {}
  215. public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>) {}
  216. public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {}
  217. public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {}
  218. public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {}
  219. public func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {}
  220. public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {}
  221. public func request(_ request: DownloadRequest,
  222. didValidateRequest urlRequest: URLRequest?,
  223. response: HTTPURLResponse,
  224. fileURL: URL?,
  225. withResult result: Request.ValidationResult) {}
  226. public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {}
  227. public func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>) {}
  228. }
  229. /// An `EventMonitor` which can contain multiple `EventMonitor`s and calls their methods on their queues.
  230. public final class CompositeEventMonitor: EventMonitor {
  231. public let queue = DispatchQueue(label: "org.alamofire.compositeEventMonitor", qos: .background)
  232. let monitors: [EventMonitor]
  233. init(monitors: [EventMonitor]) {
  234. self.monitors = monitors
  235. }
  236. func performEvent(_ event: @escaping (EventMonitor) -> Void) {
  237. queue.async {
  238. for monitor in self.monitors {
  239. monitor.queue.async { event(monitor) }
  240. }
  241. }
  242. }
  243. public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {
  244. performEvent { $0.urlSession(session, didBecomeInvalidWithError: error) }
  245. }
  246. public func urlSession(_ session: URLSession,
  247. task: URLSessionTask,
  248. didReceive challenge: URLAuthenticationChallenge) {
  249. performEvent { $0.urlSession(session, task: task, didReceive: challenge) }
  250. }
  251. public func urlSession(_ session: URLSession,
  252. task: URLSessionTask,
  253. didSendBodyData bytesSent: Int64,
  254. totalBytesSent: Int64,
  255. totalBytesExpectedToSend: Int64) {
  256. performEvent {
  257. $0.urlSession(session,
  258. task: task,
  259. didSendBodyData: bytesSent,
  260. totalBytesSent: totalBytesSent,
  261. totalBytesExpectedToSend: totalBytesExpectedToSend)
  262. }
  263. }
  264. public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
  265. performEvent {
  266. $0.urlSession(session, taskNeedsNewBodyStream: task)
  267. }
  268. }
  269. public func urlSession(_ session: URLSession,
  270. task: URLSessionTask,
  271. willPerformHTTPRedirection response: HTTPURLResponse,
  272. newRequest request: URLRequest) {
  273. performEvent {
  274. $0.urlSession(session,
  275. task: task,
  276. willPerformHTTPRedirection: response,
  277. newRequest: request)
  278. }
  279. }
  280. public func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
  281. performEvent { $0.urlSession(session, task: task, didFinishCollecting: metrics) }
  282. }
  283. public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
  284. performEvent { $0.urlSession(session, task: task, didCompleteWithError: error) }
  285. }
  286. @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
  287. public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
  288. performEvent { $0.urlSession(session, taskIsWaitingForConnectivity: task) }
  289. }
  290. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
  291. performEvent { $0.urlSession(session, dataTask: dataTask, didReceive: data) }
  292. }
  293. public func urlSession(_ session: URLSession,
  294. dataTask: URLSessionDataTask,
  295. willCacheResponse proposedResponse: CachedURLResponse) {
  296. performEvent { $0.urlSession(session, dataTask: dataTask, willCacheResponse: proposedResponse) }
  297. }
  298. public func urlSession(_ session: URLSession,
  299. downloadTask: URLSessionDownloadTask,
  300. didResumeAtOffset fileOffset: Int64,
  301. expectedTotalBytes: Int64) {
  302. performEvent {
  303. $0.urlSession(session,
  304. downloadTask: downloadTask,
  305. didResumeAtOffset: fileOffset,
  306. expectedTotalBytes: expectedTotalBytes)
  307. }
  308. }
  309. public func urlSession(_ session: URLSession,
  310. downloadTask: URLSessionDownloadTask,
  311. didWriteData bytesWritten: Int64,
  312. totalBytesWritten: Int64,
  313. totalBytesExpectedToWrite: Int64) {
  314. performEvent {
  315. $0.urlSession(session,
  316. downloadTask: downloadTask,
  317. didWriteData: bytesWritten,
  318. totalBytesWritten: totalBytesWritten,
  319. totalBytesExpectedToWrite: totalBytesExpectedToWrite)
  320. }
  321. }
  322. public func urlSession(_ session: URLSession,
  323. downloadTask: URLSessionDownloadTask,
  324. didFinishDownloadingTo location: URL) {
  325. performEvent { $0.urlSession(session, downloadTask: downloadTask, didFinishDownloadingTo: location) }
  326. }
  327. public func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {
  328. performEvent { $0.request(request, didCreateInitialURLRequest: urlRequest) }
  329. }
  330. public func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {
  331. performEvent { $0.request(request, didFailToCreateURLRequestWithError: error) }
  332. }
  333. public func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
  334. performEvent { $0.request(request, didAdaptInitialRequest: initialRequest, to: adaptedRequest) }
  335. }
  336. public func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError) {
  337. performEvent { $0.request(request, didFailToAdaptURLRequest: initialRequest, withError: error) }
  338. }
  339. public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
  340. performEvent { $0.request(request, didCreateURLRequest: urlRequest) }
  341. }
  342. public func request(_ request: Request, didCreateTask task: URLSessionTask) {
  343. performEvent { $0.request(request, didCreateTask: task) }
  344. }
  345. public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
  346. performEvent { $0.request(request, didGatherMetrics: metrics) }
  347. }
  348. public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {
  349. performEvent { $0.request(request, didFailTask: task, earlyWithError: error) }
  350. }
  351. public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {
  352. performEvent { $0.request(request, didCompleteTask: task, with: error) }
  353. }
  354. public func requestIsRetrying(_ request: Request) {
  355. performEvent { $0.requestIsRetrying(request) }
  356. }
  357. public func requestDidFinish(_ request: Request) {
  358. performEvent { $0.requestDidFinish(request) }
  359. }
  360. public func requestDidResume(_ request: Request) {
  361. performEvent { $0.requestDidResume(request) }
  362. }
  363. public func request(_ request: Request, didResumeTask task: URLSessionTask) {
  364. performEvent { $0.request(request, didResumeTask: task) }
  365. }
  366. public func requestDidSuspend(_ request: Request) {
  367. performEvent { $0.requestDidSuspend(request) }
  368. }
  369. public func request(_ request: Request, didSuspendTask task: URLSessionTask) {
  370. performEvent { $0.request(request, didSuspendTask: task) }
  371. }
  372. public func requestDidCancel(_ request: Request) {
  373. performEvent { $0.requestDidCancel(request) }
  374. }
  375. public func request(_ request: Request, didCancelTask task: URLSessionTask) {
  376. performEvent { $0.request(request, didCancelTask: task) }
  377. }
  378. public func request(_ request: DataRequest,
  379. didValidateRequest urlRequest: URLRequest?,
  380. response: HTTPURLResponse,
  381. data: Data?,
  382. withResult result: Request.ValidationResult) {
  383. performEvent { $0.request(request,
  384. didValidateRequest: urlRequest,
  385. response: response,
  386. data: data,
  387. withResult: result)
  388. }
  389. }
  390. public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {
  391. performEvent { $0.request(request, didParseResponse: response) }
  392. }
  393. public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>) {
  394. performEvent { $0.request(request, didParseResponse: response) }
  395. }
  396. public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
  397. performEvent { $0.request(request, didCreateUploadable: uploadable) }
  398. }
  399. public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {
  400. performEvent { $0.request(request, didFailToCreateUploadableWithError: error) }
  401. }
  402. public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
  403. performEvent { $0.request(request, didProvideInputStream: stream) }
  404. }
  405. public func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {
  406. performEvent { $0.request(request, didFinishDownloadingUsing: task, with: result) }
  407. }
  408. public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
  409. performEvent { $0.request(request, didCreateDestinationURL: url) }
  410. }
  411. public func request(_ request: DownloadRequest,
  412. didValidateRequest urlRequest: URLRequest?,
  413. response: HTTPURLResponse,
  414. fileURL: URL?,
  415. withResult result: Request.ValidationResult) {
  416. performEvent { $0.request(request,
  417. didValidateRequest: urlRequest,
  418. response: response,
  419. fileURL: fileURL,
  420. withResult: result) }
  421. }
  422. public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {
  423. performEvent { $0.request(request, didParseResponse: response) }
  424. }
  425. public func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>) {
  426. performEvent { $0.request(request, didParseResponse: response) }
  427. }
  428. }
  429. /// `EventMonitor` that allows optional closures to be set to receive events.
  430. open class ClosureEventMonitor: EventMonitor {
  431. /// Closure called on the `urlSession(_:didBecomeInvalidWithError:)` event.
  432. open var sessionDidBecomeInvalidWithError: ((URLSession, Error?) -> Void)?
  433. /// Closure called on the `urlSession(_:task:didReceive:completionHandler:)`.
  434. open var taskDidReceiveChallenge: ((URLSession, URLSessionTask, URLAuthenticationChallenge) -> Void)?
  435. /// Closure that receives `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` event.
  436. open var taskDidSendBodyData: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?
  437. /// Closure called on the `urlSession(_:task:needNewBodyStream:)` event.
  438. open var taskNeedNewBodyStream: ((URLSession, URLSessionTask) -> Void)?
  439. /// Closure called on the `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)` event.
  440. open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> Void)?
  441. /// Closure called on the `urlSession(_:task:didFinishCollecting:)` event.
  442. open var taskDidFinishCollectingMetrics: ((URLSession, URLSessionTask, URLSessionTaskMetrics) -> Void)?
  443. /// Closure called on the `urlSession(_:task:didCompleteWithError:)` event.
  444. open var taskDidComplete: ((URLSession, URLSessionTask, Error?) -> Void)?
  445. /// Closure called on the `urlSession(_:taskIsWaitingForConnectivity:)` event.
  446. open var taskIsWaitingForConnectivity: ((URLSession, URLSessionTask) -> Void)?
  447. /// Closure that receives the `urlSession(_:dataTask:didReceive:)` event.
  448. open var dataTaskDidReceiveData: ((URLSession, URLSessionDataTask, Data) -> Void)?
  449. /// Closure called on the `urlSession(_:dataTask:willCacheResponse:completionHandler:)` event.
  450. open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> Void)?
  451. /// Closure called on the `urlSession(_:downloadTask:didFinishDownloadingTo:)` event.
  452. open var downloadTaskDidFinishDownloadingToURL: ((URLSession, URLSessionDownloadTask, URL) -> Void)?
  453. /// Closure called on the `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)`
  454. /// event.
  455. open var downloadTaskDidWriteData: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?
  456. /// Closure called on the `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)` event.
  457. open var downloadTaskDidResumeAtOffset: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?
  458. // MARK: - Request Events
  459. /// Closure called on the `request(_:didCreateInitialURLRequest:)` event.
  460. open var requestDidCreateInitialURLRequest: ((Request, URLRequest) -> Void)?
  461. /// Closure called on the `request(_:didFailToCreateURLRequestWithError:)` event.
  462. open var requestDidFailToCreateURLRequestWithError: ((Request, AFError) -> Void)?
  463. /// Closure called on the `request(_:didAdaptInitialRequest:to:)` event.
  464. open var requestDidAdaptInitialRequestToAdaptedRequest: ((Request, URLRequest, URLRequest) -> Void)?
  465. /// Closure called on the `request(_:didFailToAdaptURLRequest:withError:)` event.
  466. open var requestDidFailToAdaptURLRequestWithError: ((Request, URLRequest, AFError) -> Void)?
  467. /// Closure called on the `request(_:didCreateURLRequest:)` event.
  468. open var requestDidCreateURLRequest: ((Request, URLRequest) -> Void)?
  469. /// Closure called on the `request(_:didCreateTask:)` event.
  470. open var requestDidCreateTask: ((Request, URLSessionTask) -> Void)?
  471. /// Closure called on the `request(_:didGatherMetrics:)` event.
  472. open var requestDidGatherMetrics: ((Request, URLSessionTaskMetrics) -> Void)?
  473. /// Closure called on the `request(_:didFailTask:earlyWithError:)` event.
  474. open var requestDidFailTaskEarlyWithError: ((Request, URLSessionTask, AFError) -> Void)?
  475. /// Closure called on the `request(_:didCompleteTask:with:)` event.
  476. open var requestDidCompleteTaskWithError: ((Request, URLSessionTask, AFError?) -> Void)?
  477. /// Closure called on the `requestIsRetrying(_:)` event.
  478. open var requestIsRetrying: ((Request) -> Void)?
  479. /// Closure called on the `requestDidFinish(_:)` event.
  480. open var requestDidFinish: ((Request) -> Void)?
  481. /// Closure called on the `requestDidResume(_:)` event.
  482. open var requestDidResume: ((Request) -> Void)?
  483. /// Closure called on the `request(_:didResumeTask:)` event.
  484. open var requestDidResumeTask: ((Request, URLSessionTask) -> Void)?
  485. /// Closure called on the `requestDidSuspend(_:)` event.
  486. open var requestDidSuspend: ((Request) -> Void)?
  487. /// Closure called on the `request(_:didSuspendTask:)` event.
  488. open var requestDidSuspendTask: ((Request, URLSessionTask) -> Void)?
  489. /// Closure called on the `requestDidCancel(_:)` event.
  490. open var requestDidCancel: ((Request) -> Void)?
  491. /// Closure called on the `request(_:didCancelTask:)` event.
  492. open var requestDidCancelTask: ((Request, URLSessionTask) -> Void)?
  493. /// Closure called on the `request(_:didValidateRequest:response:data:withResult:)` event.
  494. open var requestDidValidateRequestResponseDataWithResult: ((DataRequest, URLRequest?, HTTPURLResponse, Data?, Request.ValidationResult) -> Void)?
  495. /// Closure called on the `request(_:didParseResponse:)` event.
  496. open var requestDidParseResponse: ((DataRequest, DataResponse<Data?, AFError>) -> Void)?
  497. /// Closure called on the `request(_:didCreateUploadable:)` event.
  498. open var requestDidCreateUploadable: ((UploadRequest, UploadRequest.Uploadable) -> Void)?
  499. /// Closure called on the `request(_:didFailToCreateUploadableWithError:)` event.
  500. open var requestDidFailToCreateUploadableWithError: ((UploadRequest, AFError) -> Void)?
  501. /// Closure called on the `request(_:didProvideInputStream:)` event.
  502. open var requestDidProvideInputStream: ((UploadRequest, InputStream) -> Void)?
  503. /// Closure called on the `request(_:didFinishDownloadingUsing:with:)` event.
  504. open var requestDidFinishDownloadingUsingTaskWithResult: ((DownloadRequest, URLSessionTask, Result<URL, AFError>) -> Void)?
  505. /// Closure called on the `request(_:didCreateDestinationURL:)` event.
  506. open var requestDidCreateDestinationURL: ((DownloadRequest, URL) -> Void)?
  507. /// Closure called on the `request(_:didValidateRequest:response:temporaryURL:destinationURL:withResult:)` event.
  508. open var requestDidValidateRequestResponseFileURLWithResult: ((DownloadRequest, URLRequest?, HTTPURLResponse, URL?, Request.ValidationResult) -> Void)?
  509. /// Closure called on the `request(_:didParseResponse:)` event.
  510. open var requestDidParseDownloadResponse: ((DownloadRequest, DownloadResponse<URL?, AFError>) -> Void)?
  511. public let queue: DispatchQueue
  512. /// Creates an instance using the provided queue.
  513. ///
  514. /// - Parameter queue: `DispatchQueue` on which events will fired. `.main` by default.
  515. public init(queue: DispatchQueue = .main) {
  516. self.queue = queue
  517. }
  518. open func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {
  519. sessionDidBecomeInvalidWithError?(session, error)
  520. }
  521. open func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge) {
  522. taskDidReceiveChallenge?(session, task, challenge)
  523. }
  524. open func urlSession(_ session: URLSession,
  525. task: URLSessionTask,
  526. didSendBodyData bytesSent: Int64,
  527. totalBytesSent: Int64,
  528. totalBytesExpectedToSend: Int64) {
  529. taskDidSendBodyData?(session, task, bytesSent, totalBytesSent, totalBytesExpectedToSend)
  530. }
  531. open func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
  532. taskNeedNewBodyStream?(session, task)
  533. }
  534. open func urlSession(_ session: URLSession,
  535. task: URLSessionTask,
  536. willPerformHTTPRedirection response: HTTPURLResponse,
  537. newRequest request: URLRequest) {
  538. taskWillPerformHTTPRedirection?(session, task, response, request)
  539. }
  540. open func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
  541. taskDidFinishCollectingMetrics?(session, task, metrics)
  542. }
  543. open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
  544. taskDidComplete?(session, task, error)
  545. }
  546. open func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
  547. taskIsWaitingForConnectivity?(session, task)
  548. }
  549. open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
  550. dataTaskDidReceiveData?(session, dataTask, data)
  551. }
  552. open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse) {
  553. dataTaskWillCacheResponse?(session, dataTask, proposedResponse)
  554. }
  555. open func urlSession(_ session: URLSession,
  556. downloadTask: URLSessionDownloadTask,
  557. didResumeAtOffset fileOffset: Int64,
  558. expectedTotalBytes: Int64) {
  559. downloadTaskDidResumeAtOffset?(session, downloadTask, fileOffset, expectedTotalBytes)
  560. }
  561. open func urlSession(_ session: URLSession,
  562. downloadTask: URLSessionDownloadTask,
  563. didWriteData bytesWritten: Int64,
  564. totalBytesWritten: Int64,
  565. totalBytesExpectedToWrite: Int64) {
  566. downloadTaskDidWriteData?(session, downloadTask, bytesWritten, totalBytesWritten, totalBytesExpectedToWrite)
  567. }
  568. open func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
  569. downloadTaskDidFinishDownloadingToURL?(session, downloadTask, location)
  570. }
  571. // MARK: Request Events
  572. open func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {
  573. requestDidCreateInitialURLRequest?(request, urlRequest)
  574. }
  575. open func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {
  576. requestDidFailToCreateURLRequestWithError?(request, error)
  577. }
  578. open func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
  579. requestDidAdaptInitialRequestToAdaptedRequest?(request, initialRequest, adaptedRequest)
  580. }
  581. open func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError) {
  582. requestDidFailToAdaptURLRequestWithError?(request, initialRequest, error)
  583. }
  584. open func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
  585. requestDidCreateURLRequest?(request, urlRequest)
  586. }
  587. open func request(_ request: Request, didCreateTask task: URLSessionTask) {
  588. requestDidCreateTask?(request, task)
  589. }
  590. open func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
  591. requestDidGatherMetrics?(request, metrics)
  592. }
  593. open func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {
  594. requestDidFailTaskEarlyWithError?(request, task, error)
  595. }
  596. open func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {
  597. requestDidCompleteTaskWithError?(request, task, error)
  598. }
  599. open func requestIsRetrying(_ request: Request) {
  600. requestIsRetrying?(request)
  601. }
  602. open func requestDidFinish(_ request: Request) {
  603. requestDidFinish?(request)
  604. }
  605. open func requestDidResume(_ request: Request) {
  606. requestDidResume?(request)
  607. }
  608. public func request(_ request: Request, didResumeTask task: URLSessionTask) {
  609. requestDidResumeTask?(request, task)
  610. }
  611. open func requestDidSuspend(_ request: Request) {
  612. requestDidSuspend?(request)
  613. }
  614. public func request(_ request: Request, didSuspendTask task: URLSessionTask) {
  615. requestDidSuspendTask?(request, task)
  616. }
  617. open func requestDidCancel(_ request: Request) {
  618. requestDidCancel?(request)
  619. }
  620. public func request(_ request: Request, didCancelTask task: URLSessionTask) {
  621. requestDidCancelTask?(request, task)
  622. }
  623. open func request(_ request: DataRequest,
  624. didValidateRequest urlRequest: URLRequest?,
  625. response: HTTPURLResponse,
  626. data: Data?,
  627. withResult result: Request.ValidationResult) {
  628. requestDidValidateRequestResponseDataWithResult?(request, urlRequest, response, data, result)
  629. }
  630. open func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {
  631. requestDidParseResponse?(request, response)
  632. }
  633. open func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
  634. requestDidCreateUploadable?(request, uploadable)
  635. }
  636. open func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {
  637. requestDidFailToCreateUploadableWithError?(request, error)
  638. }
  639. open func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
  640. requestDidProvideInputStream?(request, stream)
  641. }
  642. open func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {
  643. requestDidFinishDownloadingUsingTaskWithResult?(request, task, result)
  644. }
  645. open func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
  646. requestDidCreateDestinationURL?(request, url)
  647. }
  648. open func request(_ request: DownloadRequest,
  649. didValidateRequest urlRequest: URLRequest?,
  650. response: HTTPURLResponse,
  651. fileURL: URL?,
  652. withResult result: Request.ValidationResult) {
  653. requestDidValidateRequestResponseFileURLWithResult?(request,
  654. urlRequest,
  655. response,
  656. fileURL,
  657. result)
  658. }
  659. open func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {
  660. requestDidParseDownloadResponse?(request, response)
  661. }
  662. }