EventMonitor.swift 44 KB

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