GpgFrontend-Doxygen/docs/html/GpgKeyGetter_8h_source.html

170 lines
20 KiB
HTML

<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: src/core/function/gpg/GpgKeyGetter.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">GpgFrontend Project
</div>
<div id="projectbrief">A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('GpgKeyGetter_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">GpgKeyGetter.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#ifndef GPGFRONTEND_ZH_CN_TS_GPGKEYGETTER_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define GPGFRONTEND_ZH_CN_TS_GPGKEYGETTER_H</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;core/GpgContext.h&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;core/GpgFunctionObject.h&quot;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;core/GpgModel.h&quot;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceGpgFrontend.html">GpgFrontend</a> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgKeyGetter.html"> 45</a></span>&#160;<span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code" href="classGpgFrontend_1_1GpgKeyGetter.html">GpgKeyGetter</a></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; : <span class="keyword">public</span> <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html">SingletonFunctionObject</a>&lt;GpgKeyGetter&gt; {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classGpgFrontend_1_1GpgKeyGetter.html">GpgKeyGetter</a>(</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">int</span> channel = <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">SingletonFunctionObject::GetDefaultChannel</a>());</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="classGpgFrontend_1_1GpgKey.html">GpgKey</a> GetKey(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>, <span class="keywordtype">bool</span> use_cache = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; KeyListPtr GetKeys(<span class="keyword">const</span> KeyIdArgsListPtr&amp; ids);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="classGpgFrontend_1_1GpgKey.html">GpgKey</a> GetPubkey(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>, <span class="keywordtype">bool</span> use_cache = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; KeyLinkListPtr FetchKey();</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">void</span> FlushKeyCache();</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; KeyListPtr GetKeysCopy(<span class="keyword">const</span> KeyListPtr&amp; keys);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; KeyLinkListPtr GetKeysCopy(<span class="keyword">const</span> KeyLinkListPtr&amp; keys);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgKeyGetter.html#aa4aef315d82123726be879097d3df147"> 114</a></span>&#160; <a class="code" href="classGpgFrontend_1_1GpgContext.html">GpgContext</a>&amp; ctx_ =</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgContext::GetInstance</a>(<a class="code" href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">SingletonFunctionObject::GetChannel</a>());</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgKeyGetter.html#a81941e1f562dc22977a71d00dd10956a"> 121</a></span>&#160; <span class="keyword">mutable</span> std::mutex <a class="code" href="classGpgFrontend_1_1GpgKeyGetter.html#a81941e1f562dc22977a71d00dd10956a">ctx_mutex_</a>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgKeyGetter.html#a9567d5e08ae73c5bafcd1dc378fed066"> 127</a></span>&#160; std::map&lt;std::string, GpgKey&gt; <a class="code" href="classGpgFrontend_1_1GpgKeyGetter.html#a9567d5e08ae73c5bafcd1dc378fed066">keys_cache_</a>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgKeyGetter.html#ae1d7846ad2fa17ab90c72b3186ba5335"> 133</a></span>&#160; <span class="keyword">mutable</span> std::mutex <a class="code" href="classGpgFrontend_1_1GpgKeyGetter.html#ae1d7846ad2fa17ab90c72b3186ba5335">keys_cache_mutex_</a>;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <a class="code" href="classGpgFrontend_1_1GpgKey.html">GpgKey</a> get_key_in_cache(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;};</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;} <span class="comment">// namespace GpgFrontend</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="preprocessor">#endif // GPGFRONTEND_ZH_CN_TS_GPGKEYGETTER_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html">GpgFrontend::SingletonFunctionObject</a></div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:159</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_a8eeee9f6dd74dc24c24794ce63c62285"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#a8eeee9f6dd74dc24c24794ce63c62285">GpgFrontend::GpgKeyGetter::GpgKeyGetter</a></div><div class="ttdeci">GpgKeyGetter(int channel=SingletonFunctionObject::GetDefaultChannel())</div><div class="ttdoc">Construct a new Gpg Key Getter object.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:41</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_a7ec8d8431a771c602cbfa946d13d6c74"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#a7ec8d8431a771c602cbfa946d13d6c74">GpgFrontend::GpgKeyGetter::GetKeysCopy</a></div><div class="ttdeci">KeyListPtr GetKeysCopy(const KeyListPtr &amp;keys)</div><div class="ttdoc">Get the Keys Copy object.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:164</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_ae1d7846ad2fa17ab90c72b3186ba5335"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#ae1d7846ad2fa17ab90c72b3186ba5335">GpgFrontend::GpgKeyGetter::keys_cache_mutex_</a></div><div class="ttdeci">std::mutex keys_cache_mutex_</div><div class="ttdoc">shared mutex for the keys cache</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.h:133</div></div>
<div class="ttc" id="anamespaceGpgFrontend_html"><div class="ttname"><a href="namespaceGpgFrontend.html">GpgFrontend</a></div><div class="ttdef"><b>Definition:</b> CoreCommonUtil.cpp:29</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_a70484d7cfe9f9dcbcd5f8bb749250f36"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgFrontend::SingletonFunctionObject&lt; GpgContext &gt;::GetInstance</a></div><div class="ttdeci">static GpgContext &amp; GetInstance(int channel=GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL)</div><div class="ttdoc">Get the Instance object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:181</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_ab5196ef4ed5323fc2af70abf801ea260"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#ab5196ef4ed5323fc2af70abf801ea260">GpgFrontend::GpgKeyGetter::get_key_in_cache</a></div><div class="ttdeci">GpgKey get_key_in_cache(const std::string &amp;id)</div><div class="ttdoc">Get the Key object.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:173</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html">GpgFrontend::GpgKeyGetter</a></div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.h:45</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_aa99440b9177f5d0c18840f08a40d64b7"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#aa99440b9177f5d0c18840f08a40d64b7">GpgFrontend::SingletonFunctionObject::GetChannel</a></div><div class="ttdeci">int GetChannel() const</div><div class="ttdoc">Get the Channel object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:252</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_afe78ac470287d70e7df51aae327b9f54"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#afe78ac470287d70e7df51aae327b9f54">GpgFrontend::GpgKeyGetter::FetchKey</a></div><div class="ttdeci">KeyLinkListPtr FetchKey()</div><div class="ttdoc">Get all the keys by receiving a linked list.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:82</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgContext_html"><div class="ttname"><a href="classGpgFrontend_1_1GpgContext.html">GpgFrontend::GpgContext</a></div><div class="ttdef"><b>Definition:</b> GpgContext.h:59</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_ad9a902ea54566d4583304b072c4add51"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#ad9a902ea54566d4583304b072c4add51">GpgFrontend::GpgKeyGetter::FlushKeyCache</a></div><div class="ttdeci">void FlushKeyCache()</div><div class="ttdoc">flush the keys in the cache</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:101</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_a94243d09c9418c8ebf0c7cdab4a2b7f1"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#a94243d09c9418c8ebf0c7cdab4a2b7f1">GpgFrontend::GpgKeyGetter::GetKey</a></div><div class="ttdeci">GpgKey GetKey(const std::string &amp;id, bool use_cache=true)</div><div class="ttdoc">Get the Key object.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:47</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_a7a8bc7c0f12a11e108051e4c824fc430"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#a7a8bc7c0f12a11e108051e4c824fc430">GpgFrontend::GpgKeyGetter::GetPubkey</a></div><div class="ttdeci">GpgKey GetPubkey(const std::string &amp;id, bool use_cache=true)</div><div class="ttdoc">Get the Pubkey object.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:67</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_a50e2b3794d6553f4231eaec72d9d0a50"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#a50e2b3794d6553f4231eaec72d9d0a50">GpgFrontend::SingletonFunctionObject::GetDefaultChannel</a></div><div class="ttdeci">static int GetDefaultChannel()</div><div class="ttdoc">Get the Default Channel object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:245</div></div>
<div class="ttc" id="anamespaceGpgFrontend_html_a4edac6df92596ba8eea3a8cdc1173684"><div class="ttname"><a href="namespaceGpgFrontend.html#a4edac6df92596ba8eea3a8cdc1173684">GpgFrontend::check_gpg_error_2_err_code</a></div><div class="ttdeci">GPGFRONTEND_CORE_EXPORT gpg_err_code_t check_gpg_error_2_err_code(gpgme_error_t err, gpgme_error_t predict=GPG_ERR_NO_ERROR)</div><div class="ttdef"><b>Definition:</b> GpgConstants.cpp:66</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_a9567d5e08ae73c5bafcd1dc378fed066"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#a9567d5e08ae73c5bafcd1dc378fed066">GpgFrontend::GpgKeyGetter::keys_cache_</a></div><div class="ttdeci">std::map&lt; std::string, GpgKey &gt; keys_cache_</div><div class="ttdoc">cache the keys with key id</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.h:127</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_aa5979c21af58b874b33c203752dcc805"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#aa5979c21af58b874b33c203752dcc805">GpgFrontend::GpgKeyGetter::GetKeys</a></div><div class="ttdeci">KeyListPtr GetKeys(const KeyIdArgsListPtr &amp;ids)</div><div class="ttdoc">Get the Keys object.</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.cpp:148</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyGetter_html_a81941e1f562dc22977a71d00dd10956a"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyGetter.html#a81941e1f562dc22977a71d00dd10956a">GpgFrontend::GpgKeyGetter::ctx_mutex_</a></div><div class="ttdeci">std::mutex ctx_mutex_</div><div class="ttdoc">shared mutex for the keys cache</div><div class="ttdef"><b>Definition:</b> GpgKeyGetter.h:121</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKey_html"><div class="ttname"><a href="classGpgFrontend_1_1GpgKey.html">GpgFrontend::GpgKey</a></div><div class="ttdef"><b>Definition:</b> GpgKey.h:44</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_f8a0abd6d3586538a5b71803e0ab7ffa.html">function</a></li><li class="navelem"><a class="el" href="dir_4c90737131b129f8f210b6ba3e14bca4.html">gpg</a></li><li class="navelem"><b>GpgKeyGetter.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>