2022-05-13 17:46:04 +00:00
<!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" / >
2022-11-26 18:19:17 +00:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2022-05-13 17:46:04 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > GpgFrontend Project: src/core/thread/Task.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 -->
2022-11-26 18:19:17 +00:00
<!-- Generated by Doxygen 1.9.1 -->
2022-05-13 17:46:04 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2022-11-26 18:19:17 +00:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2022-05-13 17:46:04 +00:00
/* @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('Task_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" > Task.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < span class = "preprocessor" > #include " core/GpgFrontendCore.h" < / span > < / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < span class = "preprocessor" > #include " core/function/SecureMemoryAllocator.h" < / span > < / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < span class = "preprocessor" > #include " core/model/DataObject.h" < / span > < / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   < / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < span class = "keyword" > namespace < / span > < a class = "code" href = "namespaceGpgFrontend_1_1Thread.html" > GpgFrontend::Thread< / a > {< / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   < / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   < span class = "keyword" > class < / span > TaskRunner;< / div >
2022-05-15 08:40:18 +00:00
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > < a class = "line" href = "classGpgFrontend_1_1Thread_1_1Task.html" > 39< / a > < / span >   < span class = "keyword" > class < / span > GPGFRONTEND_CORE_EXPORT < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html" > Task< / a > : < span class = "keyword" > public< / span > QObject, < span class = "keyword" > public< / span > QRunnable {< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   Q_OBJECT< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < span class = "keyword" > friend< / span > < span class = "keyword" > class < / span > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1TaskRunner.html" > TaskRunner< / a > ;< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < span class = "keyword" > using< / span > TaskRunnable = std::function< int(DataObjectPtr)> ; < / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < span class = "keyword" > using< / span > TaskCallback = std::function< void(< span class = "keywordtype" > int< / span > , DataObjectPtr)> ; < / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > < a class = "line" href = "classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler.html" > 47< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler.html" > TaskHandler< / a > {< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler.html" > TaskHandler< / a > (< a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html" > Task< / a > *);< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < span class = "keywordtype" > void< / span > Start();< / div >
2022-05-15 08:40:18 +00:00
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "keywordtype" > void< / span > Cancel();< / div >
2022-05-15 14:16:11 +00:00
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   < span class = "keyword" > auto< / span > GetTask() -> < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html" > Task< / a > *;< / div >
2023-02-25 08:33:31 +00:00
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   QPointer< Task> task_;< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   };< / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   < / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html" > Task< / a > (QString name);< / div >
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   < / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html" > Task< / a > (TaskRunnable runnable, QString name,< / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   DataObjectPtr data_object = < span class = "keyword" > nullptr< / span > );< / div >
2023-02-25 08:33:31 +00:00
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html" > Task< / a > (TaskRunnable runnable, QString name, DataObjectPtr data,< / div >
< div class = "line" > < a name = "l00081" > < / a > < span class = "lineno" > 81< / span >   TaskCallback callback);< / div >
< div class = "line" > < a name = "l00082" > < / a > < span class = "lineno" > 82< / span >   < / div >
< div class = "line" > < a name = "l00087" > < / a > < span class = "lineno" > < a class = "line" href = "classGpgFrontend_1_1Thread_1_1Task.html#a37766a505662b33ad14672c29e209ea8" > 87< / a > < / span >   < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task.html#a37766a505662b33ad14672c29e209ea8" > ~Task< / a > () < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00088" > < / a > < span class = "lineno" > 88< / span >   < / div >
< div class = "line" > < a name = "l00094" > < / a > < span class = "lineno" > 94< / span >   [[nodiscard]] < span class = "keyword" > auto< / span > GetUUID() const -> QString;< / div >
2023-02-25 08:33:31 +00:00
< div class = "line" > < a name = "l00095" > < / a > < span class = "lineno" > 95< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00101" > < / a > < span class = "lineno" > 101< / span >   [[nodiscard]] auto GetFullID() const -> QString;< / div >
< div class = "line" > < a name = "l00102" > < / a > < span class = "lineno" > 102< / span >   < / div >
< div class = "line" > < a name = "l00108" > < / a > < span class = "lineno" > 108< / span >   < span class = "keywordtype" > void< / span > HoldOnLifeCycle(< span class = "keywordtype" > bool< / span > hold_on);< / div >
< div class = "line" > < a name = "l00109" > < / a > < span class = "lineno" > 109< / span >   < / div >
< div class = "line" > < a name = "l00115" > < / a > < span class = "lineno" > 115< / span >   virtual auto Run() -> < span class = "keywordtype" > int< / span > ;< / div >
< div class = "line" > < a name = "l00116" > < / a > < span class = "lineno" > 116< / span >   < / div >
< div class = "line" > < a name = "l00122" > < / a > < span class = "lineno" > 122< / span >   [[nodiscard]] auto GetRTN();< / div >
< div class = "line" > < a name = "l00123" > < / a > < span class = "lineno" > 123< / span >   < / div >
< div class = "line" > < a name = "l00124" > < / a > < span class = "lineno" > 124< / span >   public slots:< / div >
< div class = "line" > < a name = "l00125" > < / a > < span class = "lineno" > 125< / span >   < / div >
< div class = "line" > < a name = "l00130" > < / a > < span class = "lineno" > 130< / span >   < span class = "keywordtype" > void< / span > SafelyRun();< / div >
< div class = "line" > < a name = "l00131" > < / a > < span class = "lineno" > 131< / span >   < / div >
< div class = "line" > < a name = "l00132" > < / a > < span class = "lineno" > 132< / span >   signals:< / div >
< div class = "line" > < a name = "l00133" > < / a > < span class = "lineno" > 133< / span >   < / div >
< div class = "line" > < a name = "l00138" > < / a > < span class = "lineno" > 138< / span >   < span class = "keywordtype" > void< / span > SignalRun();< / div >
2023-02-25 08:33:31 +00:00
< div class = "line" > < a name = "l00139" > < / a > < span class = "lineno" > 139< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00144" > < / a > < span class = "lineno" > 144< / span >   < span class = "keywordtype" > void< / span > SignalTaskShouldEnd(< span class = "keywordtype" > int< / span > );< / div >
2023-02-25 08:33:31 +00:00
< div class = "line" > < a name = "l00145" > < / a > < span class = "lineno" > 145< / span >   < / div >
2024-01-23 07:22:33 +00:00
< div class = "line" > < a name = "l00150" > < / a > < span class = "lineno" > 150< / span >   < span class = "keywordtype" > void< / span > SignalTaskEnd();< / div >
< div class = "line" > < a name = "l00151" > < / a > < span class = "lineno" > 151< / span >   < / div >
< div class = "line" > < a name = "l00152" > < / a > < span class = "lineno" > 152< / span >   protected:< / div >
< div class = "line" > < a name = "l00158" > < / a > < span class = "lineno" > 158< / span >   < span class = "keywordtype" > void< / span > setRTN(< span class = "keywordtype" > int< / span > rtn);< / div >
< div class = "line" > < a name = "l00159" > < / a > < span class = "lineno" > 159< / span >   < / div >
< div class = "line" > < a name = "l00160" > < / a > < span class = "lineno" > 160< / span >   private slots:< / div >
< div class = "line" > < a name = "l00161" > < / a > < span class = "lineno" > 161< / span >   < / div >
< div class = "line" > < a name = "l00166" > < / a > < span class = "lineno" > 166< / span >   < span class = "keywordtype" > void< / span > slot_exception_safe_run() noexcept;< / div >
< div class = "line" > < a name = "l00167" > < / a > < span class = "lineno" > 167< / span >   < / div >
< div class = "line" > < a name = "l00168" > < / a > < span class = "lineno" > 168< / span >   private:< / div >
< div class = "line" > < a name = "l00169" > < / a > < span class = "lineno" > 169< / span >   < a class = "code" href = "classclass.html" > class< / a > < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html" > Impl< / a > ;< / div >
< div class = "line" > < a name = "l00170" > < / a > < span class = "lineno" > 170< / span >   SecureUniquePtr< < a class = "code" href = "classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html" > Impl< / a > > p_;< / div >
< div class = "line" > < a name = "l00171" > < / a > < span class = "lineno" > 171< / span >   < / div >
< div class = "line" > < a name = "l00172" > < / a > < span class = "lineno" > 172< / span >   < span class = "keywordtype" > void< / span > run() override;< / div >
< div class = "line" > < a name = "l00173" > < / a > < span class = "lineno" > 173< / span >   };< / div >
< div class = "line" > < a name = "l00174" > < / a > < span class = "lineno" > 174< / span >   } < span class = "comment" > // namespace GpgFrontend::Thread< / span > < / div >
< div class = "ttc" id = "aclassGpgFrontend_1_1Thread_1_1TaskRunner_html" > < div class = "ttname" > < a href = "classGpgFrontend_1_1Thread_1_1TaskRunner.html" > GpgFrontend::Thread::TaskRunner< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > TaskRunner.h:37< / div > < / div >
< div class = "ttc" id = "aclassGpgFrontend_1_1Thread_1_1Task_1_1Impl_html" > < div class = "ttname" > < a href = "classGpgFrontend_1_1Thread_1_1Task_1_1Impl.html" > GpgFrontend::Thread::Task::Impl< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > Task.cpp:37< / div > < / div >
< div class = "ttc" id = "aclassGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler_html" > < div class = "ttname" > < a href = "classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler.html" > GpgFrontend::Thread::Task::TaskHandler< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > Task.h:47< / div > < / div >
< div class = "ttc" id = "aclassGpgFrontend_1_1Thread_1_1Task_html" > < div class = "ttname" > < a href = "classGpgFrontend_1_1Thread_1_1Task.html" > GpgFrontend::Thread::Task< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > Task.h:39< / div > < / div >
< div class = "ttc" id = "aclassGpgFrontend_1_1Thread_1_1Task_html_a37766a505662b33ad14672c29e209ea8" > < div class = "ttname" > < a href = "classGpgFrontend_1_1Thread_1_1Task.html#a37766a505662b33ad14672c29e209ea8" > GpgFrontend::Thread::Task::~Task< / a > < / div > < div class = "ttdeci" > ~Task() override< / div > < div class = "ttdoc" > Destroy the Task object.< / div > < / div >
< div class = "ttc" id = "aclassclass_html" > < div class = "ttname" > < a href = "classclass.html" > class< / a > < / div > < div class = "ttdoc" > Executive files related to the basic operations of GPG.< / div > < / div >
< div class = "ttc" id = "anamespaceGpgFrontend_1_1Thread_html" > < div class = "ttname" > < a href = "namespaceGpgFrontend_1_1Thread.html" > GpgFrontend::Thread< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > ModuleManager.h:39< / div > < / div >
2022-11-26 18:19:17 +00:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2022-05-13 17:46:04 +00:00
<!-- 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_fd71accbf528c1576ca21e7ec5716833.html" > thread< / a > < / li > < li class = "navelem" > < b > Task.h< / b > < / li >
2022-11-26 18:19:17 +00:00
< 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 >
2022-05-13 17:46:04 +00:00
< / ul >
< / div >
< / body >
< / html >