12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280 |
- //
- // Session.swift
- //
- // Copyright (c) 2014-2018 Alamofire Software Foundation (http://alamofire.org/)
- //
- // Permission is hereby granted, free of charge, to any person obtaining a copy
- // of this software and associated documentation files (the "Software"), to deal
- // in the Software without restriction, including without limitation the rights
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- // copies of the Software, and to permit persons to whom the Software is
- // furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in
- // all copies or substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- // THE SOFTWARE.
- //
- import Foundation
- /// `Session` creates and manages Alamofire's `Request` types during their lifetimes. It also provides common
- /// functionality for all `Request`s, including queuing, interception, trust management, redirect handling, and response
- /// cache handling.
- open class Session {
- /// Shared singleton instance used by all `AF.request` APIs. Cannot be modified.
- public static let `default` = Session()
- /// Underlying `URLSession` used to create `URLSessionTasks` for this instance, and for which this instance's
- /// `delegate` handles `URLSessionDelegate` callbacks.
- ///
- /// - Note: This instance should **NOT** be used to interact with the underlying `URLSessionTask`s. Doing so will
- /// break internal Alamofire logic that tracks those tasks.
- ///
- public let session: URLSession
- /// Instance's `SessionDelegate`, which handles the `URLSessionDelegate` methods and `Request` interaction.
- public let delegate: SessionDelegate
- /// Root `DispatchQueue` for all internal callbacks and state update. **MUST** be a serial queue.
- public let rootQueue: DispatchQueue
- /// Value determining whether this instance automatically calls `resume()` on all created `Request`s.
- public let startRequestsImmediately: Bool
- /// `DispatchQueue` on which `URLRequest`s are created asynchronously. By default this queue uses `rootQueue` as its
- /// `target`, but a separate queue can be used if request creation is determined to be a bottleneck. Always profile
- /// and test before introducing an additional queue.
- public let requestQueue: DispatchQueue
- /// `DispatchQueue` passed to all `Request`s on which they perform their response serialization. By default this
- /// queue uses `rootQueue` as its `target` but a separate queue can be used if response serialization is determined
- /// to be a bottleneck. Always profile and test before introducing an additional queue.
- public let serializationQueue: DispatchQueue
- /// `RequestInterceptor` used for all `Request` created by the instance. `RequestInterceptor`s can also be set on a
- /// per-`Request` basis, in which case the `Request`'s interceptor takes precedence over this value.
- public let interceptor: RequestInterceptor?
- /// `ServerTrustManager` instance used to evaluate all trust challenges and provide certificate and key pinning.
- public let serverTrustManager: ServerTrustManager?
- /// `RedirectHandler` instance used to provide customization for request redirection.
- public let redirectHandler: RedirectHandler?
- /// `CachedResponseHandler` instance used to provide customization of cached response handling.
- public let cachedResponseHandler: CachedResponseHandler?
- /// `CompositeEventMonitor` used to compose Alamofire's `defaultEventMonitors` and any passed `EventMonitor`s.
- public let eventMonitor: CompositeEventMonitor
- /// `EventMonitor`s included in all instances. `[AlamofireNotifications()]` by default.
- public let defaultEventMonitors: [EventMonitor] = [AlamofireNotifications()]
- /// Internal map between `Request`s and any `URLSessionTasks` that may be in flight for them.
- var requestTaskMap = RequestTaskMap()
- /// `Set` of currently active `Request`s.
- var activeRequests: Set<Request> = []
- /// Completion events awaiting `URLSessionTaskMetrics`.
- var waitingCompletions: [URLSessionTask: () -> Void] = [:]
- /// Creates a `Session` from a `URLSession` and other parameters.
- ///
- /// - Note: When passing a `URLSession`, you must create the `URLSession` with a specific `delegateQueue` value and
- /// pass the `delegateQueue`'s `underlyingQueue` as the `rootQueue` parameter of this initializer.
- ///
- /// - Parameters:
- /// - session: Underlying `URLSession` for this instance.
- /// - delegate: `SessionDelegate` that handles `session`'s delegate callbacks as well as `Request`
- /// interaction.
- /// - rootQueue: Root `DispatchQueue` for all internal callbacks and state updates. **MUST** be a
- /// serial queue.
- /// - startRequestsImmediately: Determines whether this instance will automatically start all `Request`s. `true`
- /// by default. If set to `false`, all `Request`s created must have `.resume()` called.
- /// on them for them to start.
- /// - requestQueue: `DispatchQueue` on which to perform `URLRequest` creation. By default this queue
- /// will use the `rootQueue` as its `target`. A separate queue can be used if it's
- /// determined request creation is a bottleneck, but that should only be done after
- /// careful testing and profiling. `nil` by default.
- /// - serializationQueue: `DispatchQueue` on which to perform all response serialization. By default this
- /// queue will use the `rootQueue` as its `target`. A separate queue can be used if
- /// it's determined response serialization is a bottleneck, but that should only be
- /// done after careful testing and profiling. `nil` by default.
- /// - interceptor: `RequestInterceptor` to be used for all `Request`s created by this instance. `nil`
- /// by default.
- /// - serverTrustManager: `ServerTrustManager` to be used for all trust evaluations by this instance. `nil`
- /// by default.
- /// - redirectHandler: `RedirectHandler` to be used by all `Request`s created by this instance. `nil` by
- /// default.
- /// - cachedResponseHandler: `CachedResponseHandler` to be used by all `Request`s created by this instance.
- /// `nil` by default.
- /// - eventMonitors: Additional `EventMonitor`s used by the instance. Alamofire always adds a
- /// `AlamofireNotifications` `EventMonitor` to the array passed here. `[]` by default.
- public init(session: URLSession,
- delegate: SessionDelegate,
- rootQueue: DispatchQueue,
- startRequestsImmediately: Bool = true,
- requestQueue: DispatchQueue? = nil,
- serializationQueue: DispatchQueue? = nil,
- interceptor: RequestInterceptor? = nil,
- serverTrustManager: ServerTrustManager? = nil,
- redirectHandler: RedirectHandler? = nil,
- cachedResponseHandler: CachedResponseHandler? = nil,
- eventMonitors: [EventMonitor] = [])
- {
- precondition(session.configuration.identifier == nil,
- "Alamofire does not support background URLSessionConfigurations.")
- precondition(session.delegateQueue.underlyingQueue === rootQueue,
- "Session(session:) initializer must be passed the DispatchQueue used as the delegateQueue's underlyingQueue as rootQueue.")
- self.session = session
- self.delegate = delegate
- self.rootQueue = rootQueue
- self.startRequestsImmediately = startRequestsImmediately
- self.requestQueue = requestQueue ?? DispatchQueue(label: "\(rootQueue.label).requestQueue", target: rootQueue)
- self.serializationQueue = serializationQueue ?? DispatchQueue(label: "\(rootQueue.label).serializationQueue", target: rootQueue)
- self.interceptor = interceptor
- self.serverTrustManager = serverTrustManager
- self.redirectHandler = redirectHandler
- self.cachedResponseHandler = cachedResponseHandler
- eventMonitor = CompositeEventMonitor(monitors: defaultEventMonitors + eventMonitors)
- delegate.eventMonitor = eventMonitor
- delegate.stateProvider = self
- }
- /// Creates a `Session` from a `URLSessionConfiguration`.
- ///
- /// - Note: This initializer lets Alamofire handle the creation of the underlying `URLSession` and its
- /// `delegateQueue`, and is the recommended initializer for most uses.
- ///
- /// - Parameters:
- /// - configuration: `URLSessionConfiguration` to be used to create the underlying `URLSession`. Changes
- /// to this value after being passed to this initializer will have no effect.
- /// `URLSessionConfiguration.af.default` by default.
- /// - delegate: `SessionDelegate` that handles `session`'s delegate callbacks as well as `Request`
- /// interaction. `SessionDelegate()` by default.
- /// - rootQueue: Root `DispatchQueue` for all internal callbacks and state updates. **MUST** be a
- /// serial queue. `DispatchQueue(label: "org.alamofire.session.rootQueue")` by default.
- /// - startRequestsImmediately: Determines whether this instance will automatically start all `Request`s. `true`
- /// by default. If set to `false`, all `Request`s created must have `.resume()` called.
- /// on them for them to start.
- /// - requestQueue: `DispatchQueue` on which to perform `URLRequest` creation. By default this queue
- /// will use the `rootQueue` as its `target`. A separate queue can be used if it's
- /// determined request creation is a bottleneck, but that should only be done after
- /// careful testing and profiling. `nil` by default.
- /// - serializationQueue: `DispatchQueue` on which to perform all response serialization. By default this
- /// queue will use the `rootQueue` as its `target`. A separate queue can be used if
- /// it's determined response serialization is a bottleneck, but that should only be
- /// done after careful testing and profiling. `nil` by default.
- /// - interceptor: `RequestInterceptor` to be used for all `Request`s created by this instance. `nil`
- /// by default.
- /// - serverTrustManager: `ServerTrustManager` to be used for all trust evaluations by this instance. `nil`
- /// by default.
- /// - redirectHandler: `RedirectHandler` to be used by all `Request`s created by this instance. `nil` by
- /// default.
- /// - cachedResponseHandler: `CachedResponseHandler` to be used by all `Request`s created by this instance.
- /// `nil` by default.
- /// - eventMonitors: Additional `EventMonitor`s used by the instance. Alamofire always adds a
- /// `AlamofireNotifications` `EventMonitor` to the array passed here. `[]` by default.
- public convenience init(configuration: URLSessionConfiguration = URLSessionConfiguration.af.default,
- delegate: SessionDelegate = SessionDelegate(),
- rootQueue: DispatchQueue = DispatchQueue(label: "org.alamofire.session.rootQueue"),
- startRequestsImmediately: Bool = true,
- requestQueue: DispatchQueue? = nil,
- serializationQueue: DispatchQueue? = nil,
- interceptor: RequestInterceptor? = nil,
- serverTrustManager: ServerTrustManager? = nil,
- redirectHandler: RedirectHandler? = nil,
- cachedResponseHandler: CachedResponseHandler? = nil,
- eventMonitors: [EventMonitor] = [])
- {
- precondition(configuration.identifier == nil, "Alamofire does not support background URLSessionConfigurations.")
- let delegateQueue = OperationQueue(maxConcurrentOperationCount: 1, underlyingQueue: rootQueue, name: "org.alamofire.session.sessionDelegateQueue")
- let session = URLSession(configuration: configuration, delegate: delegate, delegateQueue: delegateQueue)
- self.init(session: session,
- delegate: delegate,
- rootQueue: rootQueue,
- startRequestsImmediately: startRequestsImmediately,
- requestQueue: requestQueue,
- serializationQueue: serializationQueue,
- interceptor: interceptor,
- serverTrustManager: serverTrustManager,
- redirectHandler: redirectHandler,
- cachedResponseHandler: cachedResponseHandler,
- eventMonitors: eventMonitors)
- }
- deinit {
- finishRequestsForDeinit()
- session.invalidateAndCancel()
- }
- // MARK: - All Requests API
- /// Perform an action on all active `Request`s.
- ///
- /// - Note: The provided `action` closure is performed asynchronously, meaning that some `Request`s may complete and
- /// be unavailable by time it runs. Additionally, this action is performed on the instances's `rootQueue`,
- /// so care should be taken that actions are fast. Once the work on the `Request`s is complete, any
- /// additional work should be performed on another queue.
- ///
- /// - Parameters:
- /// - action: Closure to perform with all `Request`s.
- public func withAllRequests(perform action: @escaping (Set<Request>) -> Void) {
- rootQueue.async {
- action(self.activeRequests)
- }
- }
- /// Cancel all active `Request`s, optionally calling a completion handler when complete.
- ///
- /// - Note: This is an asynchronous operation and does not block the creation of future `Request`s. Cancelled
- /// `Request`s may not cancel immediately due internal work, and may not cancel at all if they are close to
- /// completion when cancelled.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the completion handler is run. `.main` by default.
- /// - completion: Closure to be called when all `Request`s have been cancelled.
- public func cancelAllRequests(completingOnQueue queue: DispatchQueue = .main, completion: (() -> Void)? = nil) {
- withAllRequests { requests in
- requests.forEach { $0.cancel() }
- queue.async {
- completion?()
- }
- }
- }
- // MARK: - DataRequest
- /// Closure which provides a `URLRequest` for mutation.
- public typealias RequestModifier = (inout URLRequest) throws -> Void
- struct RequestConvertible: URLRequestConvertible {
- let url: URLConvertible
- let method: HTTPMethod
- let parameters: Parameters?
- let encoding: ParameterEncoding
- let headers: HTTPHeaders?
- let requestModifier: RequestModifier?
- func asURLRequest() throws -> URLRequest {
- var request = try URLRequest(url: url, method: method, headers: headers)
- try requestModifier?(&request)
- return try encoding.encode(request, with: parameters)
- }
- }
- /// Creates a `DataRequest` from a `URLRequest` created using the passed components and a `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.get` by default.
- /// - parameters: `Parameters` (a.k.a. `[String: Any]`) value to be encoded into the `URLRequest`. `nil` by
- /// default.
- /// - encoding: `ParameterEncoding` to be used to encode the `parameters` value into the `URLRequest`.
- /// `URLEncoding.default` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the provided
- /// parameters. `nil` by default.
- ///
- /// - Returns: The created `DataRequest`.
- open func request(_ convertible: URLConvertible,
- method: HTTPMethod = .get,
- parameters: Parameters? = nil,
- encoding: ParameterEncoding = URLEncoding.default,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- requestModifier: RequestModifier? = nil) -> DataRequest
- {
- let convertible = RequestConvertible(url: convertible,
- method: method,
- parameters: parameters,
- encoding: encoding,
- headers: headers,
- requestModifier: requestModifier)
- return request(convertible, interceptor: interceptor)
- }
- struct RequestEncodableConvertible<Parameters: Encodable>: URLRequestConvertible {
- let url: URLConvertible
- let method: HTTPMethod
- let parameters: Parameters?
- let encoder: ParameterEncoder
- let headers: HTTPHeaders?
- let requestModifier: RequestModifier?
- func asURLRequest() throws -> URLRequest {
- var request = try URLRequest(url: url, method: method, headers: headers)
- try requestModifier?(&request)
- return try parameters.map { try encoder.encode($0, into: request) } ?? request
- }
- }
- /// Creates a `DataRequest` from a `URLRequest` created using the passed components, `Encodable` parameters, and a
- /// `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.get` by default.
- /// - parameters: `Encodable` value to be encoded into the `URLRequest`. `nil` by default.
- /// - encoder: `ParameterEncoder` to be used to encode the `parameters` value into the `URLRequest`.
- /// `URLEncodedFormParameterEncoder.default` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- ///
- /// - Returns: The created `DataRequest`.
- open func request<Parameters: Encodable>(_ convertible: URLConvertible,
- method: HTTPMethod = .get,
- parameters: Parameters? = nil,
- encoder: ParameterEncoder = URLEncodedFormParameterEncoder.default,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- requestModifier: RequestModifier? = nil) -> DataRequest
- {
- let convertible = RequestEncodableConvertible(url: convertible,
- method: method,
- parameters: parameters,
- encoder: encoder,
- headers: headers,
- requestModifier: requestModifier)
- return request(convertible, interceptor: interceptor)
- }
- /// Creates a `DataRequest` from a `URLRequestConvertible` value and a `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- ///
- /// - Returns: The created `DataRequest`.
- open func request(_ convertible: URLRequestConvertible, interceptor: RequestInterceptor? = nil) -> DataRequest {
- let request = DataRequest(convertible: convertible,
- underlyingQueue: rootQueue,
- serializationQueue: serializationQueue,
- eventMonitor: eventMonitor,
- interceptor: interceptor,
- delegate: self)
- perform(request)
- return request
- }
- // MARK: - DataStreamRequest
- /// Creates a `DataStreamRequest` from the passed components, `Encodable` parameters, and `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.get` by default.
- /// - parameters: `Encodable` value to be encoded into the `URLRequest`. `nil` by default.
- /// - encoder: `ParameterEncoder` to be used to encode the `parameters` value into the
- /// `URLRequest`.
- /// `URLEncodedFormParameterEncoder.default` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - automaticallyCancelOnStreamError: `Bool` indicating whether the instance should be canceled when an `Error`
- /// is thrown while serializing stream `Data`. `false` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil`
- /// by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from
- /// the provided parameters. `nil` by default.
- ///
- /// - Returns: The created `DataStream` request.
- open func streamRequest<Parameters: Encodable>(_ convertible: URLConvertible,
- method: HTTPMethod = .get,
- parameters: Parameters? = nil,
- encoder: ParameterEncoder = URLEncodedFormParameterEncoder.default,
- headers: HTTPHeaders? = nil,
- automaticallyCancelOnStreamError: Bool = false,
- interceptor: RequestInterceptor? = nil,
- requestModifier: RequestModifier? = nil) -> DataStreamRequest
- {
- let convertible = RequestEncodableConvertible(url: convertible,
- method: method,
- parameters: parameters,
- encoder: encoder,
- headers: headers,
- requestModifier: requestModifier)
- return streamRequest(convertible,
- automaticallyCancelOnStreamError: automaticallyCancelOnStreamError,
- interceptor: interceptor)
- }
- /// Creates a `DataStreamRequest` from the passed components and `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.get` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - automaticallyCancelOnStreamError: `Bool` indicating whether the instance should be canceled when an `Error`
- /// is thrown while serializing stream `Data`. `false` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil`
- /// by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from
- /// the provided parameters. `nil` by default.
- ///
- /// - Returns: The created `DataStream` request.
- open func streamRequest(_ convertible: URLConvertible,
- method: HTTPMethod = .get,
- headers: HTTPHeaders? = nil,
- automaticallyCancelOnStreamError: Bool = false,
- interceptor: RequestInterceptor? = nil,
- requestModifier: RequestModifier? = nil) -> DataStreamRequest
- {
- let convertible = RequestEncodableConvertible(url: convertible,
- method: method,
- parameters: Empty?.none,
- encoder: URLEncodedFormParameterEncoder.default,
- headers: headers,
- requestModifier: requestModifier)
- return streamRequest(convertible,
- automaticallyCancelOnStreamError: automaticallyCancelOnStreamError,
- interceptor: interceptor)
- }
- /// Creates a `DataStreamRequest` from the passed `URLRequestConvertible` value and `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - automaticallyCancelOnStreamError: `Bool` indicating whether the instance should be canceled when an `Error`
- /// is thrown while serializing stream `Data`. `false` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil`
- /// by default.
- ///
- /// - Returns: The created `DataStreamRequest`.
- open func streamRequest(_ convertible: URLRequestConvertible,
- automaticallyCancelOnStreamError: Bool = false,
- interceptor: RequestInterceptor? = nil) -> DataStreamRequest
- {
- let request = DataStreamRequest(convertible: convertible,
- automaticallyCancelOnStreamError: automaticallyCancelOnStreamError,
- underlyingQueue: rootQueue,
- serializationQueue: serializationQueue,
- eventMonitor: eventMonitor,
- interceptor: interceptor,
- delegate: self)
- perform(request)
- return request
- }
- // MARK: - DownloadRequest
- /// Creates a `DownloadRequest` using a `URLRequest` created using the passed components, `RequestInterceptor`, and
- /// `Destination`.
- ///
- /// - Parameters:
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.get` by default.
- /// - parameters: `Parameters` (a.k.a. `[String: Any]`) value to be encoded into the `URLRequest`. `nil` by
- /// default.
- /// - encoding: `ParameterEncoding` to be used to encode the `parameters` value into the `URLRequest`.
- /// Defaults to `URLEncoding.default`.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the provided
- /// parameters. `nil` by default.
- /// - destination: `DownloadRequest.Destination` closure used to determine how and where the downloaded file
- /// should be moved. `nil` by default.
- ///
- /// - Returns: The created `DownloadRequest`.
- open func download(_ convertible: URLConvertible,
- method: HTTPMethod = .get,
- parameters: Parameters? = nil,
- encoding: ParameterEncoding = URLEncoding.default,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- requestModifier: RequestModifier? = nil,
- to destination: DownloadRequest.Destination? = nil) -> DownloadRequest
- {
- let convertible = RequestConvertible(url: convertible,
- method: method,
- parameters: parameters,
- encoding: encoding,
- headers: headers,
- requestModifier: requestModifier)
- return download(convertible, interceptor: interceptor, to: destination)
- }
- /// Creates a `DownloadRequest` from a `URLRequest` created using the passed components, `Encodable` parameters, and
- /// a `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.get` by default.
- /// - parameters: Value conforming to `Encodable` to be encoded into the `URLRequest`. `nil` by default.
- /// - encoder: `ParameterEncoder` to be used to encode the `parameters` value into the `URLRequest`.
- /// Defaults to `URLEncodedFormParameterEncoder.default`.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the provided
- /// parameters. `nil` by default.
- /// - destination: `DownloadRequest.Destination` closure used to determine how and where the downloaded file
- /// should be moved. `nil` by default.
- ///
- /// - Returns: The created `DownloadRequest`.
- open func download<Parameters: Encodable>(_ convertible: URLConvertible,
- method: HTTPMethod = .get,
- parameters: Parameters? = nil,
- encoder: ParameterEncoder = URLEncodedFormParameterEncoder.default,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- requestModifier: RequestModifier? = nil,
- to destination: DownloadRequest.Destination? = nil) -> DownloadRequest
- {
- let convertible = RequestEncodableConvertible(url: convertible,
- method: method,
- parameters: parameters,
- encoder: encoder,
- headers: headers,
- requestModifier: requestModifier)
- return download(convertible, interceptor: interceptor, to: destination)
- }
- /// Creates a `DownloadRequest` from a `URLRequestConvertible` value, a `RequestInterceptor`, and a `Destination`.
- ///
- /// - Parameters:
- /// - convertible: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - destination: `DownloadRequest.Destination` closure used to determine how and where the downloaded file
- /// should be moved. `nil` by default.
- ///
- /// - Returns: The created `DownloadRequest`.
- open func download(_ convertible: URLRequestConvertible,
- interceptor: RequestInterceptor? = nil,
- to destination: DownloadRequest.Destination? = nil) -> DownloadRequest
- {
- let request = DownloadRequest(downloadable: .request(convertible),
- underlyingQueue: rootQueue,
- serializationQueue: serializationQueue,
- eventMonitor: eventMonitor,
- interceptor: interceptor,
- delegate: self,
- destination: destination ?? DownloadRequest.defaultDestination)
- perform(request)
- return request
- }
- /// Creates a `DownloadRequest` from the `resumeData` produced from a previously cancelled `DownloadRequest`, as
- /// well as a `RequestInterceptor`, and a `Destination`.
- ///
- /// - Note: If `destination` is not specified, the download will be moved to a temporary location determined by
- /// Alamofire. The file will not be deleted until the system purges the temporary files.
- ///
- /// - Note: On some versions of all Apple platforms (iOS 10 - 10.2, macOS 10.12 - 10.12.2, tvOS 10 - 10.1, watchOS 3 - 3.1.1),
- /// `resumeData` is broken on background URL session configurations. There's an underlying bug in the `resumeData`
- /// generation logic where the data is written incorrectly and will always fail to resume the download. For more
- /// information about the bug and possible workarounds, please refer to the [this Stack Overflow post](http://stackoverflow.com/a/39347461/1342462).
- ///
- /// - Parameters:
- /// - data: The resume data from a previously cancelled `DownloadRequest` or `URLSessionDownloadTask`.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - destination: `DownloadRequest.Destination` closure used to determine how and where the downloaded file
- /// should be moved. `nil` by default.
- ///
- /// - Returns: The created `DownloadRequest`.
- open func download(resumingWith data: Data,
- interceptor: RequestInterceptor? = nil,
- to destination: DownloadRequest.Destination? = nil) -> DownloadRequest
- {
- let request = DownloadRequest(downloadable: .resumeData(data),
- underlyingQueue: rootQueue,
- serializationQueue: serializationQueue,
- eventMonitor: eventMonitor,
- interceptor: interceptor,
- delegate: self,
- destination: destination ?? DownloadRequest.defaultDestination)
- perform(request)
- return request
- }
- // MARK: - UploadRequest
- struct ParameterlessRequestConvertible: URLRequestConvertible {
- let url: URLConvertible
- let method: HTTPMethod
- let headers: HTTPHeaders?
- let requestModifier: RequestModifier?
- func asURLRequest() throws -> URLRequest {
- var request = try URLRequest(url: url, method: method, headers: headers)
- try requestModifier?(&request)
- return request
- }
- }
- struct Upload: UploadConvertible {
- let request: URLRequestConvertible
- let uploadable: UploadableConvertible
- func createUploadable() throws -> UploadRequest.Uploadable {
- try uploadable.createUploadable()
- }
- func asURLRequest() throws -> URLRequest {
- try request.asURLRequest()
- }
- }
- // MARK: Data
- /// Creates an `UploadRequest` for the given `Data`, `URLRequest` components, and `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - data: The `Data` to upload.
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.post` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the provided
- /// parameters. `nil` by default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(_ data: Data,
- to convertible: URLConvertible,
- method: HTTPMethod = .post,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default,
- requestModifier: RequestModifier? = nil) -> UploadRequest
- {
- let convertible = ParameterlessRequestConvertible(url: convertible,
- method: method,
- headers: headers,
- requestModifier: requestModifier)
- return upload(data, with: convertible, interceptor: interceptor, fileManager: fileManager)
- }
- /// Creates an `UploadRequest` for the given `Data` using the `URLRequestConvertible` value and `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - data: The `Data` to upload.
- /// - convertible: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(_ data: Data,
- with convertible: URLRequestConvertible,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default) -> UploadRequest
- {
- upload(.data(data), with: convertible, interceptor: interceptor, fileManager: fileManager)
- }
- // MARK: File
- /// Creates an `UploadRequest` for the file at the given file `URL`, using a `URLRequest` from the provided
- /// components and `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - fileURL: The `URL` of the file to upload.
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.post` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `UploadRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the provided
- /// parameters. `nil` by default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(_ fileURL: URL,
- to convertible: URLConvertible,
- method: HTTPMethod = .post,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default,
- requestModifier: RequestModifier? = nil) -> UploadRequest
- {
- let convertible = ParameterlessRequestConvertible(url: convertible,
- method: method,
- headers: headers,
- requestModifier: requestModifier)
- return upload(fileURL, with: convertible, interceptor: interceptor, fileManager: fileManager)
- }
- /// Creates an `UploadRequest` for the file at the given file `URL` using the `URLRequestConvertible` value and
- /// `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - fileURL: The `URL` of the file to upload.
- /// - convertible: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(_ fileURL: URL,
- with convertible: URLRequestConvertible,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default) -> UploadRequest
- {
- upload(.file(fileURL, shouldRemove: false), with: convertible, interceptor: interceptor, fileManager: fileManager)
- }
- // MARK: InputStream
- /// Creates an `UploadRequest` from the `InputStream` provided using a `URLRequest` from the provided components and
- /// `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - stream: The `InputStream` that provides the data to upload.
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - method: `HTTPMethod` for the `URLRequest`. `.post` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the provided
- /// parameters. `nil` by default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(_ stream: InputStream,
- to convertible: URLConvertible,
- method: HTTPMethod = .post,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default,
- requestModifier: RequestModifier? = nil) -> UploadRequest
- {
- let convertible = ParameterlessRequestConvertible(url: convertible,
- method: method,
- headers: headers,
- requestModifier: requestModifier)
- return upload(stream, with: convertible, interceptor: interceptor, fileManager: fileManager)
- }
- /// Creates an `UploadRequest` from the provided `InputStream` using the `URLRequestConvertible` value and
- /// `RequestInterceptor`.
- ///
- /// - Parameters:
- /// - stream: The `InputStream` that provides the data to upload.
- /// - convertible: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(_ stream: InputStream,
- with convertible: URLRequestConvertible,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default) -> UploadRequest
- {
- upload(.stream(stream), with: convertible, interceptor: interceptor, fileManager: fileManager)
- }
- // MARK: MultipartFormData
- /// Creates an `UploadRequest` for the multipart form data built using a closure and sent using the provided
- /// `URLRequest` components and `RequestInterceptor`.
- ///
- /// It is important to understand the memory implications of uploading `MultipartFormData`. If the cumulative
- /// payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- /// efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- /// be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- /// footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- /// used for larger payloads such as video content.
- ///
- /// The `encodingMemoryThreshold` parameter allows Alamofire to automatically determine whether to encode in-memory
- /// or stream from disk. If the content length of the `MultipartFormData` is below the `encodingMemoryThreshold`,
- /// encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- /// during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- /// technique was used.
- ///
- /// - Parameters:
- /// - multipartFormData: `MultipartFormData` building closure.
- /// - convertible: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - encodingMemoryThreshold: Byte threshold used to determine whether the form data is encoded into memory or
- /// onto disk before being uploaded. `MultipartFormData.encodingMemoryThreshold` by
- /// default.
- /// - method: `HTTPMethod` for the `URLRequest`. `.post` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` to be used if the form data exceeds the memory threshold and is
- /// written to disk before being uploaded. `.default` instance by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the
- /// provided parameters. `nil` by default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(multipartFormData: @escaping (MultipartFormData) -> Void,
- to url: URLConvertible,
- usingThreshold encodingMemoryThreshold: UInt64 = MultipartFormData.encodingMemoryThreshold,
- method: HTTPMethod = .post,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default,
- requestModifier: RequestModifier? = nil) -> UploadRequest
- {
- let convertible = ParameterlessRequestConvertible(url: url,
- method: method,
- headers: headers,
- requestModifier: requestModifier)
- let formData = MultipartFormData(fileManager: fileManager)
- multipartFormData(formData)
- return upload(multipartFormData: formData,
- with: convertible,
- usingThreshold: encodingMemoryThreshold,
- interceptor: interceptor,
- fileManager: fileManager)
- }
- /// Creates an `UploadRequest` using a `MultipartFormData` building closure, the provided `URLRequestConvertible`
- /// value, and a `RequestInterceptor`.
- ///
- /// It is important to understand the memory implications of uploading `MultipartFormData`. If the cumulative
- /// payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- /// efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- /// be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- /// footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- /// used for larger payloads such as video content.
- ///
- /// The `encodingMemoryThreshold` parameter allows Alamofire to automatically determine whether to encode in-memory
- /// or stream from disk. If the content length of the `MultipartFormData` is below the `encodingMemoryThreshold`,
- /// encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- /// during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- /// technique was used.
- ///
- /// - Parameters:
- /// - multipartFormData: `MultipartFormData` building closure.
- /// - request: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - encodingMemoryThreshold: Byte threshold used to determine whether the form data is encoded into memory or
- /// onto disk before being uploaded. `MultipartFormData.encodingMemoryThreshold` by
- /// default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` to be used if the form data exceeds the memory threshold and is
- /// written to disk before being uploaded. `.default` instance by default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(multipartFormData: @escaping (MultipartFormData) -> Void,
- with request: URLRequestConvertible,
- usingThreshold encodingMemoryThreshold: UInt64 = MultipartFormData.encodingMemoryThreshold,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default) -> UploadRequest
- {
- let formData = MultipartFormData(fileManager: fileManager)
- multipartFormData(formData)
- return upload(multipartFormData: formData,
- with: request,
- usingThreshold: encodingMemoryThreshold,
- interceptor: interceptor,
- fileManager: fileManager)
- }
- /// Creates an `UploadRequest` for the prebuilt `MultipartFormData` value using the provided `URLRequest` components
- /// and `RequestInterceptor`.
- ///
- /// It is important to understand the memory implications of uploading `MultipartFormData`. If the cumulative
- /// payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- /// efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- /// be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- /// footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- /// used for larger payloads such as video content.
- ///
- /// The `encodingMemoryThreshold` parameter allows Alamofire to automatically determine whether to encode in-memory
- /// or stream from disk. If the content length of the `MultipartFormData` is below the `encodingMemoryThreshold`,
- /// encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- /// during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- /// technique was used.
- ///
- /// - Parameters:
- /// - multipartFormData: `MultipartFormData` instance to upload.
- /// - url: `URLConvertible` value to be used as the `URLRequest`'s `URL`.
- /// - encodingMemoryThreshold: Byte threshold used to determine whether the form data is encoded into memory or
- /// onto disk before being uploaded. `MultipartFormData.encodingMemoryThreshold` by
- /// default.
- /// - method: `HTTPMethod` for the `URLRequest`. `.post` by default.
- /// - headers: `HTTPHeaders` value to be added to the `URLRequest`. `nil` by default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` to be used if the form data exceeds the memory threshold and is
- /// written to disk before being uploaded. `.default` instance by default.
- /// - requestModifier: `RequestModifier` which will be applied to the `URLRequest` created from the
- /// provided parameters. `nil` by default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(multipartFormData: MultipartFormData,
- to url: URLConvertible,
- usingThreshold encodingMemoryThreshold: UInt64 = MultipartFormData.encodingMemoryThreshold,
- method: HTTPMethod = .post,
- headers: HTTPHeaders? = nil,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default,
- requestModifier: RequestModifier? = nil) -> UploadRequest
- {
- let convertible = ParameterlessRequestConvertible(url: url,
- method: method,
- headers: headers,
- requestModifier: requestModifier)
- let multipartUpload = MultipartUpload(encodingMemoryThreshold: encodingMemoryThreshold,
- request: convertible,
- multipartFormData: multipartFormData)
- return upload(multipartUpload, interceptor: interceptor, fileManager: fileManager)
- }
- /// Creates an `UploadRequest` for the prebuilt `MultipartFormData` value using the providing `URLRequestConvertible`
- /// value and `RequestInterceptor`.
- ///
- /// It is important to understand the memory implications of uploading `MultipartFormData`. If the cumulative
- /// payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- /// efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- /// be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- /// footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- /// used for larger payloads such as video content.
- ///
- /// The `encodingMemoryThreshold` parameter allows Alamofire to automatically determine whether to encode in-memory
- /// or stream from disk. If the content length of the `MultipartFormData` is below the `encodingMemoryThreshold`,
- /// encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- /// during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- /// technique was used.
- ///
- /// - Parameters:
- /// - multipartFormData: `MultipartFormData` instance to upload.
- /// - request: `URLRequestConvertible` value to be used to create the `URLRequest`.
- /// - encodingMemoryThreshold: Byte threshold used to determine whether the form data is encoded into memory or
- /// onto disk before being uploaded. `MultipartFormData.encodingMemoryThreshold` by
- /// default.
- /// - interceptor: `RequestInterceptor` value to be used by the returned `DataRequest`. `nil` by default.
- /// - fileManager: `FileManager` instance to be used by the returned `UploadRequest`. `.default` instance by
- /// default.
- ///
- /// - Returns: The created `UploadRequest`.
- open func upload(multipartFormData: MultipartFormData,
- with request: URLRequestConvertible,
- usingThreshold encodingMemoryThreshold: UInt64 = MultipartFormData.encodingMemoryThreshold,
- interceptor: RequestInterceptor? = nil,
- fileManager: FileManager = .default) -> UploadRequest
- {
- let multipartUpload = MultipartUpload(encodingMemoryThreshold: encodingMemoryThreshold,
- request: request,
- multipartFormData: multipartFormData)
- return upload(multipartUpload, interceptor: interceptor, fileManager: fileManager)
- }
- // MARK: - Internal API
- // MARK: Uploadable
- func upload(_ uploadable: UploadRequest.Uploadable,
- with convertible: URLRequestConvertible,
- interceptor: RequestInterceptor?,
- fileManager: FileManager) -> UploadRequest
- {
- let uploadable = Upload(request: convertible, uploadable: uploadable)
- return upload(uploadable, interceptor: interceptor, fileManager: fileManager)
- }
- func upload(_ upload: UploadConvertible, interceptor: RequestInterceptor?, fileManager: FileManager) -> UploadRequest {
- let request = UploadRequest(convertible: upload,
- underlyingQueue: rootQueue,
- serializationQueue: serializationQueue,
- eventMonitor: eventMonitor,
- interceptor: interceptor,
- fileManager: fileManager,
- delegate: self)
- perform(request)
- return request
- }
- // MARK: Perform
- /// Starts performing the provided `Request`.
- ///
- /// - Parameter request: The `Request` to perform.
- func perform(_ request: Request) {
- rootQueue.async {
- guard !request.isCancelled else { return }
- self.activeRequests.insert(request)
- self.requestQueue.async {
- // Leaf types must come first, otherwise they will cast as their superclass.
- switch request {
- case let r as UploadRequest: self.performUploadRequest(r) // UploadRequest must come before DataRequest due to subtype relationship.
- case let r as DataRequest: self.performDataRequest(r)
- case let r as DownloadRequest: self.performDownloadRequest(r)
- case let r as DataStreamRequest: self.performDataStreamRequest(r)
- default: fatalError("Attempted to perform unsupported Request subclass: \(type(of: request))")
- }
- }
- }
- }
- func performDataRequest(_ request: DataRequest) {
- dispatchPrecondition(condition: .onQueue(requestQueue))
- performSetupOperations(for: request, convertible: request.convertible)
- }
- func performDataStreamRequest(_ request: DataStreamRequest) {
- dispatchPrecondition(condition: .onQueue(requestQueue))
- performSetupOperations(for: request, convertible: request.convertible)
- }
- func performUploadRequest(_ request: UploadRequest) {
- dispatchPrecondition(condition: .onQueue(requestQueue))
- performSetupOperations(for: request, convertible: request.convertible) {
- do {
- let uploadable = try request.upload.createUploadable()
- self.rootQueue.async { request.didCreateUploadable(uploadable) }
- return true
- } catch {
- self.rootQueue.async { request.didFailToCreateUploadable(with: error.asAFError(or: .createUploadableFailed(error: error))) }
- return false
- }
- }
- }
- func performDownloadRequest(_ request: DownloadRequest) {
- dispatchPrecondition(condition: .onQueue(requestQueue))
- switch request.downloadable {
- case let .request(convertible):
- performSetupOperations(for: request, convertible: convertible)
- case let .resumeData(resumeData):
- rootQueue.async { self.didReceiveResumeData(resumeData, for: request) }
- }
- }
- func performSetupOperations(for request: Request,
- convertible: URLRequestConvertible,
- shouldCreateTask: @escaping () -> Bool = { true })
- {
- dispatchPrecondition(condition: .onQueue(requestQueue))
- let initialRequest: URLRequest
- do {
- initialRequest = try convertible.asURLRequest()
- try initialRequest.validate()
- } catch {
- rootQueue.async { request.didFailToCreateURLRequest(with: error.asAFError(or: .createURLRequestFailed(error: error))) }
- return
- }
- rootQueue.async { request.didCreateInitialURLRequest(initialRequest) }
- guard !request.isCancelled else { return }
- guard let adapter = adapter(for: request) else {
- guard shouldCreateTask() else { return }
- rootQueue.async { self.didCreateURLRequest(initialRequest, for: request) }
- return
- }
- adapter.adapt(initialRequest, for: self) { result in
- do {
- let adaptedRequest = try result.get()
- try adaptedRequest.validate()
- self.rootQueue.async { request.didAdaptInitialRequest(initialRequest, to: adaptedRequest) }
- guard shouldCreateTask() else { return }
- self.rootQueue.async { self.didCreateURLRequest(adaptedRequest, for: request) }
- } catch {
- self.rootQueue.async { request.didFailToAdaptURLRequest(initialRequest, withError: .requestAdaptationFailed(error: error)) }
- }
- }
- }
- // MARK: - Task Handling
- func didCreateURLRequest(_ urlRequest: URLRequest, for request: Request) {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- request.didCreateURLRequest(urlRequest)
- guard !request.isCancelled else { return }
- let task = request.task(for: urlRequest, using: session)
- requestTaskMap[request] = task
- request.didCreateTask(task)
- updateStatesForTask(task, request: request)
- }
- func didReceiveResumeData(_ data: Data, for request: DownloadRequest) {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- guard !request.isCancelled else { return }
- let task = request.task(forResumeData: data, using: session)
- requestTaskMap[request] = task
- request.didCreateTask(task)
- updateStatesForTask(task, request: request)
- }
- func updateStatesForTask(_ task: URLSessionTask, request: Request) {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- request.withState { state in
- switch state {
- case .initialized, .finished:
- // Do nothing.
- break
- case .resumed:
- task.resume()
- rootQueue.async { request.didResumeTask(task) }
- case .suspended:
- task.suspend()
- rootQueue.async { request.didSuspendTask(task) }
- case .cancelled:
- // Resume to ensure metrics are gathered.
- task.resume()
- task.cancel()
- rootQueue.async { request.didCancelTask(task) }
- }
- }
- }
- // MARK: - Adapters and Retriers
- func adapter(for request: Request) -> RequestAdapter? {
- if let requestInterceptor = request.interceptor, let sessionInterceptor = interceptor {
- return Interceptor(adapters: [requestInterceptor, sessionInterceptor])
- } else {
- return request.interceptor ?? interceptor
- }
- }
- func retrier(for request: Request) -> RequestRetrier? {
- if let requestInterceptor = request.interceptor, let sessionInterceptor = interceptor {
- return Interceptor(retriers: [requestInterceptor, sessionInterceptor])
- } else {
- return request.interceptor ?? interceptor
- }
- }
- // MARK: - Invalidation
- func finishRequestsForDeinit() {
- requestTaskMap.requests.forEach { request in
- rootQueue.async {
- request.finish(error: AFError.sessionDeinitialized)
- }
- }
- }
- }
- // MARK: - RequestDelegate
- extension Session: RequestDelegate {
- public var sessionConfiguration: URLSessionConfiguration {
- session.configuration
- }
- public var startImmediately: Bool { startRequestsImmediately }
- public func cleanup(after request: Request) {
- activeRequests.remove(request)
- }
- public func retryResult(for request: Request, dueTo error: AFError, completion: @escaping (RetryResult) -> Void) {
- guard let retrier = retrier(for: request) else {
- rootQueue.async { completion(.doNotRetry) }
- return
- }
- retrier.retry(request, for: self, dueTo: error) { retryResult in
- self.rootQueue.async {
- guard let retryResultError = retryResult.error else { completion(retryResult); return }
- let retryError = AFError.requestRetryFailed(retryError: retryResultError, originalError: error)
- completion(.doNotRetryWithError(retryError))
- }
- }
- }
- public func retryRequest(_ request: Request, withDelay timeDelay: TimeInterval?) {
- rootQueue.async {
- let retry: () -> Void = {
- guard !request.isCancelled else { return }
- request.prepareForRetry()
- self.perform(request)
- }
- if let retryDelay = timeDelay {
- self.rootQueue.after(retryDelay) { retry() }
- } else {
- retry()
- }
- }
- }
- }
- // MARK: - SessionStateProvider
- extension Session: SessionStateProvider {
- func request(for task: URLSessionTask) -> Request? {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- return requestTaskMap[task]
- }
- func didGatherMetricsForTask(_ task: URLSessionTask) {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- let didDisassociate = requestTaskMap.disassociateIfNecessaryAfterGatheringMetricsForTask(task)
- if didDisassociate {
- waitingCompletions[task]?()
- waitingCompletions[task] = nil
- }
- }
- func didCompleteTask(_ task: URLSessionTask, completion: @escaping () -> Void) {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- let didDisassociate = requestTaskMap.disassociateIfNecessaryAfterCompletingTask(task)
- if didDisassociate {
- completion()
- } else {
- waitingCompletions[task] = completion
- }
- }
- func credential(for task: URLSessionTask, in protectionSpace: URLProtectionSpace) -> URLCredential? {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- return requestTaskMap[task]?.credential ??
- session.configuration.urlCredentialStorage?.defaultCredential(for: protectionSpace)
- }
- func cancelRequestsForSessionInvalidation(with error: Error?) {
- dispatchPrecondition(condition: .onQueue(rootQueue))
- requestTaskMap.requests.forEach { $0.finish(error: AFError.sessionInvalidated(error: error)) }
- }
- }
|