RKRequestQueue Class Reference
| Inherits from | NSObject |
| Declared in | RKRequestQueue.h RKRequestQueue.m |
Overview
A lightweight queue implementation responsible for dispatching and managing RKRequest objects
Tasks
Other Methods
-
delegateThe delegate to inform when the request queue state machine changes
property -
concurrentRequestsLimitThe number of current requests supported by this queue Defaults to 5
property -
requestTimeoutRequest timeout value used by the queue Defaults to 5 minutes (300 seconds)
property -
suspendedGets the flag that determines if new load requests are allowed to reach the network.
property -
loadingCountReturns the total number of requests that are currently loading
property -
countReturns the number of requests in the queue
property -
showsNetworkActivityIndicatorWhenBusyWhen YES, this queue will spin the network activity in the menu bar when it is processing requests
property -
+ sharedQueueReturn the global queue
-
+ setSharedQueue:Set the global queue
-
– addRequest:Add an asynchronous request to the queue and send it as as soon as possible
-
– cancelRequest:Cancel a request that is in progress
-
– cancelRequestsWithDelegate:Cancel all requests with a given delegate
-
– cancelAllRequestsCancel all active or pending requests.
-
– startStart checking for and processing requests
-
– containsRequest:Returns YES if the specified request is in this queue
Other Methods
-
– responseDidLoad:Invoked via observation when a request has loaded a response. Remove the completed request from the queue and continue processing
Properties
concurrentRequestsLimit
The number of current requests supported by this queue Defaults to 5
@property (nonatomic) NSUInteger concurrentRequestsLimitDeclared In
RKRequestQueue.hcount
Returns the number of requests in the queue
@property (nonatomic, readonly) NSUInteger countDeclared In
RKRequestQueue.hdelegate
The delegate to inform when the request queue state machine changes
@property (nonatomic, assign) NSObject<RKRequestQueueDelegate> *delegateDiscussion
If the object implements the RKRequestQueueDelegate protocol, it will receive request lifecycle event messages.
Declared In
RKRequestQueue.hloadingCount
Returns the total number of requests that are currently loading
@property (nonatomic, readonly) NSUInteger loadingCountDeclared In
RKRequestQueue.hrequestTimeout
Request timeout value used by the queue Defaults to 5 minutes (300 seconds)
@property (nonatomic, assign) NSUInteger requestTimeoutDeclared In
RKRequestQueue.hshowsNetworkActivityIndicatorWhenBusy
When YES, this queue will spin the network activity in the menu bar when it is processing requests
@property (nonatomic) BOOL showsNetworkActivityIndicatorWhenBusyDiscussion
Default: NO
Currently, this implementation does not work across queues at the moment. Each queue will manipulate the activity indicator indepedently of all others.
Declared In
RKRequestQueue.hsuspended
Gets the flag that determines if new load requests are allowed to reach the network.
@property (nonatomic) BOOL suspendedDiscussion
Because network requests tend to slow down performance, this property can be used to temporarily delay them. All requests made while suspended are queued, and when suspended becomes false again they are executed.
Declared In
RKRequestQueue.hClass Methods
Instance Methods
addRequest:
Add an asynchronous request to the queue and send it as as soon as possible
- (void)addRequest:(RKRequest *)requestDeclared In
RKRequestQueue.hcancelAllRequests
Cancel all active or pending requests.
- (void)cancelAllRequestsDeclared In
RKRequestQueue.hcancelRequest:
Cancel a request that is in progress
- (void)cancelRequest:(RKRequest *)requestDeclared In
RKRequestQueue.hcancelRequestsWithDelegate:
Cancel all requests with a given delegate
- (void)cancelRequestsWithDelegate:(NSObject<RKRequestDelegate> *)delegateDeclared In
RKRequestQueue.hcontainsRequest:
Returns YES if the specified request is in this queue
- (BOOL)containsRequest:(RKRequest *)requestDeclared In
RKRequestQueue.h