GpgFrontend-Doxygen/docs/html/TaskRunner_8h_source.html

142 lines
12 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: src/core/thread/TaskRunner.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 -->
<!-- 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('TaskRunner_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">TaskRunner.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#ifndef GPGFRONTEND_TASKRUNNER_H</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define GPGFRONTEND_TASKRUNNER_H</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;queue&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;core/GpgFrontendCore.h&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<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>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">class </span>Task;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html"> 39</a></span>&#160;<span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html">TaskRunner</a> : <span class="keyword">public</span> QThread {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; Q_OBJECT</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ad3c8612cbe60112f9b14e616fb0a4acf"> 46</a></span>&#160; <a class="code" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ad3c8612cbe60112f9b14e616fb0a4acf">TaskRunner</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ac3e57b59d537e2a75e741d4a5418ae6d"> 52</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ac3e57b59d537e2a75e741d4a5418ae6d">~TaskRunner</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; [[noreturn]] <span class="keywordtype">void</span> run() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">public</span> slots:</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> PostTask(<a class="code" href="classGpgFrontend_1_1Thread_1_1Task.html">Task</a>* task);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a774775e9a91d33072b27dcf78cead6e2"> 70</a></span>&#160; std::queue&lt;Task*&gt; <a class="code" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a774775e9a91d33072b27dcf78cead6e2">tasks</a>; </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a6d92421bbbfcf3136335a5173d1b2a22"> 71</a></span>&#160; std::map&lt;std::string, Task*&gt; <a class="code" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a6d92421bbbfcf3136335a5173d1b2a22">pending_tasks_</a>; </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a5e72f1ce00d41c225a4304f1ed20b3f1"> 72</a></span>&#160; std::mutex <a class="code" href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a5e72f1ce00d41c225a4304f1ed20b3f1">tasks_mutex_</a>; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;};</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// namespace GpgFrontend::Thread</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// GPGFRONTEND_TASKRUNNER_H</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:39</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1Thread_1_1TaskRunner_html_a5e72f1ce00d41c225a4304f1ed20b3f1"><div class="ttname"><a href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a5e72f1ce00d41c225a4304f1ed20b3f1">GpgFrontend::Thread::TaskRunner::tasks_mutex_</a></div><div class="ttdeci">std::mutex tasks_mutex_</div><div class="ttdoc">The task queue mutex.</div><div class="ttdef"><b>Definition:</b> TaskRunner.h:72</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1Thread_1_1TaskRunner_html_a6d92421bbbfcf3136335a5173d1b2a22"><div class="ttname"><a href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a6d92421bbbfcf3136335a5173d1b2a22">GpgFrontend::Thread::TaskRunner::pending_tasks_</a></div><div class="ttdeci">std::map&lt; std::string, Task * &gt; pending_tasks_</div><div class="ttdoc">The pending tasks.</div><div class="ttdef"><b>Definition:</b> TaskRunner.h:71</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1Thread_1_1TaskRunner_html_a774775e9a91d33072b27dcf78cead6e2"><div class="ttname"><a href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#a774775e9a91d33072b27dcf78cead6e2">GpgFrontend::Thread::TaskRunner::tasks</a></div><div class="ttdeci">std::queue&lt; Task * &gt; tasks</div><div class="ttdoc">The task queue.</div><div class="ttdef"><b>Definition:</b> TaskRunner.h:70</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1Thread_1_1TaskRunner_html_ac3e57b59d537e2a75e741d4a5418ae6d"><div class="ttname"><a href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ac3e57b59d537e2a75e741d4a5418ae6d">GpgFrontend::Thread::TaskRunner::~TaskRunner</a></div><div class="ttdeci">virtual ~TaskRunner() override</div><div class="ttdoc">Destroy the Task Runner object.</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1Thread_1_1TaskRunner_html_ad3c8612cbe60112f9b14e616fb0a4acf"><div class="ttname"><a href="classGpgFrontend_1_1Thread_1_1TaskRunner.html#ad3c8612cbe60112f9b14e616fb0a4acf">GpgFrontend::Thread::TaskRunner::TaskRunner</a></div><div class="ttdeci">TaskRunner()</div><div class="ttdoc">Construct a new Task Runner object.</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:45</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> CtxCheckTask.h:33</div></div>
</div><!-- fragment --></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="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>TaskRunner.h</b></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>