ServerCore/latex/classcore_1_1Thread.tex

69 lines
3.1 KiB
TeX

\hypertarget{classcore_1_1Thread}{}\section{core\+:\+:Thread Class Reference}
\label{classcore_1_1Thread}\index{core\+::\+Thread@{core\+::\+Thread}}
{\ttfamily \#include $<$Thread.\+h$>$}
Inheritance diagram for core\+:\+:Thread\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=151pt]{classcore_1_1Thread__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for core\+:\+:Thread\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=151pt]{classcore_1_1Thread__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1Thread_acf8e7e682431fa6a4a3a77ce9b33aefc}\label{classcore_1_1Thread_acf8e7e682431fa6a4a3a77ce9b33aefc}}
{\bfseries Thread} (\hyperlink{classcore_1_1EPoll}{E\+Poll} \&e\+Poll)
\item
void \hyperlink{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}{start} ()
\item
\mbox{\Hypertarget{classcore_1_1Thread_a9ba3b9a5127dcfa0ee2c5f315d6a648d}\label{classcore_1_1Thread_a9ba3b9a5127dcfa0ee2c5f315d6a648d}}
void {\bfseries join} ()
\item
\mbox{\Hypertarget{classcore_1_1Thread_a0b5d8efe9bf913e06a7768cb5ef75c8a}\label{classcore_1_1Thread_a0b5d8efe9bf913e06a7768cb5ef75c8a}}
std\+::string {\bfseries get\+Status} ()
\item
\mbox{\Hypertarget{classcore_1_1Thread_adddf5bccd9189cbd81eeadf0311dbdd6}\label{classcore_1_1Thread_adddf5bccd9189cbd81eeadf0311dbdd6}}
pid\+\_\+t {\bfseries get\+Thread\+Id} ()
\item
\mbox{\Hypertarget{classcore_1_1Thread_aca6a18a5aba7e87fe91a828f4896d654}\label{classcore_1_1Thread_aca6a18a5aba7e87fe91a828f4896d654}}
int {\bfseries get\+Count} ()
\item
\mbox{\Hypertarget{classcore_1_1Thread_aa5b676aa441735c2ac60d05fd3ab02b5}\label{classcore_1_1Thread_aa5b676aa441735c2ac60d05fd3ab02b5}}
void {\bfseries output} (std\+::stringstream \&data)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}
\subsection{Detailed Description}
\hyperlink{classcore_1_1Thread}{Thread}
This thread object is designed to be the thread processor for the \hyperlink{classcore_1_1EPoll}{E\+Poll} object. It wraps the thread object to allow maintaining a status value for monitoring the thread activity. \hyperlink{classcore_1_1EPoll}{E\+Poll} will instantiate a \hyperlink{classcore_1_1Thread}{Thread} object for each thread specified in the \hyperlink{classcore_1_1EPoll}{E\+Poll}\textquotesingle{}s start method.
\subsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}\label{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}}
\index{core\+::\+Thread@{core\+::\+Thread}!start@{start}}
\index{start@{start}!core\+::\+Thread@{core\+::\+Thread}}
\subsubsection{\texorpdfstring{start()}{start()}}
{\footnotesize\ttfamily void core\+::\+Thread\+::start (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Start the thread object. This will cause the epoll scheduler to commence reading the epoll queue.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
Thread.\+h\item
Thread.\+cpp\end{DoxyCompactItemize}