76 lines
3.7 KiB
TeX
76 lines
3.7 KiB
TeX
\hypertarget{classcore_1_1Command}{}\doxysection{core\+::Command Class Reference}
|
|
\label{classcore_1_1Command}\index{core::Command@{core::Command}}
|
|
|
|
|
|
{\ttfamily \#include $<$Command.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for core\+::Command\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classcore_1_1Command__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
virtual int \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
|
|
\item
|
|
virtual void \mbox{\hyperlink{classcore_1_1Command_ab6352ce5650e70a5c76c3d6e4eefd292}{output}} (std\+::stringstream \&out)
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\mbox{\hyperlink{classcore_1_1Command}{Command}}
|
|
|
|
Use the \mbox{\hyperlink{classcore_1_1Command}{Command}} object in combination with a \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} object to maintain a list of functions that can be invoked as a result of processing a request.
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classcore_1_1Command_ab6352ce5650e70a5c76c3d6e4eefd292}\label{classcore_1_1Command_ab6352ce5650e70a5c76c3d6e4eefd292}}
|
|
\index{core::Command@{core::Command}!output@{output}}
|
|
\index{output@{output}!core::Command@{core::Command}}
|
|
\doxysubsubsection{\texorpdfstring{output()}{output()}}
|
|
{\footnotesize\ttfamily void core\+::\+Command\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
Specify the output that will occur to the specified session.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em session} & The session that will receive the output. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+TCPServer}}.
|
|
|
|
\mbox{\Hypertarget{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}\label{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}}
|
|
\index{core::Command@{core::Command}!processCommand@{processCommand}}
|
|
\index{processCommand@{processCommand}!core::Command@{core::Command}}
|
|
\doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}}
|
|
{\footnotesize\ttfamily int core\+::\+Command\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
|
|
|
This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em request} & The request that was entered by the user to invoke this command. \\
|
|
\hline
|
|
{\em session} & Specify the requesting session so that the execution of the command process can return its output to the session. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
Returns 0 if execution of the command was successful. Otherwise returns a non-\/zero value indicating an error condition.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{core\+::\+TCPServer}}, \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{core\+::\+Subscription\+Manager}}, \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{core\+::\+EPoll}}, and \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{core\+::\+Command\+List}}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
Command.\+h\item
|
|
Command.\+cpp\end{DoxyCompactItemize}
|