EventMonitor
public protocol EventMonitor
Protocol outlining the lifetime events inside Alamofire. It includes both events received from the various
URLSession
delegate protocols as well as various events from the lifetime of Request
and its subclasses.
-
queue
Default implementationThe
DispatchQueue
onto which Alamofire’s rootCompositeEventMonitor
will dispatch events. Defaults to.main
.Default Implementation
The default queue on which
CompositeEventMonitor
s will call theEventMonitor
methods. Defaults to.main
.Declaration
Swift
var queue: DispatchQueue { get }
-
urlSession(_:didBecomeInvalidWithError:)
Default implementationEvent called during
URLSessionDelegate
‘surlSession(_:didBecomeInvalidWithError:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?)
-
urlSession(_:task:didReceive:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:task:didReceive:completionHandler:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge)
-
urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, task: URLSessionTask, didSendBodyData bytesSent: Int64, totalBytesSent: Int64, totalBytesExpectedToSend: Int64)
-
urlSession(_:taskNeedsNewBodyStream:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:task:needNewBodyStream:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask)
-
urlSession(_:task:willPerformHTTPRedirection:newRequest:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, task: URLSessionTask, willPerformHTTPRedirection response: HTTPURLResponse, newRequest request: URLRequest)
-
urlSession(_:task:didFinishCollecting:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:task:didFinishCollecting:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics)
-
urlSession(_:task:didCompleteWithError:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:task:didCompleteWithError:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
-
urlSession(_:taskIsWaitingForConnectivity:)
Default implementationEvent called during
URLSessionTaskDelegate
‘surlSession(_:taskIsWaitingForConnectivity:)
method.Default Implementation
Declaration
Swift
@available(OSX 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *) func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask)
-
urlSession(_:dataTask:didReceive:)
Default implementationEvent called during
URLSessionDataDelegate
‘surlSession(_:dataTask:didReceive:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)
-
urlSession(_:dataTask:willCacheResponse:)
Default implementationEvent called during
URLSessionDataDelegate
‘surlSession(_:dataTask:willCacheResponse:completionHandler:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse)
-
urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)
Default implementationEvent called during
URLSessionDownloadDelegate
‘surlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didResumeAtOffset fileOffset: Int64, expectedTotalBytes: Int64)
-
urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)
Default implementationEvent called during
URLSessionDownloadDelegate
‘surlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)
-
urlSession(_:downloadTask:didFinishDownloadingTo:)
Default implementationEvent called during
URLSessionDownloadDelegate
‘surlSession(_:downloadTask:didFinishDownloadingTo:)
method.Default Implementation
Declaration
Swift
func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)
-
request(_:didCreateURLRequest:)
Default implementation -
request(_:didFailToCreateURLRequestWithError:)
Default implementationEvent called when the attempt to create a
URLRequest
from aRequest
‘s originalURLRequestConvertible
value fails.Default Implementation
Declaration
Swift
func request(_ request: Request, didFailToCreateURLRequestWithError error: Error)
-
request(_:didAdaptInitialRequest:to:)
Default implementationEvent called when a
RequestAdapter
adapts theRequest
‘s initialURLRequest
.Default Implementation
Declaration
Swift
func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest)
-
request(_:didFailToAdaptURLRequest:withError:)
Default implementationEvent called when a
RequestAdapter
fails to adapt theRequest
‘s initialURLRequest
.Default Implementation
Declaration
Swift
func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: Error)
-
request(_:didCreateTask:)
Default implementation -
request(_:didGatherMetrics:)
Default implementation -
request(_:didFailTask:earlyWithError:)
Default implementation -
request(_:didCompleteTask:with:)
Default implementation -
requestIsRetrying(_:)
Default implementation -
requestDidFinish(_:)
Default implementation -
requestDidResume(_:)
Default implementation -
request(_:didResumeTask:)
Default implementation -
requestDidSuspend(_:)
Default implementation -
request(_:didSuspendTask:)
Default implementation -
requestDidCancel(_:)
Default implementation -
request(_:didCancelTask:)
Default implementation
-
request(_:didValidateRequest:response:data:withResult:)
Default implementationEvent called when a
DataRequest
calls aValidation
.Default Implementation
Declaration
Swift
func request(_ request: DataRequest, didValidateRequest urlRequest: URLRequest?, response: HTTPURLResponse, data: Data?, withResult result: Request.ValidationResult)
-
request(_:didParseResponse:)
Default implementationEvent called when a
DataRequest
creates aDataResponse<Data?>
value without calling aResponseSerializer
.Default Implementation
Undocumented
Undocumented
Undocumented
Undocumented
Declaration
Swift
func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?>)
-
Event called when a
DataRequest
calls aResponseSerializer
and creates a genericDataResponse<Value>
.Declaration
Swift
func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value>)
-
request(_:didCreateUploadable:)
Default implementationEvent called when an
UploadRequest
creates itsUploadable
value, indicating the type of upload it represents.Default Implementation
Declaration
Swift
func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable)
-
request(_:didFailToCreateUploadableWithError:)
Default implementationEvent called when an
UploadRequest
failes to create itsUploadable
value due to an error.Default Implementation
Declaration
Swift
func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: Error)
-
request(_:didProvideInputStream:)
Default implementationEvent called when an
UploadRequest
provides theInputStream
from itsUploadable
value. This only occurs if theInputStream
does not wrap aData
value or fileURL
.Default Implementation
Declaration
Swift
func request(_ request: UploadRequest, didProvideInputStream stream: InputStream)
-
request(_:didFinishDownloadingUsing:with:)
Default implementationEvent called when a
DownloadRequest
‘sURLSessionDownloadTask
finishes and the temporary file has been moved.Default Implementation
Declaration
Swift
func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: AFResult<URL>)
-
request(_:didCreateDestinationURL:)
Default implementationEvent called when a
DownloadRequest
‘sDestination
closure is called and creates the destination URL the downloaded file will be moved to.Default Implementation
Declaration
Swift
func request(_ request: DownloadRequest, didCreateDestinationURL url: URL)
-
request(_:didValidateRequest:response:fileURL:withResult:)
Default implementationEvent called when a
DownloadRequest
calls aValidation
.Default Implementation
Declaration
Swift
func request(_ request: DownloadRequest, didValidateRequest urlRequest: URLRequest?, response: HTTPURLResponse, fileURL: URL?, withResult result: Request.ValidationResult)
-
Event called when a
DownloadRequest
creates aDownloadResponse<URL?>
without calling aResponseSerializer
.Declaration
Swift
func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?>)
-
Event called when a
DownloadRequest
calls aDownloadResponseSerializer
and creates a genericDownloadResponse<Value>
Declaration
Swift
func request<Value>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value>)