GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1SingletonStorage.html

265 lines
14 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: GpgFrontend::SingletonStorage 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="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('classGpgFrontend_1_1SingletonStorage.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1SingletonStorage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::SingletonStorage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for GpgFrontend::SingletonStorage:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1SingletonStorage__coll__graph.png" border="0" usemap="#GpgFrontend_1_1SingletonStorage_coll__map" alt="Collaboration graph"/></div>
<map name="GpgFrontend_1_1SingletonStorage_coll__map" id="GpgFrontend_1_1SingletonStorage_coll__map">
<area shape="rect" title=" " alt="" coords="175,683,399,804"/>
<area shape="rect" title="STL class." alt="" coords="137,528,279,605"/>
<area shape="rect" title=" " alt="" coords="304,513,501,620"/>
<area shape="rect" title=" " alt="" coords="138,359,355,451"/>
<area shape="rect" href="classGpgFrontend_1_1ChannelObject.html" title="object which in channel system" alt="" coords="5,145,213,296"/>
<area shape="rect" title="STL class." alt="" coords="237,182,395,259"/>
<area shape="rect" title=" " alt="" coords="329,5,367,83"/>
<area shape="rect" title="STL class." alt="" coords="421,182,555,259"/>
<area shape="rect" title=" " alt="" coords="469,5,507,83"/>
</map>
</div>
<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:adb22cc80a1ab040b6e4bce962625edfd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#adb22cc80a1ab040b6e4bce962625edfd">ReleaseChannel</a> (int channel)</td></tr>
<tr class="separator:adb22cc80a1ab040b6e4bce962625edfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c16c32e549494e394a0ddd859890a02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#a4c16c32e549494e394a0ddd859890a02">FindObjectInChannel</a> (int channel)</td></tr>
<tr class="separator:a4c16c32e549494e394a0ddd859890a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f09424ebdc097fbdab77564a7d723ea"><td class="memItemLeft" align="right" valign="top">std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#a3f09424ebdc097fbdab77564a7d723ea">GetAllChannelId</a> ()</td></tr>
<tr class="memdesc:a3f09424ebdc097fbdab77564a7d723ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all the channel ids. <a href="classGpgFrontend_1_1SingletonStorage.html#a3f09424ebdc097fbdab77564a7d723ea">More...</a><br /></td></tr>
<tr class="separator:a3f09424ebdc097fbdab77564a7d723ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0097bb648b2303d68a975c7cbea5a52"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#ab0097bb648b2303d68a975c7cbea5a52">SetObjectInChannel</a> (int channel, std::unique_ptr&lt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> &gt; p_obj)</td></tr>
<tr class="memdesc:ab0097bb648b2303d68a975c7cbea5a52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a new object in channel object. <a href="classGpgFrontend_1_1SingletonStorage.html#ab0097bb648b2303d68a975c7cbea5a52">More...</a><br /></td></tr>
<tr class="separator:ab0097bb648b2303d68a975c7cbea5a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a15161d0afafec602018a89266dab5641"><td class="memItemLeft" align="right" valign="top"><a id="a15161d0afafec602018a89266dab5641"></a>
std::shared_mutex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#a15161d0afafec602018a89266dab5641">instances_mutex_</a></td></tr>
<tr class="memdesc:a15161d0afafec602018a89266dab5641"><td class="mdescLeft">&#160;</td><td class="mdescRight">mutex for _instances_map <br /></td></tr>
<tr class="separator:a15161d0afafec602018a89266dab5641"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6181f2b5af39c6b86de89e1ba9eeff1c"><td class="memItemLeft" align="right" valign="top"><a id="a6181f2b5af39c6b86de89e1ba9eeff1c"></a>
std::map&lt; int, std::unique_ptr&lt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html#a6181f2b5af39c6b86de89e1ba9eeff1c">instances_map_</a></td></tr>
<tr class="memdesc:a6181f2b5af39c6b86de89e1ba9eeff1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">map of singleton instances <br /></td></tr>
<tr class="separator:a6181f2b5af39c6b86de89e1ba9eeff1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4c16c32e549494e394a0ddd859890a02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c16c32e549494e394a0ddd859890a02">&#9670;&nbsp;</a></span>FindObjectInChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGpgFrontend_1_1ChannelObject.html">GpgFrontend::ChannelObject</a> * GpgFrontend::SingletonStorage::FindObjectInChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>T* </dd></dl>
</div>
</div>
<a id="a3f09424ebdc097fbdab77564a7d723ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f09424ebdc097fbdab77564a7d723ea">&#9670;&nbsp;</a></span>GetAllChannelId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; int &gt; GpgFrontend::SingletonStorage::GetAllChannelId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all the channel ids. </p>
<dl class="section return"><dt>Returns</dt><dd>std::vector&lt;int&gt; </dd></dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#a5f2f0474871971f86ff91fb6a2408621">GpgFrontend::SingletonFunctionObject&lt; GpgContext &gt;::GetAllChannelId()</a>.</p>
</div>
</div>
<a id="adb22cc80a1ab040b6e4bce962625edfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb22cc80a1ab040b6e4bce962625edfd">&#9670;&nbsp;</a></span>ReleaseChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::SingletonStorage::ReleaseChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
</table>
</dd>
</dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#ab49b1d50252e1934691a9483a6df2106">GpgFrontend::SingletonFunctionObject&lt; GpgContext &gt;::ReleaseChannel()</a>.</p>
</div>
</div>
<a id="ab0097bb648b2303d68a975c7cbea5a52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0097bb648b2303d68a975c7cbea5a52">&#9670;&nbsp;</a></span>SetObjectInChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGpgFrontend_1_1ChannelObject.html">GpgFrontend::ChannelObject</a> * GpgFrontend::SingletonStorage::SetObjectInChannel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="classGpgFrontend_1_1ChannelObject.html">ChannelObject</a> &gt;&#160;</td>
<td class="paramname"><em>p_obj</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a new object in channel object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td></td></tr>
<tr><td class="paramname">p_obj</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>T* </dd></dl>
<p class="reference">References <a class="el" href="classGpgFrontend_1_1ChannelObject.html#aa3b19cad6d873b314bba32a3dae85f09">GpgFrontend::ChannelObject::SetChannel()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/<a class="el" href="GpgFunctionObject_8h_source.html">GpgFunctionObject.h</a></li>
<li>src/core/GpgFunctionObject.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1SingletonStorage.html">SingletonStorage</a></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>