forked from jverkoey/nimbus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_a_s_i_network_queue_8h_source.html
220 lines (199 loc) · 14.4 KB
/
_a_s_i_network_queue_8h_source.html
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Nimbus: src/ASIHTTPRequest/src/ASINetworkQueue.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="page">
<div style="position:relative">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<a style="float: right;margin-right:20px;margin-top:20px" href='http://www.pledgie.com/campaigns/15519'><img alt='Click here to support Nimbus development and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/15519.png?skin_name=chrome' border='0' /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nimbus
 <span id="projectnumber">0.9.0 - <a href="http://github.com/jverkoey/nimbus">Nimbus is proudly hosted on Github</a></span>
</div>
<div id="projectbrief">An iOS framework whose growth is bounded by O(documentation).</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4-20110629 -->
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_a_s_i_network_queue_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">src/ASIHTTPRequest/src/ASINetworkQueue.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// ASINetworkQueue.h</span>
<a name="l00003"></a>00003 <span class="comment">// Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// Created by Ben Copsey on 07/11/2008.</span>
<a name="l00006"></a>00006 <span class="comment">// Copyright 2008-2009 All-Seeing Interactive. All rights reserved.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#import <Foundation/Foundation.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#import "ASIHTTPRequestDelegate.h"</span>
<a name="l00011"></a>00011 <span class="preprocessor">#import "ASIProgressDelegate.h"</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="keyword">@interface </span>ASINetworkQueue : NSOperationQueue <ASIProgressDelegate, ASIHTTPRequestDelegate, NSCopying> {
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <span class="comment">// Delegate will get didFail + didFinish messages (if set)</span>
<a name="l00016"></a>00016 <span class="keywordtype">id</span> delegate;
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">// Will be called when a request starts with the request as the argument</span>
<a name="l00019"></a>00019 <span class="keywordtype">SEL</span> requestDidStartSelector;
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">// Will be called when a request receives response headers</span>
<a name="l00022"></a>00022 <span class="comment">// Should take the form request:didRecieveResponseHeaders:, where the first argument is the request, and the second the headers dictionary</span>
<a name="l00023"></a>00023 <span class="keywordtype">SEL</span> requestDidReceiveResponseHeadersSelector;
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// Will be called when a request is about to redirect</span>
<a name="l00026"></a>00026 <span class="comment">// Should take the form request:willRedirectToURL:, where the first argument is the request, and the second the new url</span>
<a name="l00027"></a>00027 <span class="keywordtype">SEL</span> requestWillRedirectSelector;
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// Will be called when a request completes with the request as the argument</span>
<a name="l00030"></a>00030 <span class="keywordtype">SEL</span> requestDidFinishSelector;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">// Will be called when a request fails with the request as the argument</span>
<a name="l00033"></a>00033 <span class="keywordtype">SEL</span> requestDidFailSelector;
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// Will be called when the queue finishes with the queue as the argument</span>
<a name="l00036"></a>00036 <span class="keywordtype">SEL</span> queueDidFinishSelector;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">// Upload progress indicator, probably an NSProgressIndicator or UIProgressView</span>
<a name="l00039"></a>00039 <span class="keywordtype">id</span> uploadProgressDelegate;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">// Total amount uploaded so far for all requests in this queue</span>
<a name="l00042"></a>00042 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> bytesUploadedSoFar;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">// Total amount to be uploaded for all requests in this queue - requests add to this figure as they work out how much data they have to transmit</span>
<a name="l00045"></a>00045 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> totalBytesToUpload;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">// Download progress indicator, probably an NSProgressIndicator or UIProgressView</span>
<a name="l00048"></a>00048 <span class="keywordtype">id</span> downloadProgressDelegate;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">// Total amount downloaded so far for all requests in this queue</span>
<a name="l00051"></a>00051 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> bytesDownloadedSoFar;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">// Total amount to be downloaded for all requests in this queue - requests add to this figure as they receive Content-Length headers</span>
<a name="l00054"></a>00054 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> totalBytesToDownload;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">// When YES, the queue will cancel all requests when a request fails. Default is YES</span>
<a name="l00057"></a>00057 BOOL shouldCancelAllRequestsOnFailure;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">//Number of real requests (excludes HEAD requests created to manage showAccurateProgress)</span>
<a name="l00060"></a>00060 <span class="keywordtype">int</span> requestsCount;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">// When NO, this request will only update the progress indicator when it completes</span>
<a name="l00063"></a>00063 <span class="comment">// When YES, this request will update the progress indicator according to how much data it has received so far</span>
<a name="l00064"></a>00064 <span class="comment">// When YES, the queue will first perform HEAD requests for all GET requests in the queue, so it can calculate the total download size before it starts</span>
<a name="l00065"></a>00065 <span class="comment">// NO means better performance, because it skips this step for GET requests, and it won't waste time updating the progress indicator until a request completes </span>
<a name="l00066"></a>00066 <span class="comment">// Set to YES if the size of a requests in the queue varies greatly for much more accurate results</span>
<a name="l00067"></a>00067 <span class="comment">// Default for requests in the queue is NO</span>
<a name="l00068"></a>00068 BOOL showAccurateProgress;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">// Storage container for additional queue information.</span>
<a name="l00071"></a>00071 NSDictionary *userInfo;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Convenience constructor</span>
<a name="l00076"></a>00076 + (id)queue;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">// Call this to reset a queue - it will cancel all operations, clear delegates, and suspend operation</span>
<a name="l00079"></a>00079 - (void)reset;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="comment">// Used internally to manage HEAD requests when showAccurateProgress is YES, do not use!</span>
<a name="l00082"></a>00082 - (void)addHEADOperation:(NSOperation *)operation;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">// All ASINetworkQueues are paused when created so that total size can be calculated before the queue starts</span>
<a name="l00085"></a>00085 <span class="comment">// This method will start the queue</span>
<a name="l00086"></a>00086 - (void)go;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">@property</span> (assign, nonatomic, setter=setUploadProgressDelegate:) <span class="keywordtype">id</span> uploadProgressDelegate;
<a name="l00089"></a>00089 <span class="keyword">@property</span> (assign, nonatomic, setter=setDownloadProgressDelegate:) <span class="keywordtype">id</span> downloadProgressDelegate;
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">@property</span> (assign) <span class="keywordtype">SEL</span> requestDidStartSelector;
<a name="l00092"></a>00092 <span class="keyword">@property</span> (assign) <span class="keywordtype">SEL</span> requestDidReceiveResponseHeadersSelector;
<a name="l00093"></a>00093 <span class="keyword">@property</span> (assign) <span class="keywordtype">SEL</span> requestWillRedirectSelector;
<a name="l00094"></a>00094 <span class="keyword">@property</span> (assign) <span class="keywordtype">SEL</span> requestDidFinishSelector;
<a name="l00095"></a>00095 <span class="keyword">@property</span> (assign) <span class="keywordtype">SEL</span> requestDidFailSelector;
<a name="l00096"></a>00096 <span class="keyword">@property</span> (assign) <span class="keywordtype">SEL</span> queueDidFinishSelector;
<a name="l00097"></a>00097 <span class="keyword">@property</span> (assign) BOOL shouldCancelAllRequestsOnFailure;
<a name="l00098"></a>00098 <span class="keyword">@property</span> (assign) <span class="keywordtype">id</span> delegate;
<a name="l00099"></a>00099 <span class="keyword">@property</span> (assign) BOOL showAccurateProgress;
<a name="l00100"></a>00100 <span class="keyword">@property</span> (assign, readonly) <span class="keywordtype">int</span> requestsCount;
<a name="l00101"></a>00101 <span class="keyword">@property</span> (retain) NSDictionary *userInfo;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">@property</span> (assign) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> bytesUploadedSoFar;
<a name="l00104"></a>00104 <span class="keyword">@property</span> (assign) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> totalBytesToUpload;
<a name="l00105"></a>00105 <span class="keyword">@property</span> (assign) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> bytesDownloadedSoFar;
<a name="l00106"></a>00106 <span class="keyword">@property</span> (assign) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> totalBytesToDownload;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">@end</span>
</pre></div><div id="disqus_thread"></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ASINetworkQueue.h</b> </li>
</div><!-- .fixedwidth -->
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'nimbusdocumentation'; // required: replace example with your forum shortname
// The following are highly recommended additional parameters. Remove the slashes in front to use.
// var disqus_identifier = 'unique_dynamic_id_1234';
// var disqus_url = 'http://example.com/permalink-to-page.html';
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<span class="footer">Generated for Nimbus by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4-20110629 </span>
</ul>
</div>
</div> <!-- page -->
</body>
</html>