ServerCore/latex/classcore_1_1ConsoleSession.tex

64 lines
3.2 KiB
TeX

\hypertarget{classcore_1_1ConsoleSession}{}\section{core\+:\+:Console\+Session Class Reference}
\label{classcore_1_1ConsoleSession}\index{core\+::\+Console\+Session@{core\+::\+Console\+Session}}
{\ttfamily \#include $<$Console\+Session.\+h$>$}
Inheritance diagram for core\+:\+:Console\+Session\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=194pt]{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}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1ConsoleSession_ae735e9739fb4cfd2ef983cc56f9982c7}\label{classcore_1_1ConsoleSession_ae735e9739fb4cfd2ef983cc56f9982c7}}
{\bfseries Console\+Session} (\hyperlink{classcore_1_1EPoll}{E\+Poll} \&e\+Poll, \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}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item
void \hyperlink{classcore_1_1ConsoleSession_a9fc306ab91d0f2a6990984040ecb3e47}{protocol} (std\+::stringstream \&out, std\+::string data) override
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}
\subsection{Detailed Description}
\hyperlink{classcore_1_1ConsoleSession}{Console\+Session}
Extends the session parameters for this \hyperlink{classcore_1_1TCPSocket}{T\+C\+P\+Socket} derived object. Extend the \hyperlink{classcore_1_1ConsoleSession_a9fc306ab91d0f2a6990984040ecb3e47}{protocol()} method in order to define the behavior and protocol interaction for this socket which is a console session.
\subsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1ConsoleSession_a9fc306ab91d0f2a6990984040ecb3e47}\label{classcore_1_1ConsoleSession_a9fc306ab91d0f2a6990984040ecb3e47}}
\index{core\+::\+Console\+Session@{core\+::\+Console\+Session}!protocol@{protocol}}
\index{protocol@{protocol}!core\+::\+Console\+Session@{core\+::\+Console\+Session}}
\subsubsection{\texorpdfstring{protocol()}{protocol()}}
{\footnotesize\ttfamily void core\+::\+Console\+Session\+::protocol (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{std\+::string}]{data = {\ttfamily \char`\"{}\char`\"{}} }\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.
Reimplemented from \hyperlink{classcore_1_1TLSSession_ad7f219581d1f7700ca1f88551cd01c74}{core\+::\+T\+L\+S\+Session}.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
Console\+Session.\+h\item
Console\+Session.\+cpp\end{DoxyCompactItemize}