ODPRequest class

Consists of methods for handling HTTP requests.

• addBasicAuthenticationHeaderWithUsername:andPassword:(NSString *, NSString *) method
  Constructs a basic authentication header from the user name and password specified, and adds it to the request headers.
• addRequestHeader:value:(NSString *, NSString *) method
  Adds a custom header to the request.
• appendPostData:(NSData *) method
  Adds data to the post body.
• appendPostDataFromFile:(NSString *) method
  Adds data to the post body from a file.
• applyAuthorizationHeader() method
  
• applyCookieHeader() method
  Creates a cookie header from request cookies and global store, when called during buildRequestHeaders after a redirect.
• averageBandwidthUsedPerSecond() method
  Returns an average (for the last five seconds) of how much bandwidth is used, in bytes.
• base64forData:(NSData *) method
  Base64 encodes the provided NSData*.
• buildPostBody() method
  Creates the post body.
• buildRequestHeaders() method
  Populates the request headers dictionary.
• bumpToTextFile:(NSString *) method
  
• cancelAuthentication() method
  Called by delegates to cancel authentication and stop.
• clearSession() method
  
• dataWritingOptions() method
  Returns a mask which determines whether the data should be stored in encrypted form.
• dateFromRFC1123String:(NSString *) method
  Returns a date from a string in RFC1123 format.
• decodeBase64:(NSString *) method
  Decodes a base64 encoded string.
• defaultCache() method
  Returns the default download cache or nil if no value is set at class level.
• enableXCSRF:(BOOL) method
  Enables XCSRF support.
• failWithError:(NSError *) method
  Called when a request fails, and lets the delegate know via didFailSelector.
• fileProtectionAttributes() method
  Returns an attributes dictionary used for encrypted file storage or nil if file protection has been explicitly disabled.
• getChunkSize() method
  
• getMaxConcurrentHTTPRequestCount() method
  Returns the maximum number of ODPRequest threads which can be executed in parallel.
• getMoOffset() method
  
• handleNetworkEvent:(CFStreamEventType) method
  Handles network events as they occur.
• HEADRequest() method
  Used by NetworkQueue to create a HEAD request appropriate for this request with the same headers.
• hideNetworkActivityIndicator() method
  Hides the network activity spinner.
• incrementBandwidthUsedInLastSecond:(unsigned long) method
  Records bandwidth use and used by InputStreams during upload.
• incrementDownloadSizeBy:(long long) method
  Called when you get a content-length header and shouldResetDownloadProgress is set to true.
• incrementUploadSizeBy:(long long) method
  Called when a request starts and shouldResetUploadProgress is set to true.
• initWithURL:(NSURL *) method
  HTTP or HTTPS URL.
• isBandwidthThrottled() method
  Returns YES if bandwidth throttling is currently in use.
• isNetworkInUse() method
  Indicates whether there are running requests.
• isNetworkReachableViaWWAN() method
  Returns YES when an iPhone OS device is connected via WWAN, false when connected via WIFI or not connected.
• isResponseCompressed() method
  Returns true if the response is gzip compressed.
• maxBandwidthPerSecond() method
  Maximum approximate number of bytes all requests can send or receive in a second.
• maxUploadReadLength() method
  Returns the maximum amount of data that can be read as part of the current measurement period, and retires the thread if the allowance is consumed.
• mimeTypeForFileAtPath:(NSString *) method
  
• performSelector:onTarget:withObject:amount:(SEL, id *, id, void *) method
  Helper method used for performing invocations on the main thread (used for progress).
• performThrottling() method
  Performs bandwidth throttling.
• removeCredentialsForHost:port:protocol:realm:(NSString *, int, NSString *, NSString *) method
  Deletes host credentials from the keychain.
• removeCredentialsForProxy:port:realm:(NSString *, int, NSString *) method
  Deletes proxy credentials from the keychain.
• removeUploadProgressSoFar() method
  Called when authorization is required, as you can determine that you do not have permissions only when the upload is complete.
• requestWithURL:(NSURL *) method
  Convenience constructor with URL.
• requestWithURL:usingCache:(NSURL *, id< SDMCacheDelegate >) method
  Convenience constructor with URL and cache.
• requestWithURL:usingCache:andCachePolicy:(NSURL *, id< SDMCacheDelegate >, CachePolicy) method
  Convenience constructor with URL, cache, and cache policy.
• responseData() method
  Response data, automatically uncompressed where appropriate.
• responseString() method
  Returns the contents of the result as an NSString.
• retryUsingSuppliedCredentials() method
  Unlocks the request thread so it can resume the request.
• saveCredentials:forHost:port:protocol:realm:(NSURLCredential *, NSString *, int, NSString *, NSString *) method
  Saves host credentials to the keychain.
• saveCredentials:forProxy:port:realm:(NSURLCredential *, NSString *, int, NSString *) method
  Saves proxy credentials to the keychain.
• saveCredentialsToKeychain:(NSDictionary *) method
  Saves credentials for this request to the keychain.
• savedCredentialsForHost:port:protocol:realm:(NSString *, int, NSString *, NSString *) method
  Returns host credentials from the keychain.
• savedCredentialsForProxy:port:protocol:realm:(NSString *, int, NSString *, NSString *) method
  Returns proxy credentials from the keychain.
• setChunkSize:(int) method
  
• setClientCertificateIdentity:(SecIdentityRef) method
  Sets the identity reference (X.509 certificate and private key) for this request. It is used for secure connections.
• setDefaultCache:(id< SDMCacheDelegate >) method
  Configures a default download cache which applies for all requests.
• setEtag:withMatchType:(NSString *, EtagMatchType) method
  Adds If-Match or If-None-Match or If-Range header.
• setMaxBandwidthPerSecond:(unsigned long) method
  Sets the maximum number of bytes all requests can send or receive in a second.
• setMaxConcurrentHTTPRequestCount:(const unsigned char) method
  Sets the maximum number of ODPRequest threads that can be executed at the same time.
• setMoOffset:(unsigned long) method
  
• setProtectionEnabled:(BOOL) method
  Controls whether the download cache should store files using protection.
• setShouldThrottleBandwidthForWWAN:(BOOL) method
  ODPRequest automatically turns throttling on and off as the connection type changes between WWAN and WiFi.
• setShouldUpdateNetworkActivityIndicator:(BOOL) method
  Controls whether the request should take over updating the network activity indicator.
• sharedQueue() method
  Returns the shared queue.
• showNetworkActivityIndicator() method
  Shows the network activity spinner.
• startAsynchronous() method
  Executes the request in the background.
• startSynchronous() method
  Executes a request synchronously, and returns control when the request completes or fails.
• startTrace() method
  If tracing is enabled, this method starts preparing BTX.
• stopTrace() method
  Disables the tracing (if enabled) and stops generating BTX.
• throttleBandwidthForWWANUsingLimit:(unsigned long) method
  Turns on throttling automatically when WWAN is connected using a custom limit.
• updateDownloadProgress() method
  Updates download progress (notifies the queue and/or downloadProgressDelegate of this request).
• updateProgressIndicator:withProgress:ofTotal:(id *, unsigned long long, unsigned long long) method
  Helper method for interacting with progress indicators to abstract the details of different APIS (NSProgressIndicator and UIProgressView).
• updateProgressIndicators() method
  Updates the progress delegates.
• updateUploadProgress() method
  Updates upload progress (notifies the queue and/or uploadProgressDelegate of this request).
• uploadTraceWithError:(NSError **) method