Proyectos de Subversion Iphone Microlearning

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 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
 
25
import Foundation
26
 
27
/// Protocol outlining the lifetime events inside Alamofire. It includes both events received from the various
28
/// `URLSession` delegate protocols as well as various events from the lifetime of `Request` and its subclasses.
29
public protocol EventMonitor {
30
    /// The `DispatchQueue` onto which Alamofire's root `CompositeEventMonitor` will dispatch events. `.main` by default.
31
    var queue: DispatchQueue { get }
32
 
33
    // MARK: - URLSession Events
34
 
35
    // MARK: URLSessionDelegate Events
36
 
37
    /// Event called during `URLSessionDelegate`'s `urlSession(_:didBecomeInvalidWithError:)` method.
38
    func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?)
39
 
40
    // MARK: URLSessionTaskDelegate Events
41
 
42
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didReceive:completionHandler:)` method.
43
    func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge)
44
 
45
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` method.
46
    func urlSession(_ session: URLSession,
47
                    task: URLSessionTask,
48
                    didSendBodyData bytesSent: Int64,
49
                    totalBytesSent: Int64,
50
                    totalBytesExpectedToSend: Int64)
51
 
52
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:needNewBodyStream:)` method.
53
    func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask)
54
 
55
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)` method.
56
    func urlSession(_ session: URLSession,
57
                    task: URLSessionTask,
58
                    willPerformHTTPRedirection response: HTTPURLResponse,
59
                    newRequest request: URLRequest)
60
 
61
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didFinishCollecting:)` method.
62
    func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics)
63
 
64
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didCompleteWithError:)` method.
65
    func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
66
 
67
    /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:taskIsWaitingForConnectivity:)` method.
68
    @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
69
    func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask)
70
 
71
    // MARK: URLSessionDataDelegate Events
72
 
73
    /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:didReceive:)` method.
74
    func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)
75
 
76
    /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:willCacheResponse:completionHandler:)` method.
77
    func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse)
78
 
79
    // MARK: URLSessionDownloadDelegate Events
80
 
81
    /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)` method.
82
    func urlSession(_ session: URLSession,
83
                    downloadTask: URLSessionDownloadTask,
84
                    didResumeAtOffset fileOffset: Int64,
85
                    expectedTotalBytes: Int64)
86
 
87
    /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)` method.
88
    func urlSession(_ session: URLSession,
89
                    downloadTask: URLSessionDownloadTask,
90
                    didWriteData bytesWritten: Int64,
91
                    totalBytesWritten: Int64,
92
                    totalBytesExpectedToWrite: Int64)
93
 
94
    /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didFinishDownloadingTo:)` method.
95
    func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)
96
 
97
    // MARK: - Request Events
98
 
99
    /// Event called when a `URLRequest` is first created for a `Request`. If a `RequestAdapter` is active, the
100
    /// `URLRequest` will be adapted before being issued.
101
    func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest)
102
 
103
    /// Event called when the attempt to create a `URLRequest` from a `Request`'s original `URLRequestConvertible` value fails.
104
    func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError)
105
 
106
    /// Event called when a `RequestAdapter` adapts the `Request`'s initial `URLRequest`.
107
    func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest)
108
 
109
    /// Event called when a `RequestAdapter` fails to adapt the `Request`'s initial `URLRequest`.
110
    func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError)
111
 
112
    /// Event called when a final `URLRequest` is created for a `Request`.
113
    func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest)
114
 
115
    /// Event called when a `URLSessionTask` subclass instance is created for a `Request`.
116
    func request(_ request: Request, didCreateTask task: URLSessionTask)
117
 
118
    /// Event called when a `Request` receives a `URLSessionTaskMetrics` value.
119
    func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics)
120
 
121
    /// Event called when a `Request` fails due to an error created by Alamofire. e.g. When certificate pinning fails.
122
    func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError)
123
 
124
    /// Event called when a `Request`'s task completes, possibly with an error. A `Request` may receive this event
125
    /// multiple times if it is retried.
126
    func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?)
127
 
128
    /// Event called when a `Request` is about to be retried.
129
    func requestIsRetrying(_ request: Request)
130
 
131
    /// Event called when a `Request` finishes and response serializers are being called.
132
    func requestDidFinish(_ request: Request)
133
 
134
    /// Event called when a `Request` receives a `resume` call.
135
    func requestDidResume(_ request: Request)
136
 
137
    /// Event called when a `Request`'s associated `URLSessionTask` is resumed.
138
    func request(_ request: Request, didResumeTask task: URLSessionTask)
139
 
140
    /// Event called when a `Request` receives a `suspend` call.
141
    func requestDidSuspend(_ request: Request)
142
 
143
    /// Event called when a `Request`'s associated `URLSessionTask` is suspended.
144
    func request(_ request: Request, didSuspendTask task: URLSessionTask)
145
 
146
    /// Event called when a `Request` receives a `cancel` call.
147
    func requestDidCancel(_ request: Request)
148
 
149
    /// Event called when a `Request`'s associated `URLSessionTask` is cancelled.
150
    func request(_ request: Request, didCancelTask task: URLSessionTask)
151
 
152
    // MARK: DataRequest Events
153
 
154
    /// Event called when a `DataRequest` calls a `Validation`.
155
    func request(_ request: DataRequest,
156
                 didValidateRequest urlRequest: URLRequest?,
157
                 response: HTTPURLResponse,
158
                 data: Data?,
159
                 withResult result: Request.ValidationResult)
160
 
161
    /// Event called when a `DataRequest` creates a `DataResponse<Data?>` value without calling a `ResponseSerializer`.
162
    func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>)
163
 
164
    /// Event called when a `DataRequest` calls a `ResponseSerializer` and creates a generic `DataResponse<Value, AFError>`.
165
    func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>)
166
 
167
    // MARK: DataStreamRequest Events
168
 
169
    /// Event called when a `DataStreamRequest` calls a `Validation` closure.
170
    ///
171
    /// - Parameters:
172
    ///   - request:    `DataStreamRequest` which is calling the `Validation`.
173
    ///   - urlRequest: `URLRequest` of the request being validated.
174
    ///   - response:   `HTTPURLResponse` of the request being validated.
175
    ///   - result:      Produced `ValidationResult`.
176
    func request(_ request: DataStreamRequest,
177
                 didValidateRequest urlRequest: URLRequest?,
178
                 response: HTTPURLResponse,
179
                 withResult result: Request.ValidationResult)
180
 
181
    /// Event called when a `DataStreamSerializer` produces a value from streamed `Data`.
182
    ///
183
    /// - Parameters:
184
    ///   - request: `DataStreamRequest` for which the value was serialized.
185
    ///   - result:  `Result` of the serialization attempt.
186
    func request<Value>(_ request: DataStreamRequest, didParseStream result: Result<Value, AFError>)
187
 
188
    // MARK: UploadRequest Events
189
 
190
    /// Event called when an `UploadRequest` creates its `Uploadable` value, indicating the type of upload it represents.
191
    func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable)
192
 
193
    /// Event called when an `UploadRequest` failed to create its `Uploadable` value due to an error.
194
    func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError)
195
 
196
    /// Event called when an `UploadRequest` provides the `InputStream` from its `Uploadable` value. This only occurs if
197
    /// the `InputStream` does not wrap a `Data` value or file `URL`.
198
    func request(_ request: UploadRequest, didProvideInputStream stream: InputStream)
199
 
200
    // MARK: DownloadRequest Events
201
 
202
    /// Event called when a `DownloadRequest`'s `URLSessionDownloadTask` finishes and the temporary file has been moved.
203
    func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>)
204
 
205
    /// Event called when a `DownloadRequest`'s `Destination` closure is called and creates the destination URL the
206
    /// downloaded file will be moved to.
207
    func request(_ request: DownloadRequest, didCreateDestinationURL url: URL)
208
 
209
    /// Event called when a `DownloadRequest` calls a `Validation`.
210
    func request(_ request: DownloadRequest,
211
                 didValidateRequest urlRequest: URLRequest?,
212
                 response: HTTPURLResponse,
213
                 fileURL: URL?,
214
                 withResult result: Request.ValidationResult)
215
 
216
    /// Event called when a `DownloadRequest` creates a `DownloadResponse<URL?, AFError>` without calling a `ResponseSerializer`.
217
    func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>)
218
 
219
    /// Event called when a `DownloadRequest` calls a `DownloadResponseSerializer` and creates a generic `DownloadResponse<Value, AFError>`
220
    func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>)
221
}
222
 
223
extension EventMonitor {
224
    /// The default queue on which `CompositeEventMonitor`s will call the `EventMonitor` methods. `.main` by default.
225
    public var queue: DispatchQueue { .main }
226
 
227
    // MARK: Default Implementations
228
 
229
    public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {}
230
    public func urlSession(_ session: URLSession,
231
                           task: URLSessionTask,
232
                           didReceive challenge: URLAuthenticationChallenge) {}
233
    public func urlSession(_ session: URLSession,
234
                           task: URLSessionTask,
235
                           didSendBodyData bytesSent: Int64,
236
                           totalBytesSent: Int64,
237
                           totalBytesExpectedToSend: Int64) {}
238
    public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {}
239
    public func urlSession(_ session: URLSession,
240
                           task: URLSessionTask,
241
                           willPerformHTTPRedirection response: HTTPURLResponse,
242
                           newRequest request: URLRequest) {}
243
    public func urlSession(_ session: URLSession,
244
                           task: URLSessionTask,
245
                           didFinishCollecting metrics: URLSessionTaskMetrics) {}
246
    public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {}
247
    public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {}
248
    public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {}
249
    public func urlSession(_ session: URLSession,
250
                           dataTask: URLSessionDataTask,
251
                           willCacheResponse proposedResponse: CachedURLResponse) {}
252
    public func urlSession(_ session: URLSession,
253
                           downloadTask: URLSessionDownloadTask,
254
                           didResumeAtOffset fileOffset: Int64,
255
                           expectedTotalBytes: Int64) {}
256
    public func urlSession(_ session: URLSession,
257
                           downloadTask: URLSessionDownloadTask,
258
                           didWriteData bytesWritten: Int64,
259
                           totalBytesWritten: Int64,
260
                           totalBytesExpectedToWrite: Int64) {}
261
    public func urlSession(_ session: URLSession,
262
                           downloadTask: URLSessionDownloadTask,
263
                           didFinishDownloadingTo location: URL) {}
264
    public func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {}
265
    public func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {}
266
    public func request(_ request: Request,
267
                        didAdaptInitialRequest initialRequest: URLRequest,
268
                        to adaptedRequest: URLRequest) {}
269
    public func request(_ request: Request,
270
                        didFailToAdaptURLRequest initialRequest: URLRequest,
271
                        withError error: AFError) {}
272
    public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {}
273
    public func request(_ request: Request, didCreateTask task: URLSessionTask) {}
274
    public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {}
275
    public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {}
276
    public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {}
277
    public func requestIsRetrying(_ request: Request) {}
278
    public func requestDidFinish(_ request: Request) {}
279
    public func requestDidResume(_ request: Request) {}
280
    public func request(_ request: Request, didResumeTask task: URLSessionTask) {}
281
    public func requestDidSuspend(_ request: Request) {}
282
    public func request(_ request: Request, didSuspendTask task: URLSessionTask) {}
283
    public func requestDidCancel(_ request: Request) {}
284
    public func request(_ request: Request, didCancelTask task: URLSessionTask) {}
285
    public func request(_ request: DataRequest,
286
                        didValidateRequest urlRequest: URLRequest?,
287
                        response: HTTPURLResponse,
288
                        data: Data?,
289
                        withResult result: Request.ValidationResult) {}
290
    public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {}
291
    public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>) {}
292
    public func request(_ request: DataStreamRequest,
293
                        didValidateRequest urlRequest: URLRequest?,
294
                        response: HTTPURLResponse,
295
                        withResult result: Request.ValidationResult) {}
296
    public func request<Value>(_ request: DataStreamRequest, didParseStream result: Result<Value, AFError>) {}
297
    public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {}
298
    public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {}
299
    public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {}
300
    public func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {}
301
    public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {}
302
    public func request(_ request: DownloadRequest,
303
                        didValidateRequest urlRequest: URLRequest?,
304
                        response: HTTPURLResponse,
305
                        fileURL: URL?,
306
                        withResult result: Request.ValidationResult) {}
307
    public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {}
308
    public func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>) {}
309
}
310
 
311
/// An `EventMonitor` which can contain multiple `EventMonitor`s and calls their methods on their queues.
312
public final class CompositeEventMonitor: EventMonitor {
313
    public let queue = DispatchQueue(label: "org.alamofire.compositeEventMonitor", qos: .utility)
314
 
315
    let monitors: [EventMonitor]
316
 
317
    init(monitors: [EventMonitor]) {
318
        self.monitors = monitors
319
    }
320
 
321
    func performEvent(_ event: @escaping (EventMonitor) -> Void) {
322
        queue.async {
323
            for monitor in self.monitors {
324
                monitor.queue.async { event(monitor) }
325
            }
326
        }
327
    }
328
 
329
    public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {
330
        performEvent { $0.urlSession(session, didBecomeInvalidWithError: error) }
331
    }
332
 
333
    public func urlSession(_ session: URLSession,
334
                           task: URLSessionTask,
335
                           didReceive challenge: URLAuthenticationChallenge) {
336
        performEvent { $0.urlSession(session, task: task, didReceive: challenge) }
337
    }
338
 
339
    public func urlSession(_ session: URLSession,
340
                           task: URLSessionTask,
341
                           didSendBodyData bytesSent: Int64,
342
                           totalBytesSent: Int64,
343
                           totalBytesExpectedToSend: Int64) {
344
        performEvent {
345
            $0.urlSession(session,
346
                          task: task,
347
                          didSendBodyData: bytesSent,
348
                          totalBytesSent: totalBytesSent,
349
                          totalBytesExpectedToSend: totalBytesExpectedToSend)
350
        }
351
    }
352
 
353
    public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
354
        performEvent {
355
            $0.urlSession(session, taskNeedsNewBodyStream: task)
356
        }
357
    }
358
 
359
    public func urlSession(_ session: URLSession,
360
                           task: URLSessionTask,
361
                           willPerformHTTPRedirection response: HTTPURLResponse,
362
                           newRequest request: URLRequest) {
363
        performEvent {
364
            $0.urlSession(session,
365
                          task: task,
366
                          willPerformHTTPRedirection: response,
367
                          newRequest: request)
368
        }
369
    }
370
 
371
    public func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
372
        performEvent { $0.urlSession(session, task: task, didFinishCollecting: metrics) }
373
    }
374
 
375
    public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
376
        performEvent { $0.urlSession(session, task: task, didCompleteWithError: error) }
377
    }
378
 
379
    @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
380
    public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
381
        performEvent { $0.urlSession(session, taskIsWaitingForConnectivity: task) }
382
    }
383
 
384
    public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
385
        performEvent { $0.urlSession(session, dataTask: dataTask, didReceive: data) }
386
    }
387
 
388
    public func urlSession(_ session: URLSession,
389
                           dataTask: URLSessionDataTask,
390
                           willCacheResponse proposedResponse: CachedURLResponse) {
391
        performEvent { $0.urlSession(session, dataTask: dataTask, willCacheResponse: proposedResponse) }
392
    }
393
 
394
    public func urlSession(_ session: URLSession,
395
                           downloadTask: URLSessionDownloadTask,
396
                           didResumeAtOffset fileOffset: Int64,
397
                           expectedTotalBytes: Int64) {
398
        performEvent {
399
            $0.urlSession(session,
400
                          downloadTask: downloadTask,
401
                          didResumeAtOffset: fileOffset,
402
                          expectedTotalBytes: expectedTotalBytes)
403
        }
404
    }
405
 
406
    public func urlSession(_ session: URLSession,
407
                           downloadTask: URLSessionDownloadTask,
408
                           didWriteData bytesWritten: Int64,
409
                           totalBytesWritten: Int64,
410
                           totalBytesExpectedToWrite: Int64) {
411
        performEvent {
412
            $0.urlSession(session,
413
                          downloadTask: downloadTask,
414
                          didWriteData: bytesWritten,
415
                          totalBytesWritten: totalBytesWritten,
416
                          totalBytesExpectedToWrite: totalBytesExpectedToWrite)
417
        }
418
    }
419
 
420
    public func urlSession(_ session: URLSession,
421
                           downloadTask: URLSessionDownloadTask,
422
                           didFinishDownloadingTo location: URL) {
423
        performEvent { $0.urlSession(session, downloadTask: downloadTask, didFinishDownloadingTo: location) }
424
    }
425
 
426
    public func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {
427
        performEvent { $0.request(request, didCreateInitialURLRequest: urlRequest) }
428
    }
429
 
430
    public func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {
431
        performEvent { $0.request(request, didFailToCreateURLRequestWithError: error) }
432
    }
433
 
434
    public func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
435
        performEvent { $0.request(request, didAdaptInitialRequest: initialRequest, to: adaptedRequest) }
436
    }
437
 
438
    public func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError) {
439
        performEvent { $0.request(request, didFailToAdaptURLRequest: initialRequest, withError: error) }
440
    }
441
 
442
    public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
443
        performEvent { $0.request(request, didCreateURLRequest: urlRequest) }
444
    }
445
 
446
    public func request(_ request: Request, didCreateTask task: URLSessionTask) {
447
        performEvent { $0.request(request, didCreateTask: task) }
448
    }
449
 
450
    public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
451
        performEvent { $0.request(request, didGatherMetrics: metrics) }
452
    }
453
 
454
    public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {
455
        performEvent { $0.request(request, didFailTask: task, earlyWithError: error) }
456
    }
457
 
458
    public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {
459
        performEvent { $0.request(request, didCompleteTask: task, with: error) }
460
    }
461
 
462
    public func requestIsRetrying(_ request: Request) {
463
        performEvent { $0.requestIsRetrying(request) }
464
    }
465
 
466
    public func requestDidFinish(_ request: Request) {
467
        performEvent { $0.requestDidFinish(request) }
468
    }
469
 
470
    public func requestDidResume(_ request: Request) {
471
        performEvent { $0.requestDidResume(request) }
472
    }
473
 
474
    public func request(_ request: Request, didResumeTask task: URLSessionTask) {
475
        performEvent { $0.request(request, didResumeTask: task) }
476
    }
477
 
478
    public func requestDidSuspend(_ request: Request) {
479
        performEvent { $0.requestDidSuspend(request) }
480
    }
481
 
482
    public func request(_ request: Request, didSuspendTask task: URLSessionTask) {
483
        performEvent { $0.request(request, didSuspendTask: task) }
484
    }
485
 
486
    public func requestDidCancel(_ request: Request) {
487
        performEvent { $0.requestDidCancel(request) }
488
    }
489
 
490
    public func request(_ request: Request, didCancelTask task: URLSessionTask) {
491
        performEvent { $0.request(request, didCancelTask: task) }
492
    }
493
 
494
    public func request(_ request: DataRequest,
495
                        didValidateRequest urlRequest: URLRequest?,
496
                        response: HTTPURLResponse,
497
                        data: Data?,
498
                        withResult result: Request.ValidationResult) {
499
        performEvent { $0.request(request,
500
                                  didValidateRequest: urlRequest,
501
                                  response: response,
502
                                  data: data,
503
                                  withResult: result)
504
        }
505
    }
506
 
507
    public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {
508
        performEvent { $0.request(request, didParseResponse: response) }
509
    }
510
 
511
    public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>) {
512
        performEvent { $0.request(request, didParseResponse: response) }
513
    }
514
 
515
    public func request(_ request: DataStreamRequest,
516
                        didValidateRequest urlRequest: URLRequest?,
517
                        response: HTTPURLResponse,
518
                        withResult result: Request.ValidationResult) {
519
        performEvent { $0.request(request,
520
                                  didValidateRequest: urlRequest,
521
                                  response: response,
522
                                  withResult: result)
523
        }
524
    }
525
 
526
    public func request<Value>(_ request: DataStreamRequest, didParseStream result: Result<Value, AFError>) {
527
        performEvent { $0.request(request, didParseStream: result) }
528
    }
529
 
530
    public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
531
        performEvent { $0.request(request, didCreateUploadable: uploadable) }
532
    }
533
 
534
    public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {
535
        performEvent { $0.request(request, didFailToCreateUploadableWithError: error) }
536
    }
537
 
538
    public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
539
        performEvent { $0.request(request, didProvideInputStream: stream) }
540
    }
541
 
542
    public func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {
543
        performEvent { $0.request(request, didFinishDownloadingUsing: task, with: result) }
544
    }
545
 
546
    public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
547
        performEvent { $0.request(request, didCreateDestinationURL: url) }
548
    }
549
 
550
    public func request(_ request: DownloadRequest,
551
                        didValidateRequest urlRequest: URLRequest?,
552
                        response: HTTPURLResponse,
553
                        fileURL: URL?,
554
                        withResult result: Request.ValidationResult) {
555
        performEvent { $0.request(request,
556
                                  didValidateRequest: urlRequest,
557
                                  response: response,
558
                                  fileURL: fileURL,
559
                                  withResult: result) }
560
    }
561
 
562
    public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {
563
        performEvent { $0.request(request, didParseResponse: response) }
564
    }
565
 
566
    public func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>) {
567
        performEvent { $0.request(request, didParseResponse: response) }
568
    }
569
}
570
 
571
/// `EventMonitor` that allows optional closures to be set to receive events.
572
open class ClosureEventMonitor: EventMonitor {
573
    /// Closure called on the `urlSession(_:didBecomeInvalidWithError:)` event.
574
    open var sessionDidBecomeInvalidWithError: ((URLSession, Error?) -> Void)?
575
 
576
    /// Closure called on the `urlSession(_:task:didReceive:completionHandler:)`.
577
    open var taskDidReceiveChallenge: ((URLSession, URLSessionTask, URLAuthenticationChallenge) -> Void)?
578
 
579
    /// Closure that receives `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` event.
580
    open var taskDidSendBodyData: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?
581
 
582
    /// Closure called on the `urlSession(_:task:needNewBodyStream:)` event.
583
    open var taskNeedNewBodyStream: ((URLSession, URLSessionTask) -> Void)?
584
 
585
    /// Closure called on the `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)` event.
586
    open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> Void)?
587
 
588
    /// Closure called on the `urlSession(_:task:didFinishCollecting:)` event.
589
    open var taskDidFinishCollectingMetrics: ((URLSession, URLSessionTask, URLSessionTaskMetrics) -> Void)?
590
 
591
    /// Closure called on the `urlSession(_:task:didCompleteWithError:)` event.
592
    open var taskDidComplete: ((URLSession, URLSessionTask, Error?) -> Void)?
593
 
594
    /// Closure called on the `urlSession(_:taskIsWaitingForConnectivity:)` event.
595
    open var taskIsWaitingForConnectivity: ((URLSession, URLSessionTask) -> Void)?
596
 
597
    /// Closure that receives the `urlSession(_:dataTask:didReceive:)` event.
598
    open var dataTaskDidReceiveData: ((URLSession, URLSessionDataTask, Data) -> Void)?
599
 
600
    /// Closure called on the `urlSession(_:dataTask:willCacheResponse:completionHandler:)` event.
601
    open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> Void)?
602
 
603
    /// Closure called on the `urlSession(_:downloadTask:didFinishDownloadingTo:)` event.
604
    open var downloadTaskDidFinishDownloadingToURL: ((URLSession, URLSessionDownloadTask, URL) -> Void)?
605
 
606
    /// Closure called on the `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)`
607
    /// event.
608
    open var downloadTaskDidWriteData: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?
609
 
610
    /// Closure called on the `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)` event.
611
    open var downloadTaskDidResumeAtOffset: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?
612
 
613
    // MARK: - Request Events
614
 
615
    /// Closure called on the `request(_:didCreateInitialURLRequest:)` event.
616
    open var requestDidCreateInitialURLRequest: ((Request, URLRequest) -> Void)?
617
 
618
    /// Closure called on the `request(_:didFailToCreateURLRequestWithError:)` event.
619
    open var requestDidFailToCreateURLRequestWithError: ((Request, AFError) -> Void)?
620
 
621
    /// Closure called on the `request(_:didAdaptInitialRequest:to:)` event.
622
    open var requestDidAdaptInitialRequestToAdaptedRequest: ((Request, URLRequest, URLRequest) -> Void)?
623
 
624
    /// Closure called on the `request(_:didFailToAdaptURLRequest:withError:)` event.
625
    open var requestDidFailToAdaptURLRequestWithError: ((Request, URLRequest, AFError) -> Void)?
626
 
627
    /// Closure called on the `request(_:didCreateURLRequest:)` event.
628
    open var requestDidCreateURLRequest: ((Request, URLRequest) -> Void)?
629
 
630
    /// Closure called on the `request(_:didCreateTask:)` event.
631
    open var requestDidCreateTask: ((Request, URLSessionTask) -> Void)?
632
 
633
    /// Closure called on the `request(_:didGatherMetrics:)` event.
634
    open var requestDidGatherMetrics: ((Request, URLSessionTaskMetrics) -> Void)?
635
 
636
    /// Closure called on the `request(_:didFailTask:earlyWithError:)` event.
637
    open var requestDidFailTaskEarlyWithError: ((Request, URLSessionTask, AFError) -> Void)?
638
 
639
    /// Closure called on the `request(_:didCompleteTask:with:)` event.
640
    open var requestDidCompleteTaskWithError: ((Request, URLSessionTask, AFError?) -> Void)?
641
 
642
    /// Closure called on the `requestIsRetrying(_:)` event.
643
    open var requestIsRetrying: ((Request) -> Void)?
644
 
645
    /// Closure called on the `requestDidFinish(_:)` event.
646
    open var requestDidFinish: ((Request) -> Void)?
647
 
648
    /// Closure called on the `requestDidResume(_:)` event.
649
    open var requestDidResume: ((Request) -> Void)?
650
 
651
    /// Closure called on the `request(_:didResumeTask:)` event.
652
    open var requestDidResumeTask: ((Request, URLSessionTask) -> Void)?
653
 
654
    /// Closure called on the `requestDidSuspend(_:)` event.
655
    open var requestDidSuspend: ((Request) -> Void)?
656
 
657
    /// Closure called on the `request(_:didSuspendTask:)` event.
658
    open var requestDidSuspendTask: ((Request, URLSessionTask) -> Void)?
659
 
660
    /// Closure called on the `requestDidCancel(_:)` event.
661
    open var requestDidCancel: ((Request) -> Void)?
662
 
663
    /// Closure called on the `request(_:didCancelTask:)` event.
664
    open var requestDidCancelTask: ((Request, URLSessionTask) -> Void)?
665
 
666
    /// Closure called on the `request(_:didValidateRequest:response:data:withResult:)` event.
667
    open var requestDidValidateRequestResponseDataWithResult: ((DataRequest, URLRequest?, HTTPURLResponse, Data?, Request.ValidationResult) -> Void)?
668
 
669
    /// Closure called on the `request(_:didParseResponse:)` event.
670
    open var requestDidParseResponse: ((DataRequest, DataResponse<Data?, AFError>) -> Void)?
671
 
672
    /// Closure called on the `request(_:didValidateRequest:response:withResult:)` event.
673
    open var requestDidValidateRequestResponseWithResult: ((DataStreamRequest, URLRequest?, HTTPURLResponse, Request.ValidationResult) -> Void)?
674
 
675
    /// Closure called on the `request(_:didCreateUploadable:)` event.
676
    open var requestDidCreateUploadable: ((UploadRequest, UploadRequest.Uploadable) -> Void)?
677
 
678
    /// Closure called on the `request(_:didFailToCreateUploadableWithError:)` event.
679
    open var requestDidFailToCreateUploadableWithError: ((UploadRequest, AFError) -> Void)?
680
 
681
    /// Closure called on the `request(_:didProvideInputStream:)` event.
682
    open var requestDidProvideInputStream: ((UploadRequest, InputStream) -> Void)?
683
 
684
    /// Closure called on the `request(_:didFinishDownloadingUsing:with:)` event.
685
    open var requestDidFinishDownloadingUsingTaskWithResult: ((DownloadRequest, URLSessionTask, Result<URL, AFError>) -> Void)?
686
 
687
    /// Closure called on the `request(_:didCreateDestinationURL:)` event.
688
    open var requestDidCreateDestinationURL: ((DownloadRequest, URL) -> Void)?
689
 
690
    /// Closure called on the `request(_:didValidateRequest:response:temporaryURL:destinationURL:withResult:)` event.
691
    open var requestDidValidateRequestResponseFileURLWithResult: ((DownloadRequest, URLRequest?, HTTPURLResponse, URL?, Request.ValidationResult) -> Void)?
692
 
693
    /// Closure called on the `request(_:didParseResponse:)` event.
694
    open var requestDidParseDownloadResponse: ((DownloadRequest, DownloadResponse<URL?, AFError>) -> Void)?
695
 
696
    public let queue: DispatchQueue
697
 
698
    /// Creates an instance using the provided queue.
699
    ///
700
    /// - Parameter queue: `DispatchQueue` on which events will fired. `.main` by default.
701
    public init(queue: DispatchQueue = .main) {
702
        self.queue = queue
703
    }
704
 
705
    open func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?) {
706
        sessionDidBecomeInvalidWithError?(session, error)
707
    }
708
 
709
    open func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge) {
710
        taskDidReceiveChallenge?(session, task, challenge)
711
    }
712
 
713
    open func urlSession(_ session: URLSession,
714
                         task: URLSessionTask,
715
                         didSendBodyData bytesSent: Int64,
716
                         totalBytesSent: Int64,
717
                         totalBytesExpectedToSend: Int64) {
718
        taskDidSendBodyData?(session, task, bytesSent, totalBytesSent, totalBytesExpectedToSend)
719
    }
720
 
721
    open func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
722
        taskNeedNewBodyStream?(session, task)
723
    }
724
 
725
    open func urlSession(_ session: URLSession,
726
                         task: URLSessionTask,
727
                         willPerformHTTPRedirection response: HTTPURLResponse,
728
                         newRequest request: URLRequest) {
729
        taskWillPerformHTTPRedirection?(session, task, response, request)
730
    }
731
 
732
    open func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
733
        taskDidFinishCollectingMetrics?(session, task, metrics)
734
    }
735
 
736
    open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
737
        taskDidComplete?(session, task, error)
738
    }
739
 
740
    open func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
741
        taskIsWaitingForConnectivity?(session, task)
742
    }
743
 
744
    open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
745
        dataTaskDidReceiveData?(session, dataTask, data)
746
    }
747
 
748
    open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse) {
749
        dataTaskWillCacheResponse?(session, dataTask, proposedResponse)
750
    }
751
 
752
    open func urlSession(_ session: URLSession,
753
                         downloadTask: URLSessionDownloadTask,
754
                         didResumeAtOffset fileOffset: Int64,
755
                         expectedTotalBytes: Int64) {
756
        downloadTaskDidResumeAtOffset?(session, downloadTask, fileOffset, expectedTotalBytes)
757
    }
758
 
759
    open func urlSession(_ session: URLSession,
760
                         downloadTask: URLSessionDownloadTask,
761
                         didWriteData bytesWritten: Int64,
762
                         totalBytesWritten: Int64,
763
                         totalBytesExpectedToWrite: Int64) {
764
        downloadTaskDidWriteData?(session, downloadTask, bytesWritten, totalBytesWritten, totalBytesExpectedToWrite)
765
    }
766
 
767
    open func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
768
        downloadTaskDidFinishDownloadingToURL?(session, downloadTask, location)
769
    }
770
 
771
    // MARK: Request Events
772
 
773
    open func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {
774
        requestDidCreateInitialURLRequest?(request, urlRequest)
775
    }
776
 
777
    open func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {
778
        requestDidFailToCreateURLRequestWithError?(request, error)
779
    }
780
 
781
    open func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
782
        requestDidAdaptInitialRequestToAdaptedRequest?(request, initialRequest, adaptedRequest)
783
    }
784
 
785
    open func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError) {
786
        requestDidFailToAdaptURLRequestWithError?(request, initialRequest, error)
787
    }
788
 
789
    open func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
790
        requestDidCreateURLRequest?(request, urlRequest)
791
    }
792
 
793
    open func request(_ request: Request, didCreateTask task: URLSessionTask) {
794
        requestDidCreateTask?(request, task)
795
    }
796
 
797
    open func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
798
        requestDidGatherMetrics?(request, metrics)
799
    }
800
 
801
    open func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {
802
        requestDidFailTaskEarlyWithError?(request, task, error)
803
    }
804
 
805
    open func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {
806
        requestDidCompleteTaskWithError?(request, task, error)
807
    }
808
 
809
    open func requestIsRetrying(_ request: Request) {
810
        requestIsRetrying?(request)
811
    }
812
 
813
    open func requestDidFinish(_ request: Request) {
814
        requestDidFinish?(request)
815
    }
816
 
817
    open func requestDidResume(_ request: Request) {
818
        requestDidResume?(request)
819
    }
820
 
821
    public func request(_ request: Request, didResumeTask task: URLSessionTask) {
822
        requestDidResumeTask?(request, task)
823
    }
824
 
825
    open func requestDidSuspend(_ request: Request) {
826
        requestDidSuspend?(request)
827
    }
828
 
829
    public func request(_ request: Request, didSuspendTask task: URLSessionTask) {
830
        requestDidSuspendTask?(request, task)
831
    }
832
 
833
    open func requestDidCancel(_ request: Request) {
834
        requestDidCancel?(request)
835
    }
836
 
837
    public func request(_ request: Request, didCancelTask task: URLSessionTask) {
838
        requestDidCancelTask?(request, task)
839
    }
840
 
841
    open func request(_ request: DataRequest,
842
                      didValidateRequest urlRequest: URLRequest?,
843
                      response: HTTPURLResponse,
844
                      data: Data?,
845
                      withResult result: Request.ValidationResult) {
846
        requestDidValidateRequestResponseDataWithResult?(request, urlRequest, response, data, result)
847
    }
848
 
849
    open func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {
850
        requestDidParseResponse?(request, response)
851
    }
852
 
853
    public func request(_ request: DataStreamRequest, didValidateRequest urlRequest: URLRequest?, response: HTTPURLResponse, withResult result: Request.ValidationResult) {
854
        requestDidValidateRequestResponseWithResult?(request, urlRequest, response, result)
855
    }
856
 
857
    open func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
858
        requestDidCreateUploadable?(request, uploadable)
859
    }
860
 
861
    open func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {
862
        requestDidFailToCreateUploadableWithError?(request, error)
863
    }
864
 
865
    open func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
866
        requestDidProvideInputStream?(request, stream)
867
    }
868
 
869
    open func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {
870
        requestDidFinishDownloadingUsingTaskWithResult?(request, task, result)
871
    }
872
 
873
    open func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
874
        requestDidCreateDestinationURL?(request, url)
875
    }
876
 
877
    open func request(_ request: DownloadRequest,
878
                      didValidateRequest urlRequest: URLRequest?,
879
                      response: HTTPURLResponse,
880
                      fileURL: URL?,
881
                      withResult result: Request.ValidationResult) {
882
        requestDidValidateRequestResponseFileURLWithResult?(request,
883
                                                            urlRequest,
884
                                                            response,
885
                                                            fileURL,
886
                                                            result)
887
    }
888
 
889
    open func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {
890
        requestDidParseDownloadResponse?(request, response)
891
    }
892
}