// AVHTTPRequestOperation.h // // Copyright (c) 2011 Gowalla (http://gowalla.com/) // // 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 #import "AVURLConnectionOperation.h" /** `AVHTTPRequestOperation` is a subclass of `AVURLConnectionOperation` for requests using the HTTP or HTTPS protocols. It encapsulates the concept of acceptable status codes and content types, which determine the success or failure of a request. */ @interface AVHTTPRequestOperation : AVURLConnectionOperation ///---------------------------------------------- /// @name Getting HTTP URL Connection Information ///---------------------------------------------- /** The last HTTP response received by the operation's connection. */ @property (readonly, nonatomic, strong) NSHTTPURLResponse *response; ///---------------------------------------------------------- /// @name Managing And Checking For Acceptable HTTP Responses ///---------------------------------------------------------- /** A Boolean value that corresponds to whether the status code of the response is within the specified set of acceptable status codes. Returns `YES` if `acceptableStatusCodes` is `nil`. */ @property (nonatomic, readonly) BOOL hasAcceptableStatusCode; /** A Boolean value that corresponds to whether the MIME type of the response is among the specified set of acceptable content types. Returns `YES` if `acceptableContentTypes` is `nil`. */ @property (nonatomic, readonly) BOOL hasAcceptableContentType; /** The callback dispatch queue on success. If `NULL` (default), the main queue is used. */ @property (nonatomic, assign) dispatch_queue_t successCallbackQueue; /** The callback dispatch queue on failure. If `NULL` (default), the main queue is used. */ @property (nonatomic, assign) dispatch_queue_t failureCallbackQueue; ///------------------------------------------------------------ /// @name Managing Acceptable HTTP Status Codes & Content Types ///------------------------------------------------------------ /** Returns an `NSIndexSet` object containing the ranges of acceptable HTTP status codes. When non-`nil`, the operation will set the `error` property to an error in `AVErrorDomain`. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html By default, this is the range 200 to 299, inclusive. */ + (NSIndexSet *)acceptableStatusCodes; /** Adds status codes to the set of acceptable HTTP status codes returned by `+acceptableStatusCodes` in subsequent calls by this class and its descendants. @param statusCodes The status codes to be added to the set of acceptable HTTP status codes */ + (void)addAcceptableStatusCodes:(NSIndexSet *)statusCodes; /** Returns an `NSSet` object containing the acceptable MIME types. When non-`nil`, the operation will set the `error` property to an error in `AVErrorDomain`. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 By default, this is `nil`. */ + (NSSet *)acceptableContentTypes; /** Adds content types to the set of acceptable MIME types returned by `+acceptableContentTypes` in subsequent calls by this class and its descendants. @param contentTypes The content types to be added to the set of acceptable MIME types */ + (void)addAcceptableContentTypes:(NSSet *)contentTypes; ///----------------------------------------------------- /// @name Determining Whether A Request Can Be Processed ///----------------------------------------------------- /** A Boolean value determining whether or not the class can process the specified request. For example, `AVJSONRequestOperation` may check to make sure the content type was `application/json` or the URL path extension was `.json`. @param urlRequest The request that is determined to be supported or not supported for this class. */ + (BOOL)canProcessRequest:(NSURLRequest *)urlRequest; ///----------------------------------------------------------- /// @name Setting Completion Block Success / Failure Callbacks ///----------------------------------------------------------- /** Sets the `completionBlock` property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If `error` returns a value, which can be caused by an unacceptable status code or content type, then `failure` is executed. Otherwise, `success` is executed. @param success The block to be executed on the completion of a successful request. This block has no return value and takes two arguments: the receiver operation and the object constructed from the response data of the request. @param failure The block to be executed on the completion of an unsuccessful request. This block has no return value and takes two arguments: the receiver operation and the error that occurred during the request. @discussion This method should be overridden in subclasses in order to specify the response object passed into the success block. */ - (void)setCompletionBlockWithSuccess:(void (^)(AVHTTPRequestOperation *operation, id responseObject))success failure:(void (^)(AVHTTPRequestOperation *operation, NSError *error))failure; @end ///---------------- /// @name Functions ///---------------- /** Returns a set of MIME types detected in an HTTP `Accept` or `Content-Type` header. */ extern NSSet * AVContentTypesFromHTTPHeader(NSString *string);