This repository was archived by the owner on Dec 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathblackcore_2data_2authenticateduser_8h_source.html
115 lines (113 loc) · 12.2 KB
/
blackcore_2data_2authenticateduser_8h_source.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>swift: src/blackcore/data/authenticateduser.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" />
<link href="doxygen-awesome.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">swift
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4bd6e9e49f4b1ea1ce646f85835c78ce.html">blackcore</a></li><li class="navelem"><a class="el" href="dir_cd5dbff4e6af2292a88cafb9fc22c472.html">data</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">authenticateduser.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="blackcore_2data_2authenticateduser_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> <span class="comment">// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef BLACKCORE_DATA_AUTHENTICATEDUSER_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define BLACKCORE_DATA_AUTHENTICATEDUSER_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="blackcoreexport_8h.html">blackcore/blackcoreexport.h</a>"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="datacache_8h.html">blackmisc/datacache.h</a>"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="blackmisc_2network_2authenticateduser_8h.html">blackmisc/network/authenticateduser.h</a>"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span><a class="code" href="namespace_black_core_1_1_data.html">BlackCore::Data</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html"> 17</a></span>  <span class="keyword">struct </span><a class="code" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html">TAuthenticatedDbUser</a> : <span class="keyword">public</span> <a class="code" href="struct_black_misc_1_1_t_data_trait.html">BlackMisc::TDataTrait</a><BlackMisc::Network::CAuthenticatedUser></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  {</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#aa9594920da215b48532c3f4ec393128e"> 20</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#aa9594920da215b48532c3f4ec393128e">key</a>() { <span class="keywordflow">return</span> <span class="stringliteral">"dbuser"</span>; }</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#a9a9e5814c131cd2a2cb94cbeab73f078"> 23</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">bool</span> <a class="code" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#a9a9e5814c131cd2a2cb94cbeab73f078">isPinned</a>() { <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#ab8daa1acd95e67d5921f5b494e8906ce"> 26</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">bool</span> <a class="code" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#ab8daa1acd95e67d5921f5b494e8906ce">isSession</a>() { <span class="keywordflow">return</span> <span class="keyword">true</span>; }</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#aa18a23f7fafe412abd8003552b623573"> 29</a></span>  <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#aa18a23f7fafe412abd8003552b623573">timeToLive</a>() { <span class="keywordflow">return</span> 18 * 60 * 60 * 1000; }</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="comment">// ns</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif </span><span class="comment">// guard</span></div>
<div class="ttc" id="ablackcoreexport_8h_html"><div class="ttname"><a href="blackcoreexport_8h.html">blackcoreexport.h</a></div></div>
<div class="ttc" id="ablackmisc_2network_2authenticateduser_8h_html"><div class="ttname"><a href="blackmisc_2network_2authenticateduser_8h.html">authenticateduser.h</a></div></div>
<div class="ttc" id="adatacache_8h_html"><div class="ttname"><a href="datacache_8h.html">datacache.h</a></div></div>
<div class="ttc" id="anamespace_black_core_1_1_data_html"><div class="ttname"><a href="namespace_black_core_1_1_data.html">BlackCore::Data</a></div><div class="ttdoc">Core data traits (aka cached values) and classes.</div></div>
<div class="ttc" id="astruct_black_core_1_1_data_1_1_t_authenticated_db_user_html"><div class="ttname"><a href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html">BlackCore::Data::TAuthenticatedDbUser</a></div><div class="ttdoc">Trait for for global cached DB user. This user has authenticated with the swift DB.</div><div class="ttdef"><b>Definition:</b> <a href="blackcore_2data_2authenticateduser_8h_source.html#l00017">authenticateduser.h:18</a></div></div>
<div class="ttc" id="astruct_black_core_1_1_data_1_1_t_authenticated_db_user_html_a9a9e5814c131cd2a2cb94cbeab73f078"><div class="ttname"><a href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#a9a9e5814c131cd2a2cb94cbeab73f078">BlackCore::Data::TAuthenticatedDbUser::isPinned</a></div><div class="ttdeci">static constexpr bool isPinned()</div><div class="ttdoc">First load is synchronous.</div><div class="ttdef"><b>Definition:</b> <a href="blackcore_2data_2authenticateduser_8h_source.html#l00023">authenticateduser.h:23</a></div></div>
<div class="ttc" id="astruct_black_core_1_1_data_1_1_t_authenticated_db_user_html_aa18a23f7fafe412abd8003552b623573"><div class="ttname"><a href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#aa18a23f7fafe412abd8003552b623573">BlackCore::Data::TAuthenticatedDbUser::timeToLive</a></div><div class="ttdeci">static int timeToLive()</div><div class="ttdoc">Cache lifetime.</div><div class="ttdef"><b>Definition:</b> <a href="blackcore_2data_2authenticateduser_8h_source.html#l00029">authenticateduser.h:29</a></div></div>
<div class="ttc" id="astruct_black_core_1_1_data_1_1_t_authenticated_db_user_html_aa9594920da215b48532c3f4ec393128e"><div class="ttname"><a href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#aa9594920da215b48532c3f4ec393128e">BlackCore::Data::TAuthenticatedDbUser::key</a></div><div class="ttdeci">static const char * key()</div><div class="ttdoc">Key in data cache.</div><div class="ttdef"><b>Definition:</b> <a href="blackcore_2data_2authenticateduser_8h_source.html#l00020">authenticateduser.h:20</a></div></div>
<div class="ttc" id="astruct_black_core_1_1_data_1_1_t_authenticated_db_user_html_ab8daa1acd95e67d5921f5b494e8906ce"><div class="ttname"><a href="struct_black_core_1_1_data_1_1_t_authenticated_db_user.html#ab8daa1acd95e67d5921f5b494e8906ce">BlackCore::Data::TAuthenticatedDbUser::isSession</a></div><div class="ttdeci">static constexpr bool isSession()</div><div class="ttdoc">Session object.</div><div class="ttdef"><b>Definition:</b> <a href="blackcore_2data_2authenticateduser_8h_source.html#l00026">authenticateduser.h:26</a></div></div>
<div class="ttc" id="astruct_black_misc_1_1_t_data_trait_html"><div class="ttname"><a href="struct_black_misc_1_1_t_data_trait.html">BlackMisc::TDataTrait</a></div><div class="ttdoc">Base class for traits to be used as template argument to BlackMisc::CData.</div><div class="ttdef"><b>Definition:</b> <a href="datacache_8h_source.html#l00438">datacache.h:439</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 3 2023 18:38:36 for swift by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>