66 lines
3.3 KiB
TeX
66 lines
3.3 KiB
TeX
\hypertarget{classcore_1_1ConsoleSession}{}\doxysection{core\+::Console\+Session Class Reference}
|
|
\label{classcore_1_1ConsoleSession}\index{core::ConsoleSession@{core::ConsoleSession}}
|
|
|
|
|
|
{\ttfamily \#include $<$Console\+Session.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for core\+::Console\+Session\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=203pt]{classcore_1_1ConsoleSession__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for core\+::Console\+Session\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{classcore_1_1ConsoleSession__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classcore_1_1ConsoleSession_ae735e9739fb4cfd2ef983cc56f9982c7}\label{classcore_1_1ConsoleSession_ae735e9739fb4cfd2ef983cc56f9982c7}}
|
|
{\bfseries Console\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server)
|
|
\item
|
|
\mbox{\Hypertarget{classcore_1_1ConsoleSession_a6e6b56503966f1cae5bdff8b3814e2b9}\label{classcore_1_1ConsoleSession_a6e6b56503966f1cae5bdff8b3814e2b9}}
|
|
void {\bfseries write\+Log} (std\+::string data)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{protocol}} (coreutils\+::\+Z\+String data) override
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Additional Inherited Members}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\mbox{\hyperlink{classcore_1_1ConsoleSession}{Console\+Session}}
|
|
|
|
Extends the session parameters for this \mbox{\hyperlink{classcore_1_1TCPSocket}{T\+C\+P\+Socket}} derived object. Extend the \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{protocol()}} method in order to define the behavior and protocol interaction for this socket which is a console session.
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}\label{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}}
|
|
\index{core::ConsoleSession@{core::ConsoleSession}!protocol@{protocol}}
|
|
\index{protocol@{protocol}!core::ConsoleSession@{core::ConsoleSession}}
|
|
\doxysubsubsection{\texorpdfstring{protocol()}{protocol()}}
|
|
{\footnotesize\ttfamily void core\+::\+Console\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
|
|
|
Override the protocol method to manage and control the session communications in your inherited session. If you do not override this method then the Session default will process the \textquotesingle{}commands\textquotesingle{} added to the server object using the process\+Request method on the session input.
|
|
|
|
When data is received within the session two modes are available to pass the data through the protocol method\+: L\+I\+NE or B\+L\+O\+CK.
|
|
|
|
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}{core\+::\+T\+C\+P\+Session}}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
Console\+Session.\+h\item
|
|
Console\+Session.\+cpp\end{DoxyCompactItemize}
|