Update changes.
This commit is contained in:
1 parent
86bd62221f
commit
608f8a2b0c
249 files changed
+1562
-1734
No files matched your search
@@ -13,30 +13,20 @@ Inheritance diagram for core\+::Command\+:\nopagebreak
|
||||
\includegraphics[width=350pt]{classcore_1_1Command__inherit__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
|
||||
|
||||
Collaboration diagram for core\+::Command\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=174pt]{classcore_1_1Command__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
virtual bool \mbox{\hyperlink{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}{check}} (coreutils\+::\+Z\+String request)
|
||||
virtual bool \mbox{\hyperlink{classcore_1_1Command_a3bec2a324e71b72f1525a28b2bb028fe}{check}} (coreutils\+::\+Z\+String \&request)
|
||||
\item
|
||||
virtual int \mbox{\hyperlink{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}{process\+Command}} (coreutils\+::\+Z\+String request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data)
|
||||
virtual int \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1Command_a314aef05f78aacb802097f8ae0875291}{output}} (Session $\ast$session)
|
||||
virtual void \mbox{\hyperlink{classcore_1_1Command_ab6352ce5650e70a5c76c3d6e4eefd292}{output}} (std\+::stringstream \&out)
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1Command_ad8b0321c64838f4d5c8f93461b97cfef}{set\+Name}} (std\+::string name)
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1Command_aa63cf88493b2a1b775b5b93b07e79324}\label{classcore_1_1Command_aa63cf88493b2a1b775b5b93b07e79324}}
|
||||
std\+::string {\bfseries get\+Name} ()
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Additional Inherited Members}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
@@ -45,15 +35,15 @@ std\+::string {\bfseries get\+Name} ()
|
||||
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_af9b8d8b3a6d6566f86e0abcb0d10f905}\label{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}}
|
||||
\mbox{\Hypertarget{classcore_1_1Command_a3bec2a324e71b72f1525a28b2bb028fe}\label{classcore_1_1Command_a3bec2a324e71b72f1525a28b2bb028fe}}
|
||||
\index{core::Command@{core::Command}!check@{check}}
|
||||
\index{check@{check}!core::Command@{core::Command}}
|
||||
\doxysubsubsection{\texorpdfstring{check()}{check()}}
|
||||
{\footnotesize\ttfamily bool core\+::\+Command\+::check (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{request }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily bool core\+::\+Command\+::check (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
||||
|
||||
Implement check method to provide a special check rule upon the request to see if the command should be processed.
|
||||
|
||||
The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}}. This can be overridden by implementing the \mbox{\hyperlink{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}{check()}} method to perform the test and return the condition of the command.
|
||||
The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}}. This can be overridden by implementing the \mbox{\hyperlink{classcore_1_1Command_a3bec2a324e71b72f1525a28b2bb028fe}{check()}} method to perform the test and return the condition of the command.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
@@ -63,11 +53,11 @@ The default rule is to verify that the first token in the request string matches
|
||||
\begin{DoxyReturn}{Returns}
|
||||
Return true to execute the command. Returning false will cause no action on this command.
|
||||
\end{DoxyReturn}
|
||||
\mbox{\Hypertarget{classcore_1_1Command_a314aef05f78aacb802097f8ae0875291}\label{classcore_1_1Command_a314aef05f78aacb802097f8ae0875291}}
|
||||
\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[{Session $\ast$}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
||||
{\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.
|
||||
|
||||
@@ -76,11 +66,15 @@ Specify the output that will occur to the specified session.
|
||||
{\em session} & The session that will receive the output. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\mbox{\Hypertarget{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}\label{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}}
|
||||
|
||||
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+T\+C\+P\+Server}}.
|
||||
|
||||
\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\+::\+Z\+String}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily int core\+::\+Command\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{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.
|
||||
|
||||
@@ -96,7 +90,7 @@ Returns 0 if execution of the command was successful. Otherwise returns a non-\/
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{core\+::\+E\+Poll}}, and \mbox{\hyperlink{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}{core\+::\+T\+C\+P\+Server}}.
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{core\+::\+T\+C\+P\+Server}}, \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{core\+::\+E\+Poll}}, and \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{core\+::\+Command\+List}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1Command_ad8b0321c64838f4d5c8f93461b97cfef}\label{classcore_1_1Command_ad8b0321c64838f4d5c8f93461b97cfef}}
|
||||
\index{core::Command@{core::Command}!setName@{setName}}
|
||||
|
||||
@@ -25,26 +25,30 @@ Collaboration diagram for core\+::Command\+List\+:\nopagebreak
|
||||
\doxysubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1CommandList_a5e7b306d08d02a0d03ad541e3479d845}\label{classcore_1_1CommandList_a5e7b306d08d02a0d03ad541e3479d845}}
|
||||
{\bfseries Command\+List} (std\+::string delimiter=\char`\"{}\char`\"{})
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1CommandList_a7a45e75e3d21a25fd3f7e887acf395e9}{add}} (\mbox{\hyperlink{classcore_1_1Command}{Command}} \&command, std\+::string name=\char`\"{}\char`\"{})
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}{remove}} (\mbox{\hyperlink{classcore_1_1Command}{Command}} \&command)
|
||||
\item
|
||||
bool \mbox{\hyperlink{classcore_1_1CommandList_a4d0150f59f832c65f113a6a575f45c19}{process\+Request}} (coreutils\+::\+Z\+String request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data)
|
||||
bool \mbox{\hyperlink{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}{process\+Request}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
|
||||
\item
|
||||
bool \mbox{\hyperlink{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}{grab\+Input}} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command)
|
||||
bool \mbox{\hyperlink{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}{grab\+Input}} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command)
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1CommandList_a2bf14022331b23e0878aa9d676a90110}\label{classcore_1_1CommandList_a2bf14022331b23e0878aa9d676a90110}}
|
||||
void {\bfseries clear\+Grab} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session)
|
||||
\mbox{\Hypertarget{classcore_1_1CommandList_a9214dc76dbcde1520277d044c00cc1fc}\label{classcore_1_1CommandList_a9214dc76dbcde1520277d044c00cc1fc}}
|
||||
void {\bfseries clear\+Grab} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}\label{classcore_1_1CommandList_a98939555ca061b445019a841726e3ef6}}
|
||||
int {\bfseries process\+Command} (std\+::string request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data)
|
||||
int \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::vector$<$ \mbox{\hyperlink{classcore_1_1Command}{Command}} $\ast$ $>$ \mbox{\hyperlink{classcore_1_1CommandList_a435f09d15c78dad43e7bca4977d6bdf1}{commands}}
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1CommandList_adfc9ae3f4473a3cd35d5d1ebb5d1b2eb}\label{classcore_1_1CommandList_adfc9ae3f4473a3cd35d5d1ebb5d1b2eb}}
|
||||
std\+::string {\bfseries delimiter}
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Additional Inherited Members}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
@@ -59,19 +63,41 @@ This object organizes \mbox{\hyperlink{classcore_1_1Command}{Command}} objects i
|
||||
\doxysubsubsection{\texorpdfstring{add()}{add()}}
|
||||
{\footnotesize\ttfamily void core\+::\+Command\+List\+::add (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command, }\item[{std\+::string}]{name = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
|
||||
|
||||
Add a new command to the command list and assign a default search value. \mbox{\Hypertarget{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}\label{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}}
|
||||
Add a new command to the command list and assign a default search value. \mbox{\Hypertarget{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}\label{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}}
|
||||
\index{core::CommandList@{core::CommandList}!grabInput@{grabInput}}
|
||||
\index{grabInput@{grabInput}!core::CommandList@{core::CommandList}}
|
||||
\doxysubsubsection{\texorpdfstring{grabInput()}{grabInput()}}
|
||||
{\footnotesize\ttfamily bool core\+::\+Command\+List\+::grab\+Input (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command }\end{DoxyParamCaption})}
|
||||
{\footnotesize\ttfamily bool core\+::\+Command\+List\+::grab\+Input (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session, }\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command }\end{DoxyParamCaption})}
|
||||
|
||||
Use \mbox{\hyperlink{classcore_1_1CommandList_a40211d843807cd65f6614c17efcb00e4}{grab\+Input()}} within a \mbox{\hyperlink{classcore_1_1Command}{Command}} object to force the requesting handler to receive all further input from the socket. Use release\+Grab() method to release the session back to normal command processing. \mbox{\Hypertarget{classcore_1_1CommandList_a4d0150f59f832c65f113a6a575f45c19}\label{classcore_1_1CommandList_a4d0150f59f832c65f113a6a575f45c19}}
|
||||
Use \mbox{\hyperlink{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}{grab\+Input()}} within a \mbox{\hyperlink{classcore_1_1Command}{Command}} object to force the requesting handler to receive all further input from the socket. Use release\+Grab() method to release the session back to normal command processing. \mbox{\Hypertarget{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}\label{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}}
|
||||
\index{core::CommandList@{core::CommandList}!processCommand@{processCommand}}
|
||||
\index{processCommand@{processCommand}!core::CommandList@{core::CommandList}}
|
||||
\doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}}
|
||||
{\footnotesize\ttfamily int core\+::\+Command\+List\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{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 from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{core\+::\+Command}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}\label{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}}
|
||||
\index{core::CommandList@{core::CommandList}!processRequest@{processRequest}}
|
||||
\index{processRequest@{processRequest}!core::CommandList@{core::CommandList}}
|
||||
\doxysubsubsection{\texorpdfstring{processRequest()}{processRequest()}}
|
||||
{\footnotesize\ttfamily bool core\+::\+Command\+List\+::process\+Request (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})}
|
||||
{\footnotesize\ttfamily bool core\+::\+Command\+List\+::process\+Request (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})}
|
||||
|
||||
Use this method to apply a parsed P\+String to the command set and execute the matching parameter. The selected command will return a true on a call to \mbox{\hyperlink{classcore_1_1Command_af9b8d8b3a6d6566f86e0abcb0d10f905}{check()}}. If there is a handler that has a grab on the process handler then control is given to the process handler holding the grab on the input. \mbox{\Hypertarget{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}\label{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}}
|
||||
Use this method to apply a parsed Z\+String to the command set and execute the matching parameter. The selected command will return a true on a call to \mbox{\hyperlink{classcore_1_1Command_a3bec2a324e71b72f1525a28b2bb028fe}{check()}}. If there is a handler that has a grab on the process handler then control is given to the process handler holding the grab on the input. \mbox{\Hypertarget{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}\label{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}}
|
||||
\index{core::CommandList@{core::CommandList}!remove@{remove}}
|
||||
\index{remove@{remove}!core::CommandList@{core::CommandList}}
|
||||
\doxysubsubsection{\texorpdfstring{remove()}{remove()}}
|
||||
|
||||
@@ -1 +1 @@
|
||||
95346e4570bcf3dd3c88ed5e9d7073cd
|
||||
a96f3e328f89a36f8c825e2406f69cfd
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
95346e4570bcf3dd3c88ed5e9d7073cd
|
||||
a96f3e328f89a36f8c825e2406f69cfd
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
2abf51e9c484a58dcf854d92c5055b65
|
||||
38ac49863a90b12efd31d3d12c147e7d
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
23a9f7a7fad5f99c7a211cd84e8f2a11
|
||||
261b3912acde00a442c24349594bedd3
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
0cbbd9531a1296f08dbc3e54fad6f694
|
||||
d8a7b139f69b81405af9117126175bb6
|
||||
Binary file not shown.
@@ -34,7 +34,7 @@ void {\bfseries write\+Log} (std\+::string data)
|
||||
\doxysubsection*{Protected Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{protocol}} (coreutils\+::\+Z\+String data) override
|
||||
void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol}} (coreutils\+::\+Z\+String \&data) override
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Additional Inherited Members}
|
||||
|
||||
@@ -42,20 +42,20 @@ void \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424f
|
||||
\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.
|
||||
Extends the session parameters for this \mbox{\hyperlink{classcore_1_1TCPSocket}{T\+C\+P\+Socket}} derived object. Extend the \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{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}}
|
||||
\mbox{\Hypertarget{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}\label{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}}
|
||||
\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]}}
|
||||
{\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}}.
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+T\+C\+P\+Session}}.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
e3a5c5da26e73687babd96ad5f9b9573
|
||||
656a75ca6d8b724bd1b273b066ac880e
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
8ecb0228f3cbdcb6fa45a4bcddfe8fcc
|
||||
0f5e7e7912dc563e80e4ac78360dc9fe
|
||||
Binary file not shown.
@@ -43,7 +43,7 @@ int \mbox{\hyperlink{classcore_1_1EPoll_a1e52017e1deae15c1c87c6b6a099e1ed}{get\+
|
||||
\begin{DoxyCompactList}\small\item\em Return the descriptor for the e\+Poll socket. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{classcore_1_1EPoll_a3238b150b5d0a57eb2e1b17daa236d3b}{event\+Received}} (struct epoll\+\_\+event event)
|
||||
\begin{DoxyCompactList}\small\item\em Dispatch event to appropriate socket. \end{DoxyCompactList}\item
|
||||
int \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{process\+Command}} (coreutils\+::\+Z\+String command, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) override
|
||||
int \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override
|
||||
\begin{DoxyCompactList}\small\item\em Output the threads array to the console. \end{DoxyCompactList}\item
|
||||
\mbox{\Hypertarget{classcore_1_1EPoll_a033633714311f3edc4127ddd1c37f299}\label{classcore_1_1EPoll_a033633714311f3edc4127ddd1c37f299}}
|
||||
void {\bfseries reset\+Socket} (\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$socket)
|
||||
@@ -114,17 +114,17 @@ Use this method to obtain the current descriptor socket number for the epoll fun
|
||||
|
||||
Returns a true if the stop command has been requested.
|
||||
|
||||
This method returns a true if the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop()}} method has been called and the epoll system is shutting. \mbox{\Hypertarget{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}\label{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}}
|
||||
This method returns a true if the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop()}} method has been called and the epoll system is shutting. \mbox{\Hypertarget{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}\label{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}}
|
||||
\index{core::EPoll@{core::EPoll}!processCommand@{processCommand}}
|
||||
\index{processCommand@{processCommand}!core::EPoll@{core::EPoll}}
|
||||
\doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}}
|
||||
{\footnotesize\ttfamily int core\+::\+E\+Poll\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{command, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily int core\+::\+E\+Poll\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
||||
|
||||
|
||||
|
||||
Output the threads array to the console.
|
||||
|
||||
The \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{process\+Command()}} method displays the thread array to the requesting console via the session passed as parameter.
|
||||
The \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{process\+Command()}} method displays the thread array to the requesting console via the session passed as parameter.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
@@ -133,7 +133,7 @@ The \mbox{\hyperlink{classcore_1_1EPoll_a5cb8a89fb45922c8c88472ec3eae7858}{proce
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}{core\+::\+Command}}.
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{core\+::\+Command}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1EPoll_a3d813c7bbf0da70ebc8e3cb6aeeacfb4}\label{classcore_1_1EPoll_a3d813c7bbf0da70ebc8e3cb6aeeacfb4}}
|
||||
\index{core::EPoll@{core::EPoll}!registerSocket@{registerSocket}}
|
||||
|
||||
@@ -1 +1 @@
|
||||
65b06e5175304b2aa128b1dfbbdb661f
|
||||
98b90bfe6ece875f9b9fa2075b6d694f
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
65b06e5175304b2aa128b1dfbbdb661f
|
||||
98b90bfe6ece875f9b9fa2075b6d694f
|
||||
Binary file not shown.
@@ -15,7 +15,7 @@ Collaboration diagram for core\+::I\+Notify\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=228pt]{classcore_1_1INotify__coll__graph}
|
||||
\includegraphics[width=174pt]{classcore_1_1INotify__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
@@ -30,8 +30,8 @@ int {\bfseries add\+Watch} (std\+::string watch)
|
||||
\mbox{\Hypertarget{classcore_1_1INotify_a5ce2a1bbfd69f5a88ef807f7ed439c06}\label{classcore_1_1INotify_a5ce2a1bbfd69f5a88ef807f7ed439c06}}
|
||||
void {\bfseries remove\+Watch} (int wd)
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1INotify_a934781c449fbd9171f47c34db6cac4e9}\label{classcore_1_1INotify_a934781c449fbd9171f47c34db6cac4e9}}
|
||||
void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String data) override
|
||||
\mbox{\Hypertarget{classcore_1_1INotify_a642e44e906da81ce8180beb2bc09d602}\label{classcore_1_1INotify_a642e44e906da81ce8180beb2bc09d602}}
|
||||
void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String \&data) override
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}\label{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}}
|
||||
virtual void {\bfseries in\+Access} (std\+::string name)
|
||||
|
||||
@@ -1 +1 @@
|
||||
076c1cf18e83963f9600dd9fea0054af
|
||||
4ce64bfd98c2c85efcf959f9b2ce61d2
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
807497635409383358ebc5447fd98333
|
||||
3f5ea77c62672e519022863919c4aea3
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
b4f9f6052ab76f7912389463eff07b50
|
||||
0072956b617b9e545ab65b3703c04beb
|
||||
Binary file not shown.
@@ -19,7 +19,7 @@ Collaboration diagram for core\+::Socket\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=228pt]{classcore_1_1Socket__coll__graph}
|
||||
\includegraphics[width=174pt]{classcore_1_1Socket__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
@@ -77,10 +77,10 @@ int {\bfseries get\+Buffer\+Size} ()
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}{on\+Data\+Received}} (std\+::string data)
|
||||
\begin{DoxyCompactList}\small\item\em Called when data is received from the socket. \end{DoxyCompactList}\item
|
||||
\mbox{\Hypertarget{classcore_1_1Socket_aa1b212533877a49c965a3aaa05f22d03}\label{classcore_1_1Socket_aa1b212533877a49c965a3aaa05f22d03}}
|
||||
virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String data)
|
||||
\mbox{\Hypertarget{classcore_1_1Socket_ae048b57ac2c34381378f3da0e758b3c8}\label{classcore_1_1Socket_ae048b57ac2c34381378f3da0e758b3c8}}
|
||||
virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String \&data)
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}{receive\+Data}} (coreutils\+::\+Z\+String buffer)
|
||||
virtual void \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{receive\+Data}} (coreutils\+::\+Z\+String \&buffer)
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
@@ -98,8 +98,7 @@ bool {\bfseries shut\+Down} = false
|
||||
|
||||
The core component to managing a socket.
|
||||
|
||||
Hooks into the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} object and also provides buffering for output data requests to the socket. ~\newline
|
||||
|
||||
Hooks into the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} object and also provides buffering for output data requests to the socket.
|
||||
|
||||
A program using a socket object can request to open a socket (network or device) and communicate through the streambuffer interface of the socket object.
|
||||
|
||||
@@ -189,15 +188,15 @@ Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77
|
||||
|
||||
Called when the socket has finished unregistering for the epoll processing.
|
||||
|
||||
The on\+Unregistered method is called whenever the socket is unregistered with e\+Poll and socket communcation events will be stopped. The default method will close the socket and clean up the connection. If this is overridden by an extended object then the object should call this method to clean the socket up. \mbox{\Hypertarget{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}\label{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}}
|
||||
The on\+Unregistered method is called whenever the socket is unregistered with e\+Poll and socket communcation events will be stopped. The default method will close the socket and clean up the connection. If this is overridden by an extended object then the object should call this method to clean the socket up. \mbox{\Hypertarget{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}\label{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}}
|
||||
\index{core::Socket@{core::Socket}!receiveData@{receiveData}}
|
||||
\index{receiveData@{receiveData}!core::Socket@{core::Socket}}
|
||||
\doxysubsubsection{\texorpdfstring{receiveData()}{receiveData()}}
|
||||
{\footnotesize\ttfamily void core\+::\+Socket\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+Socket\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
receive\+Data will read the data from the socket and place it in the socket buffer. T\+LS layer overrides this to be able to read from S\+SL.
|
||||
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}{core\+::\+T\+L\+S\+Session}}.
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{core\+::\+T\+L\+S\+Session}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}\label{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}}
|
||||
\index{core::Socket@{core::Socket}!setDescriptor@{setDescriptor}}
|
||||
|
||||
@@ -1 +1 @@
|
||||
8972ad3d81c6154d568a5e7384a0c2ba
|
||||
601ffa7b2c2f8f190cefef69aff78b25
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
140b9c232187e83dc49f10083bb844ae
|
||||
8091a6c3a543813cfce9b032080c642a
|
||||
Binary file not shown.
@@ -25,7 +25,7 @@ Collaboration diagram for core\+::T\+C\+P\+Server\+:\nopagebreak
|
||||
\doxysubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{classcore_1_1TCPServer_a418924164fd6e59800272fbd6f069bb9}{T\+C\+P\+Server}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address, std\+::string text=\char`\"{}\char`\"{})
|
||||
\mbox{\hyperlink{classcore_1_1TCPServer_aef07f6f0f9e9f9c9db5f5cadb70b86d9}{T\+C\+P\+Server}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address, std\+::string delimiter=\char`\"{} \char`\"{}, std\+::string text=\char`\"{}\char`\"{})
|
||||
\item
|
||||
\mbox{\hyperlink{classcore_1_1TCPServer_a7ccdc057c9eee8504fce796301f82088}{$\sim$\+T\+C\+P\+Server}} ()
|
||||
\item
|
||||
@@ -37,9 +37,16 @@ virtual \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ \mbo
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_a88c603cd5df9dbc1632fd4b5e164d75b}\label{classcore_1_1TCPServer_a88c603cd5df9dbc1632fd4b5e164d75b}}
|
||||
void {\bfseries remove\+From\+Session\+List} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session)
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_a120d5031360cc62251bdc43fa2d9813a}\label{classcore_1_1TCPServer_a120d5031360cc62251bdc43fa2d9813a}}
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_a120d5031360cc62251bdc43fa2d9813a}{output}} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session)
|
||||
\begin{DoxyCompactList}\small\item\em Output the consoles array to the console. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}\label{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}}
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{output}} (std\+::stringstream \&out)
|
||||
\begin{DoxyCompactList}\small\item\em Output the consoles array to the console. \end{DoxyCompactList}\item
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_a9cfcf2984ddc7e1d8f157c9f07ad03e1}\label{classcore_1_1TCPServer_a9cfcf2984ddc7e1d8f157c9f07ad03e1}}
|
||||
void {\bfseries send\+To\+All} (std\+::stringstream \&out)
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&sender, \mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}} filter)
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_af708df59e1bc60077c16db97f9cc8ff0}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&sender)
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Public Attributes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
@@ -56,11 +63,7 @@ std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_a276ccbc8cb9b4380ebd78807b97f0159}{on\+Data\+Received}} (std\+::string data) override
|
||||
\item
|
||||
int \mbox{\hyperlink{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}{process\+Command}} (coreutils\+::\+Z\+String command, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$session, std\+::stringstream \&data) override
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_a151f29593c0d1fa998e2b86b19c631f4}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$sender, \mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}} \&filter)
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TCPServer_aa225cd2b704167ff22503e1897fe538f}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$sender)
|
||||
int \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Additional Inherited Members}
|
||||
|
||||
@@ -75,11 +78,11 @@ A list of connections is maintained in a vector object.
|
||||
This object extends the B\+M\+A\+Command object as well so it can be added to a Console object and process commands to display status information.
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_a418924164fd6e59800272fbd6f069bb9}\label{classcore_1_1TCPServer_a418924164fd6e59800272fbd6f069bb9}}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_aef07f6f0f9e9f9c9db5f5cadb70b86d9}\label{classcore_1_1TCPServer_aef07f6f0f9e9f9c9db5f5cadb70b86d9}}
|
||||
\index{core::TCPServer@{core::TCPServer}!TCPServer@{TCPServer}}
|
||||
\index{TCPServer@{TCPServer}!core::TCPServer@{core::TCPServer}}
|
||||
\doxysubsubsection{\texorpdfstring{TCPServer()}{TCPServer()}}
|
||||
{\footnotesize\ttfamily core\+::\+T\+C\+P\+Server\+::\+T\+C\+P\+Server (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}}}]{address, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
|
||||
{\footnotesize\ttfamily core\+::\+T\+C\+P\+Server\+::\+T\+C\+P\+Server (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}}}]{address, }\item[{std\+::string}]{delimiter = {\ttfamily \char`\"{}~\char`\"{}}, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
|
||||
|
||||
The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} object.
|
||||
|
||||
@@ -132,11 +135,11 @@ Override the virtual data\+Received since for the server these are requests to a
|
||||
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}{core\+::\+Socket}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}\label{classcore_1_1TCPServer_ad08e04a2ff44c9c40419cdc6bd0e4b79}}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}\label{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}}
|
||||
\index{core::TCPServer@{core::TCPServer}!processCommand@{processCommand}}
|
||||
\index{processCommand@{processCommand}!core::TCPServer@{core::TCPServer}}
|
||||
\doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}}
|
||||
{\footnotesize\ttfamily int core\+::\+T\+C\+P\+Server\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{command, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{session, }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily int core\+::\+T\+C\+P\+Server\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
This method is called when the \mbox{\hyperlink{classcore_1_1Command}{Command}} associated with this object is requested because a user has typed in the associated command name on a command entry line.
|
||||
|
||||
@@ -147,19 +150,19 @@ This method is called when the \mbox{\hyperlink{classcore_1_1Command}{Command}}
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Command_ad8eecee5b179a0030d2f34bcfa30d4f4}{core\+::\+Command}}.
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{core\+::\+Command}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_aa225cd2b704167ff22503e1897fe538f}\label{classcore_1_1TCPServer_aa225cd2b704167ff22503e1897fe538f}}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPServer_af708df59e1bc60077c16db97f9cc8ff0}\label{classcore_1_1TCPServer_af708df59e1bc60077c16db97f9cc8ff0}}
|
||||
\index{core::TCPServer@{core::TCPServer}!sendToAll@{sendToAll}}
|
||||
\index{sendToAll@{sendToAll}!core::TCPServer@{core::TCPServer}}
|
||||
\doxysubsubsection{\texorpdfstring{sendToAll()}{sendToAll()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{sender }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{sender }\end{DoxyParamCaption})}
|
||||
|
||||
Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session and the entries identified by the passed in filter object. \mbox{\Hypertarget{classcore_1_1TCPServer_a151f29593c0d1fa998e2b86b19c631f4}\label{classcore_1_1TCPServer_a151f29593c0d1fa998e2b86b19c631f4}}
|
||||
Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session and the entries identified by the passed in filter object. \mbox{\Hypertarget{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}\label{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}}
|
||||
\index{core::TCPServer@{core::TCPServer}!sendToAll@{sendToAll}}
|
||||
\index{sendToAll@{sendToAll}!core::TCPServer@{core::TCPServer}}
|
||||
\doxysubsubsection{\texorpdfstring{sendToAll()}{sendToAll()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$}]{sender, }\item[{\mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}} \&}]{filter }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{sender, }\item[{\mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}}}]{filter }\end{DoxyParamCaption})}
|
||||
|
||||
Use this send\+To\+All method to output the contents of the out stream to all the connections on the server excluding the sender session.
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
c2f920e944c957d37b6ae81996f8f831
|
||||
d83280ccc4433fc6386ad879a66ac13c
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
c139f1cfe9d80689faf32cee0d8e8b8b
|
||||
b99be97b5935f58c2a5f55c17513c720
|
||||
Binary file not shown.
@@ -40,10 +40,10 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a2c39191d695d79891989ea628f42c0a8}\label{classcore_1_1TCPSession_a2c39191d695d79891989ea628f42c0a8}}
|
||||
\mbox{\hyperlink{classcore_1_1Command}{Command}} $\ast$ {\bfseries grab} = N\+U\+LL
|
||||
\item
|
||||
std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}{out}}
|
||||
\item
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a265d9493fa544e601b5ad5fb1663340c}\label{classcore_1_1TCPSession_a265d9493fa544e601b5ad5fb1663340c}}
|
||||
\mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \& {\bfseries server}
|
||||
\item
|
||||
std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}{out}}
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
@@ -51,15 +51,15 @@ std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc754
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}\label{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}}
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_aed4ed499b978bcea57a8efefe929fc98}{on\+Registered}} () override
|
||||
\begin{DoxyCompactList}\small\item\em Called after the socket has been registered with epoll processing. \end{DoxyCompactList}\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a6683cc5b39d3e47adc9ead3f3e3d7587}{on\+Data\+Received}} (coreutils\+::\+Z\+String data) override
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}{on\+Data\+Received}} (coreutils\+::\+Z\+String \&data) override
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a018d0458806811b98e4aa30da27a1a2d}{on\+Line\+Received}} (coreutils\+::\+Z\+String line)
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}{on\+Line\+Received}} (coreutils\+::\+Z\+String \&line)
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_ada0eb595b5c506ae2f74851fd1588512}{on\+Block\+Received}} (coreutils\+::\+Z\+String block)
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}{on\+Block\+Received}} (coreutils\+::\+Z\+String \&block)
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}{on\+Connected}} ()
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}{protocol}} (coreutils\+::\+Z\+String data)
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{protocol}} (coreutils\+::\+Z\+String \&data)
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}{set\+Block\+Size}} (int size=0)
|
||||
\end{DoxyCompactItemize}
|
||||
@@ -72,11 +72,11 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}
|
||||
\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} defines the nature of the interaction with the client and stores persistent data for a defined session. \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} objects are not sockets but instead provide a communications control mechanism. Protocol conversations are provided through extensions from this object.
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_ada0eb595b5c506ae2f74851fd1588512}\label{classcore_1_1TCPSession_ada0eb595b5c506ae2f74851fd1588512}}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}\label{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}}
|
||||
\index{core::TCPSession@{core::TCPSession}!onBlockReceived@{onBlockReceived}}
|
||||
\index{onBlockReceived@{onBlockReceived}!core::TCPSession@{core::TCPSession}}
|
||||
\doxysubsubsection{\texorpdfstring{onBlockReceived()}{onBlockReceived()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Block\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{block }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Block\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{block }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
Override the on\+Block\+Received method to receive a string of characters that represents a single block of data of length determined by the block length value. If on\+Data\+Received was overriden this method will not be called unless the on\+Data\+Received calls this method explicitly using the class and member name. \mbox{\Hypertarget{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}\label{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}}
|
||||
\index{core::TCPSession@{core::TCPSession}!onConnected@{onConnected}}
|
||||
@@ -84,21 +84,21 @@ Override the on\+Block\+Received method to receive a string of characters that r
|
||||
\doxysubsubsection{\texorpdfstring{onConnected()}{onConnected()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Connected (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
This method is called from within the protocol method when protocol is called on the initial connection where the data is an empty string. Use this method to deliver a message to the connection upon connection. \mbox{\Hypertarget{classcore_1_1TCPSession_a6683cc5b39d3e47adc9ead3f3e3d7587}\label{classcore_1_1TCPSession_a6683cc5b39d3e47adc9ead3f3e3d7587}}
|
||||
This method is called from within the protocol method when protocol is called on the initial connection where the data is an empty string. Use this method to deliver a message to the connection upon connection. \mbox{\Hypertarget{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}\label{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}}
|
||||
\index{core::TCPSession@{core::TCPSession}!onDataReceived@{onDataReceived}}
|
||||
\index{onDataReceived@{onDataReceived}!core::TCPSession@{core::TCPSession}}
|
||||
\doxysubsubsection{\texorpdfstring{onDataReceived()}{onDataReceived()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
Override this method to receive data directly from the socket as data is received. If you need data split by line termination characters then override the on\+Line\+Received method instead.
|
||||
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a018d0458806811b98e4aa30da27a1a2d}\label{classcore_1_1TCPSession_a018d0458806811b98e4aa30da27a1a2d}}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}\label{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}}
|
||||
\index{core::TCPSession@{core::TCPSession}!onLineReceived@{onLineReceived}}
|
||||
\index{onLineReceived@{onLineReceived}!core::TCPSession@{core::TCPSession}}
|
||||
\doxysubsubsection{\texorpdfstring{onLineReceived()}{onLineReceived()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Line\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{line }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::on\+Line\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{line }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
Override the on\+Line\+Received method to receive a string of characters that represents a single line of data terminated by a LF or C\+R\+LF. If on\+Data\+Received was overriden this method will not be called unless the on\+Data\+Received calls this method explicitly using the class and member name. \mbox{\Hypertarget{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}\label{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}}
|
||||
\index{core::TCPSession@{core::TCPSession}!output@{output}}
|
||||
@@ -114,17 +114,17 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7
|
||||
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}\label{classcore_1_1TCPSession_a4a2a34c9b1252664e93c576a27c30720}}
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}\label{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}}
|
||||
\index{core::TCPSession@{core::TCPSession}!protocol@{protocol}}
|
||||
\index{protocol@{protocol}!core::TCPSession@{core::TCPSession}}
|
||||
\doxysubsubsection{\texorpdfstring{protocol()}{protocol()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\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 in \mbox{\hyperlink{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_a72cd8a1ed55112b7245d889a9424fd64}{core\+::\+Console\+Session}}.
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{core\+::\+Console\+Session}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TCPSession_a2b09eeafef5e44009a77d9da43e3b889}\label{classcore_1_1TCPSession_a2b09eeafef5e44009a77d9da43e3b889}}
|
||||
\index{core::TCPSession@{core::TCPSession}!send@{send}}
|
||||
|
||||
@@ -1 +1 @@
|
||||
711c00bd88cb953a5c6ecf80fdbce559
|
||||
2a2d85aa1ac1b45e730afbdf75982884
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
afc73337bd4329c988a68aaf0b512757
|
||||
91ad32f695f6c4292b387bb70491673d
|
||||
Binary file not shown.
@@ -19,7 +19,7 @@ Collaboration diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=260pt]{classcore_1_1TCPSocket__coll__graph}
|
||||
\includegraphics[width=275pt]{classcore_1_1TCPSocket__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
@@ -61,7 +61,7 @@ For accessing T\+CP network functions use this object. The connection oriented n
|
||||
|
||||
The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}) and will output the detail information for the client socket. When extending B\+M\+A\+T\+C\+P\+Socket or B\+M\+A\+Session you can override the method to add attributes to the list.
|
||||
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}.
|
||||
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+T\+C\+P\+Server}}, \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
45d94885a61efc762ddc3c8e590a48e6
|
||||
a33fab216720a2263f2d7805928efbed
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
e1ab27f91b23a5bd46126af5bc534fef
|
||||
2c35632b80d53d66f35deaed94cc2c7e
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
06dd49540bf0b9bc8d6d30dcbcd1f908
|
||||
56d7304dcefbcc3a212a2bd19c4f222f
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
b557149d33adcd0e054b6c429adc0078
|
||||
d627f85b92b90c661bf33ed669aca2d6
|
||||
Binary file not shown.
@@ -30,12 +30,12 @@ Collaboration diagram for core\+::T\+L\+S\+Session\+:\nopagebreak
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{output}} (std\+::stringstream \&\mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}{out}})
|
||||
\item
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}{protocol}} (coreutils\+::\+Z\+String data) override
|
||||
virtual void \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{protocol}} (coreutils\+::\+Z\+String \&data) override
|
||||
\end{DoxyCompactItemize}
|
||||
\doxysubsection*{Protected Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}{receive\+Data}} (coreutils\+::\+Z\+String buffer) override
|
||||
void \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{receive\+Data}} (coreutils\+::\+Z\+String \&buffer) override
|
||||
\item
|
||||
void \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}{on\+Register}} ()
|
||||
\begin{DoxyCompactList}\small\item\em Called before the socket has registered with the epoll processing. \end{DoxyCompactList}\item
|
||||
@@ -77,27 +77,27 @@ The output method is called by a socket session (Session) and will output the de
|
||||
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}\label{classcore_1_1TLSSession_a2ff61cfcb3ffd3593b1bf7b39343ee56}}
|
||||
\mbox{\Hypertarget{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}\label{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}}
|
||||
\index{core::TLSSession@{core::TLSSession}!protocol@{protocol}}
|
||||
\index{protocol@{protocol}!core::TLSSession@{core::TLSSession}}
|
||||
\doxysubsubsection{\texorpdfstring{protocol()}{protocol()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\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}}.
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+T\+C\+P\+Session}}.
|
||||
|
||||
\mbox{\Hypertarget{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}\label{classcore_1_1TLSSession_a4b3c2d871d83150974bba48435eaf6cf}}
|
||||
\mbox{\Hypertarget{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}\label{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}}
|
||||
\index{core::TLSSession@{core::TLSSession}!receiveData@{receiveData}}
|
||||
\index{receiveData@{receiveData}!core::TLSSession@{core::TLSSession}}
|
||||
\doxysubsubsection{\texorpdfstring{receiveData()}{receiveData()}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+Z\+String \&}]{buffer }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
|
||||
|
||||
receive\+Data will read the data from the socket and place it in the socket buffer. T\+LS layer overrides this to be able to read from S\+SL.
|
||||
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a481b3b3874a6862f8d97030297cc6f32}{core\+::\+Socket}}.
|
||||
Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{core\+::\+Socket}}.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
4b4e04eef98ed454cb8bb0eb211081b4
|
||||
bb7b72ab545059e6869b8149ca11d20e
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
61d63fe6b2c9be6553ef9377dc278de0
|
||||
547702fb1dc57c45ed4be5e1a8eb0583
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
79a104eec9d87e5725cdcedbbd80ce2b
|
||||
ddcf4edd95011751dbbfe508acb046f9
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
5d48819c89efffda2390cb97e42f0b32
|
||||
3e581dfae79d3970f63743d4be890c78
|
||||
Binary file not shown.
@@ -19,7 +19,7 @@ Collaboration diagram for core\+::Timer\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=228pt]{classcore_1_1Timer__coll__graph}
|
||||
\includegraphics[width=174pt]{classcore_1_1Timer__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
|
||||
@@ -1 +1 @@
|
||||
355597a5b8f73bdd4a64e5354c67cd58
|
||||
7797114d50492239a6a8ab7ebcacad0b
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
617971adb50a1efe813581edca119552
|
||||
ab2b38172e6372d1ef31defa9e6f6b5e
|
||||
Binary file not shown.
@@ -19,7 +19,7 @@ Collaboration diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=255pt]{classcore_1_1UDPServerSocket__coll__graph}
|
||||
\includegraphics[width=245pt]{classcore_1_1UDPServerSocket__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
|
||||
@@ -1 +1 @@
|
||||
ee5edced35c03e5bc69a3bd5b59cb218
|
||||
5fe54968761d04dd96b6878affeacc10
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
d160cdaf2d27afabe4f7472a96002fb2
|
||||
460ca49f78cf9de9f37d9f3ea2fa6542
|
||||
Binary file not shown.
@@ -15,7 +15,7 @@ Collaboration diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[width=235pt]{classcore_1_1UDPSocket__coll__graph}
|
||||
\includegraphics[width=177pt]{classcore_1_1UDPSocket__coll__graph}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\doxysubsection*{Public Member Functions}
|
||||
|
||||
@@ -1 +1 @@
|
||||
b78440274322ebafec9b093976210cc0
|
||||
e118447cd2727ab7cf67c7f37abad058
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
c67a7f359a1f48f7b3e8b59b69c2ddb1
|
||||
e21e5069bcc5ad5911e1036f19eb0699
|
||||
Binary file not shown.
+8
-8
@@ -1,11 +1,5 @@
|
||||
\doxysection{Class Hierarchy}
|
||||
This inheritance list is sorted roughly, but not completely, alphabetically\+:\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::I\+P\+Address\+List}{\pageref{classcore_1_1IPAddressList}}{}
|
||||
\item Log\+Listener\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Console\+Server}{\pageref{classcore_1_1ConsoleServer}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Object}{\pageref{classcore_1_1Object}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Command}{\pageref{classcore_1_1Command}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Command\+List}{\pageref{classcore_1_1CommandList}}{}
|
||||
@@ -17,8 +11,16 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::U\+D\+P\+Server\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::I\+P\+Address\+List}{\pageref{classcore_1_1IPAddressList}}{}
|
||||
\item Log\+Listener\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Console\+Server}{\pageref{classcore_1_1ConsoleServer}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Object}{\pageref{classcore_1_1Object}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::I\+P\+Address}{\pageref{classcore_1_1IPAddress}}{}
|
||||
\item \contentsline{section}{core\+::Session\+Filter}{\pageref{classcore_1_1SessionFilter}}{}
|
||||
\item \contentsline{section}{core\+::Thread}{\pageref{classcore_1_1Thread}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Socket}{\pageref{classcore_1_1Socket}}{}
|
||||
\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::I\+Notify}{\pageref{classcore_1_1INotify}}{}
|
||||
@@ -40,6 +42,4 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b
|
||||
\item \contentsline{section}{core\+::U\+D\+P\+Server\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{}
|
||||
\end{DoxyCompactList}
|
||||
\end{DoxyCompactList}
|
||||
\item \contentsline{section}{core\+::Thread}{\pageref{classcore_1_1Thread}}{}
|
||||
\end{DoxyCompactList}
|
||||
\end{DoxyCompactList}
|
||||
Reference in new issue
Block a user