Back to Alamofire

ClosureEventMonitor

docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/ClosureEventMonitor.html

5.12.021.1 KB
Original Source

ClosureEventMonitor

open class ClosureEventMonitor : EventMonitor, @unchecked Sendable

EventMonitor that allows optional closures to be set to receive events.

`

                sessionDidBecomeInvalidWithError
                `

Closure called on the urlSession(_:didBecomeInvalidWithError:) event.

Declaration

Swift

open var sessionDidBecomeInvalidWithError: ((URLSession, (any Error)?) -> Void)?

`

                taskDidReceiveChallenge
                `

Closure called on the urlSession(_:task:didReceive:completionHandler:).

Declaration

Swift

open var taskDidReceiveChallenge: ((URLSession, URLSessionTask, URLAuthenticationChallenge) -> Void)?

`

                taskDidSendBodyData
                `

Closure that receives urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:) event.

Declaration

Swift

open var taskDidSendBodyData: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?

`

                taskNeedNewBodyStream
                `

Closure called on the urlSession(_:task:needNewBodyStream:) event.

Declaration

Swift

open var taskNeedNewBodyStream: ((URLSession, URLSessionTask) -> Void)?

`

                taskWillPerformHTTPRedirection
                `

Closure called on the urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:) event.

Declaration

Swift

open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> Void)?

`

                taskDidFinishCollectingMetrics
                `

Closure called on the urlSession(_:task:didFinishCollecting:) event.

Declaration

Swift

open var taskDidFinishCollectingMetrics: ((URLSession, URLSessionTask, URLSessionTaskMetrics) -> Void)?

`

                taskDidComplete
                `

Closure called on the urlSession(_:task:didCompleteWithError:) event.

Declaration

Swift

open var taskDidComplete: ((URLSession, URLSessionTask, (any Error)?) -> Void)?

`

                taskIsWaitingForConnectivity
                `

Closure called on the urlSession(_:taskIsWaitingForConnectivity:) event.

Declaration

Swift

open var taskIsWaitingForConnectivity: ((URLSession, URLSessionTask) -> Void)?

`

                dataTaskDidReceiveResponse
                `

Closure called on the urlSession(_:dataTask:didReceive:completionHandler:) event.

Declaration

Swift

open var dataTaskDidReceiveResponse: ((URLSession, URLSessionDataTask, URLResponse) -> Void)?

`

                dataTaskDidReceiveData
                `

Closure that receives the urlSession(_:dataTask:didReceive:) event.

Declaration

Swift

open var dataTaskDidReceiveData: ((URLSession, URLSessionDataTask, Data) -> Void)?

`

                dataTaskWillCacheResponse
                `

Closure called on the urlSession(_:dataTask:willCacheResponse:completionHandler:) event.

Declaration

Swift

open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> Void)?

`

                downloadTaskDidFinishDownloadingToURL
                `

Closure called on the urlSession(_:downloadTask:didFinishDownloadingTo:) event.

Declaration

Swift

open var downloadTaskDidFinishDownloadingToURL: ((URLSession, URLSessionDownloadTask, URL) -> Void)?

`

                downloadTaskDidWriteData
                `

Closure called on the urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:) event.

Declaration

Swift

open var downloadTaskDidWriteData: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?

`

                downloadTaskDidResumeAtOffset
                `

Closure called on the urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:) event.

Declaration

Swift

open var downloadTaskDidResumeAtOffset: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?

Request Events

`

                requestDidCreateInitialURLRequest
                `

Closure called on the request(_:didCreateInitialURLRequest:) event.

Declaration

Swift

open var requestDidCreateInitialURLRequest: ((Request, URLRequest) -> Void)?

`

                requestDidFailToCreateURLRequestWithError
                `

Closure called on the request(_:didFailToCreateURLRequestWithError:) event.

Declaration

Swift

open var requestDidFailToCreateURLRequestWithError: ((Request, AFError) -> Void)?

`

                requestDidAdaptInitialRequestToAdaptedRequest
                `

Closure called on the request(_:didAdaptInitialRequest:to:) event.

Declaration

Swift

open var requestDidAdaptInitialRequestToAdaptedRequest: ((Request, URLRequest, URLRequest) -> Void)?

`

                requestDidFailToAdaptURLRequestWithError
                `

Closure called on the request(_:didFailToAdaptURLRequest:withError:) event.

Declaration

Swift

open var requestDidFailToAdaptURLRequestWithError: ((Request, URLRequest, AFError) -> Void)?

`

                requestDidCreateURLRequest
                `

Closure called on the request(_:didCreateURLRequest:) event.

Declaration

Swift

open var requestDidCreateURLRequest: ((Request, URLRequest) -> Void)?

`

                requestDidCreateTask
                `

Closure called on the request(_:didCreateTask:) event.

Declaration

Swift

open var requestDidCreateTask: ((Request, URLSessionTask) -> Void)?

`

                requestDidGatherMetrics
                `

Closure called on the request(_:didGatherMetrics:) event.

Declaration

Swift

open var requestDidGatherMetrics: ((Request, URLSessionTaskMetrics) -> Void)?

`

                requestDidFailTaskEarlyWithError
                `

Closure called on the request(_:didFailTask:earlyWithError:) event.

Declaration

Swift

open var requestDidFailTaskEarlyWithError: ((Request, URLSessionTask, AFError) -> Void)?

`

                requestDidCompleteTaskWithError
                `

Closure called on the request(_:didCompleteTask:with:) event.

Declaration

Swift

open var requestDidCompleteTaskWithError: ((Request, URLSessionTask, AFError?) -> Void)?

`

                requestIsRetrying
                `

Closure called on the requestIsRetrying(_:) event.

Declaration

Swift

open var requestIsRetrying: ((Request) -> Void)?

`

                requestDidFinish
                `

Closure called on the requestDidFinish(_:) event.

Declaration

Swift

open var requestDidFinish: ((Request) -> Void)?

`

                requestDidResume
                `

Closure called on the requestDidResume(_:) event.

Declaration

Swift

open var requestDidResume: ((Request) -> Void)?

`

                requestDidResumeTask
                `

Closure called on the request(_:didResumeTask:) event.

Declaration

Swift

open var requestDidResumeTask: ((Request, URLSessionTask) -> Void)?

`

                requestDidSuspend
                `

Closure called on the requestDidSuspend(_:) event.

Declaration

Swift

open var requestDidSuspend: ((Request) -> Void)?

`

                requestDidSuspendTask
                `

Closure called on the request(_:didSuspendTask:) event.

Declaration

Swift

open var requestDidSuspendTask: ((Request, URLSessionTask) -> Void)?

`

                requestDidCancel
                `

Closure called on the requestDidCancel(_:) event.

Declaration

Swift

open var requestDidCancel: ((Request) -> Void)?

`

                requestDidCancelTask
                `

Closure called on the request(_:didCancelTask:) event.

Declaration

Swift

open var requestDidCancelTask: ((Request, URLSessionTask) -> Void)?

`

                requestDidValidateRequestResponseDataWithResult
                `

Closure called on the request(_:didValidateRequest:response:data:withResult:) event.

Declaration

Swift

open var requestDidValidateRequestResponseDataWithResult: ((DataRequest, URLRequest?, HTTPURLResponse, Data?, Request.ValidationResult) -> Void)?

`

                requestDidParseResponse
                `

Closure called on the request(_:didParseResponse:) event.

Declaration

Swift

open var requestDidParseResponse: ((DataRequest, DataResponse<Data?, AFError>) -> Void)?

`

                requestDidValidateRequestResponseWithResult
                `

Closure called on the request(_:didValidateRequest:response:withResult:) event.

Declaration

Swift

open var requestDidValidateRequestResponseWithResult: ((DataStreamRequest, URLRequest?, HTTPURLResponse, Request.ValidationResult) -> Void)?

`

                requestDidCreateUploadable
                `

Closure called on the request(_:didCreateUploadable:) event.

Declaration

Swift

open var requestDidCreateUploadable: ((UploadRequest, UploadRequest.Uploadable) -> Void)?

`

                requestDidFailToCreateUploadableWithError
                `

Closure called on the request(_:didFailToCreateUploadableWithError:) event.

Declaration

Swift

open var requestDidFailToCreateUploadableWithError: ((UploadRequest, AFError) -> Void)?

`

                requestDidProvideInputStream
                `

Closure called on the request(_:didProvideInputStream:) event.

Declaration

Swift

open var requestDidProvideInputStream: ((UploadRequest, InputStream) -> Void)?

`

                requestDidFinishDownloadingUsingTaskWithResult
                `

Closure called on the request(_:didFinishDownloadingUsing:with:) event.

Declaration

Swift

open var requestDidFinishDownloadingUsingTaskWithResult: ((DownloadRequest, URLSessionTask, Result<URL, AFError>) -> Void)?

`

                requestDidCreateDestinationURL
                `

Closure called on the request(_:didCreateDestinationURL:) event.

Declaration

Swift

open var requestDidCreateDestinationURL: ((DownloadRequest, URL) -> Void)?

`

                requestDidValidateRequestResponseFileURLWithResult
                `

Closure called on the request(_:didValidateRequest:response:temporaryURL:destinationURL:withResult:) event.

Declaration

Swift

open var requestDidValidateRequestResponseFileURLWithResult: ((DownloadRequest, URLRequest?, HTTPURLResponse, URL?, Request.ValidationResult) -> Void)?

`

                requestDidParseDownloadResponse
                `

Closure called on the request(_:didParseResponse:) event.

Declaration

Swift

open var requestDidParseDownloadResponse: ((DownloadRequest, DownloadResponse<URL?, AFError>) -> Void)?

`

                queue
                `

Declaration

Swift

public let queue: DispatchQueue

`

                init(queue:)
                `

Creates an instance using the provided queue.

Declaration

Swift

public init(queue: DispatchQueue = .main)

Parameters

| queue |

DispatchQueue on which events will fired. .main by default.

|

`

                urlSession(_:didBecomeInvalidWithError:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, didBecomeInvalidWithError error: (any Error)?)

`

                urlSession(_:task:didReceive:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge)

`

                urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession,
                     task: URLSessionTask,
                     didSendBodyData bytesSent: Int64,
                     totalBytesSent: Int64,
                     totalBytesExpectedToSend: Int64)

`

                urlSession(_:taskNeedsNewBodyStream:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask)

`

                urlSession(_:task:willPerformHTTPRedirection:newRequest:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession,
                     task: URLSessionTask,
                     willPerformHTTPRedirection response: HTTPURLResponse,
                     newRequest request: URLRequest)

`

                urlSession(_:task:didFinishCollecting:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics)

`

                urlSession(_:task:didCompleteWithError:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: (any Error)?)

`

                urlSession(_:taskIsWaitingForConnectivity:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask)

`

                urlSession(_:dataTask:didReceive:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse)

`

                urlSession(_:dataTask:didReceive:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)

`

                urlSession(_:dataTask:willCacheResponse:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse)

`

                urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession,
                     downloadTask: URLSessionDownloadTask,
                     didResumeAtOffset fileOffset: Int64,
                     expectedTotalBytes: Int64)

`

                urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession,
                     downloadTask: URLSessionDownloadTask,
                     didWriteData bytesWritten: Int64,
                     totalBytesWritten: Int64,
                     totalBytesExpectedToWrite: Int64)

`

                urlSession(_:downloadTask:didFinishDownloadingTo:)
                `

Declaration

Swift

open func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)

`

                request(_:didCreateInitialURLRequest:)
                `

Declaration

Swift

open func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest)

`

                request(_:didFailToCreateURLRequestWithError:)
                `

Declaration

Swift

open func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError)

`

                request(_:didAdaptInitialRequest:to:)
                `

Declaration

Swift

open func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest)

`

                request(_:didFailToAdaptURLRequest:withError:)
                `

Declaration

Swift

open func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError)

`

                request(_:didCreateURLRequest:)
                `

Declaration

Swift

open func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest)

`

                request(_:didCreateTask:)
                `

Declaration

Swift

open func request(_ request: Request, didCreateTask task: URLSessionTask)

`

                request(_:didGatherMetrics:)
                `

Declaration

Swift

open func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics)

`

                request(_:didFailTask:earlyWithError:)
                `

Declaration

Swift

open func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError)

`

                request(_:didCompleteTask:with:)
                `

Declaration

Swift

open func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?)

`

                requestIsRetrying(_:)
                `

Declaration

Swift

open func requestIsRetrying(_ request: Request)

`

                requestDidFinish(_:)
                `

Declaration

Swift

open func requestDidFinish(_ request: Request)

`

                requestDidResume(_:)
                `

Declaration

Swift

open func requestDidResume(_ request: Request)

`

                request(_:didResumeTask:)
                `

Declaration

Swift

public func request(_ request: Request, didResumeTask task: URLSessionTask)

`

                requestDidSuspend(_:)
                `

Declaration

Swift

open func requestDidSuspend(_ request: Request)

`

                request(_:didSuspendTask:)
                `

Declaration

Swift

public func request(_ request: Request, didSuspendTask task: URLSessionTask)

`

                requestDidCancel(_:)
                `

Declaration

Swift

open func requestDidCancel(_ request: Request)

`

                request(_:didCancelTask:)
                `

Declaration

Swift

public func request(_ request: Request, didCancelTask task: URLSessionTask)

`

                request(_:didValidateRequest:response:data:withResult:)
                `

Declaration

Swift

open func request(_ request: DataRequest,
                  didValidateRequest urlRequest: URLRequest?,
                  response: HTTPURLResponse,
                  data: Data?,
                  withResult result: Request.ValidationResult)

`

                request(_:didParseResponse:)
                `

Declaration

Swift

open func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>)

`

                request(_:didValidateRequest:response:withResult:)
                `

Declaration

Swift

public func request(_ request: DataStreamRequest, didValidateRequest urlRequest: URLRequest?, response: HTTPURLResponse, withResult result: Request.ValidationResult)

`

                request(_:didCreateUploadable:)
                `

Declaration

Swift

open func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable)

`

                request(_:didFailToCreateUploadableWithError:)
                `

Declaration

Swift

open func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError)

`

                request(_:didProvideInputStream:)
                `

Declaration

Swift

open func request(_ request: UploadRequest, didProvideInputStream stream: InputStream)

`

                request(_:didFinishDownloadingUsing:with:)
                `

Declaration

Swift

open func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>)

`

                request(_:didCreateDestinationURL:)
                `

Declaration

Swift

open func request(_ request: DownloadRequest, didCreateDestinationURL url: URL)

`

                request(_:didValidateRequest:response:fileURL:withResult:)
                `

Declaration

Swift

open func request(_ request: DownloadRequest,
                  didValidateRequest urlRequest: URLRequest?,
                  response: HTTPURLResponse,
                  fileURL: URL?,
                  withResult result: Request.ValidationResult)

`

                request(_:didParseResponse:)
                `

Declaration

Swift

open func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>)