NSURLSessionTask 大致说明
NSURLSessionTask类是URL会话中任务的基类。任务总是会话的一部分;您可以通过调用NSURLSession实例上的任务创建方法之一来创建任务。您调用的方法确定任务的类型
创建任务之后,通过调用其resume方法启动任务。然后会话保持对任务的强引用,直到请求完成或失败;你不需要维护对任务的引用,除非它对你的应用程序的内部记账有用。
Note:所有任务属性都支持键值观察。
NSURLSessionTask 属性和方法说明
@property (readonly) NSUInteger taskIdentifier;
此任务的标识符,由所属会话分配且唯一。
在给定会话中唯一标识任务的标识符。
此值仅在单个会话的上下文中是惟一的;其他会话中的任务可能具有相同的任务标识符值。
@property (nullable, readonly, copy) NSURLRequest *originalRequest;
创建任务时传递的原始请求对象。
这个值通常与当前活动的请求(currentRequest)相同,除非服务器已经用重定向到另一个URL响应了初始请求。
如果这是一个流任务,可能是nil
@property (nullable, readonly, copy) NSURLRequest *currentRequest;
当前由任务处理的URL请求对象。
此值通常与初始请求(originalRequest)相同,除非服务器已经用重定向到另一个URL响应了初始请求。
由于http服务器重定向,可能与原始请求不同
@property (nullable, readonly, copy) NSURLResponse *response;
服务器对当前活动请求的响应。
此对象提供由服务器提供的关于请求的信息。这些信息总是包含原始URL。它还可能包括预期的长度、MIME类型信息、编码信息、建议的文件名或这些的组合。
如果没有收到任何响应,可能为nil
@property (readonly, strong) NSProgress *progress API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
总体任务进度的表示。
表示任务进程的NSProgress对象。它可用于任务进度跟踪。
@property (nullable, copy) NSDate *earliestBeginDate API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
网络负载开始的最早日期。
对于从后台NSURLSession实例创建的任务,此属性指示网络加载不应在此日期之前开始。
设置此属性并不保证加载将在指定的日期开始,而是保证加载不会更早开始。
如果没有指定,则不使用启动延迟。
此属性对从非后台会话创建的任务无效。
不早于指定日期启动此任务的网络负载。如果没有指定,则不使用启动延迟。
只适用于从后台NSURLSession实例创建的任务;对从其他会话类型创建的任务没有影响。
@property int64_t countOfBytesClientExpectsToSend API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
客户机期望发送的字节数的最佳猜测上限。
此属性的值集应考虑HTTP头和正文数据或正文流的大小。
如果没有指定值,则系统将使用NSURLSessionTransferSizeUnknown
系统使用此属性优化URL会话任务的调度。
强烈建议开发人员提供一个近似的上界,如果可能的话,提供一个精确的字节数,而不是接受默认值。
@property int64_t countOfBytesClientExpectsToReceive API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
客户机期望接收的字节数的最佳猜测上限。
此属性的值集应同时考虑HTTP响应头和响应体的大小。
如果没有指定值,则系统将使用NSURLSessionTransferSizeUnknown。
系统使用此属性优化URL会话任务的调度。
强烈建议开发人员提供一个近似的上界,如果可能的话,提供一个精确的字节数,而不是接受默认值。
@property (readonly) int64_t countOfBytesReceived;
任务从服务器的响应主体中的接收到的字节数。
已接收的主体字节数
@property (readonly) int64_t countOfBytesSent;
任务发送到请求体中的服务器的字节数。
这个字节数只包括请求体本身的长度,而不包括请求头。
已发送的主体字节数
@property (readonly) int64_t countOfBytesExpectedToSend;
任务期望在请求体中发送的字节数。
如果提供了流或主体数据对象,则该值为NSURLSessionTransferSizeUnknown(-1);如果没有提供,则为0(0)。
我们期望发送的体字节数,由HTTP请求的内容长度派生
@property (readonly) int64_t countOfBytesExpectedToReceive;
任务期望在响应体中接收的字节数。
此值是根据从服务器接收到的内容长度头确定的。
如果该头部不存在,则值为NSURLSessionTransferSizeUnknown。
@property (nullable, copy) NSString *taskDescription;
应用程序提供的当前任务的描述。
这个值可以是nil。它的目的是包含人类可读的字符串,然后您可以将其作为应用程序用户界面的一部分显示给用户。
开发人员可以使用taskDescription属性为任务提供描述性标签。
- (void)cancel;
取消任务。
这个方法立即返回,
将任务标记为已取消。
一旦一个任务被标记为被取消,
URLSession:task:didCompleteWithError:将被发送到任务委托,
使用代码nsurlerrorcancel在域NSURLErrorDomain中传递错误。
在某些情况下,任务可以在确认取消之前向其委托发送消息。
可以在挂起的任务上调用此方法。
@property (readonly) NSURLSessionTaskState state;
当前任务处于活动状态、暂停状态、正在被取消或完成的状态。
The current state of the task within the session.
typedef NS_ENUM(NSInteger, NSURLSessionTaskState) {
NSURLSessionTaskStateRunning = 0, 该任务目前由会话提供服务。处于此状态的任务受会话配置对象中指定的请求和资源超时的限制。
NSURLSessionTaskStateSuspended = 1, 应用程序暂停了该任务。在任务恢复之前不会进行进一步的处理。此状态下的任务不受超时的限制。
NSURLSessionTaskStateCanceling = 2, 任务已收到取消消息。
委托可能已经或还没有收URLSession:task:didCompleteWithError: message。此状态下的任务不受超时的限制。
NSURLSessionTaskStateCompleted = 3, 任务已经完成(没有被取消),任务的委托没有收到进一步的回调。如果任务成功完成,则任务的错误属性为nil。否则,它将提供一个错误对象来告诉出错的地方。此状态下的任务不受超时的限制。
} NS_ENUM_AVAILABLE(NSURLSESSION_AVAILABLE, 7_0);
@property (nullable, readonly, copy) NSError *error;
指示任务失败原因的错误对象。
如果任务仍然处于活动状态或传输成功完成,则此值为nil。
如果有错误,则通过-URLSession:task:didCompleteWithError:这个属性将在没有发生错误的情况下为nil。
- (void)suspend;
临时挂起一个任务。
任务在挂起时不会产生网络流量,并且不受超时的限制。下载任务可以在稍后的时间继续传输数据。所有其他任务必须重新开始时恢复。
暂停任务将阻止NSURLSession继续加载数据。
可能仍然会有代表该任务的委托调用(例如,报告在挂起时接收到的数据),但是在发送-resume之前不会代表该任务进行进一步的传输。
当任务挂起时,将禁用与任务关联的超时计时器。-suspend和-resume是可嵌套的。
- (void)resume;
如果任务被挂起,则继续该任务。
新初始化的任务以挂起状态开始,因此需要调用此方法来启动任务。
@property float priority API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
您希望主机处理任务的相对优先级,指定为0.0(最低优先级)和1.0(最高优先级)之间的浮点值。
要向主机提供关于如何从应用程序对URL会话任务进行优先级排序的提示,请为每个任务指定优先级。指定优先级只提供提示,并不保证性能。如果没有指定优先级,URL会话任务的优先级为NSURLSessionTaskPriorityDefault,值为0.5。
您可以使用三个命名的优先级,在URL会话任务优先级中进行了描述。
您可以在任何时候指定或更改任务的优先级,但不是所有网络协议都在任务启动后响应更改。没有API可以让您从主机的角度确定任务的有效优先级。
相对应取值:
FOUNDATION_EXPORT const float NSURLSessionTaskPriorityDefault API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
FOUNDATION_EXPORT const float NSURLSessionTaskPriorityLow API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
FOUNDATION_EXPORT const float NSURLSessionTaskPriorityHigh API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
涉及相关类(未深度研究的)
NSProgress