GpgFrontend/GpgFrontend-Doxygen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
develop
GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1Thread_1_1TaskRunner.html

383 lines
19 KiB
HTML
Raw Permalink Blame History

<!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::TaskRunner 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_1TaskRunner.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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1Thread_1_1TaskRunner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::Thread::TaskRunner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for GpgFrontend::Thread::TaskRunner:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Thread_1_1TaskRunner__inherit__graph.png" border="0" usemap="#aGpgFrontend_1_1Thread_1_1TaskRunner_inherit__map" alt="Inheritance graph"/></div>
<map name="aGpgFrontend_1_1Thread_1_1TaskRunner_inherit__map" id="aGpgFrontend_1_1Thread_1_1TaskRunner_inherit__map">
<area shape="rect" title=" " alt="" coords="5,131,180,369"/>
<area shape="rect" title=" " alt="" coords="55,5,130,83"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for GpgFrontend::Thread::TaskRunner:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Thread_1_1TaskRunner__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1Thread_1_1TaskRunner_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1Thread_1_1TaskRunner_coll__map" id="aGpgFrontend_1_1Thread_1_1TaskRunner_coll__map">
<area shape="rect" title=" " alt="" coords="5,131,180,369"/>
<area shape="rect" title=" " alt="" coords="55,5,130,83"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner_1_1Impl.html">Impl</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ad3c8612cbe60112f9b14e616fb0a4acf"><td class="memItemLeft" align="right" valign="top"><a id="ad3c8612cbe60112f9b14e616fb0a4acf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ad3c8612cbe60112f9b14e616fb0a4acf">TaskRunner</a> ()</td></tr>
<tr class="memdesc:ad3c8612cbe60112f9b14e616fb0a4acf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> Runner object. <br /></td></tr>
<tr class="separator:ad3c8612cbe60112f9b14e616fb0a4acf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3e57b59d537e2a75e741d4a5418ae6d"><td class="memItemLeft" align="right" valign="top"><a id="ac3e57b59d537e2a75e741d4a5418ae6d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ac3e57b59d537e2a75e741d4a5418ae6d">~TaskRunner</a> () override</td></tr>
<tr class="memdesc:ac3e57b59d537e2a75e741d4a5418ae6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> Runner object. <br /></td></tr>
<tr class="separator:ac3e57b59d537e2a75e741d4a5418ae6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfc4b5922a7760e4334de7edc0f088c1"><td class="memItemLeft" align="right" valign="top"><a id="acfc4b5922a7760e4334de7edc0f088c1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Start</b> ()</td></tr>
<tr class="separator:acfc4b5922a7760e4334de7edc0f088c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78c7e4bdca5abfde140acf8e236b9d49"><td class="memItemLeft" align="right" valign="top"><a id="a78c7e4bdca5abfde140acf8e236b9d49"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Stop</b> ()</td></tr>
<tr class="separator:a78c7e4bdca5abfde140acf8e236b9d49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57e29f0dde8ceec05c68841985b43f42"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a57e29f0dde8ceec05c68841985b43f42">GetThread</a> () -&gt; QThread *</td></tr>
<tr class="memdesc:a57e29f0dde8ceec05c68841985b43f42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceGpgFrontend_1_1Thread.html">Thread</a> object. <a href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a57e29f0dde8ceec05c68841985b43f42">More...</a><br /></td></tr>
<tr class="separator:a57e29f0dde8ceec05c68841985b43f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a172bca161e13c253b16f0f712721b450"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a172bca161e13c253b16f0f712721b450">IsRunning</a> () -&gt; bool</td></tr>
<tr class="separator:a172bca161e13c253b16f0f712721b450"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fae01eb0a5b296b8c4c6bf8408f1c6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a4fae01eb0a5b296b8c4c6bf8408f1c6b">PostTask</a> (<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *task)</td></tr>
<tr class="separator:a4fae01eb0a5b296b8c4c6bf8408f1c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38e1af613d2bc390198a8744f2148f5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a38e1af613d2bc390198a8744f2148f5e">PostTask</a> (const QString &amp;, const Task::TaskRunnable &amp;, const Task::TaskCallback &amp;, DataObjectPtr)</td></tr>
<tr class="separator:a38e1af613d2bc390198a8744f2148f5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31a08bfcc288cc70be93de991841d9f9"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a31a08bfcc288cc70be93de991841d9f9">RegisterTask</a> (const QString &amp;, const Task::TaskRunnable &amp;, const Task::TaskCallback &amp;, DataObjectPtr) -&gt; <a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler.html">Task::TaskHandler</a></td></tr>
<tr class="separator:a31a08bfcc288cc70be93de991841d9f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af65c46061d6ee2008b5fa5593de70026"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#af65c46061d6ee2008b5fa5593de70026">PostConcurrentTask</a> (<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *task)</td></tr>
<tr class="separator:af65c46061d6ee2008b5fa5593de70026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaddb0cdd8eb57aac08ca9caf8b8e6bac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#aaddb0cdd8eb57aac08ca9caf8b8e6bac">PostScheduleTask</a> (<a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *task, size_t seconds)</td></tr>
<tr class="separator:aaddb0cdd8eb57aac08ca9caf8b8e6bac"><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:a3a27880489e708b589fb72d56f9b5579"><td class="memItemLeft" align="right" valign="top"><a id="a3a27880489e708b589fb72d56f9b5579"></a>
SecureUniquePtr&lt; <a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner_1_1Impl.html">Impl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>p_</b></td></tr>
<tr class="separator:a3a27880489e708b589fb72d56f9b5579"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a57e29f0dde8ceec05c68841985b43f42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57e29f0dde8ceec05c68841985b43f42">&#9670;&nbsp;</a></span>GetThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::TaskRunner::GetThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; QThread*</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <a class="el" href="namespaceGpgFrontend_1_1Thread.html">Thread</a> object. </p>
<dl class="section return"><dt>Returns</dt><dd>QThread* </dd></dl>
</div>
</div>
<a id="a172bca161e13c253b16f0f712721b450"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a172bca161e13c253b16f0f712721b450">&#9670;&nbsp;</a></span>IsRunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::TaskRunner::IsRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; bool</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true </dd>
<dd>
false </dd></dl>
</div>
</div>
<a id="af65c46061d6ee2008b5fa5593de70026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af65c46061d6ee2008b5fa5593de70026">&#9670;&nbsp;</a></span>PostConcurrentTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::TaskRunner::PostConcurrentTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *&#160;</td>
<td class="paramname"><em>task</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">task</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaddb0cdd8eb57aac08ca9caf8b8e6bac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaddb0cdd8eb57aac08ca9caf8b8e6bac">&#9670;&nbsp;</a></span>PostScheduleTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::TaskRunner::PostScheduleTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *&#160;</td>
<td class="paramname"><em>task</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>seconds</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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">task</td><td></td></tr>
<tr><td class="paramname">seconds</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a38e1af613d2bc390198a8744f2148f5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38e1af613d2bc390198a8744f2148f5e">&#9670;&nbsp;</a></span>PostTask() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::TaskRunner::PostTask </td>
<td>(</td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Task::TaskRunnable &amp;&#160;</td>
<td class="paramname"><em>runner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Task::TaskCallback &amp;&#160;</td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DataObjectPtr&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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">runner</td><td></td></tr>
<tr><td class="paramname">cb</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4fae01eb0a5b296b8c4c6bf8408f1c6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fae01eb0a5b296b8c4c6bf8408f1c6b">&#9670;&nbsp;</a></span>PostTask() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::TaskRunner::PostTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> *&#160;</td>
<td class="paramname"><em>task</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">task</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a31a08bfcc288cc70be93de991841d9f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31a08bfcc288cc70be93de991841d9f9">&#9670;&nbsp;</a></span>RegisterTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::Thread::TaskRunner::RegisterTask </td>
<td>(</td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Task::TaskRunnable &amp;&#160;</td>
<td class="paramname"><em>runnable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Task::TaskCallback &amp;&#160;</td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DataObjectPtr&#160;</td>
<td class="paramname"><em>p_pbj</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> -&gt; <a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler.html">Task::TaskHandler</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>std::tuple&lt;QPointer&lt;Task&gt;, TaskTrigger&gt; </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/thread/<a class="el" href="TaskRunner_8h_source.html">TaskRunner.h</a></li>
<li>src/core/thread/TaskRunner.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_1TaskRunner.html">TaskRunner</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>
Reference in New Issue View Git Blame Copy Permalink