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

369 lines
18 KiB
HTML
Raw 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::Task::DataObject 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_1DataObject.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-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::Thread::Task::DataObject Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><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></p>
<p><code>#include &lt;<a class="el" href="Task_8h_source.html">Task.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for GpgFrontend::Thread::Task::DataObject:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1Thread_1_1Task_1_1DataObject_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1Thread_1_1Task_1_1DataObject_coll__map" id="aGpgFrontend_1_1Thread_1_1Task_1_1DataObject_coll__map">
<area shape="rect" title="DataObject to be passed to the callback function." alt="" coords="23,469,181,649"/>
<area shape="rect" title=" " alt="" coords="5,300,199,407"/>
<area shape="rect" title=" " alt="" coords="41,145,163,223"/>
<area shape="rect" title=" " alt="" coords="83,5,121,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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html">Destructor</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:aa35e6ad1ef3a5733fb338f3333b5c637"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#aa35e6ad1ef3a5733fb338f3333b5c637">GetObjectSize</a> ()</td></tr>
<tr class="memdesc:aa35e6ad1ef3a5733fb338f3333b5c637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Objects Size. <a href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#aa35e6ad1ef3a5733fb338f3333b5c637">More...</a><br /></td></tr>
<tr class="separator:aa35e6ad1ef3a5733fb338f3333b5c637"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521dccfd42e13769b4edc4286318cc4c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a521dccfd42e13769b4edc4286318cc4c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#a521dccfd42e13769b4edc4286318cc4c">AppendObject</a> (T &amp;&amp;obj)</td></tr>
<tr class="separator:a521dccfd42e13769b4edc4286318cc4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5812bb84c6241e89f8b8b04d2a2f3b55"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a5812bb84c6241e89f8b8b04d2a2f3b55"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#a5812bb84c6241e89f8b8b04d2a2f3b55">AppendObject</a> (T *obj)</td></tr>
<tr class="separator:a5812bb84c6241e89f8b8b04d2a2f3b55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ef5ddec0b82017cc4ad7f34b9b13f64"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a5ef5ddec0b82017cc4ad7f34b9b13f64"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#a5ef5ddec0b82017cc4ad7f34b9b13f64">PopObject</a> ()</td></tr>
<tr class="separator:a5ef5ddec0b82017cc4ad7f34b9b13f64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85bb3c482bf6f47edcd6593cca568a22"><td class="memItemLeft" align="right" valign="top"><a id="a85bb3c482bf6f47edcd6593cca568a22"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#a85bb3c482bf6f47edcd6593cca568a22">~DataObject</a> ()</td></tr>
<tr class="memdesc:a85bb3c482bf6f47edcd6593cca568a22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the Data Object object. <br /></td></tr>
<tr class="separator:a85bb3c482bf6f47edcd6593cca568a22"><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:a0e1ab5e5bf5ef647a30a5ee2884ac63a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html">Destructor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#a0e1ab5e5bf5ef647a30a5ee2884ac63a">get_heap_ptr</a> (size_t bytes_size)</td></tr>
<tr class="memdesc:a0e1ab5e5bf5ef647a30a5ee2884ac63a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the heap ptr object. <a href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html#a0e1ab5e5bf5ef647a30a5ee2884ac63a">More...</a><br /></td></tr>
<tr class="separator:a0e1ab5e5bf5ef647a30a5ee2884ac63a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17252d07835dab3772381639ec8473ea"><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_1DataObject.html#a17252d07835dab3772381639ec8473ea">free_heap_ptr</a> (<a class="el" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html">Destructor</a> *)</td></tr>
<tr class="separator:a17252d07835dab3772381639ec8473ea"><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:add6080349c4774da4f37a62ab68561c7"><td class="memItemLeft" align="right" valign="top"><a id="add6080349c4774da4f37a62ab68561c7"></a>
std::stack&lt; <a class="el" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html">Destructor</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>data_objects_</b></td></tr>
<tr class="separator:add6080349c4774da4f37a62ab68561c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><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. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a521dccfd42e13769b4edc4286318cc4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a521dccfd42e13769b4edc4286318cc4c">&#9670;&nbsp;</a></span>AppendObject() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::Task::DataObject::AppendObject </td>
<td>(</td>
<td class="paramtype">T &amp;&amp;&#160;</td>
<td class="paramname"><em>obj</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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5812bb84c6241e89f8b8b04d2a2f3b55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5812bb84c6241e89f8b8b04d2a2f3b55">&#9670;&nbsp;</a></span>AppendObject() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::Thread::Task::DataObject::AppendObject </td>
<td>(</td>
<td class="paramtype">T *&#160;</td>
<td class="paramname"><em>obj</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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17252d07835dab3772381639ec8473ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17252d07835dab3772381639ec8473ea">&#9670;&nbsp;</a></span>free_heap_ptr()</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::DataObject::free_heap_ptr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html">Destructor</a> *&#160;</td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">heap_ptr</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0e1ab5e5bf5ef647a30a5ee2884ac63a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e1ab5e5bf5ef647a30a5ee2884ac63a">&#9670;&nbsp;</a></span>get_heap_ptr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structGpgFrontend_1_1Thread_1_1Task_1_1DataObject_1_1Destructor.html">GpgFrontend::Thread::Task::DataObject::Destructor</a> * GpgFrontend::Thread::Task::DataObject::get_heap_ptr </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>bytes_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the heap ptr object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes_size</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void* </dd></dl>
</div>
</div>
<a id="aa35e6ad1ef3a5733fb338f3333b5c637"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa35e6ad1ef3a5733fb338f3333b5c637">&#9670;&nbsp;</a></span>GetObjectSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t GpgFrontend::Thread::Task::DataObject::GetObjectSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Objects Size. </p>
<dl class="section return"><dt>Returns</dt><dd>size_t </dd></dl>
</div>
</div>
<a id="a5ef5ddec0b82017cc4ad7f34b9b13f64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ef5ddec0b82017cc4ad7f34b9b13f64">&#9670;&nbsp;</a></span>PopObject()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T GpgFrontend::Thread::Task::DataObject::PopObject </td>
<td>(</td>
<td class="paramname"></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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;T&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="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="navelem"><a class="el" href="classGpgFrontend_1_1Thread_1_1Task_1_1DataObject.html">DataObject</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