forked from nfarina/webrequest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SMWebRequest.h
131 lines (104 loc) · 5.76 KB
/
SMWebRequest.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
The MIT License
Copyright (c) 2010 Nick Farina
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.
*/
// SMWebRequest encapsulates a single HTTP request and response. It is designed to be less verbose
// and simpler to use than NSURLConnection. The server response is buffered completely into memory
// then passed back to event listeners as NSData. Optionally, you can specify a delegate which
// can process the NSData in some way on a background thread then return something else.
// While the SMWebRequest's internal connection to the server is open, it will retain itself.
// This means you can create an autoreleased SMWebRequest without retaining it and subscribe
// to its events for a quick and dirty (non-cancellable) request.
// Please note that this means you MUST remove any event listeners before releasing
// your SMWebRequest! Otherwise the request may still be alive and will attempt to execute
// events on your object (which may be dealloc'd at this point).
enum {
SMWebRequestEventComplete = 1 << 0, // selector will be passed the result pointer
SMWebRequestEventError = 1 << 1, // selector will be passed a pointer to NSError instance
SMWebRequestEventAllEvents = 0xFFFFFFFF
};
typedef NSUInteger SMWebRequestEvents;
@protocol SMWebRequestDelegate;
@interface SMWebRequest : NSObject
#if __IPHONE_OS_VERSION_MAX_ALLOWED <= __IPHONE_4_3
<NSURLConnectionDelegate>
#else
<NSURLConnectionDataDelegate>
#endif
{
id<SMWebRequestDelegate> delegate; // not retained
id context;
NSMutableArray *targetActions;
NSURLConnection *connection;
NSMutableURLRequest *request;
NSURLResponse *response;
NSMutableData *data;
struct {
unsigned int started:1;
unsigned int cancelled:1;
unsigned int wasTemporarilyRedirected:1;
} requestFlags;
}
@property (nonatomic, readonly) BOOL started;
@property (nonatomic, readonly, retain) id context;
@property (nonatomic, readonly, retain) NSMutableURLRequest *request;
@property (nonatomic, readonly, retain) NSURLResponse *response;
// Designated initializer.
- (id)initWithURLRequest:(NSMutableURLRequest *)request delegate:(id<SMWebRequestDelegate>)delegate context:(id)context;
// Convenience creators.
+ (SMWebRequest *)requestWithURL:(NSURL *)url;
+ (SMWebRequest *)requestWithURL:(NSURL *)url delegate:(id<SMWebRequestDelegate>)delegate context:(id)context;
+ (SMWebRequest *)requestWithURLRequest:(NSMutableURLRequest *)request delegate:(id<SMWebRequestDelegate>)delegate context:(id)context;
- (void)start;
- (void)cancel;
- (void)setHTTPMethod:(NSString *)method;
- (void)setHTTPBody:(NSMutableData *)data;
- (void)setContentType:(NSString *)contentType;
// register interest. does not retain target. action can take one or two arguments;
// first is the result object returned by the delegate, second is the context.
- (void)addTarget:(id)target action:(SEL)action forRequestEvents:(SMWebRequestEvents)event;
// pass in NULL for the action to remove all actions for that target.
// if there are no more target/actions, loading/processing will be cancelled.
- (void)removeTarget:(id)target action:(SEL)action forRequestEvents:(SMWebRequestEvents)event;
- (void)removeTarget:(id)target; // all actions+events
@end
@protocol SMWebRequestDelegate <NSObject>
@optional
// called on the main thread if applicable, behaves just like NSURLConnection.
- (NSMutableURLRequest *)webRequest:(SMWebRequest *)webRequest willSendRequest:(NSMutableURLRequest *)newRequest redirectResponse:(NSURLResponse *)redirectResponse;
// called on a background thread and result will be passed to the targets,
// otherwise if the delegate is nil the data will be passed to the targets.
- (id)webRequest:(SMWebRequest *)webRequest resultObjectForData:(NSData *)data context:(id)context;
// both of these are called on the main thread, BEFORE the target/action listeners are called
- (void)webRequest:(SMWebRequest *)webRequest didCompleteWithResult:(id)result context:(id)context;
- (void)webRequest:(SMWebRequest *)webRequest didFailWithError:(NSError *)error context:(id)context;
@end
// Global NSNotifications you can hook into to be notified of request completions and errors.
extern NSString *const kSMWebRequestComplete, *const kSMWebRequestError;
// For NSErrors generated by SMWebRequest, you can use this key to retrieve the HTTP response plus the
// raw response data from the server (if any), which may contain useful information about the error.
extern NSString *const SMErrorResponseKey; // SMErrorResponse
// Special wrapper class for passing back information about a response+data inside an NSError.
// always associated with SMErrorResponseKey.
@interface SMErrorResponse : NSObject {
NSHTTPURLResponse *response;
NSData *data;
}
@property (nonatomic, retain) NSHTTPURLResponse *response;
@property (nonatomic, retain) NSData *data;
@end