GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1Thread_1_1TaskRunner.tex

153 lines
9.9 KiB
TeX

\hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner}{}\doxysection{Gpg\+Frontend\+::Thread\+::Task\+Runner Class Reference}
\label{classGpgFrontend_1_1Thread_1_1TaskRunner}\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
Inheritance diagram for Gpg\+Frontend\+::Thread\+::Task\+Runner\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=211pt]{classGpgFrontend_1_1Thread_1_1TaskRunner__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Gpg\+Frontend\+::Thread\+::Task\+Runner\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=211pt]{classGpgFrontend_1_1Thread_1_1TaskRunner__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item
class \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_1_1Impl}{Impl}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_ad3c8612cbe60112f9b14e616fb0a4acf}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_ad3c8612cbe60112f9b14e616fb0a4acf}}
\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_ad3c8612cbe60112f9b14e616fb0a4acf}{Task\+Runner}} ()
\begin{DoxyCompactList}\small\item\em Construct a new \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} Runner object. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_ac3e57b59d537e2a75e741d4a5418ae6d}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_ac3e57b59d537e2a75e741d4a5418ae6d}}
\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_ac3e57b59d537e2a75e741d4a5418ae6d}{$\sim$\+Task\+Runner}} () override
\begin{DoxyCompactList}\small\item\em Destroy the \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} Runner object. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_acfc4b5922a7760e4334de7edc0f088c1}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_acfc4b5922a7760e4334de7edc0f088c1}}
void {\bfseries Start} ()
\item
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a78c7e4bdca5abfde140acf8e236b9d49}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a78c7e4bdca5abfde140acf8e236b9d49}}
void {\bfseries Stop} ()
\item
auto \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_a57e29f0dde8ceec05c68841985b43f42}{Get\+Thread}} () -\/$>$ QThread $\ast$
\begin{DoxyCompactList}\small\item\em Get the \mbox{\hyperlink{namespaceGpgFrontend_1_1Thread}{Thread}} object. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_a172bca161e13c253b16f0f712721b450}{Is\+Running}} () -\/$>$ bool
\item
void \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_a4fae01eb0a5b296b8c4c6bf8408f1c6b}{Post\+Task}} (\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} $\ast$task)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_a38e1af613d2bc390198a8744f2148f5e}{Post\+Task}} (const QString \&, const Task\+::\+Task\+Runnable \&, const Task\+::\+Task\+Callback \&, Data\+Object\+Ptr)
\item
auto \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_a31a08bfcc288cc70be93de991841d9f9}{Register\+Task}} (const QString \&, const Task\+::\+Task\+Runnable \&, const Task\+::\+Task\+Callback \&, Data\+Object\+Ptr) -\/$>$ \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler}{Task\+::\+Task\+Handler}}
\item
void \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_af65c46061d6ee2008b5fa5593de70026}{Post\+Concurrent\+Task}} (\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} $\ast$task)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_aaddb0cdd8eb57aac08ca9caf8b8e6bac}{Post\+Schedule\+Task}} (\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} $\ast$task, size\+\_\+t seconds)
\end{DoxyCompactItemize}
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a3a27880489e708b589fb72d56f9b5579}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a3a27880489e708b589fb72d56f9b5579}}
Secure\+Unique\+Ptr$<$ \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1TaskRunner_1_1Impl}{Impl}} $>$ {\bfseries p\+\_\+}
\end{DoxyCompactItemize}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a57e29f0dde8ceec05c68841985b43f42}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a57e29f0dde8ceec05c68841985b43f42}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!GetThread@{GetThread}}
\index{GetThread@{GetThread}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{GetThread()}{GetThread()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Get\+Thread (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) -\/$>$ QThread$\ast$}
Get the \mbox{\hyperlink{namespaceGpgFrontend_1_1Thread}{Thread}} object.
\begin{DoxyReturn}{Returns}
QThread$\ast$
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a172bca161e13c253b16f0f712721b450}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a172bca161e13c253b16f0f712721b450}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!IsRunning@{IsRunning}}
\index{IsRunning@{IsRunning}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{IsRunning()}{IsRunning()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Is\+Running (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) -\/$>$ bool}
\begin{DoxyReturn}{Returns}
true
false
\end{DoxyReturn}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_af65c46061d6ee2008b5fa5593de70026}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_af65c46061d6ee2008b5fa5593de70026}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!PostConcurrentTask@{PostConcurrentTask}}
\index{PostConcurrentTask@{PostConcurrentTask}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{PostConcurrentTask()}{PostConcurrentTask()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Post\+Concurrent\+Task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} $\ast$}]{task }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em task} & \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_aaddb0cdd8eb57aac08ca9caf8b8e6bac}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_aaddb0cdd8eb57aac08ca9caf8b8e6bac}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!PostScheduleTask@{PostScheduleTask}}
\index{PostScheduleTask@{PostScheduleTask}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{PostScheduleTask()}{PostScheduleTask()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Post\+Schedule\+Task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} $\ast$}]{task, }\item[{size\+\_\+t}]{seconds }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em task} & \\
\hline
{\em seconds} & \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a38e1af613d2bc390198a8744f2148f5e}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a38e1af613d2bc390198a8744f2148f5e}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!PostTask@{PostTask}}
\index{PostTask@{PostTask}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{PostTask()}{PostTask()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Post\+Task (\begin{DoxyParamCaption}\item[{const QString \&}]{name, }\item[{const Task\+::\+Task\+Runnable \&}]{runner, }\item[{const Task\+::\+Task\+Callback \&}]{cb, }\item[{Data\+Object\+Ptr}]{params }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em runner} & \\
\hline
{\em cb} & \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a4fae01eb0a5b296b8c4c6bf8408f1c6b}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a4fae01eb0a5b296b8c4c6bf8408f1c6b}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!PostTask@{PostTask}}
\index{PostTask@{PostTask}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{PostTask()}{PostTask()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Post\+Task (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task}{Task}} $\ast$}]{task }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em task} & \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classGpgFrontend_1_1Thread_1_1TaskRunner_a31a08bfcc288cc70be93de991841d9f9}\label{classGpgFrontend_1_1Thread_1_1TaskRunner_a31a08bfcc288cc70be93de991841d9f9}}
\index{GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}!RegisterTask@{RegisterTask}}
\index{RegisterTask@{RegisterTask}!GpgFrontend::Thread::TaskRunner@{GpgFrontend::Thread::TaskRunner}}
\doxysubsubsection{\texorpdfstring{RegisterTask()}{RegisterTask()}}
{\footnotesize\ttfamily auto Gpg\+Frontend\+::\+Thread\+::\+Task\+Runner\+::\+Register\+Task (\begin{DoxyParamCaption}\item[{const QString \&}]{name, }\item[{const Task\+::\+Task\+Runnable \&}]{runnable, }\item[{const Task\+::\+Task\+Callback \&}]{cb, }\item[{Data\+Object\+Ptr}]{p\+\_\+pbj }\end{DoxyParamCaption}) -\/$>$ \mbox{\hyperlink{classGpgFrontend_1_1Thread_1_1Task_1_1TaskHandler}{Task\+::\+Task\+Handler}}}
\begin{DoxyReturn}{Returns}
std\+::tuple$<$QPointer$<$\+Task$>$, Task\+Trigger$>$
\end{DoxyReturn}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/core/thread/Task\+Runner.\+h\item
src/core/thread/Task\+Runner.\+cpp\end{DoxyCompactItemize}