-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_n_i_operations_8h_source.html
193 lines (172 loc) · 14.3 KB
/
_n_i_operations_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
<!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/core/src/NIOperations.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.3 - <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('_n_i_operations_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">src/core/src/NIOperations.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">// Copyright 2011 Jeff Verkoeyen</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment">// you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment">// You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment">// See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment">// limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#import <Foundation/Foundation.h></span>
<a name="l00018"></a>00018 <span class="preprocessor">#import <UIKit/UIKit.h></span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#import "NIBlocks.h"</span>
<a name="l00021"></a>00021
<a name="l00033"></a>00033 <span class="keyword">@protocol </span><a class="code" href="protocol_n_i_operation_delegate-p.html" title="The delegate protocol for an NIOperation.">NIOperationDelegate</a>;
<a name="l00034"></a>00034
<a name="l00046"></a><a class="code" href="interface_n_i_operation.html">00046</a> <span class="keyword">@interface </span><a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a> : NSOperation
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="interface_n_i_operation.html#af4051a42c46f1ddb9d308daf9596c40d">00048</a> @property (readwrite, assign) id<<a class="code" href="protocol_n_i_operation_delegate-p.html" title="The delegate protocol for an NIOperation.">NIOperationDelegate</a>> <a class="code" href="interface_n_i_operation.html#af4051a42c46f1ddb9d308daf9596c40d" title="The delegate through which changes are notified for this operation.">delegate</a>;
<a name="l00049"></a><a class="code" href="interface_n_i_operation.html#ab16ac8d4ce97062b0d4545df15226c27">00049</a> @property (readonly, retain) NSError* lastError;
<a name="l00050"></a><a class="code" href="interface_n_i_operation.html#a9229f5fb6b21513181aed08ba7592ba6">00050</a> @property (readwrite, assign) NSInteger <a class="code" href="interface_n_i_operation.html#a9229f5fb6b21513181aed08ba7592ba6" title="A simple tagging mechanism for identifying operations.">tag</a>;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="preprocessor">#if NS_BLOCKS_AVAILABLE</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span>
<a name="l00054"></a><a class="code" href="interface_n_i_operation.html#aed06f75966016ce2da29d77740ce4ac5">00054</a> @property (readwrite, copy) NIBasicBlock <a class="code" href="interface_n_i_operation.html#aed06f75966016ce2da29d77740ce4ac5" title="The operation has started executing.">didStartBlock</a>;
<a name="l00055"></a><a class="code" href="interface_n_i_operation.html#af5538a8120694393733756e11b5752e5">00055</a> @property (readwrite, copy) NIBasicBlock <a class="code" href="interface_n_i_operation.html#af5538a8120694393733756e11b5752e5" title="The operation has completed successfully.">didFinishBlock</a>;
<a name="l00056"></a><a class="code" href="interface_n_i_operation.html#a1b39afe4f59c082cf04189a8763e6964">00056</a> @property (readwrite, copy) NIErrorBlock <a class="code" href="interface_n_i_operation.html#a1b39afe4f59c082cf04189a8763e6964" title="The operation failed in some way and has completed.">didFailWithErrorBlock</a>;
<a name="l00057"></a><a class="code" href="interface_n_i_operation.html#a14bfd44503230b2e7c9e57ea83f16fcf">00057</a> @property (readwrite, copy) NIBasicBlock <a class="code" href="interface_n_i_operation.html#a14bfd44503230b2e7c9e57ea83f16fcf" title="The operation is about to complete successfully.">willFinishBlock</a>;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="preprocessor">#endif // #if NS_BLOCKS_AVAILABLE</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span>
<a name="l00061"></a>00061 - (void)<a class="code" href="interface_n_i_operation.html#acf48122935cc81ddf40d978ab1862435" title="On the main thread, notify the delegate that the operation has begun.">didStart</a>;
<a name="l00062"></a>00062 - (void)<a class="code" href="interface_n_i_operation.html#a7d954123028a59aea877f5e2b4fdbae4" title="On the main thread, notify the delegate that the operation has finished.">didFinish</a>;
<a name="l00063"></a>00063 - (void)didFailWithError:(NSError *)error;
<a name="l00064"></a>00064 - (void)<a class="code" href="interface_n_i_operation.html#a386802f5f40d14a17847bcbc9c02e628" title="In the operation's thread, notify the delegate that the operation will finish successfully.">willFinish</a>;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">@end</span>
<a name="l00067"></a>00067
<a name="l00077"></a><a class="code" href="interface_n_i_network_request_operation.html">00077</a> <span class="keyword">@interface </span><a class="code" href="interface_n_i_network_request_operation.html" title="An operation that makes a network request.">NINetworkRequestOperation</a> : <a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a>
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// Designated initializer.</span>
<a name="l00080"></a>00080 - (id)initWithURL:(NSURL *)url;
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="interface_n_i_network_request_operation.html#a0c009df785e56c1d3624e835f38299bb">00082</a> <span class="keyword">@property</span> (readwrite, copy) NSURL* <a class="code" href="interface_n_i_network_request_operation.html#a0c009df785e56c1d3624e835f38299bb" title="The url that will be loaded in the network operation.">url</a>;
<a name="l00083"></a><a class="code" href="interface_n_i_network_request_operation.html#aa4bca4d57ffcac2986056815151b1a05">00083</a> <span class="keyword">@property</span> (readwrite, assign) NSTimeInterval <a class="code" href="interface_n_i_network_request_operation.html#aa4bca4d57ffcac2986056815151b1a05" title="The number of seconds that may pass before a request gives up and fails.">timeout</a>; <span class="comment">// Default: 60</span>
<a name="l00084"></a><a class="code" href="interface_n_i_network_request_operation.html#ada71db35a26b6a0bb007d4e92bfa3261">00084</a> <span class="keyword">@property</span> (readwrite, assign) NSURLRequestCachePolicy <a class="code" href="interface_n_i_network_request_operation.html#ada71db35a26b6a0bb007d4e92bfa3261" title="The request cache policy to use.">cachePolicy</a>; <span class="comment">// Default: NSURLRequestUseProtocolCachePolicy</span>
<a name="l00085"></a><a class="code" href="interface_n_i_network_request_operation.html#a3752c6c0fc4db423b6128728a9f0be60">00085</a> <span class="keyword">@property</span> (readonly, retain) <a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a>* data;
<a name="l00086"></a><a class="code" href="interface_n_i_network_request_operation.html#a96e82ef25c81b771c0d46449ae333ccf">00086</a> <span class="keyword">@property</span> (readwrite, retain) <span class="keywordtype">id</span> <a class="code" href="interface_n_i_network_request_operation.html#a96e82ef25c81b771c0d46449ae333ccf" title="An object created from the data that was fetched.">processedObject</a>;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">@end</span>
<a name="l00089"></a>00089
<a name="l00095"></a><a class="code" href="protocol_n_i_operation_delegate-p.html">00095</a> <span class="keyword">@protocol </span><a class="code" href="protocol_n_i_operation_delegate-p.html" title="The delegate protocol for an NIOperation.">NIOperationDelegate</a> <NSObject>
<a name="l00096"></a>00096 <span class="keyword">@optional</span>
<a name="l00097"></a>00097
<a name="l00101"></a>00101 - (void)nimbusOperationDidStart:(<a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a> *)operation;
<a name="l00102"></a>00102
<a name="l00110"></a>00110 - (void)nimbusOperationWillFinish:(<a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a> *)operation;
<a name="l00111"></a>00111
<a name="l00117"></a>00117 - (void)nimbusOperationDidFinish:(<a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a> *)operation;
<a name="l00118"></a>00118
<a name="l00124"></a>00124 - (void)nimbusOperationDidFail:(<a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a> *)operation withError:(NSError *)error;
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">@end</span>
<a name="l00127"></a>00127
<a name="l00128"></a>00128
<a name="l00130"></a>00130 <span class="comment">// NIOperation</span>
<a name="l00131"></a>00131
<a name="l00161"></a>00161 <span class="preprocessor">#if NS_BLOCKS_AVAILABLE</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span>
<a name="l00201"></a>00201 <span class="preprocessor">#endif // #if NS_BLOCKS_AVAILABLE</span>
<a name="l00202"></a>00202 <span class="preprocessor"></span>
<a name="l00203"></a>00203
<a name="l00236"></a>00236 <span class="comment">// NINetworkRequestOperation</span>
<a name="l00237"></a>00237
</pre></div><div id="disqus_thread"></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>NIOperations.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>