This repository has been archived by the owner on May 24, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
interface_n_i_operation.html
339 lines (287 loc) · 15.7 KB
/
interface_n_i_operation.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!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: NIOperation Class Reference</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.2 - <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('interface_n_i_operation.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">NIOperation Class Reference<div class="ingroups"><a class="el" href="group___operations.html">Operations</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="NIOperation" --><hr/><a name="details" id="details"></a><h2>Overview</h2>
<div class="textblock"><p>A base implementation of an NSOperation that supports traditional delegation and blocks. </p>
<h2>Subclassing</h2>
<p>A subclass should call the operationDid* methods to notify the delegate on the main thread of changes in the operation's state. Calling these methods will notify the delegate and the blocks if provided. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00046">46</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div><div class="dynheader">
Inheritance diagram for NIOperation:</div>
<div class="dyncontent">
<div class="center">
<img src="interface_n_i_operation.png" usemap="#NIOperation_map" alt=""/>
<map id="NIOperation_map" name="NIOperation_map">
<area href="interface_n_i_network_request_operation.html" title="An operation that makes a network request." alt="NINetworkRequestOperation" shape="rect" coords="180,56,350,80"/>
<area href="interface_n_i_network_image_request.html" title="A threaded network request for an image that chops up and resizes the image before returning to the U..." alt="NINetworkImageRequest" shape="rect" coords="0,112,170,136"/>
<area href="interface_n_i_network_j_s_o_n_request.html" title="A processor that uses JSONKit to turn the JSON response into objects." alt="NINetworkJSONRequest" shape="rect" coords="180,112,350,136"/>
<area href="interface_n_i_network_j_s_o_n_request.html" title="A processor that uses JSONKit to turn the JSON response into objects." alt="NINetworkJSONRequest" shape="rect" coords="360,112,530,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Delegation</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">id< <a class="el" href="protocol_n_i_operation_delegate-p.html">NIOperationDelegate</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#af4051a42c46f1ddb9d308daf9596c40d">delegate</a> <span class="suffix">property</span></td></tr>
<tr><td colspan="2"><div class="groupHeader">Post-Operation Properties</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NSError * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#ab16ac8d4ce97062b0d4545df15226c27">lastError</a> <span class="suffix">property</span></td></tr>
<tr><td colspan="2"><div class="groupHeader">Identification</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NSInteger </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#a9229f5fb6b21513181aed08ba7592ba6">tag</a> <span class="suffix">property</span></td></tr>
<tr><td colspan="2"><div class="groupHeader">Blocks</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NIBasicBlock </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#aed06f75966016ce2da29d77740ce4ac5">didStartBlock</a> <span class="suffix">property</span></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NIBasicBlock </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#af5538a8120694393733756e11b5752e5">didFinishBlock</a> <span class="suffix">property</span></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NIErrorBlock </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#a1b39afe4f59c082cf04189a8763e6964">didFailWithErrorBlock</a> <span class="suffix">property</span></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">NIBasicBlock </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_operation.html#a14bfd44503230b2e7c9e57ea83f16fcf">willFinishBlock</a> <span class="suffix">property</span></td></tr>
<tr><td colspan="2"><div class="groupHeader">Subclassing</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The following methods are provided to aid in subclassing and are not meant to be used externally. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_i_operation.html#a8c484d9ee1a76ea72b0d3afc0782f8fc">operationDidStart</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_i_operation.html#aa348248e667a2f1021f6451cb7cbbc0f">operationDidFinish</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_i_operation.html#ac7e636b6ec59af66fc5964c7b30a2930">operationWillFinish</a></td></tr>
</table>
<hr/><h2>Method Documentation</h2>
<a class="anchor" id="af4051a42c46f1ddb9d308daf9596c40d"></a><!-- doxytag: member="NIOperation::delegate" ref="af4051a42c46f1ddb9d308daf9596c40d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The delegate through which changes are notified for this operation. </p>
<p>All delegate methods are performed on the main thread. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00065">65</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab16ac8d4ce97062b0d4545df15226c27"></a><!-- doxytag: member="NIOperation::lastError" ref="ab16ac8d4ce97062b0d4545df15226c27" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, retain]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The error last passed to the didFailWithError notification. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00066">66</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9229f5fb6b21513181aed08ba7592ba6"></a><!-- doxytag: member="NIOperation::tag" ref="a9229f5fb6b21513181aed08ba7592ba6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A simple tagging mechanism for identifying operations. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00067">67</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="aed06f75966016ce2da29d77740ce4ac5"></a><!-- doxytag: member="NIOperation::didStartBlock" ref="aed06f75966016ce2da29d77740ce4ac5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, write, copy]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The operation has started executing. </p>
<p>Performed on the main thread. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00072">72</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="af5538a8120694393733756e11b5752e5"></a><!-- doxytag: member="NIOperation::didFinishBlock" ref="af5538a8120694393733756e11b5752e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, write, copy]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The operation has completed successfully. </p>
<p>This will not be called if the operation fails.</p>
<p>Performed on the main thread. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00073">73</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1b39afe4f59c082cf04189a8763e6964"></a><!-- doxytag: member="NIOperation::didFailWithErrorBlock" ref="a1b39afe4f59c082cf04189a8763e6964" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, write, copy]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The operation failed in some way and has completed. </p>
<p>didFinishBlock will not be executed.</p>
<p>Performed on the main thread. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00074">74</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="a14bfd44503230b2e7c9e57ea83f16fcf"></a><!-- doxytag: member="NIOperation::willFinishBlock" ref="a14bfd44503230b2e7c9e57ea83f16fcf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- NIOperation:<code> [read, write, copy]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The operation is about to complete successfully. </p>
<p>This will not be called if the operation fails.</p>
<p>Performed in the operation's thread. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8h_source.html#l00075">75</a> of file <a class="el" href="_n_i_operations_8h_source.html">NIOperations.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8c484d9ee1a76ea72b0d3afc0782f8fc"></a><!-- doxytag: member="NIOperation::operationDidStart" ref="a8c484d9ee1a76ea72b0d3afc0782f8fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) operationDidStart </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>On the main thread, notify the delegate that the operation has begun. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8m_source.html#l00163">163</a> of file <a class="el" href="_n_i_operations_8m_source.html">NIOperations.m</a>.</p>
</div>
</div>
<a class="anchor" id="aa348248e667a2f1021f6451cb7cbbc0f"></a><!-- doxytag: member="NIOperation::operationDidFinish" ref="aa348248e667a2f1021f6451cb7cbbc0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) operationDidFinish </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>On the main thread, notify the delegate that the operation has finished. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8m_source.html#l00171">171</a> of file <a class="el" href="_n_i_operations_8m_source.html">NIOperations.m</a>.</p>
</div>
</div>
<a class="anchor" id="ac7e636b6ec59af66fc5964c7b30a2930"></a><!-- doxytag: member="NIOperation::operationWillFinish" ref="ac7e636b6ec59af66fc5964c7b30a2930" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) operationWillFinish </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>In the operation's thread, notify the delegate that the operation will finish successfully. </p>
<p>Definition at line <a class="el" href="_n_i_operations_8m_source.html#l00189">189</a> of file <a class="el" href="_n_i_operations_8m_source.html">NIOperations.m</a>.</p>
</div>
</div>
<div id="disqus_thread"></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="interface_n_i_operation.html">NIOperation</a> </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>