diff options
Diffstat (limited to 'doc/latex/classSignalController.tex')
-rw-r--r-- | doc/latex/classSignalController.tex | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/doc/latex/classSignalController.tex b/doc/latex/classSignalController.tex new file mode 100644 index 0000000..c55b22c --- /dev/null +++ b/doc/latex/classSignalController.tex @@ -0,0 +1,128 @@ +\section{Signal\-Controller Class Reference} +\label{classSignalController}\index{SignalController@{SignalController}} +{\tt \#include $<$signal\-Controller.h$>$} + +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf Signal\-Controller} () +\item +{\bf $\sim$Signal\-Controller} () +\item +void {\bf init} () +\item +int {\bf run} () +\end{CompactItemize} +\subsection*{Static Public Member Functions} +\begin{CompactItemize} +\item +static void $\ast$ {\bf handle} (void $\ast$s) +\end{CompactItemize} +\subsection*{Private Types} +\begin{CompactItemize} +\item +typedef std::map$<$ int, {\bf Signal\-Handler} $\ast$ $>$ {\bf Handler\-Map} +\end{CompactItemize} +\subsection*{Private Member Functions} +\begin{CompactItemize} +\item +{\bf Signal\-Controller} (const {\bf Signal\-Controller} \&s) +\item +void {\bf operator=} (const {\bf Signal\-Controller} \&s) +\end{CompactItemize} +\subsection*{Private Attributes} +\begin{CompactItemize} +\item +std::queue$<$ int $>$ {\bf sig\-Queue} +\item +{\bf Mutex} {\bf sig\-Queue\-Mutex} +\item +{\bf Semaphore} {\bf sig\-Queue\-Sem} +\item +pthread\_\-t {\bf thread} +\item +{\bf Handler\-Map} {\bf handler} +\end{CompactItemize} + + +\subsection{Member Typedef Documentation} +\index{SignalController@{Signal\-Controller}!HandlerMap@{HandlerMap}} +\index{HandlerMap@{HandlerMap}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef std::map$<$int, {\bf Signal\-Handler}$\ast$$>$ {\bf Signal\-Controller::Handler\-Map}\hspace{0.3cm}{\tt [private]}}\label{classSignalController_659eb661ef3d40565d739a50bbe4b554} + + + + +\subsection{Constructor \& Destructor Documentation} +\index{SignalController@{Signal\-Controller}!SignalController@{SignalController}} +\index{SignalController@{SignalController}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Signal\-Controller::Signal\-Controller ()\hspace{0.3cm}{\tt [inline]}}\label{classSignalController_d057c96011d444cce15e2a398a0a8bbf} + + +\index{SignalController@{Signal\-Controller}!~SignalController@{$\sim$SignalController}} +\index{~SignalController@{$\sim$SignalController}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Signal\-Controller::$\sim$Signal\-Controller ()}\label{classSignalController_e8d687dc4fcc75bffff50e8cda37c7aa} + + +\index{SignalController@{Signal\-Controller}!SignalController@{SignalController}} +\index{SignalController@{SignalController}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Signal\-Controller::Signal\-Controller (const {\bf Signal\-Controller} \& {\em s})\hspace{0.3cm}{\tt [private]}}\label{classSignalController_31af143ea1219cd000abe91aeccc84bc} + + + + +\subsection{Member Function Documentation} +\index{SignalController@{Signal\-Controller}!handle@{handle}} +\index{handle@{handle}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void $\ast$ Signal\-Controller::handle (void $\ast$ {\em s})\hspace{0.3cm}{\tt [static]}}\label{classSignalController_5df4d6ebe373117a9bf072035e16997f} + + +\index{SignalController@{Signal\-Controller}!init@{init}} +\index{init@{init}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Signal\-Controller::init ()}\label{classSignalController_0d66065172b1c7ac0d55757d178e6911} + + +\index{SignalController@{Signal\-Controller}!run@{run}} +\index{run@{run}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Signal\-Controller::run ()}\label{classSignalController_0f7657b70cb2e8457539d9f844a93619} + + +\index{SignalController@{Signal\-Controller}!operator=@{operator=}} +\index{operator=@{operator=}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Signal\-Controller::operator= (const {\bf Signal\-Controller} \& {\em s})\hspace{0.3cm}{\tt [private]}}\label{classSignalController_7bfe78f3e8c5d40ddd51c313d30cf6a2} + + + + +\subsection{Member Data Documentation} +\index{SignalController@{Signal\-Controller}!sigQueue@{sigQueue}} +\index{sigQueue@{sigQueue}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::queue$<$int$>$ {\bf Signal\-Controller::sig\-Queue}\hspace{0.3cm}{\tt [private]}}\label{classSignalController_543fa6d49a071df92cdfcc7bc96de161} + + +\index{SignalController@{Signal\-Controller}!sigQueueMutex@{sigQueueMutex}} +\index{sigQueueMutex@{sigQueueMutex}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Mutex} {\bf Signal\-Controller::sig\-Queue\-Mutex}\hspace{0.3cm}{\tt [private]}}\label{classSignalController_6b7853059aa422fac6c2cc77e00d28ee} + + +\index{SignalController@{Signal\-Controller}!sigQueueSem@{sigQueueSem}} +\index{sigQueueSem@{sigQueueSem}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Semaphore} {\bf Signal\-Controller::sig\-Queue\-Sem}\hspace{0.3cm}{\tt [private]}}\label{classSignalController_4dfee82061341e1af5ca827333c8bd10} + + +\index{SignalController@{Signal\-Controller}!thread@{thread}} +\index{thread@{thread}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}pthread\_\-t {\bf Signal\-Controller::thread}\hspace{0.3cm}{\tt [private]}}\label{classSignalController_79c5fbfa55aa9edc2a45c5ed3197b782} + + +\index{SignalController@{Signal\-Controller}!handler@{handler}} +\index{handler@{handler}!SignalController@{Signal\-Controller}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Handler\-Map} {\bf Signal\-Controller::handler}\hspace{0.3cm}{\tt [private]}}\label{classSignalController_f76d2f570d55019dd15921eba71efe0b} + + + + +The documentation for this class was generated from the following files:\begin{CompactItemize} +\item +{\bf signal\-Controller.h}\item +{\bf signal\-Controller.cpp}\end{CompactItemize} |