forked from jverkoey/nimbus
/
interface_nimbus.html
199 lines (168 loc) · 8.67 KB
/
interface_nimbus.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
<!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: Nimbus 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.6.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('interface_nimbus.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Nimbus Class Reference<div class="ingroups"><a class="el" href="group___core-_state.html">State</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Nimbus" --><hr/><a name="details" id="details"></a><h2>Overview</h2>
<div class="textblock"><p>The <a class="el" href="interface_nimbus.html" title="The Nimbus state interface.">Nimbus</a> state interface. </p>
<p>Definition at line <a class="el" href="_n_i_state_8h_source.html#l00038">38</a> of file <a class="el" href="_n_i_state_8h_source.html">NIState.h</a>.</p>
</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">Accessing Global State</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_n_i_image_memory_cache.html">NIImageMemoryCache</a> *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_nimbus.html#a3c0417e0cf4a64e6d8004346fc744ce3">imageMemoryCache</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(NSOperationQueue *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_nimbus.html#a1b76dec78c8c30a174aaea7a6f859b8e">networkOperationQueue</a></td></tr>
<tr><td colspan="2"><div class="groupHeader">Modifying Global State</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_nimbus.html#a342e309249ac5309fb6feb238da6630e">setImageMemoryCache:</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_nimbus.html#ae74df4b59708c91c251273369a3c4caf">setNetworkOperationQueue:</a></td></tr>
</table>
<hr/><h2>Method Documentation</h2>
<a class="anchor" id="a3c0417e0cf4a64e6d8004346fc744ce3"></a><!-- doxytag: member="Nimbus::imageMemoryCache" ref="a3c0417e0cf4a64e6d8004346fc744ce3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="interface_n_i_image_memory_cache.html">NIImageMemoryCache</a> *) imageMemoryCache </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access the global image memory cache. </p>
<p>If a cache hasn't been assigned via Nimbus::setGlobalImageMemoryCache: then one will be created automatically.</p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>The default image cache has no upper limit on its memory consumption. It is up to you to specify an upper limit in your application. </dd></dl>
<p>Definition at line <a class="el" href="_n_i_state_8m_source.html#l00041">41</a> of file <a class="el" href="_n_i_state_8m_source.html">NIState.m</a>.</p>
</div>
</div>
<a class="anchor" id="a1b76dec78c8c30a174aaea7a6f859b8e"></a><!-- doxytag: member="Nimbus::networkOperationQueue" ref="a1b76dec78c8c30a174aaea7a6f859b8e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (NSOperationQueue *) networkOperationQueue </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access the global network operation queue. </p>
<p>The global network operation queue exists to be used for asynchronous network requests if you choose. By defining a global operation queue in the core of <a class="el" href="interface_nimbus.html" title="The Nimbus state interface.">Nimbus</a>, we can ensure that all libraries that depend on core will use the same network operation queue unless configured otherwise.</p>
<p>If an operation queue hasn't been assigned via Nimbus::setGlobalNetworkOperationQueue: then one will be created automatically with the default iOS settings. </p>
<p>Definition at line <a class="el" href="_n_i_state_8m_source.html#l00059">59</a> of file <a class="el" href="_n_i_state_8m_source.html">NIState.m</a>.</p>
</div>
</div>
<a class="anchor" id="a342e309249ac5309fb6feb238da6630e"></a><!-- doxytag: member="Nimbus::setImageMemoryCache:" ref="a342e309249ac5309fb6feb238da6630e" args="(NIImageMemoryCache *imageMemoryCache)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (void) setImageMemoryCache: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_n_i_image_memory_cache.html">NIImageMemoryCache</a> *) </td>
<td class="paramname"><em>imageMemoryCache</em></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the global image memory cache. </p>
<p>The cache will be retained and the old cache released. </p>
<p>Definition at line <a class="el" href="_n_i_state_8m_source.html#l00032">32</a> of file <a class="el" href="_n_i_state_8m_source.html">NIState.m</a>.</p>
</div>
</div>
<a class="anchor" id="ae74df4b59708c91c251273369a3c4caf"></a><!-- doxytag: member="Nimbus::setNetworkOperationQueue:" ref="ae74df4b59708c91c251273369a3c4caf" args="(NSOperationQueue *queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (void) setNetworkOperationQueue: </td>
<td></td>
<td class="paramtype">(NSOperationQueue *) </td>
<td class="paramname"><em>queue</em></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the global network operation queue. </p>
<p>The queue will be retained and the old queue released. </p>
<p>Definition at line <a class="el" href="_n_i_state_8m_source.html#l00050">50</a> of file <a class="el" href="_n_i_state_8m_source.html">NIState.m</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="interface_nimbus.html">Nimbus</a> </li>
</div><!-- .fixedwidth -->
<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>