GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html

388 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: GpgFrontend::Thread::Task::Impl 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.9.1 -->
<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','.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&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_1Thread_1_1Task_1_1Impl.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-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::Thread::Task::Impl Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for GpgFrontend::Thread::Task::Impl:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Thread_1_1Task_1_1Impl__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1Thread_1_1Task_1_1Impl_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1Thread_1_1Task_1_1Impl_coll__map" id="aGpgFrontend_1_1Thread_1_1Task_1_1Impl_coll__map">
<area shape="rect" title=" " alt="" coords="145,631,303,957"/>
<area shape="rect" href="classGpgFrontend_1_1Thread_1_1Task.html" title=" " alt="" coords="37,285,198,568"/>
<area shape="rect" title=" " alt="" coords="5,145,80,223"/>
<area shape="rect" title=" " alt="" coords="104,145,197,223"/>
<area shape="rect" title=" " alt="" coords="222,388,445,465"/>
<area shape="rect" title=" " alt="" coords="255,145,412,223"/>
<area shape="rect" title=" " alt="" coords="314,5,353,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:ae7d3121030a93a2420350fc579928df8"><td class="memItemLeft" align="right" valign="top"><a id="ae7d3121030a93a2420350fc579928df8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Impl</b> (<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *parent, QString name)</td></tr>
<tr class="separator:ae7d3121030a93a2420350fc579928df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27d0bbc6af06626bd67285c095313f0e"><td class="memItemLeft" align="right" valign="top"><a id="a27d0bbc6af06626bd67285c095313f0e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Impl</b> (<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *parent, TaskRunnable runnable, QString name, DataObjectPtr data_object)</td></tr>
<tr class="separator:a27d0bbc6af06626bd67285c095313f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65de8c02c4d2d8badba8e0fb1a21e6b6"><td class="memItemLeft" align="right" valign="top"><a id="a65de8c02c4d2d8badba8e0fb1a21e6b6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Impl</b> (<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *parent, TaskRunnable runnable, QString name, DataObjectPtr data_object, TaskCallback callback)</td></tr>
<tr class="separator:a65de8c02c4d2d8badba8e0fb1a21e6b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b844765ba5c75ee061fe19ccb663e1d"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#a2b844765ba5c75ee061fe19ccb663e1d">GetFullID</a> () const -&gt; QString</td></tr>
<tr class="separator:a2b844765ba5c75ee061fe19ccb663e1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80cea2ad3b8049cc5c71c79952eaaeb8"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#a80cea2ad3b8049cc5c71c79952eaaeb8">GetUUID</a> () const -&gt; QString</td></tr>
<tr class="separator:a80cea2ad3b8049cc5c71c79952eaaeb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af57e2e511eb44f755d1bfc62898f433d"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#af57e2e511eb44f755d1bfc62898f433d">Run</a> () -&gt; int</td></tr>
<tr class="separator:af57e2e511eb44f755d1bfc62898f433d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef6600ccb8fed406e8b9112b5dd7ef8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#aef6600ccb8fed406e8b9112b5dd7ef8f">HoldOnLifeCycle</a> (bool hold_on)</td></tr>
<tr class="memdesc:aef6600ccb8fed406e8b9112b5dd7ef8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Finish After Run object. <a href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#aef6600ccb8fed406e8b9112b5dd7ef8f">More...</a><br /></td></tr>
<tr class="separator:aef6600ccb8fed406e8b9112b5dd7ef8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f5addc7abfd18e180a5969895f5d83a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#a4f5addc7abfd18e180a5969895f5d83a">SetRTN</a> (int rtn)</td></tr>
<tr class="separator:a4f5addc7abfd18e180a5969895f5d83a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a4918c9e0edd5ca6e843b370326666b"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#a7a4918c9e0edd5ca6e843b370326666b">GetRTN</a> () const</td></tr>
<tr class="separator:a7a4918c9e0edd5ca6e843b370326666b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a4d9dd61c1e5525b41de70e1bda2f6137"><td class="memItemLeft" align="right" valign="top"><a id="a4d9dd61c1e5525b41de70e1bda2f6137"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>init</b> ()</td></tr>
<tr class="separator:a4d9dd61c1e5525b41de70e1bda2f6137"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:ad0878b39a1fe88d7a207ee0df0b90842"><td class="memItemLeft" align="right" valign="top">static auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#ad0878b39a1fe88d7a207ee0df0b90842">generate_uuid</a> () -&gt; QString</td></tr>
<tr class="separator:ad0878b39a1fe88d7a207ee0df0b90842"><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:ada0cade5504c349b91e261a2e8de93d2"><td class="memItemLeft" align="right" valign="top"><a id="ada0cade5504c349b91e261a2e8de93d2"></a>
<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *const&#160;</td><td class="memItemRight" valign="bottom"><b>parent_</b></td></tr>
<tr class="separator:ada0cade5504c349b91e261a2e8de93d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e894802cf9be661b0948e6ed64983e"><td class="memItemLeft" align="right" valign="top"><a id="af8e894802cf9be661b0948e6ed64983e"></a>
const QString&#160;</td><td class="memItemRight" valign="bottom"><b>uuid_</b></td></tr>
<tr class="separator:af8e894802cf9be661b0948e6ed64983e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a583a25185e2f0543ce127b58f483f4"><td class="memItemLeft" align="right" valign="top"><a id="a4a583a25185e2f0543ce127b58f483f4"></a>
const QString&#160;</td><td class="memItemRight" valign="bottom"><b>name_</b></td></tr>
<tr class="separator:a4a583a25185e2f0543ce127b58f483f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a9e26e0652fa795db0ea75d9d4a22b4"><td class="memItemLeft" align="right" valign="top"><a id="a0a9e26e0652fa795db0ea75d9d4a22b4"></a>
TaskRunnable&#160;</td><td class="memItemRight" valign="bottom"><b>runnable_</b></td></tr>
<tr class="separator:a0a9e26e0652fa795db0ea75d9d4a22b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad34e22b1a93671aff7fb15609281de9c"><td class="memItemLeft" align="right" valign="top"><a id="ad34e22b1a93671aff7fb15609281de9c"></a>
TaskCallback&#160;</td><td class="memItemRight" valign="bottom"><b>callback_</b></td></tr>
<tr class="separator:ad34e22b1a93671aff7fb15609281de9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9285cc0f8d3b527bcd9f3882e86c9e"><td class="memItemLeft" align="right" valign="top"><a id="a6d9285cc0f8d3b527bcd9f3882e86c9e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>rtn_</b> = -99</td></tr>
<tr class="separator:a6d9285cc0f8d3b527bcd9f3882e86c9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a194f4e5ee8a6ef14bde85a3bb08bebae"><td class="memItemLeft" align="right" valign="top"><a id="a194f4e5ee8a6ef14bde85a3bb08bebae"></a>
QThread *&#160;</td><td class="memItemRight" valign="bottom"><b>callback_thread_</b> = nullptr</td></tr>
<tr class="separator:a194f4e5ee8a6ef14bde85a3bb08bebae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99d15d4c664a06c124828d515d07a2c4"><td class="memItemLeft" align="right" valign="top"><a id="a99d15d4c664a06c124828d515d07a2c4"></a>
DataObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><b>data_object_</b> = nullptr</td></tr>
<tr class="separator:a99d15d4c664a06c124828d515d07a2c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad0878b39a1fe88d7a207ee0df0b90842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0878b39a1fe88d7a207ee0df0b90842">&#9670;&nbsp;</a></span>generate_uuid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static auto GpgFrontend::Thread::Task::Impl::generate_uuid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; QString </td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>QString </dd></dl>
</div>
</div>
<a id="a2b844765ba5c75ee061fe19ccb663e1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b844765ba5c75ee061fe19ccb663e1d">&#9670;&nbsp;</a></span>GetFullID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::Task::Impl::GetFullID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const -&gt; QString </td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>QString </dd></dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#af57e2e511eb44f755d1bfc62898f433d">Run()</a>.</p>
</div>
</div>
<a id="a7a4918c9e0edd5ca6e843b370326666b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a4918c9e0edd5ca6e843b370326666b">&#9670;&nbsp;</a></span>GetRTN()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::Task::Impl::GetRTN </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>auto </dd></dl>
</div>
</div>
<a id="a80cea2ad3b8049cc5c71c79952eaaeb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80cea2ad3b8049cc5c71c79952eaaeb8">&#9670;&nbsp;</a></span>GetUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::Task::Impl::GetUUID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const -&gt; QString </td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>QString </dd></dl>
</div>
</div>
<a id="aef6600ccb8fed406e8b9112b5dd7ef8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef6600ccb8fed406e8b9112b5dd7ef8f">&#9670;&nbsp;</a></span>HoldOnLifeCycle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::Task::Impl::HoldOnLifeCycle </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>hold_on</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Finish After Run object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">finish_after_run</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af57e2e511eb44f755d1bfc62898f433d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af57e2e511eb44f755d1bfc62898f433d">&#9670;&nbsp;</a></span>Run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::Task::Impl::Run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; int </td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
<p class="reference">References <a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html#a2b844765ba5c75ee061fe19ccb663e1d">GetFullID()</a>.</p>
</div>
</div>
<a id="a4f5addc7abfd18e180a5969895f5d83a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f5addc7abfd18e180a5969895f5d83a">&#9670;&nbsp;</a></span>SetRTN()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::Task::Impl::SetRTN </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>rtn</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rtn</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/core/thread/Task.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="namespaceGpgFrontend_1_1Thread.html">Thread</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html">Impl</a></li>
<li class="footer">Generated 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 </li>
</ul>
</div>
</body>
</html>