classhueplusplus_1_1_a_p_i_cache.html
23.2 KB
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::APICache Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">hueplusplus
 <span id="projectnumber">1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhueplusplus_1_1_a_p_i_cache-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::APICache Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Caches API GET requests and refreshes regularly.
<a href="classhueplusplus_1_1_a_p_i_cache.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_a_p_i_cache_8h_source.html">hueplusplus/APICache.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab4657a168d72e1f2c344ef1f2f44647c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#ab4657a168d72e1f2c344ef1f2f44647c">APICache</a> (std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > baseCache, const std::string &subEntry, std::chrono::steady_clock::duration <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#a712df81284602eb43afae322f8d43e7b">refresh</a>)</td></tr>
<tr class="memdesc:ab4657a168d72e1f2c344ef1f2f44647c"><td class="mdescLeft"> </td><td class="mdescRight">Constructs <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html" title="Caches API GET requests and refreshes regularly. ">APICache</a> which forwards to a base cache. <a href="#ab4657a168d72e1f2c344ef1f2f44647c">More...</a><br /></td></tr>
<tr class="separator:ab4657a168d72e1f2c344ef1f2f44647c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2c4e98ff7510eb216316c927e18a772"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#ae2c4e98ff7510eb216316c927e18a772">APICache</a> (const std::string &path, const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> &commands, std::chrono::steady_clock::duration <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#a712df81284602eb43afae322f8d43e7b">refresh</a>, const nlohmann::json &initial)</td></tr>
<tr class="memdesc:ae2c4e98ff7510eb216316c927e18a772"><td class="mdescLeft"> </td><td class="mdescRight">Constructs <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html" title="Caches API GET requests and refreshes regularly. ">APICache</a> with an own internal json cache. <a href="#ae2c4e98ff7510eb216316c927e18a772">More...</a><br /></td></tr>
<tr class="separator:ae2c4e98ff7510eb216316c927e18a772"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a712df81284602eb43afae322f8d43e7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#a712df81284602eb43afae322f8d43e7b">refresh</a> ()</td></tr>
<tr class="memdesc:a712df81284602eb43afae322f8d43e7b"><td class="mdescLeft"> </td><td class="mdescRight">Refresh cache now. <a href="#a712df81284602eb43afae322f8d43e7b">More...</a><br /></td></tr>
<tr class="separator:a712df81284602eb43afae322f8d43e7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afeededdbb81e3c668b2b983c3d29ee0d"><td class="memItemLeft" align="right" valign="top">nlohmann::json & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#afeededdbb81e3c668b2b983c3d29ee0d">getValue</a> ()</td></tr>
<tr class="memdesc:afeededdbb81e3c668b2b983c3d29ee0d"><td class="mdescLeft"> </td><td class="mdescRight">Get cached value, refresh if necessary. <a href="#afeededdbb81e3c668b2b983c3d29ee0d">More...</a><br /></td></tr>
<tr class="separator:afeededdbb81e3c668b2b983c3d29ee0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1e0c41745a569f7ef420bd6acd5ecc1"><td class="memItemLeft" align="right" valign="top">const nlohmann::json & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#aa1e0c41745a569f7ef420bd6acd5ecc1">getValue</a> () const</td></tr>
<tr class="memdesc:aa1e0c41745a569f7ef420bd6acd5ecc1"><td class="mdescLeft"> </td><td class="mdescRight">Get cached value, does not refresh. <a href="#aa1e0c41745a569f7ef420bd6acd5ecc1">More...</a><br /></td></tr>
<tr class="separator:aa1e0c41745a569f7ef420bd6acd5ecc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25233da7881b9046555164bcf44b0f85"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#a25233da7881b9046555164bcf44b0f85">setRefreshDuration</a> (std::chrono::steady_clock::duration refreshDuration)</td></tr>
<tr class="memdesc:a25233da7881b9046555164bcf44b0f85"><td class="mdescLeft"> </td><td class="mdescRight">Set duration after which the cache is refreshed. <a href="#a25233da7881b9046555164bcf44b0f85">More...</a><br /></td></tr>
<tr class="separator:a25233da7881b9046555164bcf44b0f85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f924bf1a6341b11f68f020472041548"><td class="memItemLeft" align="right" valign="top">std::chrono::steady_clock::duration </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#a0f924bf1a6341b11f68f020472041548">getRefreshDuration</a> () const</td></tr>
<tr class="memdesc:a0f924bf1a6341b11f68f020472041548"><td class="mdescLeft"> </td><td class="mdescRight">Get duration between refreshes. <a href="#a0f924bf1a6341b11f68f020472041548">More...</a><br /></td></tr>
<tr class="separator:a0f924bf1a6341b11f68f020472041548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbbe9068d0b6e8e3b600091c51123464"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#afbbe9068d0b6e8e3b600091c51123464">getCommandAPI</a> ()</td></tr>
<tr class="memdesc:afbbe9068d0b6e8e3b600091c51123464"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> used for requests. <a href="#afbbe9068d0b6e8e3b600091c51123464">More...</a><br /></td></tr>
<tr class="separator:afbbe9068d0b6e8e3b600091c51123464"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa68d56e9779ef00d8d7f7e96eb2a370"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#afa68d56e9779ef00d8d7f7e96eb2a370">getCommandAPI</a> () const</td></tr>
<tr class="memdesc:afa68d56e9779ef00d8d7f7e96eb2a370"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> used for requests. <a href="#afa68d56e9779ef00d8d7f7e96eb2a370">More...</a><br /></td></tr>
<tr class="separator:afa68d56e9779ef00d8d7f7e96eb2a370"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7bfbec1c32e236c2878a3368f8767cb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#ab7bfbec1c32e236c2878a3368f8767cb">getRequestPath</a> () const</td></tr>
<tr class="memdesc:ab7bfbec1c32e236c2878a3368f8767cb"><td class="mdescLeft"> </td><td class="mdescRight">Get path the cache is refreshed from. <a href="#ab7bfbec1c32e236c2878a3368f8767cb">More...</a><br /></td></tr>
<tr class="separator:ab7bfbec1c32e236c2878a3368f8767cb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Caches API GET requests and refreshes regularly. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab4657a168d72e1f2c344ef1f2f44647c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4657a168d72e1f2c344ef1f2f44647c">◆ </a></span>APICache() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::APICache::APICache </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > </td>
<td class="paramname"><em>baseCache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>subEntry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refresh</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html" title="Caches API GET requests and refreshes regularly. ">APICache</a> which forwards to a base cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">baseCache</td><td>Base cache providing a parent state, must not be nullptr </td></tr>
<tr><td class="paramname">subEntry</td><td>Key of the child to use in the base cache </td></tr>
<tr><td class="paramname">refresh</td><td>Interval between cache refreshing. May be 0 to always refresh. This is independent from the base cache refresh rate.</td></tr>
</table>
</dd>
</dl>
<p>Refreshes only part of the base cache. </p>
</div>
</div>
<a id="ae2c4e98ff7510eb216316c927e18a772"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c4e98ff7510eb216316c927e18a772">◆ </a></span>APICache() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::APICache::APICache </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & </td>
<td class="paramname"><em>commands</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refresh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>initial</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html" title="Caches API GET requests and refreshes regularly. ">APICache</a> with an own internal json cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>URL appended after username, may be empty. </td></tr>
<tr><td class="paramname">commands</td><td><a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> for making API requests. </td></tr>
<tr><td class="paramname">refresh</td><td>Interval between cache refreshing. May be 0 to always refresh. </td></tr>
<tr><td class="paramname">initial</td><td>Initial value, may be null. If present, assumes the value is up to date. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afbbe9068d0b6e8e3b600091c51123464"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbbe9068d0b6e8e3b600091c51123464">◆ </a></span>getCommandAPI() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & hueplusplus::APICache::getCommandAPI </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> used for requests. </p>
</div>
</div>
<a id="afa68d56e9779ef00d8d7f7e96eb2a370"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa68d56e9779ef00d8d7f7e96eb2a370">◆ </a></span>getCommandAPI() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & hueplusplus::APICache::getCommandAPI </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> used for requests. </p>
</div>
</div>
<a id="a0f924bf1a6341b11f68f020472041548"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f924bf1a6341b11f68f020472041548">◆ </a></span>getRefreshDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::chrono::steady_clock::duration hueplusplus::APICache::getRefreshDuration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get duration between refreshes. </p>
</div>
</div>
<a id="ab7bfbec1c32e236c2878a3368f8767cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7bfbec1c32e236c2878a3368f8767cb">◆ </a></span>getRequestPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::APICache::getRequestPath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get path the cache is refreshed from. </p>
<dl class="section return"><dt>Returns</dt><dd>Request path as passed to <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html#a075e958c9cf465c8c955d725a2037b88" title="Sends a HTTP GET request to the bridge and returns the response. ">HueCommandAPI::GETRequest</a> </dd></dl>
</div>
</div>
<a id="afeededdbb81e3c668b2b983c3d29ee0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afeededdbb81e3c668b2b983c3d29ee0d">◆ </a></span>getValue() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nlohmann::json & hueplusplus::APICache::getValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get cached value, refresh if necessary. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa1e0c41745a569f7ef420bd6acd5ecc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1e0c41745a569f7ef420bd6acd5ecc1">◆ </a></span>getValue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const nlohmann::json & hueplusplus::APICache::getValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get cached value, does not refresh. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when no previous request was cached </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a712df81284602eb43afae322f8d43e7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a712df81284602eb43afae322f8d43e7b">◆ </a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::APICache::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refresh cache now. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed</td></tr>
</table>
</dd>
</dl>
<p>If there is a base cache, refreshes only the used part of that cache. </p>
</div>
</div>
<a id="a25233da7881b9046555164bcf44b0f85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25233da7881b9046555164bcf44b0f85">◆ </a></span>setRefreshDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::APICache::setRefreshDuration </td>
<td>(</td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refreshDuration</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set duration after which the cache is refreshed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">refreshDuration</td><td>Interval between cache refreshing. May be 0 to always refresh, or <a class="el" href="namespacehueplusplus.html#add9e010e3277f7763db4006cc9f46b86">c_refreshNever</a> to never refresh.</td></tr>
</table>
</dd>
</dl>
<p>If the new refresh duration is exceeded, does not refresh immediately. Instead, the next non-const <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html#afeededdbb81e3c668b2b983c3d29ee0d" title="Get cached value, refresh if necessary. ">getValue()</a> call will refresh the value. This is to reduce the number of unneccessary requests. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_a_p_i_cache_8h_source.html">APICache.h</a></li>
<li>src/<a class="el" href="_a_p_i_cache_8cpp.html">APICache.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>