524 lines
30 KiB
HTML
524 lines
30 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::Thread::Task 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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classGpgFrontend_1_1Thread_1_1Task.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> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#signals">Signals</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classGpgFrontend_1_1Thread_1_1Task-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GpgFrontend::Thread::Task Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for GpgFrontend::Thread::Task:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classGpgFrontend_1_1Thread_1_1Task__inherit__graph.png" border="0" usemap="#GpgFrontend_1_1Thread_1_1Task_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="GpgFrontend_1_1Thread_1_1Task_inherit__map" id="GpgFrontend_1_1Thread_1_1Task_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="110,131,273,472"/>
|
|
<area shape="rect" href="classGpgFrontend_1_1Thread_1_1CtxCheckTask.html" title=" " alt="" coords="5,549,164,656"/>
|
|
<area shape="rect" href="classGpgFrontend_1_1UI_1_1FileReadTask.html" title=" " alt="" coords="188,520,408,685"/>
|
|
<area shape="rect" title=" " alt="" coords="101,5,175,83"/>
|
|
<area shape="rect" title=" " alt="" coords="199,5,293,83"/>
|
|
</map>
|
|
</div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for GpgFrontend::Thread::Task:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classGpgFrontend_1_1Thread_1_1Task__coll__graph.png" border="0" usemap="#GpgFrontend_1_1Thread_1_1Task_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="GpgFrontend_1_1Thread_1_1Task_coll__map" id="GpgFrontend_1_1Thread_1_1Task_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="108,944,271,1256"/>
|
|
<area shape="rect" title=" " alt="" coords="5,804,80,881"/>
|
|
<area shape="rect" title=" " alt="" coords="104,804,197,881"/>
|
|
<area shape="rect" title="STL class." alt="" coords="222,804,309,881"/>
|
|
<area shape="rect" title="STL class." alt="" coords="196,605,335,697"/>
|
|
<area shape="rect" title=" " alt="" coords="333,804,555,881"/>
|
|
<area shape="rect" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html" title="DataObject to be passed to the callback function." alt="" coords="362,561,521,741"/>
|
|
<area shape="rect" title=" " alt="" coords="250,392,443,499"/>
|
|
<area shape="rect" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html" title=" " alt="" coords="159,145,318,267"/>
|
|
<area shape="rect" title="STL class." alt="" coords="360,167,483,245"/>
|
|
<area shape="rect" title=" " alt="" coords="526,5,565,83"/>
|
|
<area shape="rect" title="STL class." alt="" coords="575,291,732,368"/>
|
|
</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html">DataObject</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html" title="DataObject to be passed to the callback function.">DataObject</a> to be passed to the callback function. <a href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a58f0de628876e2c064f3867f209ce1c9"><td class="memItemLeft" align="right" valign="top"><a id="a58f0de628876e2c064f3867f209ce1c9"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>DataObjectPtr</b> = std::shared_ptr< <a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html">DataObject</a> ></td></tr>
|
|
<tr class="separator:a58f0de628876e2c064f3867f209ce1c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0015912ca0513a10252e01db7b527bb"><td class="memItemLeft" align="right" valign="top"><a id="aa0015912ca0513a10252e01db7b527bb"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>TaskRunnable</b> = std::function< int(DataObjectPtr)></td></tr>
|
|
<tr class="separator:aa0015912ca0513a10252e01db7b527bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492f8b0f6ec2832da20fc481bfa5cdbd"><td class="memItemLeft" align="right" valign="top"><a id="a492f8b0f6ec2832da20fc481bfa5cdbd"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>TaskCallback</b> = std::function< void(int, DataObjectPtr)></td></tr>
|
|
<tr class="separator:a492f8b0f6ec2832da20fc481bfa5cdbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
|
|
Signals</h2></td></tr>
|
|
<tr class="memitem:af50c7642efe45554c61943fb3d8825b3"><td class="memItemLeft" align="right" valign="top"><a id="af50c7642efe45554c61943fb3d8825b3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SignalTaskFinished</b> ()</td></tr>
|
|
<tr class="separator:af50c7642efe45554c61943fb3d8825b3"><td class="memSeparator" colspan="2"> </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:a1ec53d301fc83e0da39e43055ded5d14"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#a1ec53d301fc83e0da39e43055ded5d14">Task</a> ()</td></tr>
|
|
<tr class="memdesc:a1ec53d301fc83e0da39e43055ded5d14"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. <a href="classGpgFrontend_1_1Thread_1_1Task.html#a1ec53d301fc83e0da39e43055ded5d14">More...</a><br /></td></tr>
|
|
<tr class="separator:a1ec53d301fc83e0da39e43055ded5d14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35f3065116d2295bb2ddc9f41b1192bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#a35f3065116d2295bb2ddc9f41b1192bb">Task</a> (TaskCallback callback, DataObjectPtr data_object=nullptr)</td></tr>
|
|
<tr class="memdesc:a35f3065116d2295bb2ddc9f41b1192bb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. <a href="classGpgFrontend_1_1Thread_1_1Task.html#a35f3065116d2295bb2ddc9f41b1192bb">More...</a><br /></td></tr>
|
|
<tr class="separator:a35f3065116d2295bb2ddc9f41b1192bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa242a8e025c448aacd0704b7d0b3c001"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#aa242a8e025c448aacd0704b7d0b3c001">Task</a> (TaskRunnable runnable, TaskCallback callback=[](int, std::shared_ptr< <a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html">DataObject</a> >) {}, DataObjectPtr data=nullptr)</td></tr>
|
|
<tr class="memdesc:aa242a8e025c448aacd0704b7d0b3c001"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. <a href="classGpgFrontend_1_1Thread_1_1Task.html#aa242a8e025c448aacd0704b7d0b3c001">More...</a><br /></td></tr>
|
|
<tr class="separator:aa242a8e025c448aacd0704b7d0b3c001"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37766a505662b33ad14672c29e209ea8"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#a37766a505662b33ad14672c29e209ea8">~Task</a> () override</td></tr>
|
|
<tr class="memdesc:a37766a505662b33ad14672c29e209ea8"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. <a href="classGpgFrontend_1_1Thread_1_1Task.html#a37766a505662b33ad14672c29e209ea8">More...</a><br /></td></tr>
|
|
<tr class="separator:a37766a505662b33ad14672c29e209ea8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac60aa71a24f452fd8031597ff4cbbd00"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#ac60aa71a24f452fd8031597ff4cbbd00">Run</a> ()</td></tr>
|
|
<tr class="memdesc:ac60aa71a24f452fd8031597ff4cbbd00"><td class="mdescLeft"> </td><td class="mdescRight">Run - run the task. <a href="classGpgFrontend_1_1Thread_1_1Task.html#ac60aa71a24f452fd8031597ff4cbbd00">More...</a><br /></td></tr>
|
|
<tr class="separator:ac60aa71a24f452fd8031597ff4cbbd00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50b91d27874af31ef13c493b00824ccf"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#a50b91d27874af31ef13c493b00824ccf">GetUUID</a> () const</td></tr>
|
|
<tr class="separator:a50b91d27874af31ef13c493b00824ccf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a689969e7d88ba7ad73a693a1b38aedd7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#a689969e7d88ba7ad73a693a1b38aedd7">SetFinishAfterRun</a> (bool finish_after_run)</td></tr>
|
|
<tr class="memdesc:a689969e7d88ba7ad73a693a1b38aedd7"><td class="mdescLeft"> </td><td class="mdescRight">Set the Finish After Run object. <a href="classGpgFrontend_1_1Thread_1_1Task.html#a689969e7d88ba7ad73a693a1b38aedd7">More...</a><br /></td></tr>
|
|
<tr class="separator:a689969e7d88ba7ad73a693a1b38aedd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6d702417bdd6a88c447ed6a457fa098"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#aa6d702417bdd6a88c447ed6a457fa098">SetRTN</a> (int rtn)</td></tr>
|
|
<tr class="separator:aa6d702417bdd6a88c447ed6a457fa098"><td class="memSeparator" colspan="2"> </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:a98486634324dc28d05fb0b812ed807e3"><td class="memItemLeft" align="right" valign="top"><a id="a98486634324dc28d05fb0b812ed807e3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>before_finish_task</b> ()</td></tr>
|
|
<tr class="separator:a98486634324dc28d05fb0b812ed807e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ee1ea118ac5d91f005faecef54742b8"><td class="memItemLeft" align="right" valign="top"><a id="a5ee1ea118ac5d91f005faecef54742b8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>init</b> ()</td></tr>
|
|
<tr class="separator:a5ee1ea118ac5d91f005faecef54742b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a024a05bb89556c5b93336cb35d4bd10c"><td class="memItemLeft" align="right" valign="top"><a id="a024a05bb89556c5b93336cb35d4bd10c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>run</b> () override</td></tr>
|
|
<tr class="separator:a024a05bb89556c5b93336cb35d4bd10c"><td class="memSeparator" colspan="2"> </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:a96d087abb7cf99d16f778f1a93b4f9e5"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html#a96d087abb7cf99d16f778f1a93b4f9e5">generate_uuid</a> ()</td></tr>
|
|
<tr class="separator:a96d087abb7cf99d16f778f1a93b4f9e5"><td class="memSeparator" colspan="2"> </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:a468f4b05a8eb6b66c3f240bc2a660a08"><td class="memItemLeft" align="right" valign="top"><a id="a468f4b05a8eb6b66c3f240bc2a660a08"></a>
|
|
const std::string </td><td class="memItemRight" valign="bottom"><b>uuid_</b></td></tr>
|
|
<tr class="separator:a468f4b05a8eb6b66c3f240bc2a660a08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b47295d027309aee116d219b50de4f8"><td class="memItemLeft" align="right" valign="top"><a id="a5b47295d027309aee116d219b50de4f8"></a>
|
|
TaskCallback </td><td class="memItemRight" valign="bottom"><b>callback_</b></td></tr>
|
|
<tr class="separator:a5b47295d027309aee116d219b50de4f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cb0482d29d502870dc8d38b8aaedf68"><td class="memItemLeft" align="right" valign="top"><a id="a0cb0482d29d502870dc8d38b8aaedf68"></a>
|
|
TaskRunnable </td><td class="memItemRight" valign="bottom"><b>runnable_</b></td></tr>
|
|
<tr class="separator:a0cb0482d29d502870dc8d38b8aaedf68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f29cfb3a72d718da6d835f3a049f7cc"><td class="memItemLeft" align="right" valign="top"><a id="a4f29cfb3a72d718da6d835f3a049f7cc"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>finish_after_run_</b> = true</td></tr>
|
|
<tr class="separator:a4f29cfb3a72d718da6d835f3a049f7cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6388db7b0e4960db5bf8296481481dd"><td class="memItemLeft" align="right" valign="top"><a id="ad6388db7b0e4960db5bf8296481481dd"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>rtn_</b> = 0</td></tr>
|
|
<tr class="separator:ad6388db7b0e4960db5bf8296481481dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a6a92c92febc94e8abbc1a96d489446"><td class="memItemLeft" align="right" valign="top"><a id="a1a6a92c92febc94e8abbc1a96d489446"></a>
|
|
QThread * </td><td class="memItemRight" valign="bottom"><b>callback_thread_</b> = nullptr</td></tr>
|
|
<tr class="separator:a1a6a92c92febc94e8abbc1a96d489446"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa500f907beee47f99fdeb626d2c788bd"><td class="memItemLeft" align="right" valign="top"><a id="aa500f907beee47f99fdeb626d2c788bd"></a>
|
|
DataObjectPtr </td><td class="memItemRight" valign="bottom"><b>data_object_</b> = nullptr</td></tr>
|
|
<tr class="separator:aa500f907beee47f99fdeb626d2c788bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a1956d94b45592a4096a335641aab65f8"><td class="memItemLeft" align="right" valign="top"><a id="a1956d94b45592a4096a335641aab65f8"></a>
|
|
<a class="el" href="classclass.html">class</a> </td><td class="memItemRight" valign="bottom"><b>TaskRunner</b></td></tr>
|
|
<tr class="separator:a1956d94b45592a4096a335641aab65f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a1ec53d301fc83e0da39e43055ded5d14"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ec53d301fc83e0da39e43055ded5d14">◆ </a></span>Task() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpgFrontend::Thread::Task::Task </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. </p>
|
|
<p>Copyright (C) 2021 Saturneric</p>
|
|
<p>This file is part of <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a>.</p>
|
|
<p><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
|
|
<p><a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a> is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
|
|
<p>You should have received a copy of the GNU General Public License along with <a class="el" href="namespaceGpgFrontend.html">GpgFrontend</a>. If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.</p>
|
|
<p>The initial version of the source code is inherited from the gpg4usb project, which is under GPL-3.0-or-later.</p>
|
|
<p>The source code version of this software was modified and released by Saturneric<a href="#" onclick="location.href='mai'+'lto:'+'eri'+'c@'+'bkt'+'us'+'.co'+'m'; return false;">eric@<span style="display: none;">.nosp@m.</span>bktu<span style="display: none;">.nosp@m.</span>s.com</a><a href="#" onclick="location.href='mai'+'lto:'+'eri'+'c@'+'bkt'+'us'+'.co'+'m'; return false;">eric@<span style="display: none;">.nosp@m.</span>bktu<span style="display: none;">.nosp@m.</span>s.com</a> starting on May 12, 2021. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35f3065116d2295bb2ddc9f41b1192bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35f3065116d2295bb2ddc9f41b1192bb">◆ </a></span>Task() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpgFrontend::Thread::Task::Task </td>
|
|
<td>(</td>
|
|
<td class="paramtype">TaskCallback </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">DataObjectPtr </td>
|
|
<td class="paramname"><em>data_object</em> = <code>nullptr</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback</td><td>The callback function to be executed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa242a8e025c448aacd0704b7d0b3c001"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa242a8e025c448aacd0704b7d0b3c001">◆ </a></span>Task() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpgFrontend::Thread::Task::Task </td>
|
|
<td>(</td>
|
|
<td class="paramtype">TaskRunnable </td>
|
|
<td class="paramname"><em>runnable</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">TaskCallback </td>
|
|
<td class="paramname"><em>callback</em> = <code>[](int, std::shared_ptr<<a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html">DataObject</a>>) {}</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">DataObjectPtr </td>
|
|
<td class="paramname"><em>data</em> = <code>nullptr</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">runnable</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37766a505662b33ad14672c29e209ea8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37766a505662b33ad14672c29e209ea8">◆ </a></span>~Task()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GpgFrontend::Thread::Task::~Task </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroy the <a class="el" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a> object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a96d087abb7cf99d16f778f1a93b4f9e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96d087abb7cf99d16f778f1a93b4f9e5">◆ </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">std::string GpgFrontend::Thread::Task::generate_uuid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><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>std::string </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50b91d27874af31ef13c493b00824ccf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50b91d27874af31ef13c493b00824ccf">◆ </a></span>GetUUID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string GpgFrontend::Thread::Task::GetUUID </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>std::string </dd></dl>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a4fae01eb0a5b296b8c4c6bf8408f1c6b">GpgFrontend::Thread::TaskRunner::PostTask()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac60aa71a24f452fd8031597ff4cbbd00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac60aa71a24f452fd8031597ff4cbbd00">◆ </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">void GpgFrontend::Thread::Task::Run </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Run - run the task. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classGpgFrontend_1_1Thread_1_1CtxCheckTask.html#a1c94cb1290df40a9043fe2d1a9a231f2">GpgFrontend::Thread::CtxCheckTask</a>, and <a class="el" href="classGpgFrontend_1_1UI_1_1FileReadTask.html#a0f8bc1c253380b68c0e65cabc011ac09">GpgFrontend::UI::FileReadTask</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a689969e7d88ba7ad73a693a1b38aedd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a689969e7d88ba7ad73a693a1b38aedd7">◆ </a></span>SetFinishAfterRun()</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::SetFinishAfterRun </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>finish_after_run</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</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>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1UI_1_1FileReadTask.html#a0f8bc1c253380b68c0e65cabc011ac09">GpgFrontend::UI::FileReadTask::Run()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6d702417bdd6a88c447ed6a457fa098"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6d702417bdd6a88c447ed6a457fa098">◆ </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::SetRTN </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </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">protected</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 files:<ul>
|
|
<li>src/core/thread/<a class="el" href="Task_8h_source.html">Task.h</a></li>
|
|
<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="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>
|