_a_p_i_cache_8h.html 13.9 KB

Edit Raw Blame History Permalink

<!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: include/hueplusplus/APICache.h File 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
   &#160;<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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e05b4b7707bd5f9fd045e8be02b17d0a.html">hueplusplus</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">APICache.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;chrono&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &quot;<a class="el" href="_hue_command_a_p_i_8h_source.html">HueCommandAPI.h</a>&quot;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for APICache.h:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="_a_p_i_cache_8h__incl.png" border="0" usemap="#include_2hueplusplus_2_a_p_i_cache_8h" alt=""/></div>
<map name="include_2hueplusplus_2_a_p_i_cache_8h" id="include_2hueplusplus_2_a_p_i_cache_8h">
<area shape="rect" id="node4" href="_hue_command_a_p_i_8h.html" title="HueCommandAPI.h" alt="" coords="339,95,487,121"/>
<area shape="rect" id="node7" href="_hue_exception_8h.html" title="HueException.h" alt="" coords="111,169,235,196"/>
<area shape="rect" id="node10" href="_i_http_handler_8h.html" title="IHttpHandler.h" alt="" coords="355,169,471,196"/>
</map>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="_a_p_i_cache_8h__dep__incl.png" border="0" usemap="#include_2hueplusplus_2_a_p_i_cache_8hdep" alt=""/></div>
<map name="include_2hueplusplus_2_a_p_i_cache_8hdep" id="include_2hueplusplus_2_a_p_i_cache_8hdep">
<area shape="rect" id="node2" href="_base_device_8h.html" title="include/hueplusplus\l/BaseDevice.h" alt="" coords="1708,95,1859,136"/>
<area shape="rect" id="node3" href="_light_8h.html" title="include/hueplusplus\l/Light.h" alt="" coords="1136,184,1287,225"/>
<area shape="rect" id="node5" href="_bridge_8h.html" title="include/hueplusplus\l/Bridge.h" alt="" coords="2261,363,2412,404"/>
<area shape="rect" id="node33" href="_bridge_config_8h.html" title="include/hueplusplus\l/BridgeConfig.h" alt="" coords="2188,95,2339,136"/>
<area shape="rect" id="node35" href="_group_8h.html" title="include/hueplusplus\l/Group.h" alt="" coords="2961,273,3112,315"/>
<area shape="rect" id="node37" href="_resource_list_8h.html" title="include/hueplusplus\l/ResourceList.h" alt="" coords="1969,184,2120,225"/>
<area shape="rect" id="node38" href="_rule_8h.html" title="include/hueplusplus\l/Rule.h" alt="" coords="2363,95,2513,136"/>
<area shape="rect" id="node40" href="_scene_8h.html" title="include/hueplusplus\l/Scene.h" alt="" coords="2537,95,2688,136"/>
<area shape="rect" id="node42" href="_schedule_8h.html" title="include/hueplusplus\l/Schedule.h" alt="" coords="2712,95,2863,136"/>
<area shape="rect" id="node44" href="_a_p_i_cache_8cpp.html" title="src/APICache.cpp" alt="" coords="3043,102,3177,129"/>
<area shape="rect" id="node25" href="_sensor_8h.html" title="include/hueplusplus\l/Sensor.h" alt="" coords="1620,184,1771,225"/>
<area shape="rect" id="node32" href="_base_device_8cpp.html" title="src/BaseDevice.cpp" alt="" coords="1795,191,1945,218"/>
<area shape="rect" id="node4" href="_hue_device_types_8h.html" title="include/hueplusplus\l/HueDeviceTypes.h" alt="" coords="1332,273,1483,315"/>
<area shape="rect" id="node14" href="_extended_color_hue_strategy_8h.html" title="include/hueplusplus\l/ExtendedColorHueStrategy.h" alt="" coords="1200,363,1412,404"/>
<area shape="rect" id="node16" href="_simple_color_hue_strategy_8h.html" title="include/hueplusplus\l/SimpleColorHueStrategy.h" alt="" coords="932,273,1128,315"/>
<area shape="rect" id="node18" href="_extended_color_temperature_strategy_8h.html" title="include/hueplusplus\l/ExtendedColorTemperatureStrategy.h" alt="" coords="5,363,273,404"/>
<area shape="rect" id="node20" href="_simple_color_temperature_strategy_8h.html" title="include/hueplusplus\l/SimpleColorTemperatureStrategy.h" alt="" coords="323,273,575,315"/>
<area shape="rect" id="node22" href="_simple_brightness_strategy_8h.html" title="include/hueplusplus\l/SimpleBrightnessStrategy.h" alt="" coords="647,273,853,315"/>
<area shape="rect" id="node24" href="_light_8cpp.html" title="src/Light.cpp" alt="" coords="1203,281,1307,307"/>
<area shape="rect" id="node13" href="_hue_device_types_8cpp.html" title="src/HueDeviceTypes.cpp" alt="" coords="660,459,840,486"/>
<area shape="rect" id="node6" href="_entertainment_mode_8h.html" title="include/hueplusplus\l/EntertainmentMode.h" alt="" coords="2781,452,2948,493"/>
<area shape="rect" id="node8" href="_bridge_8cpp.html" title="src/Bridge.cpp" alt="" coords="2395,459,2510,486"/>
<area shape="rect" id="node9" href="_bridge_setup_8cpp.html" title="examples/BridgeSetup.cpp" alt="" coords="2535,459,2731,486"/>
<area shape="rect" id="node10" href="_lights_off_8cpp.html" title="examples/LightsOff.cpp" alt="" coords="1947,459,2121,486"/>
<area shape="rect" id="node11" href="_snippets_8cpp.html" title="Contains code snippets used in the documentation, performs no useful functions. " alt="" coords="1670,459,1843,486"/>
<area shape="rect" id="node12" href="_username_config_8cpp.html" title="examples/UsernameConfig.cpp" alt="" coords="2145,459,2371,486"/>
<area shape="rect" id="node7" href="_entertainment_mode_8cpp.html" title="src/EntertainmentMode.cpp" alt="" coords="2765,541,2965,568"/>
<area shape="rect" id="node15" href="_extended_color_hue_strategy_8cpp.html" title="src/ExtendedColorHueStrategy.cpp" alt="" coords="1183,459,1429,486"/>
<area shape="rect" id="node17" href="_simple_color_hue_strategy_8cpp.html" title="src/SimpleColorHueStrategy.cpp" alt="" coords="945,370,1176,397"/>
<area shape="rect" id="node19" href="_extended_color_temperature_strategy_8cpp.html" title="src/ExtendedColorTemperature\lStrategy.cpp" alt="" coords="28,452,251,493"/>
<area shape="rect" id="node21" href="_simple_color_temperature_strategy_8cpp.html" title="src/SimpleColorTemperature\lStrategy.cpp" alt="" coords="297,363,504,404"/>
<area shape="rect" id="node23" href="_simple_brightness_strategy_8cpp.html" title="src/SimpleBrightnessStrategy.cpp" alt="" coords="631,370,869,397"/>
<area shape="rect" id="node26" href="_sensor_list_8h.html" title="include/hueplusplus\l/SensorList.h" alt="" coords="2097,273,2248,315"/>
<area shape="rect" id="node27" href="_c_l_i_p_sensors_8h.html" title="include/hueplusplus\l/CLIPSensors.h" alt="" coords="1507,273,1657,315"/>
<area shape="rect" id="node29" href="_z_l_l_sensors_8h.html" title="include/hueplusplus\l/ZLLSensors.h" alt="" coords="1681,273,1832,315"/>
<area shape="rect" id="node31" href="_sensor_8cpp.html" title="src/Sensor.cpp" alt="" coords="1907,281,2022,307"/>
<area shape="rect" id="node28" href="_c_l_i_p_sensors_8cpp.html" title="src/CLIPSensors.cpp" alt="" coords="1568,370,1719,397"/>
<area shape="rect" id="node30" href="_z_l_l_sensors_8cpp.html" title="src/ZLLSensors.cpp" alt="" coords="1794,370,1941,397"/>
<area shape="rect" id="node34" href="_bridge_config_8cpp.html" title="src/BridgeConfig.cpp" alt="" coords="2145,191,2299,218"/>
<area shape="rect" id="node36" href="_group_8cpp.html" title="src/Group.cpp" alt="" coords="2981,370,3092,397"/>
<area shape="rect" id="node39" href="_rule_8cpp.html" title="src/Rule.cpp" alt="" coords="2425,191,2525,218"/>
<area shape="rect" id="node41" href="_scene_8cpp.html" title="src/Scene.cpp" alt="" coords="2601,191,2712,218"/>
<area shape="rect" id="node43" href="_schedule_8cpp.html" title="src/Schedule.cpp" alt="" coords="2787,191,2918,218"/>
</map>
</div>
</div>
<p><a href="_a_p_i_cache_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">hueplusplus::APICache</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Caches API GET requests and refreshes regularly.  <a href="classhueplusplus_1_1_a_p_i_cache.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacehueplusplus"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></td></tr>
<tr class="memdesc:namespacehueplusplus"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for the hueplusplus library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:add9e010e3277f7763db4006cc9f46b86"><td class="memItemLeft" align="right" valign="top">constexpr std::chrono::steady_clock::duration&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacehueplusplus.html#add9e010e3277f7763db4006cc9f46b86">hueplusplus::c_refreshNever</a> = std::chrono::steady_clock::duration::max()</td></tr>
<tr class="memdesc:add9e010e3277f7763db4006cc9f46b86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum duration, used to indicate that the cache should never be refreshed automatically.  <a href="namespacehueplusplus.html#add9e010e3277f7763db4006cc9f46b86">More...</a><br /></td></tr>
<tr class="separator:add9e010e3277f7763db4006cc9f46b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Copyright Notice<br />
Copyright (C) 2020 Jan Rogall - developer<br />
Copyright (C) 2020 Moritz Wirger - developer<br />
 This file is part of hueplusplus.</p>
<p>hueplusplus is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>hueplusplus is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with hueplusplus. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>