_bridge_config_8h_source.html
17.7 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
<!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/BridgeConfig.h Source File</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="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="headertitle">
<div class="title">BridgeConfig.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_bridge_config_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef INCLUDE_HUEPLUSPLUS_BRIDGE_CONFIG_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define INCLUDE_HUEPLUSPLUS_BRIDGE_CONFIG_H</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="_a_p_i_cache_8h.html">APICache.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="_time_pattern_8h.html">TimePattern.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacehueplusplus.html">hueplusplus</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_version.html"> 34</a></span> <span class="keyword">struct </span><a class="code" href="structhueplusplus_1_1_version.html">Version</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_version.html#a86e6ded781d236b64b2763aae6119476"> 36</a></span>  <span class="keywordtype">int</span> <a class="code" href="structhueplusplus_1_1_version.html#a86e6ded781d236b64b2763aae6119476">major</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_version.html#a53ab47eaccb2eeeb32a227a29f841472"> 37</a></span>  <span class="keywordtype">int</span> <a class="code" href="structhueplusplus_1_1_version.html#a53ab47eaccb2eeeb32a227a29f841472">minor</a>;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_version.html#a309a02fdc79b1249314dbd9b5388f220"> 38</a></span>  <span class="keywordtype">int</span> <a class="code" href="structhueplusplus_1_1_version.html#a309a02fdc79b1249314dbd9b5388f220">patch</a>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_whitelisted_user.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="structhueplusplus_1_1_whitelisted_user.html">WhitelistedUser</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_whitelisted_user.html#a3d668d495747fb2bbb0f7890ac93644b"> 45</a></span>  std::string <a class="code" href="structhueplusplus_1_1_whitelisted_user.html#a3d668d495747fb2bbb0f7890ac93644b">key</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_whitelisted_user.html#a4ee19d0e64bbe68656cf5d9110f9669e"> 47</a></span>  std::string <a class="code" href="structhueplusplus_1_1_whitelisted_user.html#a4ee19d0e64bbe68656cf5d9110f9669e">name</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_whitelisted_user.html#a1c2ac0a6b6c6a510172176b5e0d78ca0"> 49</a></span>  <a class="code" href="classhueplusplus_1_1time_1_1_absolute_time.html">time::AbsoluteTime</a> <a class="code" href="structhueplusplus_1_1_whitelisted_user.html#a1c2ac0a6b6c6a510172176b5e0d78ca0">lastUsed</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structhueplusplus_1_1_whitelisted_user.html#a215b666e60ec721bb5b8238623479edb"> 51</a></span>  <a class="code" href="classhueplusplus_1_1time_1_1_absolute_time.html">time::AbsoluteTime</a> <a class="code" href="structhueplusplus_1_1_whitelisted_user.html#a215b666e60ec721bb5b8238623479edb">created</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classhueplusplus_1_1_bridge_config.html"> 55</a></span> <span class="keyword">class </span><a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>(std::shared_ptr<APICache> baseCache, std::chrono::steady_clock::duration refreshDuration);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> refresh(<span class="keywordtype">bool</span> force = <span class="keyword">false</span>);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> setRefreshDuration(std::chrono::steady_clock::duration refreshDuration);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::vector<WhitelistedUser> getWhitelistedUsers() <span class="keyword">const</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> removeUser(<span class="keyword">const</span> std::string& userKey);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> getLinkButton() <span class="keyword">const</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> pressLinkButton();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> touchLink();</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  std::string getMACAddress() <span class="keyword">const</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classhueplusplus_1_1time_1_1_absolute_time.html">time::AbsoluteTime</a> getUTCTime() <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::string getTimezone() <span class="keyword">const</span>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>(<span class="keyword">const</span> <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>(<a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>&&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>& operator=(<span class="keyword">const</span> <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>& operator=(<a class="code" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a>&&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> cache;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> } <span class="comment">// namespace hueplusplus</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structhueplusplus_1_1_whitelisted_user_html"><div class="ttname"><a href="structhueplusplus_1_1_whitelisted_user.html">hueplusplus::WhitelistedUser</a></div><div class="ttdoc">User that is whitelisted for Hue API usage. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:42</div></div>
<div class="ttc" id="structhueplusplus_1_1_version_html_a309a02fdc79b1249314dbd9b5388f220"><div class="ttname"><a href="structhueplusplus_1_1_version.html#a309a02fdc79b1249314dbd9b5388f220">hueplusplus::Version::patch</a></div><div class="ttdeci">int patch</div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:38</div></div>
<div class="ttc" id="namespacehueplusplus_html"><div class="ttname"><a href="namespacehueplusplus.html">hueplusplus</a></div><div class="ttdoc">Namespace for the hueplusplus library. </div><div class="ttdef"><b>Definition:</b> Action.h:27</div></div>
<div class="ttc" id="classhueplusplus_1_1_a_p_i_cache_html"><div class="ttname"><a href="classhueplusplus_1_1_a_p_i_cache.html">hueplusplus::APICache</a></div><div class="ttdoc">Caches API GET requests and refreshes regularly. </div><div class="ttdef"><b>Definition:</b> APICache.h:37</div></div>
<div class="ttc" id="structhueplusplus_1_1_version_html_a53ab47eaccb2eeeb32a227a29f841472"><div class="ttname"><a href="structhueplusplus_1_1_version.html#a53ab47eaccb2eeeb32a227a29f841472">hueplusplus::Version::minor</a></div><div class="ttdeci">int minor</div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:37</div></div>
<div class="ttc" id="structhueplusplus_1_1_version_html_a86e6ded781d236b64b2763aae6119476"><div class="ttname"><a href="structhueplusplus_1_1_version.html#a86e6ded781d236b64b2763aae6119476">hueplusplus::Version::major</a></div><div class="ttdeci">int major</div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:36</div></div>
<div class="ttc" id="classhueplusplus_1_1time_1_1_absolute_time_html"><div class="ttname"><a href="classhueplusplus_1_1time_1_1_absolute_time.html">hueplusplus::time::AbsoluteTime</a></div><div class="ttdoc">One-time, absolute time point. </div><div class="ttdef"><b>Definition:</b> TimePattern.h:72</div></div>
<div class="ttc" id="_time_pattern_8h_html"><div class="ttname"><a href="_time_pattern_8h.html">TimePattern.h</a></div></div>
<div class="ttc" id="structhueplusplus_1_1_whitelisted_user_html_a4ee19d0e64bbe68656cf5d9110f9669e"><div class="ttname"><a href="structhueplusplus_1_1_whitelisted_user.html#a4ee19d0e64bbe68656cf5d9110f9669e">hueplusplus::WhitelistedUser::name</a></div><div class="ttdeci">std::string name</div><div class="ttdoc">Name provided on user creation. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:47</div></div>
<div class="ttc" id="structhueplusplus_1_1_version_html"><div class="ttname"><a href="structhueplusplus_1_1_version.html">hueplusplus::Version</a></div><div class="ttdoc">API version consisting of major, minor and patch version. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:34</div></div>
<div class="ttc" id="_a_p_i_cache_8h_html"><div class="ttname"><a href="_a_p_i_cache_8h.html">APICache.h</a></div></div>
<div class="ttc" id="classhueplusplus_1_1_bridge_config_html"><div class="ttname"><a href="classhueplusplus_1_1_bridge_config.html">hueplusplus::BridgeConfig</a></div><div class="ttdoc">General bridge configuration properties. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:55</div></div>
<div class="ttc" id="structhueplusplus_1_1_whitelisted_user_html_a3d668d495747fb2bbb0f7890ac93644b"><div class="ttname"><a href="structhueplusplus_1_1_whitelisted_user.html#a3d668d495747fb2bbb0f7890ac93644b">hueplusplus::WhitelistedUser::key</a></div><div class="ttdeci">std::string key</div><div class="ttdoc">API username of the user. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:45</div></div>
<div class="ttc" id="structhueplusplus_1_1_whitelisted_user_html_a215b666e60ec721bb5b8238623479edb"><div class="ttname"><a href="structhueplusplus_1_1_whitelisted_user.html#a215b666e60ec721bb5b8238623479edb">hueplusplus::WhitelistedUser::created</a></div><div class="ttdeci">time::AbsoluteTime created</div><div class="ttdoc">Time the user was created. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:51</div></div>
<div class="ttc" id="structhueplusplus_1_1_whitelisted_user_html_a1c2ac0a6b6c6a510172176b5e0d78ca0"><div class="ttname"><a href="structhueplusplus_1_1_whitelisted_user.html#a1c2ac0a6b6c6a510172176b5e0d78ca0">hueplusplus::WhitelistedUser::lastUsed</a></div><div class="ttdeci">time::AbsoluteTime lastUsed</div><div class="ttdoc">Last time the user was used. </div><div class="ttdef"><b>Definition:</b> BridgeConfig.h:49</div></div>
</div><!-- fragment --></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>