barant/ServerCore
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modified to compile on jammy jellyfish.

Browse Source
This commit is contained in:
Brad Arant committed 2022-03-18 07:04:21 -07:00
1 parent 565f119653
commit 7ff2b5e779
226 files changed
+2002 -1747
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

latex/annotated.tex
+11 -11
View File
@@ -4,24 +4,24 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1CommandList}{core\+::\+Command\+List}} }{\pageref{classcore_1_1CommandList}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1ConsoleServer}{core\+::\+Console\+Server}} }{\pageref{classcore_1_1ConsoleServer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1ConsoleSession}{core\+::\+Console\+Session}} }{\pageref{classcore_1_1ConsoleSession}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1EPoll}{core\+::\+E\+Poll}} }{\pageref{classcore_1_1EPoll}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1INotify}{core\+::\+I\+Notify}} }{\pageref{classcore_1_1INotify}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddress}{core\+::\+I\+P\+Address}} }{\pageref{classcore_1_1IPAddress}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddressList}{core\+::\+I\+P\+Address\+List}} }{\pageref{classcore_1_1IPAddressList}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1EPoll}{core\+::\+EPoll}} }{\pageref{classcore_1_1EPoll}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1INotify}{core\+::\+INotify}} }{\pageref{classcore_1_1INotify}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddress}{core\+::\+IPAddress}} }{\pageref{classcore_1_1IPAddress}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1IPAddressList}{core\+::\+IPAddress\+List}} }{\pageref{classcore_1_1IPAddressList}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Object}{core\+::\+Object}} }{\pageref{classcore_1_1Object}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1SessionFilter}{core\+::\+Session\+Filter}} }{\pageref{classcore_1_1SessionFilter}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}} }{\pageref{classcore_1_1Socket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Subscription}{core\+::\+Subscription}} }{\pageref{classcore_1_1Subscription}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1SubscriptionManager}{core\+::\+Subscription\+Manager}} }{\pageref{classcore_1_1SubscriptionManager}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPServer}{core\+::\+T\+C\+P\+Server}} }{\pageref{classcore_1_1TCPServer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSession}{core\+::\+T\+C\+P\+Session}} }{\pageref{classcore_1_1TCPSession}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSocket}{core\+::\+T\+C\+P\+Socket}} }{\pageref{classcore_1_1TCPSocket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPServer}{core\+::\+TCPServer}} }{\pageref{classcore_1_1TCPServer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSession}{core\+::\+TCPSession}} }{\pageref{classcore_1_1TCPSession}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TCPSocket}{core\+::\+TCPSocket}} }{\pageref{classcore_1_1TCPSocket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TerminalSession}{core\+::\+Terminal\+Session}} }{\pageref{classcore_1_1TerminalSession}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Thread}{core\+::\+Thread}} }{\pageref{classcore_1_1Thread}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1ThreadScope}{core\+::\+Thread\+Scope}} }{\pageref{classcore_1_1ThreadScope}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1Timer}{core\+::\+Timer}} }{\pageref{classcore_1_1Timer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSServer}{core\+::\+T\+L\+S\+Server}} }{\pageref{classcore_1_1TLSServer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSSession}{core\+::\+T\+L\+S\+Session}} }{\pageref{classcore_1_1TLSSession}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPServerSocket}{core\+::\+U\+D\+P\+Server\+Socket}} }{\pageref{classcore_1_1UDPServerSocket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPSocket}{core\+::\+U\+D\+P\+Socket}} }{\pageref{classcore_1_1UDPSocket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSServer}{core\+::\+TLSServer}} }{\pageref{classcore_1_1TLSServer}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1TLSSession}{core\+::\+TLSSession}} }{\pageref{classcore_1_1TLSSession}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPServerSocket}{core\+::\+UDPServer\+Socket}} }{\pageref{classcore_1_1UDPServerSocket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcore_1_1UDPSocket}{core\+::\+UDPSocket}} }{\pageref{classcore_1_1UDPSocket}}{}
\end{DoxyCompactList}
latex/classcore_1_1Command.tex
+4 -4
View File
@@ -16,7 +16,7 @@ Inheritance diagram for core\+::Command\+:\nopagebreak
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
virtual int \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
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}
@@ -43,13 +43,13 @@ Specify the output that will occur to the specified session.
\end{DoxyParams}
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+T\+C\+P\+Server}}.
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\+::\+Z\+String \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
{\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.
@@ -65,7 +65,7 @@ Returns 0 if execution of the command was successful. Otherwise returns a non-\/
\end{DoxyReturn}
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{core\+::\+T\+C\+P\+Server}}, \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{core\+::\+E\+Poll}}, \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{core\+::\+Subscription\+Manager}}, and \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{core\+::\+Command\+List}}.
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}}.
latex/classcore_1_1CommandList.tex
+8 -8
View File
@@ -32,14 +32,14 @@ void \mbox{\hyperlink{classcore_1_1CommandList_a7a45e75e3d21a25fd3f7e887acf395e9
\item
void \mbox{\hyperlink{classcore_1_1CommandList_aaac684effb9ecf5238d23ca60d3fffaa}{remove}} (\mbox{\hyperlink{classcore_1_1Command}{Command}} \&command)
\item
bool \mbox{\hyperlink{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}{process\+Request}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
bool \mbox{\hyperlink{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}{process\+Request}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
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)
bool \mbox{\hyperlink{classcore_1_1CommandList_a72aea93a650f148c639ba25a724da243}{grab\+Input}} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command)
\item
\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)
void {\bfseries clear\+Grab} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
int \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
int \mbox{\hyperlink{classcore_1_1CommandList_a1819e1cb377b5d8e5e00b4777e2b4aba}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\end{DoxyCompactItemize}
\doxysubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
@@ -70,13 +70,13 @@ Add a new command to the command list and assign a default search value. \mbox{\
\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}} \&}]{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}{TCPSession}} \&}]{session, }\item[{\mbox{\hyperlink{classcore_1_1Command}{Command}} \&}]{command }\end{DoxyParamCaption})}
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]}}
{\footnotesize\ttfamily int core\+::\+Command\+List\+::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.
@@ -98,9 +98,9 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee
\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}} \&}]{session }\end{DoxyParamCaption})}
{\footnotesize\ttfamily bool core\+::\+Command\+List\+::process\+Request (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})}
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 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 ZString to the command set and execute the matching parameter. The selected command will return a true on a call to 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()}}
latex/classcore_1_1ConsoleServer.tex
+6 -5
View File
@@ -11,7 +11,8 @@ Inheritance diagram for core\+::Console\+Server\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::Console\+Server\+:\nopagebreak
Collaboration diagram for core\+::Console\+Server\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -22,12 +23,12 @@ Collaboration diagram for core\+::Console\+Server\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1ConsoleServer_a938c93207ced5bfa3e15e9f4a1cbf3f0}\label{classcore_1_1ConsoleServer_a938c93207ced5bfa3e15e9f4a1cbf3f0}}
{\bfseries Console\+Server} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address)
{\bfseries Console\+Server} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address)
\item
\mbox{\Hypertarget{classcore_1_1ConsoleServer_ace482706881fd6cbec4e01534c091391}\label{classcore_1_1ConsoleServer_ace482706881fd6cbec4e01534c091391}}
void {\bfseries log\+Send} (std\+::string out) override
\item
\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ \mbox{\hyperlink{classcore_1_1ConsoleServer_a80d9ea7f3fc5e07c50d5b9e0d4943ca8}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll) override
\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ \mbox{\hyperlink{classcore_1_1ConsoleServer_a80d9ea7f3fc5e07c50d5b9e0d4943ca8}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll) override
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
@@ -37,11 +38,11 @@ void {\bfseries log\+Send} (std\+::string out) override
\index{core::ConsoleServer@{core::ConsoleServer}!getSocketAccept@{getSocketAccept}}
\index{getSocketAccept@{getSocketAccept}!core::ConsoleServer@{core::ConsoleServer}}
\doxysubsubsection{\texorpdfstring{getSocketAccept()}{getSocketAccept()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ core\+::\+Console\+Server\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ core\+::\+Console\+Server\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
get\+Socket\+Accept is designed to allow a polymorphic extension of this object to return a type of object that extends the definition of the server socket. Returning the appropriate session object that extends from Session provides the mechanism where the server can select the protocol dialog for the desired service.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{core\+::\+T\+C\+P\+Server}}.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{core\+::\+TCPServer}}.
latex/classcore_1_1ConsoleServer__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
71124607dbe320f41db9015995c9dd1e
a4ebc47440f704b1f6db6bf83abbc128
latex/classcore_1_1ConsoleServer__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1ConsoleSession.tex
+8 -7
View File
@@ -15,7 +15,8 @@ Inheritance diagram for core\+::Console\+Session\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::Console\+Session\+:\nopagebreak
Collaboration diagram for core\+::Console\+Session\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -26,7 +27,7 @@ Collaboration diagram for core\+::Console\+Session\+:\nopagebreak
\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)
{\bfseries Console\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server)
\item
\mbox{\Hypertarget{classcore_1_1ConsoleSession_a6e6b56503966f1cae5bdff8b3814e2b9}\label{classcore_1_1ConsoleSession_a6e6b56503966f1cae5bdff8b3814e2b9}}
void {\bfseries write\+Log} (std\+::string data)
@@ -34,7 +35,7 @@ void {\bfseries write\+Log} (std\+::string data)
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol}} (coreutils\+::\+Z\+String \&data) override
void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{protocol}} (coreutils\+::\+ZString \&data) override
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
@@ -42,20 +43,20 @@ void \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08
\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_aa1818efcd33a4152d2089aa545f08833}{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}{TCPSocket}} 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_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\+::\+ZString \&}]{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.
When data is received within the session two modes are available to pass the data through the protocol method\+: LINE or BLOCK.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+T\+C\+P\+Session}}.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+TCPSession}}.
latex/classcore_1_1ConsoleSession__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
095ce2fe54c4cbec491c802d229e681e
cc5d4fa0c42ae34b1169b000474a8246
latex/classcore_1_1ConsoleSession__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1EPoll.tex
+34 -34
View File
@@ -1,12 +1,12 @@
\hypertarget{classcore_1_1EPoll}{}\doxysection{core\+::E\+Poll Class Reference}
\hypertarget{classcore_1_1EPoll}{}\doxysection{core\+::EPoll Class Reference}
\label{classcore_1_1EPoll}\index{core::EPoll@{core::EPoll}}
{\ttfamily \#include $<$E\+Poll.\+h$>$}
{\ttfamily \#include $<$EPoll.\+h$>$}
Inheritance diagram for core\+::E\+Poll\+:\nopagebreak
Inheritance diagram for core\+::EPoll\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +15,7 @@ Inheritance diagram for core\+::E\+Poll\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::E\+Poll\+:\nopagebreak
Collaboration diagram for core\+::EPoll\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -25,25 +25,25 @@ Collaboration diagram for core\+::E\+Poll\+:\nopagebreak
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classcore_1_1EPoll_a2fd5cc4336b5f72990ecc0e7ea3d7641}{E\+Poll}} ()
\mbox{\hyperlink{classcore_1_1EPoll_a2fd5cc4336b5f72990ecc0e7ea3d7641}{EPoll}} ()
\item
\mbox{\hyperlink{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}{$\sim$\+E\+Poll}} ()
\mbox{\hyperlink{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}{$\sim$\+EPoll}} ()
\item
bool \mbox{\hyperlink{classcore_1_1EPoll_aaefe2caef75eb538af90cb34682d277b}{start}} (int number\+Of\+Threads, int \mbox{\hyperlink{classcore_1_1EPoll_acfcef2513d94f7b9a191fed3dc744d90}{max\+Sockets}})
\begin{DoxyCompactList}\small\item\em Start the B\+M\+A\+E\+Poll processing. \end{DoxyCompactList}\item
\begin{DoxyCompactList}\small\item\em Start the BMAEPoll processing. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop}} ()
\begin{DoxyCompactList}\small\item\em Stop and shut down the B\+M\+A\+E\+Poll processing. \end{DoxyCompactList}\item
\begin{DoxyCompactList}\small\item\em Stop and shut down the BMAEPoll processing. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{classcore_1_1EPoll_a301b46b71ac7ac61a687ff723fe269b3}{is\+Stopping}} ()
\begin{DoxyCompactList}\small\item\em Returns a true if the stop command has been requested. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{classcore_1_1EPoll_a3d813c7bbf0da70ebc8e3cb6aeeacfb4}{register\+Socket}} (\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$socket)
\begin{DoxyCompactList}\small\item\em Register a B\+M\+A\+Socket for monitoring by B\+M\+A\+E\+Poll. \end{DoxyCompactList}\item
\begin{DoxyCompactList}\small\item\em Register a BMASocket for monitoring by BMAEPoll. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{classcore_1_1EPoll_a5ab5e82ab51e0952fc8fbcc128f52900}{unregister\+Socket}} (\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$socket)
\begin{DoxyCompactList}\small\item\em Unregister a B\+M\+A\+Socket from monitoring by B\+M\+A\+E\+Poll. \end{DoxyCompactList}\item
\begin{DoxyCompactList}\small\item\em Unregister a BMASocket from monitoring by BMAEPoll. \end{DoxyCompactList}\item
int \mbox{\hyperlink{classcore_1_1EPoll_a1e52017e1deae15c1c87c6b6a099e1ed}{get\+Descriptor}} ()
\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_a22b5f1545aff3162040844be043abcce}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override
int \mbox{\hyperlink{classcore_1_1EPoll_a22b5f1545aff3162040844be043abcce}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&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)
@@ -56,13 +56,13 @@ int \mbox{\hyperlink{classcore_1_1EPoll_acfcef2513d94f7b9a191fed3dc744d90}{max\+
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}}
\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}}
Manage socket events from the epoll system call.
Use this object to establish a socket server using the epoll network structure of Linux.
Use this object to establish the basis of working with multiple sockets of all sorts using the epoll capabilities of the Linux platform. \mbox{\hyperlink{classcore_1_1Socket}{Socket}} objects can register with \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} which will establish a communication mechanism with that socket.
Use this object to establish the basis of working with multiple sockets of all sorts using the epoll capabilities of the Linux platform. \mbox{\hyperlink{classcore_1_1Socket}{Socket}} objects can register with \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} which will establish a communication mechanism with that socket.
The maximum number of sockets to communicate with is specified on the start method.
@@ -73,22 +73,22 @@ Threads are used to establish a read queue for epoll. The desired number of thre
\index{core::EPoll@{core::EPoll}!EPoll@{EPoll}}
\index{EPoll@{EPoll}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{EPoll()}{EPoll()}}
{\footnotesize\ttfamily core\+::\+E\+Poll\+::\+E\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily core\+::\+EPoll\+::\+EPoll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
The constructor for the B\+M\+A\+E\+Poll object. \mbox{\Hypertarget{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}\label{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}}
The constructor for the BMAEPoll object. \mbox{\Hypertarget{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}\label{classcore_1_1EPoll_a8e7a2496d684b745a6410f9bd3e88534}}
\index{core::EPoll@{core::EPoll}!````~EPoll@{$\sim$EPoll}}
\index{````~EPoll@{$\sim$EPoll}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{$\sim$EPoll()}{~EPoll()}}
{\footnotesize\ttfamily core\+::\+E\+Poll\+::$\sim$\+E\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily core\+::\+EPoll\+::$\sim$\+EPoll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
The destructor for the B\+M\+A\+E\+Poll object.
The destructor for the BMAEPoll object.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1EPoll_a3238b150b5d0a57eb2e1b17daa236d3b}\label{classcore_1_1EPoll_a3238b150b5d0a57eb2e1b17daa236d3b}}
\index{core::EPoll@{core::EPoll}!eventReceived@{eventReceived}}
\index{eventReceived@{eventReceived}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{eventReceived()}{eventReceived()}}
{\footnotesize\ttfamily void core\+::\+E\+Poll\+::event\+Received (\begin{DoxyParamCaption}\item[{struct epoll\+\_\+event}]{event }\end{DoxyParamCaption})}
{\footnotesize\ttfamily void core\+::\+EPoll\+::event\+Received (\begin{DoxyParamCaption}\item[{struct epoll\+\_\+event}]{event }\end{DoxyParamCaption})}
@@ -98,7 +98,7 @@ Receive the epoll events and dispatch the event to the socket making the request
\index{core::EPoll@{core::EPoll}!getDescriptor@{getDescriptor}}
\index{getDescriptor@{getDescriptor}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{getDescriptor()}{getDescriptor()}}
{\footnotesize\ttfamily int core\+::\+E\+Poll\+::get\+Descriptor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily int core\+::\+EPoll\+::get\+Descriptor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
@@ -108,7 +108,7 @@ Use this method to obtain the current descriptor socket number for the epoll fun
\index{core::EPoll@{core::EPoll}!isStopping@{isStopping}}
\index{isStopping@{isStopping}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{isStopping()}{isStopping()}}
{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::is\+Stopping (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily bool core\+::\+EPoll\+::is\+Stopping (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
@@ -118,7 +118,7 @@ This method returns a true if the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd
\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 \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
{\footnotesize\ttfamily int core\+::\+EPoll\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
@@ -139,17 +139,17 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee
\index{core::EPoll@{core::EPoll}!registerSocket@{registerSocket}}
\index{registerSocket@{registerSocket}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{registerSocket()}{registerSocket()}}
{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::register\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})}
{\footnotesize\ttfamily bool core\+::\+EPoll\+::register\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})}
Register a B\+M\+A\+Socket for monitoring by B\+M\+A\+E\+Poll.
Register a BMASocket for monitoring by BMAEPoll.
Use register\+Socket to add a new socket to the e\+Poll event watch list. This enables a new B\+M\+A\+Socket object to receive events when data is received as well as to write data output to the socket.
Use register\+Socket to add a new socket to the e\+Poll event watch list. This enables a new BMASocket object to receive events when data is received as well as to write data output to the socket.
\begin{DoxyParams}{Parameters}
{\em socket} & a pointer to a B\+M\+A\+Socket object. \\
{\em socket} & a pointer to a BMASocket object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
@@ -159,11 +159,11 @@ a booelean that indicates the socket was registered or not.
\index{core::EPoll@{core::EPoll}!start@{start}}
\index{start@{start}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{start()}{start()}}
{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::start (\begin{DoxyParamCaption}\item[{int}]{number\+Of\+Threads, }\item[{int}]{max\+Sockets }\end{DoxyParamCaption})}
{\footnotesize\ttfamily bool core\+::\+EPoll\+::start (\begin{DoxyParamCaption}\item[{int}]{number\+Of\+Threads, }\item[{int}]{max\+Sockets }\end{DoxyParamCaption})}
Start the B\+M\+A\+E\+Poll processing.
Start the BMAEPoll processing.
Use the \mbox{\hyperlink{classcore_1_1EPoll_aaefe2caef75eb538af90cb34682d277b}{start()}} method to initiate the threads and begin epoll queue processing.
@@ -178,11 +178,11 @@ Use the \mbox{\hyperlink{classcore_1_1EPoll_aaefe2caef75eb538af90cb34682d277b}{s
\index{core::EPoll@{core::EPoll}!stop@{stop}}
\index{stop@{stop}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{stop()}{stop()}}
{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::stop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily bool core\+::\+EPoll\+::stop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Stop and shut down the B\+M\+A\+E\+Poll processing.
Stop and shut down the BMAEPoll processing.
Use the \mbox{\hyperlink{classcore_1_1EPoll_a0c2865acd31d14fbf19dbc42cc084ddc}{stop()}} method to initiate the shutdown process for the epoll socket management.
@@ -190,11 +190,11 @@ A complete shutdown of all managed sockets will be initiated by this method call
\index{core::EPoll@{core::EPoll}!unregisterSocket@{unregisterSocket}}
\index{unregisterSocket@{unregisterSocket}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{unregisterSocket()}{unregisterSocket()}}
{\footnotesize\ttfamily bool core\+::\+E\+Poll\+::unregister\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})}
{\footnotesize\ttfamily bool core\+::\+EPoll\+::unregister\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1Socket}{Socket}} $\ast$}]{socket }\end{DoxyParamCaption})}
Unregister a B\+M\+A\+Socket from monitoring by B\+M\+A\+E\+Poll.
Unregister a BMASocket from monitoring by BMAEPoll.
Use this method to remove a socket from receiving events from the epoll system.
@@ -203,7 +203,7 @@ Use this method to remove a socket from receiving events from the epoll system.
\index{core::EPoll@{core::EPoll}!maxSockets@{maxSockets}}
\index{maxSockets@{maxSockets}!core::EPoll@{core::EPoll}}
\doxysubsubsection{\texorpdfstring{maxSockets}{maxSockets}}
{\footnotesize\ttfamily int core\+::\+E\+Poll\+::max\+Sockets}
{\footnotesize\ttfamily int core\+::\+EPoll\+::max\+Sockets}
@@ -213,5 +213,5 @@ The maximum number of sockets that can be managed by the epoll system.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
E\+Poll.\+h\item
E\+Poll.\+cpp\end{DoxyCompactItemize}
EPoll.\+h\item
EPoll.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1INotify.tex
+7 -7
View File
@@ -1,8 +1,8 @@
\hypertarget{classcore_1_1INotify}{}\doxysection{core\+::I\+Notify Class Reference}
\hypertarget{classcore_1_1INotify}{}\doxysection{core\+::INotify Class Reference}
\label{classcore_1_1INotify}\index{core::INotify@{core::INotify}}
Inheritance diagram for core\+::I\+Notify\+:\nopagebreak
Inheritance diagram for core\+::INotify\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -11,7 +11,7 @@ Inheritance diagram for core\+::I\+Notify\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::I\+Notify\+:\nopagebreak
Collaboration diagram for core\+::INotify\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -22,7 +22,7 @@ Collaboration diagram for core\+::I\+Notify\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1INotify_a777d8ab058639165974b7c0144564b26}\label{classcore_1_1INotify_a777d8ab058639165974b7c0144564b26}}
{\bfseries I\+Notify} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll)
{\bfseries INotify} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll)
\item
\mbox{\Hypertarget{classcore_1_1INotify_ab498fca3d44a7de75b1a6b1f9e1404e7}\label{classcore_1_1INotify_ab498fca3d44a7de75b1a6b1f9e1404e7}}
int {\bfseries add\+Watch} (std\+::string watch)
@@ -31,7 +31,7 @@ int {\bfseries add\+Watch} (std\+::string watch)
void {\bfseries remove\+Watch} (int wd)
\item
\mbox{\Hypertarget{classcore_1_1INotify_a642e44e906da81ce8180beb2bc09d602}\label{classcore_1_1INotify_a642e44e906da81ce8180beb2bc09d602}}
void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String \&data) override
void {\bfseries on\+Data\+Received} (coreutils\+::\+ZString \&data) override
\item
\mbox{\Hypertarget{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}\label{classcore_1_1INotify_a172949023698fc486d690d3b6d3d6f17}}
virtual void {\bfseries in\+Access} (std\+::string name)
@@ -73,5 +73,5 @@ virtual void {\bfseries in\+Open} (std\+::string name)
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
I\+Notify.\+h\item
I\+Notify.\+cpp\end{DoxyCompactItemize}
INotify.\+h\item
INotify.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1IPAddress.tex
+7 -7
View File
@@ -1,8 +1,8 @@
\hypertarget{classcore_1_1IPAddress}{}\doxysection{core\+::I\+P\+Address Class Reference}
\hypertarget{classcore_1_1IPAddress}{}\doxysection{core\+::IPAddress Class Reference}
\label{classcore_1_1IPAddress}\index{core::IPAddress@{core::IPAddress}}
Inheritance diagram for core\+::I\+P\+Address\+:\nopagebreak
Inheritance diagram for core\+::IPAddress\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -11,7 +11,7 @@ Inheritance diagram for core\+::I\+P\+Address\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::I\+P\+Address\+:\nopagebreak
Collaboration diagram for core\+::IPAddress\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -22,10 +22,10 @@ Collaboration diagram for core\+::I\+P\+Address\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1IPAddress_a31fb55b1b979f0e8a07446285f9a99f8}\label{classcore_1_1IPAddress_a31fb55b1b979f0e8a07446285f9a99f8}}
{\bfseries I\+P\+Address} (std\+::string address)
{\bfseries IPAddress} (std\+::string address)
\item
\mbox{\Hypertarget{classcore_1_1IPAddress_a37d942b8fae09010adbda33f714808c0}\label{classcore_1_1IPAddress_a37d942b8fae09010adbda33f714808c0}}
{\bfseries I\+P\+Address} (std\+::string address, int port)
{\bfseries IPAddress} (std\+::string address, int port)
\item
\mbox{\Hypertarget{classcore_1_1IPAddress_a095a5ab48cc72161c1614ddfa89ac3ee}\label{classcore_1_1IPAddress_a095a5ab48cc72161c1614ddfa89ac3ee}}
struct sockaddr $\ast$ {\bfseries get\+Pointer} ()
@@ -52,5 +52,5 @@ socklen\+\_\+t {\bfseries address\+Length}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
I\+P\+Address.\+h\item
I\+P\+Address.\+cpp\end{DoxyCompactItemize}
IPAddress.\+h\item
IPAddress.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1IPAddressList.tex
+6 -6
View File
@@ -1,16 +1,16 @@
\hypertarget{classcore_1_1IPAddressList}{}\doxysection{core\+::I\+P\+Address\+List Class Reference}
\hypertarget{classcore_1_1IPAddressList}{}\doxysection{core\+::IPAddress\+List Class Reference}
\label{classcore_1_1IPAddressList}\index{core::IPAddressList@{core::IPAddressList}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1IPAddressList_a740cf5f7e2633836b7a741b9f048036f}\label{classcore_1_1IPAddressList_a740cf5f7e2633836b7a741b9f048036f}}
std\+::map$<$ std\+::string, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} $>$ {\bfseries get\+List} ()
std\+::map$<$ std\+::string, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} $>$ {\bfseries get\+List} ()
\item
\mbox{\Hypertarget{classcore_1_1IPAddressList_ab98c5a502d8f5cfb4e8c451c48dbc131}\label{classcore_1_1IPAddressList_ab98c5a502d8f5cfb4e8c451c48dbc131}}
void {\bfseries add} (\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} ip\+Address)
void {\bfseries add} (\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} ip\+Address)
\item
\mbox{\Hypertarget{classcore_1_1IPAddressList_a86e9890e15e8e0d87e34f36b637d5c40}\label{classcore_1_1IPAddressList_a86e9890e15e8e0d87e34f36b637d5c40}}
bool {\bfseries remove} (\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} ip\+Address)
bool {\bfseries remove} (\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} ip\+Address)
\item
\mbox{\Hypertarget{classcore_1_1IPAddressList_add254c996687fd8f9ada0b5335e477cd}\label{classcore_1_1IPAddressList_add254c996687fd8f9ada0b5335e477cd}}
bool {\bfseries contains} (std\+::string ip\+Address)
@@ -19,5 +19,5 @@ bool {\bfseries contains} (std\+::string ip\+Address)
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
I\+P\+Address\+List.\+h\item
I\+P\+Address\+List.\+cpp\end{DoxyCompactItemize}
IPAddress\+List.\+h\item
IPAddress\+List.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1SessionFilter.tex
+1 -1
View File
@@ -22,7 +22,7 @@ Collaboration diagram for core\+::Session\+Filter\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1SessionFilter_a9871d18a9f90c8028f879b0993b25b6f}\label{classcore_1_1SessionFilter_a9871d18a9f90c8028f879b0993b25b6f}}
virtual bool {\bfseries test} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
virtual bool {\bfseries test} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
latex/classcore_1_1Socket.tex
+19 -18
View File
@@ -6,7 +6,8 @@
Inheritance diagram for core\+::Socket\+:\nopagebreak
Inheritance diagram for core\+::Socket\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -25,7 +26,7 @@ Collaboration diagram for core\+::Socket\+:\nopagebreak
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}{Socket}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, std\+::string text=\char`\"{}\char`\"{})
\mbox{\hyperlink{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}{Socket}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, std\+::string text=\char`\"{}\char`\"{})
\item
virtual \mbox{\hyperlink{classcore_1_1Socket_aa5003845f8ae464ad2fa206176381be0}{$\sim$\+Socket}} ()
\item
@@ -78,15 +79,15 @@ int {\bfseries get\+Buffer\+Size} ()
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_ae048b57ac2c34381378f3da0e758b3c8}\label{classcore_1_1Socket_ae048b57ac2c34381378f3da0e758b3c8}}
virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+Z\+String \&data)
virtual void {\bfseries on\+Data\+Received} (coreutils\+::\+ZString \&data)
\item
virtual void \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{receive\+Data}} (coreutils\+::\+Z\+String \&buffer)
virtual void \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{receive\+Data}} (coreutils\+::\+ZString \&buffer)
\end{DoxyCompactItemize}
\doxysubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1Socket_a3b0b139ac7da581f0d969f6ae9a0c97c}\label{classcore_1_1Socket_a3b0b139ac7da581f0d969f6ae9a0c97c}}
\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \& {\bfseries e\+Poll}
\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \& {\bfseries e\+Poll}
\item
\mbox{\Hypertarget{classcore_1_1Socket_aa09db6c6298d20ea76c6e65f8bffd3dc}\label{classcore_1_1Socket_aa09db6c6298d20ea76c6e65f8bffd3dc}}
bool {\bfseries shut\+Down} = false
@@ -98,26 +99,26 @@ 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.
Hooks into the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} 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}{EPoll}} 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.
The socket side of the \mbox{\hyperlink{classcore_1_1Socket}{Socket}} accepts E\+P\+O\+L\+L\+IN event and will maintain the data in a buffer for the stream readers to read. A on\+Data\+Received event is then sent with the data received in the buffer that can be read through the stream. Only sockets that send events to epoll can be used with this object.
The socket side of the \mbox{\hyperlink{classcore_1_1Socket}{Socket}} accepts EPOLLIN event and will maintain the data in a buffer for the stream readers to read. A on\+Data\+Received event is then sent with the data received in the buffer that can be read through the stream. Only sockets that send events to epoll can be used with this object.
When writing to the stream the data is written into a buffer and a E\+P\+O\+L\+L\+O\+UT is scheduled. Upon receiving the E\+P\+O\+L\+L\+O\+UT event then the buffer is written to the socket output.
When writing to the stream the data is written into a buffer and a EPOLLOUT is scheduled. Upon receiving the EPOLLOUT event then the buffer is written to the socket output.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}\label{classcore_1_1Socket_a4c3f87fd1de3c9eab4bf5efbb30ce87d}}
\index{core::Socket@{core::Socket}!Socket@{Socket}}
\index{Socket@{Socket}!core::Socket@{core::Socket}}
\doxysubsubsection{\texorpdfstring{Socket()}{Socket()}}
{\footnotesize\ttfamily core\+::\+Socket\+::\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
{\footnotesize\ttfamily core\+::\+Socket\+::\+Socket (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
Constructor
\begin{DoxyParams}{Parameters}
{\em e\+Poll} & The \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} socket descriptor. \\
{\em e\+Poll} & The \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} socket descriptor. \\
\hline
{\em text} & A title for this socket. \\
\hline
@@ -143,7 +144,7 @@ Parse epoll event and call specified callbacks.
The event received from epoll is sent through the event\+Received method which will parse the event and call the read and write callbacks on the socket.
This method is called by the B\+M\+A\+E\+Poll object and should not be called from any user extended classes unless an epoll event is being simulated.
This method is called by the BMAEPoll object and should not be called from any user extended classes unless an epoll event is being simulated.
The return value of false will delete the socket object causing the destructors to run. The return value of true will enable the socket on e\+Poll to receive more events. \mbox{\Hypertarget{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}\label{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf6bcf6b4e5}}
\index{core::Socket@{core::Socket}!onDataReceived@{onDataReceived}}
@@ -155,7 +156,7 @@ The return value of false will delete the socket object causing the destructors
Called when data is received from the socket.
The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. E\+P\+O\+L\+L\+IN
The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. EPOLLIN
\begin{DoxyParams}{Parameters}
@@ -164,7 +165,7 @@ The on\+Connected method is called when the socket is ready to communicate. Writ
\end{DoxyParams}
Reimplemented in \mbox{\hyperlink{classcore_1_1TCPServer_a276ccbc8cb9b4380ebd78807b97f0159}{core\+::\+T\+C\+P\+Server}}, and \mbox{\hyperlink{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}{core\+::\+U\+D\+P\+Server\+Socket}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}{core\+::\+UDPServer\+Socket}}, and \mbox{\hyperlink{classcore_1_1TCPServer_a276ccbc8cb9b4380ebd78807b97f0159}{core\+::\+TCPServer}}.
\mbox{\Hypertarget{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}\label{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}}
\index{core::Socket@{core::Socket}!onRegister@{onRegister}}
@@ -178,7 +179,7 @@ Called before the socket has registered with the epoll processing.
The on\+Register method is called before the socket is registered with e\+Poll so objects extending the \mbox{\hyperlink{classcore_1_1Socket}{Socket}} definition can initialize the socket before receiving events. Evoked when the descriptor is set using set\+Descriptor for the socket.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}{core\+::\+T\+L\+S\+Session}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}{core\+::\+TLSSession}}.
\mbox{\Hypertarget{classcore_1_1Socket_ae9be59697c2b2e5efb19aaae3ba943d2}\label{classcore_1_1Socket_ae9be59697c2b2e5efb19aaae3ba943d2}}
\index{core::Socket@{core::Socket}!onUnregistered@{onUnregistered}}
@@ -194,11 +195,11 @@ The on\+Unregistered method is called whenever the socket is unregistered with e
\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\+::\+ZString \&}]{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.
receive\+Data will read the data from the socket and place it in the socket buffer. TLS layer overrides this to be able to read from SSL.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{core\+::\+T\+L\+S\+Session}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{core\+::\+TLSSession}}.
\mbox{\Hypertarget{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}\label{classcore_1_1Socket_ac44f6ae3196a8a3e09a6a85fcf495762}}
\index{core::Socket@{core::Socket}!setDescriptor@{setDescriptor}}
@@ -210,7 +211,7 @@ Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f
Set the descriptor for the socket.
set\+Descriptor establishes the file descriptor for the socket and registers the socket on the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} controller. set\+Descriptor will invoke the \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}{on\+Register()}} event. \mbox{\Hypertarget{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}\label{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}}
set\+Descriptor establishes the file descriptor for the socket and registers the socket on the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} controller. set\+Descriptor will invoke the \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8b7dfe0da0}{on\+Register()}} event. \mbox{\Hypertarget{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}\label{classcore_1_1Socket_af2d1b6de7a64a9d446b0305b6ec47b31}}
\index{core::Socket@{core::Socket}!shutdown@{shutdown}}
\index{shutdown@{shutdown}!core::Socket@{core::Socket}}
\doxysubsubsection{\texorpdfstring{shutdown()}{shutdown()}}
latex/classcore_1_1Socket__inherit__graph.md5
+1 -1
View File
@@ -1 +1 @@
8091a6c3a543813cfce9b032080c642a
5ea0d5d5486386272f1f6c4c06eae462
latex/classcore_1_1Socket__inherit__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1Subscription.tex
+12 -11
View File
@@ -2,7 +2,8 @@
\label{classcore_1_1Subscription}\index{core::Subscription@{core::Subscription}}
Collaboration diagram for core\+::Subscription\+:\nopagebreak
Collaboration diagram for core\+::Subscription\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -13,28 +14,28 @@ Collaboration diagram for core\+::Subscription\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a348a4ec8232ada37f5be2b6f756f01f3}\label{classcore_1_1Subscription_a348a4ec8232ada37f5be2b6f756f01f3}}
{\bfseries Subscription} (std\+::string id, std\+::string mode=\char`\"{}$\ast$A\+U\+T\+H\+OR\char`\"{})
{\bfseries Subscription} (std\+::string id, std\+::string mode=\char`\"{}$\ast$AUTHOR\char`\"{})
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a75e36b110e87138d4f5d8f0cbbaca4c1}\label{classcore_1_1Subscription_a75e36b110e87138d4f5d8f0cbbaca4c1}}
{\bfseries Subscription} (std\+::string id, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session, std\+::string mode=\char`\"{}$\ast$A\+U\+T\+H\+OR\char`\"{})
{\bfseries Subscription} (std\+::string id, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session, std\+::string mode=\char`\"{}$\ast$AUTHOR\char`\"{})
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a57c23d7c49328eecf8358f84b485f7cb}\label{classcore_1_1Subscription_a57c23d7c49328eecf8358f84b485f7cb}}
int {\bfseries subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
int {\bfseries subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a4b6d9f10c605f20c7e27c308577ab8d4}\label{classcore_1_1Subscription_a4b6d9f10c605f20c7e27c308577ab8d4}}
int {\bfseries unsubscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
int {\bfseries unsubscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a6065524e207dde927d553c581269e937}\label{classcore_1_1Subscription_a6065524e207dde927d553c581269e937}}
virtual int {\bfseries process} (coreutils\+::\+Z\+String \&request, std\+::stringstream \&out)
\mbox{\Hypertarget{classcore_1_1Subscription_afe97bd6c3c714df84381fdd6d66e5037}\label{classcore_1_1Subscription_afe97bd6c3c714df84381fdd6d66e5037}}
virtual int {\bfseries process} (coreutils\+::\+ZString \&request, std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a886b136b6eae0adcfac1384fc2fae67f}\label{classcore_1_1Subscription_a886b136b6eae0adcfac1384fc2fae67f}}
virtual int {\bfseries on\+Subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
virtual int {\bfseries on\+Subscribe} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
\mbox{\Hypertarget{classcore_1_1Subscription_adfd211503f5eccfda620995de58c73f9}\label{classcore_1_1Subscription_adfd211503f5eccfda620995de58c73f9}}
int {\bfseries event} (std\+::stringstream \&out)
\item
\mbox{\Hypertarget{classcore_1_1Subscription_addf187a8e97c2be1ac0cce9c21da5a28}\label{classcore_1_1Subscription_addf187a8e97c2be1ac0cce9c21da5a28}}
bool {\bfseries if\+Subscriber} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
bool {\bfseries if\+Subscriber} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
@@ -46,10 +47,10 @@ std\+::string {\bfseries id}
std\+::string {\bfseries mode}
\item
\mbox{\Hypertarget{classcore_1_1Subscription_a5526427600aa4a5b180f76f201e85f58}\label{classcore_1_1Subscription_a5526427600aa4a5b180f76f201e85f58}}
\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ {\bfseries owner}
\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ {\bfseries owner}
\item
\mbox{\Hypertarget{classcore_1_1Subscription_ad1a5c1a3e5a6e253eb34795f43d4f9be}\label{classcore_1_1Subscription_ad1a5c1a3e5a6e253eb34795f43d4f9be}}
std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ $>$ {\bfseries subscribers}
std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ $>$ {\bfseries subscribers}
\end{DoxyCompactItemize}
latex/classcore_1_1SubscriptionManager.tex
+3 -3
View File
@@ -25,9 +25,9 @@ Collaboration diagram for core\+::Subscription\+Manager\+:\nopagebreak
int {\bfseries add} (\mbox{\hyperlink{classcore_1_1Subscription}{Subscription}} \&subscription)
\item
\mbox{\Hypertarget{classcore_1_1SubscriptionManager_aed407c183c390f4459bb6527b30c8198}\label{classcore_1_1SubscriptionManager_aed407c183c390f4459bb6527b30c8198}}
int {\bfseries remove\+Session\+Subscriptions} (\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session)
int {\bfseries remove\+Session\+Subscriptions} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
\item
int \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override
int \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a790662e4f8ae}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) override
\end{DoxyCompactItemize}
@@ -36,7 +36,7 @@ int \mbox{\hyperlink{classcore_1_1SubscriptionManager_aaa30bf772ad72b3f319a79066
\index{core::SubscriptionManager@{core::SubscriptionManager}!processCommand@{processCommand}}
\index{processCommand@{processCommand}!core::SubscriptionManager@{core::SubscriptionManager}}
\doxysubsubsection{\texorpdfstring{processCommand()}{processCommand()}}
{\footnotesize\ttfamily int core\+::\+Subscription\+Manager\+::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]}}
{\footnotesize\ttfamily int core\+::\+Subscription\+Manager\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\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.
latex/classcore_1_1Subscription__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
66e736a90742b1dc209cc7069b9e8c91
2729f4733c58f8e25137c8d4e188b60b
latex/classcore_1_1Subscription__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TCPServer.tex
+36 -35
View File
@@ -1,12 +1,12 @@
\hypertarget{classcore_1_1TCPServer}{}\doxysection{core\+::T\+C\+P\+Server Class Reference}
\hypertarget{classcore_1_1TCPServer}{}\doxysection{core\+::TCPServer Class Reference}
\label{classcore_1_1TCPServer}\index{core::TCPServer@{core::TCPServer}}
{\ttfamily \#include $<$T\+C\+P\+Server.\+h$>$}
{\ttfamily \#include $<$TCPServer.\+h$>$}
Inheritance diagram for core\+::T\+C\+P\+Server\+:\nopagebreak
Inheritance diagram for core\+::TCPServer\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +15,8 @@ Inheritance diagram for core\+::T\+C\+P\+Server\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::T\+C\+P\+Server\+:\nopagebreak
Collaboration diagram for core\+::TCPServer\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -25,17 +26,17 @@ Collaboration diagram for core\+::T\+C\+P\+Server\+:\nopagebreak
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}{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`\"{}, int depth=10, std\+::string text=\char`\"{}\char`\"{})
\mbox{\hyperlink{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}{TCPServer}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address, std\+::string delimiter=\char`\"{} \char`\"{}, int depth=10, std\+::string text=\char`\"{}\char`\"{})
\item
virtual \mbox{\hyperlink{classcore_1_1TCPServer_a7ccdc057c9eee8504fce796301f82088}{$\sim$\+T\+C\+P\+Server}} ()
virtual \mbox{\hyperlink{classcore_1_1TCPServer_a7ccdc057c9eee8504fce796301f82088}{$\sim$\+TCPServer}} ()
\item
\mbox{\Hypertarget{classcore_1_1TCPServer_a554ec6e67d368e7bb545d95635c0a0df}\label{classcore_1_1TCPServer_a554ec6e67d368e7bb545d95635c0a0df}}
virtual void {\bfseries session\+Error\+Handler} (std\+::string error\+String, std\+::stringstream \&out)
\item
virtual \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&epoll)
virtual \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a841f02799ad8529aad7cea132f4de8a9}{get\+Socket\+Accept}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&epoll)
\item
\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)
void {\bfseries remove\+From\+Session\+List} (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$session)
\item
\mbox{\Hypertarget{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}\label{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}}
void \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{output}} (std\+::stringstream \&out)
@@ -43,20 +44,20 @@ void \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{
\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)
void \mbox{\hyperlink{classcore_1_1TCPServer_a7080f7d45e734087e81b83c5e1f8e676}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&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)
void \mbox{\hyperlink{classcore_1_1TCPServer_af708df59e1bc60077c16db97f9cc8ff0}{send\+To\+All}} (std\+::stringstream \&out, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&sender)
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ $>$ \mbox{\hyperlink{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}{sessions}}
std\+::vector$<$ \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ $>$ \mbox{\hyperlink{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}{sessions}}
\item
\mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} \mbox{\hyperlink{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}{commands}}
\item
\mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a82f6bf16e4ab20d8b30da09e034fffff}{black\+List}}
\mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_a82f6bf16e4ab20d8b30da09e034fffff}{black\+List}}
\item
\mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}{white\+List}}
\mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}} $\ast$ \mbox{\hyperlink{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}{white\+List}}
\item
\mbox{\hyperlink{classcore_1_1SubscriptionManager}{Subscription\+Manager}} \mbox{\hyperlink{classcore_1_1TCPServer_a28302dd844cfc971ee41de2000d24aa0}{subscriptions}}
\end{DoxyCompactItemize}
@@ -65,32 +66,32 @@ 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_a6b7a7e1ac4132942fcaf418ed41c1437}{process\+Command}} (coreutils\+::\+Z\+String \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&session) override
int \mbox{\hyperlink{classcore_1_1TCPServer_a6b7a7e1ac4132942fcaf418ed41c1437}{process\+Command}} (coreutils\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session) override
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}}
\mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}}
Manage a socket connection as a T\+CP server type. Connections to the socket are processed through the accept functionality.
Manage a socket connection as a TCP server type. Connections to the socket are processed through the accept functionality.
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.
This object extends the BMACommand 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_abaecb97c336b757d1029d45277f9fc5b}\label{classcore_1_1TCPServer_abaecb97c336b757d1029d45277f9fc5b}}
\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}]{delimiter = {\ttfamily \char`\"{}~\char`\"{}}, }\item[{int}]{depth = {\ttfamily 10}, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
{\footnotesize\ttfamily core\+::\+TCPServer\+::\+TCPServer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}}}]{address, }\item[{std\+::string}]{delimiter = {\ttfamily \char`\"{}~\char`\"{}}, }\item[{int}]{depth = {\ttfamily 10}, }\item[{std\+::string}]{text = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}
The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} object.
The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} object.
\begin{DoxyParams}{Parameters}
{\em e\+Poll} & the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} instance that manages the socket. \\
{\em e\+Poll} & the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} instance that manages the socket. \\
\hline
{\em url} & the IP address for the socket to receive connection requests. \\
\hline
@@ -103,7 +104,7 @@ The constructor for the \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server
\index{core::TCPServer@{core::TCPServer}!````~TCPServer@{$\sim$TCPServer}}
\index{````~TCPServer@{$\sim$TCPServer}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{$\sim$TCPServer()}{~TCPServer()}}
{\footnotesize\ttfamily core\+::\+T\+C\+P\+Server\+::$\sim$\+T\+C\+P\+Server (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
{\footnotesize\ttfamily core\+::\+TCPServer\+::$\sim$\+TCPServer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
The destructor for this object.
@@ -112,7 +113,7 @@ The destructor for this object.
\index{core::TCPServer@{core::TCPServer}!getSocketAccept@{getSocketAccept}}
\index{getSocketAccept@{getSocketAccept}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{getSocketAccept()}{getSocketAccept()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ core\+::\+T\+C\+P\+Server\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ core\+::\+TCPServer\+::get\+Socket\+Accept (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{epoll }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
get\+Socket\+Accept is designed to allow a polymorphic extension of this object to return a type of object that extends the definition of the server socket. Returning the appropriate session object that extends from Session provides the mechanism where the server can select the protocol dialog for the desired service.
@@ -122,7 +123,7 @@ Reimplemented in \mbox{\hyperlink{classcore_1_1ConsoleServer_a80d9ea7f3fc5e07c50
\index{core::TCPServer@{core::TCPServer}!onDataReceived@{onDataReceived}}
\index{onDataReceived@{onDataReceived}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{onDataReceived()}{onDataReceived()}}
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Server\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
{\footnotesize\ttfamily void core\+::\+TCPServer\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
Override the virtual data\+Received since for the server these are requests to accept the new connection socket. No data is to be read or written when this method is called. It is the response to the fact that a new connection is coming into the system
@@ -141,7 +142,7 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf
\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 \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} \&}]{session }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
{\footnotesize\ttfamily int core\+::\+TCPServer\+::process\+Command (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{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.
@@ -158,13 +159,13 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee
\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}} \&}]{sender }\end{DoxyParamCaption})}
{\footnotesize\ttfamily void core\+::\+TCPServer\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{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_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}} \&}]{sender, }\item[{\mbox{\hyperlink{classcore_1_1SessionFilter}{Session\+Filter}}}]{filter }\end{DoxyParamCaption})}
{\footnotesize\ttfamily void core\+::\+TCPServer\+::send\+To\+All (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{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.
@@ -173,35 +174,35 @@ Use this send\+To\+All method to output the contents of the out stream to all th
\index{core::TCPServer@{core::TCPServer}!blackList@{blackList}}
\index{blackList@{blackList}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{blackList}{blackList}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}}$\ast$ core\+::\+T\+C\+P\+Server\+::black\+List}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}}$\ast$ core\+::\+TCPServer\+::black\+List}
If not N\+U\+LL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted. \mbox{\Hypertarget{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}\label{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}}
If not NULL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted. \mbox{\Hypertarget{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}\label{classcore_1_1TCPServer_afcc44802b988e2f4292504e804dccf8b}}
\index{core::TCPServer@{core::TCPServer}!commands@{commands}}
\index{commands@{commands}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{commands}{commands}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} core\+::\+T\+C\+P\+Server\+::commands}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} core\+::\+TCPServer\+::commands}
The commands object is a \mbox{\hyperlink{classcore_1_1CommandList}{Command\+List}} and is used to store \mbox{\hyperlink{classcore_1_1Command}{Command}} objects to be parsed and run as data comes into the session. \mbox{\Hypertarget{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}\label{classcore_1_1TCPServer_aeed1bc55d099667ccda51cd682bfc633}}
\index{core::TCPServer@{core::TCPServer}!sessions@{sessions}}
\index{sessions@{sessions}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{sessions}{sessions}}
{\footnotesize\ttfamily std\+::vector$<$\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$$>$ core\+::\+T\+C\+P\+Server\+::sessions}
{\footnotesize\ttfamily std\+::vector$<$\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$$>$ core\+::\+TCPServer\+::sessions}
The list of sessions that are currently open and being maintained by this object. \mbox{\Hypertarget{classcore_1_1TCPServer_a28302dd844cfc971ee41de2000d24aa0}\label{classcore_1_1TCPServer_a28302dd844cfc971ee41de2000d24aa0}}
\index{core::TCPServer@{core::TCPServer}!subscriptions@{subscriptions}}
\index{subscriptions@{subscriptions}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{subscriptions}{subscriptions}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1SubscriptionManager}{Subscription\+Manager}} core\+::\+T\+C\+P\+Server\+::subscriptions}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1SubscriptionManager}{Subscription\+Manager}} core\+::\+TCPServer\+::subscriptions}
The \mbox{\hyperlink{classcore_1_1Subscription}{Subscription}} Manager tracks all subscriptions on the server. \mbox{\Hypertarget{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}\label{classcore_1_1TCPServer_abad6300b6234ca8b69cef9128755342e}}
\index{core::TCPServer@{core::TCPServer}!whiteList@{whiteList}}
\index{whiteList@{whiteList}!core::TCPServer@{core::TCPServer}}
\doxysubsubsection{\texorpdfstring{whiteList}{whiteList}}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{I\+P\+Address\+List}}$\ast$ core\+::\+T\+C\+P\+Server\+::white\+List}
{\footnotesize\ttfamily \mbox{\hyperlink{classcore_1_1IPAddressList}{IPAddress\+List}}$\ast$ core\+::\+TCPServer\+::white\+List}
If not N\+U\+LL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted.
If not NULL the blacklist object can be assigned to this server socket and the server IP addresses connecting to the server attempting to accept a socket are contained in this list then the connection is rejected and no accept is granted.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
T\+C\+P\+Server.\+h\item
T\+C\+P\+Server.\+cpp\end{DoxyCompactItemize}
TCPServer.\+h\item
TCPServer.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1TCPServer__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
69b71d93a92fa95269e4cf915e547067
6217c13639011961a1bf70a3e5264d12
latex/classcore_1_1TCPServer__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TCPSession.tex
+34 -32
View File
@@ -1,12 +1,13 @@
\hypertarget{classcore_1_1TCPSession}{}\doxysection{core\+::T\+C\+P\+Session Class Reference}
\hypertarget{classcore_1_1TCPSession}{}\doxysection{core\+::TCPSession Class Reference}
\label{classcore_1_1TCPSession}\index{core::TCPSession@{core::TCPSession}}
{\ttfamily \#include $<$T\+C\+P\+Session.\+h$>$}
{\ttfamily \#include $<$TCPSession.\+h$>$}
Inheritance diagram for core\+::T\+C\+P\+Session\+:\nopagebreak
Inheritance diagram for core\+::TCPSession\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +16,8 @@ Inheritance diagram for core\+::T\+C\+P\+Session\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::T\+C\+P\+Session\+:\nopagebreak
Collaboration diagram for core\+::TCPSession\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -26,7 +28,7 @@ Collaboration diagram for core\+::T\+C\+P\+Session\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TCPSession_a7e1192babcdeb688f463d3e9e85d0979}\label{classcore_1_1TCPSession_a7e1192babcdeb688f463d3e9e85d0979}}
{\bfseries T\+C\+P\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server, std\+::string text=\char`\"{}\char`\"{})
{\bfseries TCPSession} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server, std\+::string text=\char`\"{}\char`\"{})
\item
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{output}} (std\+::stringstream \&data)
\item
@@ -38,10 +40,10 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TCPSession_a2c39191d695d79891989ea628f42c0a8}\label{classcore_1_1TCPSession_a2c39191d695d79891989ea628f42c0a8}}
\mbox{\hyperlink{classcore_1_1Command}{Command}} $\ast$ {\bfseries grab} = N\+U\+LL
\mbox{\hyperlink{classcore_1_1Command}{Command}} $\ast$ {\bfseries grab} = NULL
\item
\mbox{\Hypertarget{classcore_1_1TCPSession_a265d9493fa544e601b5ad5fb1663340c}\label{classcore_1_1TCPSession_a265d9493fa544e601b5ad5fb1663340c}}
\mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \& {\bfseries server}
\mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \& {\bfseries server}
\item
std\+::stringstream \mbox{\hyperlink{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}{out}}
\end{DoxyCompactItemize}
@@ -51,15 +53,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_afc2d2a92bc65e1e5122a93d120253a1d}{on\+Data\+Received}} (coreutils\+::\+Z\+String \&data) override
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_afc2d2a92bc65e1e5122a93d120253a1d}{on\+Data\+Received}} (coreutils\+::\+ZString \&data) override
\item
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}{on\+Line\+Received}} (coreutils\+::\+Z\+String \&line)
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a3d9e0f14e7d24357fd1950b3f9b4eaff}{on\+Line\+Received}} (coreutils\+::\+ZString \&line)
\item
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}{on\+Block\+Received}} (coreutils\+::\+Z\+String \&block)
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a9c996cbbfa2e592c23cf67ed8b15a32a}{on\+Block\+Received}} (coreutils\+::\+ZString \&block)
\item
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a8719952f7bb00bf7239ec40aa2868626}{on\+Connected}} ()
\item
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{protocol}} (coreutils\+::\+Z\+String \&data)
virtual void \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{protocol}} (coreutils\+::\+ZString \&data)
\item
void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}{set\+Block\+Size}} (int size=0)
\end{DoxyCompactItemize}
@@ -67,28 +69,28 @@ void \mbox{\hyperlink{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}
\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}
\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.
\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} defines the nature of the interaction with the client and stores persistent data for a defined session. \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} 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_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\+::\+TCPSession\+::on\+Block\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{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}}
\index{onConnected@{onConnected}!core::TCPSession@{core::TCPSession}}
\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]}}
{\footnotesize\ttfamily void core\+::\+TCPSession\+::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_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\+::\+TCPSession\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{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.
@@ -98,64 +100,64 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket}{core\+::\+Socket}}.
\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\+::\+TCPSession\+::on\+Line\+Received (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{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}}
Override the on\+Line\+Received method to receive a string of characters that represents a single line of data terminated by a LF or CRLF. 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}}
\index{output@{output}!core::TCPSession@{core::TCPSession}}
\doxysubsubsection{\texorpdfstring{output()}{output()}}
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
{\footnotesize\ttfamily void core\+::\+TCPSession\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
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.
The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{core\+::\+T\+C\+P\+Socket}}.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{core\+::\+TCPSocket}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+T\+L\+S\+Session}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+TLSSession}}.
\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\+::\+TCPSession\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{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.
When data is received within the session two modes are available to pass the data through the protocol method\+: LINE or BLOCK.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{core\+::\+T\+L\+S\+Session}}, and \mbox{\hyperlink{classcore_1_1ConsoleSession_aa1818efcd33a4152d2089aa545f08833}{core\+::\+Console\+Session}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{core\+::\+TLSSession}}, 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}}
\index{send@{send}!core::TCPSession@{core::TCPSession}}
\doxysubsubsection{\texorpdfstring{send()}{send()}}
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::send (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily void core\+::\+TCPSession\+::send (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
The send method is used to output the contents of the out stream to the session containing the stream. \mbox{\Hypertarget{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}\label{classcore_1_1TCPSession_a836fb3fd5ee543ebc93262a980ae88b5}}
\index{core::TCPSession@{core::TCPSession}!setBlockSize@{setBlockSize}}
\index{setBlockSize@{setBlockSize}!core::TCPSession@{core::TCPSession}}
\doxysubsubsection{\texorpdfstring{setBlockSize()}{setBlockSize()}}
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::set\+Block\+Size (\begin{DoxyParamCaption}\item[{int}]{size = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
{\footnotesize\ttfamily void core\+::\+TCPSession\+::set\+Block\+Size (\begin{DoxyParamCaption}\item[{int}]{size = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
Use set\+Block\+Size to set the amount of data that should be read at once from the session data buffer. If this value is set to 0 then the data will be retrieved \mbox{\Hypertarget{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}\label{classcore_1_1TCPSession_a34936745e8d7669d5400e78d353a56d3}}
\index{core::TCPSession@{core::TCPSession}!terminate@{terminate}}
\index{terminate@{terminate}!core::TCPSession@{core::TCPSession}}
\doxysubsubsection{\texorpdfstring{terminate()}{terminate()}}
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Session\+::terminate (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily void core\+::\+TCPSession\+::terminate (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Use this method to terminate this \mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}}.
Use this method to terminate this \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}.
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}\label{classcore_1_1TCPSession_abb302bbb3d7e7bc75490c736364f0d4d}}
\index{core::TCPSession@{core::TCPSession}!out@{out}}
\index{out@{out}!core::TCPSession@{core::TCPSession}}
\doxysubsubsection{\texorpdfstring{out}{out}}
{\footnotesize\ttfamily std\+::stringstream core\+::\+T\+C\+P\+Session\+::out}
{\footnotesize\ttfamily std\+::stringstream core\+::\+TCPSession\+::out}
Use out to send data to the session socket or other session sockets.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
T\+C\+P\+Session.\+h\item
T\+C\+P\+Session.\+cpp\end{DoxyCompactItemize}
TCPSession.\+h\item
TCPSession.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1TCPSession__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
f3d3860698dff70bd5955f0fbd35ea6d
3b790dd1292cdd59467f33301651c136
latex/classcore_1_1TCPSession__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TCPSession__inherit__graph.md5
+1 -1
View File
@@ -1 +1 @@
91ad32f695f6c4292b387bb70491673d
01b803dfb26ef948867565d97c1cc8c4
latex/classcore_1_1TCPSession__inherit__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TCPSocket.tex
+17 -16
View File
@@ -1,12 +1,13 @@
\hypertarget{classcore_1_1TCPSocket}{}\doxysection{core\+::T\+C\+P\+Socket Class Reference}
\hypertarget{classcore_1_1TCPSocket}{}\doxysection{core\+::TCPSocket Class Reference}
\label{classcore_1_1TCPSocket}\index{core::TCPSocket@{core::TCPSocket}}
{\ttfamily \#include $<$T\+C\+P\+Socket.\+h$>$}
{\ttfamily \#include $<$TCPSocket.\+h$>$}
Inheritance diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak
Inheritance diagram for core\+::TCPSocket\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +16,7 @@ Inheritance diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak
Collaboration diagram for core\+::TCPSocket\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -26,13 +27,13 @@ Collaboration diagram for core\+::T\+C\+P\+Socket\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TCPSocket_a09089f0bc701edcf6c148958fd29d374}\label{classcore_1_1TCPSocket_a09089f0bc701edcf6c148958fd29d374}}
{\bfseries T\+C\+P\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll)
{\bfseries TCPSocket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll)
\item
\mbox{\Hypertarget{classcore_1_1TCPSocket_aa7ffbbd17827ffe769684fa8345862d6}\label{classcore_1_1TCPSocket_aa7ffbbd17827ffe769684fa8345862d6}}
{\bfseries T\+C\+P\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, std\+::string text)
{\bfseries TCPSocket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, std\+::string text)
\item
\mbox{\Hypertarget{classcore_1_1TCPSocket_a22dae8f5b7989d206fab918297e0df94}\label{classcore_1_1TCPSocket_a22dae8f5b7989d206fab918297e0df94}}
void {\bfseries connect} (\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} \&address)
void {\bfseries connect} (\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} \&address)
\item
virtual void \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}{output}} (std\+::stringstream \&out)
\end{DoxyCompactItemize}
@@ -40,32 +41,32 @@ virtual void \mbox{\hyperlink{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TCPSocket_abe7d0a740dc0c19c058661270a6fb630}\label{classcore_1_1TCPSocket_abe7d0a740dc0c19c058661270a6fb630}}
\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} {\bfseries ip\+Address}
\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} {\bfseries ip\+Address}
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1TCPSocket}{T\+C\+P\+Socket}}
\mbox{\hyperlink{classcore_1_1TCPSocket}{TCPSocket}}
Provides a network T\+CP socket.
Provides a network TCP socket.
For accessing T\+CP network functions use this object. The connection oriented nature of T\+CP provides a single client persistent connection with data error correction and a durable synchronous data connection.
For accessing TCP network functions use this object. The connection oriented nature of TCP provides a single client persistent connection with data error correction and a durable synchronous data connection.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}\label{classcore_1_1TCPSocket_afacf7528ff3c9ac077d7b5a49e2116fd}}
\index{core::TCPSocket@{core::TCPSocket}!output@{output}}
\index{output@{output}!core::TCPSocket@{core::TCPSocket}}
\doxysubsubsection{\texorpdfstring{output()}{output()}}
{\footnotesize\ttfamily void core\+::\+T\+C\+P\+Socket\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
{\footnotesize\ttfamily void core\+::\+TCPSocket\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
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.
The output method is called by a socket session (\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}}) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list.
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}}.
Reimplemented in \mbox{\hyperlink{classcore_1_1TLSSession_ae55de8a035d1ddc560cf619b2030af43}{core\+::\+TLSSession}}, \mbox{\hyperlink{classcore_1_1TCPServer_a49e3ead1bf4e7830685780e73c4db5db}{core\+::\+TCPServer}}, and \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+TCPSession}}.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
T\+C\+P\+Socket.\+h\item
T\+C\+P\+Socket.\+cpp\end{DoxyCompactItemize}
TCPSocket.\+h\item
TCPSocket.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1TCPSocket__inherit__graph.md5
+1 -1
View File
@@ -1 +1 @@
2c35632b80d53d66f35deaed94cc2c7e
5cc14ce538486df71a602b5b618d16e5
latex/classcore_1_1TCPSocket__inherit__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TLSServer.tex
+17 -16
View File
@@ -1,12 +1,12 @@
\hypertarget{classcore_1_1TLSServer}{}\doxysection{core\+::T\+L\+S\+Server Class Reference}
\hypertarget{classcore_1_1TLSServer}{}\doxysection{core\+::TLSServer Class Reference}
\label{classcore_1_1TLSServer}\index{core::TLSServer@{core::TLSServer}}
{\ttfamily \#include $<$T\+L\+S\+Server.\+h$>$}
{\ttfamily \#include $<$TLSServer.\+h$>$}
Inheritance diagram for core\+::T\+L\+S\+Server\+:\nopagebreak
Inheritance diagram for core\+::TLSServer\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +15,8 @@ Inheritance diagram for core\+::T\+L\+S\+Server\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::T\+L\+S\+Server\+:\nopagebreak
Collaboration diagram for core\+::TLSServer\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -25,39 +26,39 @@ Collaboration diagram for core\+::T\+L\+S\+Server\+:\nopagebreak
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}{T\+L\+S\+Server}} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}} address)
\mbox{\hyperlink{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}{TLSServer}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address)
\item
\mbox{\hyperlink{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}{$\sim$\+T\+L\+S\+Server}} ()
\mbox{\hyperlink{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}{$\sim$\+TLSServer}} ()
\item
\mbox{\Hypertarget{classcore_1_1TLSServer_a984dfd9faaa792e29f905e860d2e4a9e}\label{classcore_1_1TLSServer_a984dfd9faaa792e29f905e860d2e4a9e}}
\mbox{\hyperlink{classcore_1_1TCPSession}{T\+C\+P\+Session}} $\ast$ {\bfseries get\+Socket\+Accept} ()
\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ {\bfseries get\+Socket\+Accept} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TLSServer_ab4e788350bda508fa44604d146e7537f}\label{classcore_1_1TLSServer_ab4e788350bda508fa44604d146e7537f}}
S\+S\+L\+\_\+\+C\+TX $\ast$ {\bfseries ctx}
SSL\+\_\+\+CTX $\ast$ {\bfseries ctx}
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1TLSServer}{T\+L\+S\+Server}}
\mbox{\hyperlink{classcore_1_1TLSServer}{TLSServer}}
Manage a socket connection as a T\+LS server type. Connections to the socket are processed through the accept functionality.
Manage a socket connection as a TLS server type. Connections to the socket are processed through the accept functionality.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}\label{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}}
\index{core::TLSServer@{core::TLSServer}!TLSServer@{TLSServer}}
\index{TLSServer@{TLSServer}!core::TLSServer@{core::TLSServer}}
\doxysubsubsection{\texorpdfstring{TLSServer()}{TLSServer()}}
{\footnotesize\ttfamily core\+::\+T\+L\+S\+Server\+::\+T\+L\+S\+Server (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{I\+P\+Address}}}]{address }\end{DoxyParamCaption})}
{\footnotesize\ttfamily core\+::\+TLSServer\+::\+TLSServer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}}}]{address }\end{DoxyParamCaption})}
The constructor.
\begin{DoxyParams}{Parameters}
{\em e\+Poll} & the B\+M\+A\+E\+Poll instance that manages the socket. \\
{\em e\+Poll} & the BMAEPoll instance that manages the socket. \\
\hline
{\em url} & the IP address for the socket to receive connection requests. \\
\hline
@@ -67,17 +68,17 @@ The constructor.
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the instance of the B\+M\+A\+T\+L\+S\+Server\+Socket.
the instance of the BMATLSServer\+Socket.
\end{DoxyReturn}
\mbox{\Hypertarget{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}\label{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}}
\index{core::TLSServer@{core::TLSServer}!````~TLSServer@{$\sim$TLSServer}}
\index{````~TLSServer@{$\sim$TLSServer}!core::TLSServer@{core::TLSServer}}
\doxysubsubsection{\texorpdfstring{$\sim$TLSServer()}{~TLSServer()}}
{\footnotesize\ttfamily core\+::\+T\+L\+S\+Server\+::$\sim$\+T\+L\+S\+Server (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily core\+::\+TLSServer\+::$\sim$\+TLSServer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
The destructor for this object.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
T\+L\+S\+Server.\+h\item
T\+L\+S\+Server.\+cpp\end{DoxyCompactItemize}
TLSServer.\+h\item
TLSServer.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1TLSServer__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
e96a05dd0a826020326f33fbd922b00e
f3c936336841423916e1884cda6e5405
latex/classcore_1_1TLSServer__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TLSSession.tex
+22 -21
View File
@@ -1,12 +1,12 @@
\hypertarget{classcore_1_1TLSSession}{}\doxysection{core\+::T\+L\+S\+Session Class Reference}
\hypertarget{classcore_1_1TLSSession}{}\doxysection{core\+::TLSSession Class Reference}
\label{classcore_1_1TLSSession}\index{core::TLSSession@{core::TLSSession}}
{\ttfamily \#include $<$T\+L\+S\+Session.\+h$>$}
{\ttfamily \#include $<$TLSSession.\+h$>$}
Inheritance diagram for core\+::T\+L\+S\+Session\+:\nopagebreak
Inheritance diagram for core\+::TLSSession\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +15,8 @@ Inheritance diagram for core\+::T\+L\+S\+Session\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::T\+L\+S\+Session\+:\nopagebreak
Collaboration diagram for core\+::TLSSession\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -26,16 +27,16 @@ Collaboration diagram for core\+::T\+L\+S\+Session\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TLSSession_ac2bd48a18a46a3b6827cd689775e3552}\label{classcore_1_1TLSSession_ac2bd48a18a46a3b6827cd689775e3552}}
{\bfseries T\+L\+S\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server)
{\bfseries TLSSession} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server)
\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_a208145cc1fcdc14054602aacc2c51d91}{protocol}} (coreutils\+::\+Z\+String \&data) override
virtual void \mbox{\hyperlink{classcore_1_1TLSSession_a208145cc1fcdc14054602aacc2c51d91}{protocol}} (coreutils\+::\+ZString \&data) override
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{receive\+Data}} (coreutils\+::\+Z\+String \&buffer) override
void \mbox{\hyperlink{classcore_1_1TLSSession_a8507cdcd23ac4b340ce6f6d5f0b26a52}{receive\+Data}} (coreutils\+::\+ZString \&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
@@ -46,18 +47,18 @@ void \mbox{\hyperlink{classcore_1_1TLSSession_a8e26fdc9e8a6c573b5a504a1f1b137a9}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1TLSSession}{T\+L\+S\+Session}}
\mbox{\hyperlink{classcore_1_1TLSSession}{TLSSession}}
Provides a network T\+LS socket.
Provides a network TLS socket.
For accessing T\+LS network functions use this object. The connection oriented nature of T\+LS provides a single client persistent connection with data error correction and a durable synchronous data connection.
For accessing TLS network functions use this object. The connection oriented nature of TLS provides a single client persistent connection with data error correction and a durable synchronous data connection.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}\label{classcore_1_1TLSSession_a76cec7cf4851eb27abe77a2339344c6d}}
\index{core::TLSSession@{core::TLSSession}!onRegister@{onRegister}}
\index{onRegister@{onRegister}!core::TLSSession@{core::TLSSession}}
\doxysubsubsection{\texorpdfstring{onRegister()}{onRegister()}}
{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::on\+Register (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
{\footnotesize\ttfamily void core\+::\+TLSSession\+::on\+Register (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}}
@@ -71,31 +72,31 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a81e5ee3e17834166d97c6e8
\index{core::TLSSession@{core::TLSSession}!output@{output}}
\index{output@{output}!core::TLSSession@{core::TLSSession}}
\doxysubsubsection{\texorpdfstring{output()}{output()}}
{\footnotesize\ttfamily void core\+::\+T\+L\+S\+Session\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
{\footnotesize\ttfamily void core\+::\+TLSSession\+::output (\begin{DoxyParamCaption}\item[{std\+::stringstream \&}]{out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
The output method is called by a socket session (Session) and will output the detail information for the client socket. When extending T\+L\+S\+Socket or Session you can override the method to add attributes to the list.
The output method is called by a socket session (Session) and will output the detail information for the client socket. When extending TLSSocket or Session you can override the method to add attributes to the list.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+T\+C\+P\+Session}}.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a50037cbfc515650e04054e5481785981}{core\+::\+TCPSession}}.
\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\+::\+TLSSession\+::protocol (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{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.
When data is received within the session two modes are available to pass the data through the protocol method\+: LINE or BLOCK.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+T\+C\+P\+Session}}.
Reimplemented from \mbox{\hyperlink{classcore_1_1TCPSession_a98a65da2346b79bee659fca6902e94c7}{core\+::\+TCPSession}}.
\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\+::\+TLSSession\+::receive\+Data (\begin{DoxyParamCaption}\item[{coreutils\+::\+ZString \&}]{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.
receive\+Data will read the data from the socket and place it in the socket buffer. TLS layer overrides this to be able to read from SSL.
Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979ebbc4ac875}{core\+::\+Socket}}.
@@ -103,5 +104,5 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_a46ed2e240852d3fa949979e
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
T\+L\+S\+Session.\+h\item
T\+L\+S\+Session.\+cpp\end{DoxyCompactItemize}
TLSSession.\+h\item
TLSSession.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1TLSSession__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
cc9f449868650fe7138b6b9b091dc80a
5fc9a5f70f8f3528a30212ff7794e169
latex/classcore_1_1TLSSession__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1TerminalSession.tex
+5 -4
View File
@@ -11,7 +11,8 @@ Inheritance diagram for core\+::Terminal\+Session\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::Terminal\+Session\+:\nopagebreak
Collaboration diagram for core\+::Terminal\+Session\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -22,14 +23,14 @@ Collaboration diagram for core\+::Terminal\+Session\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TerminalSession_a6773b1897d2e417ab573b28fa127230c}\label{classcore_1_1TerminalSession_a6773b1897d2e417ab573b28fa127230c}}
{\bfseries Terminal\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{T\+C\+P\+Server}} \&server)
{\bfseries Terminal\+Session} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1TCPServer}{TCPServer}} \&server)
\item
\mbox{\Hypertarget{classcore_1_1TerminalSession_a0df0106164a7f213acf2e814e725c576}\label{classcore_1_1TerminalSession_a0df0106164a7f213acf2e814e725c576}}
int {\bfseries get\+Lines} ()
\item
void \mbox{\hyperlink{classcore_1_1TerminalSession_a42bb06857891220a831da04248233935}{clear}} ()
\item
void \mbox{\hyperlink{classcore_1_1TerminalSession_aa660768eed03b0b996a749e8a146446c}{clear\+E\+OL}} ()
void \mbox{\hyperlink{classcore_1_1TerminalSession_aa660768eed03b0b996a749e8a146446c}{clear\+EOL}} ()
\item
void \mbox{\hyperlink{classcore_1_1TerminalSession_aa9939cbe36c08e1a0b8413a96ca251fa}{set\+Cursor\+Location}} (int x, int y)
\item
@@ -68,7 +69,7 @@ Clear the display. \mbox{\Hypertarget{classcore_1_1TerminalSession_aa660768eed03
\index{core::TerminalSession@{core::TerminalSession}!clearEOL@{clearEOL}}
\index{clearEOL@{clearEOL}!core::TerminalSession@{core::TerminalSession}}
\doxysubsubsection{\texorpdfstring{clearEOL()}{clearEOL()}}
{\footnotesize\ttfamily void core\+::\+Terminal\+Session\+::clear\+E\+OL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
{\footnotesize\ttfamily void core\+::\+Terminal\+Session\+::clear\+EOL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Clear the display from the cursor to the end of line. \mbox{\Hypertarget{classcore_1_1TerminalSession_aa9939cbe36c08e1a0b8413a96ca251fa}\label{classcore_1_1TerminalSession_aa9939cbe36c08e1a0b8413a96ca251fa}}
\index{core::TerminalSession@{core::TerminalSession}!setCursorLocation@{setCursorLocation}}
latex/classcore_1_1TerminalSession__coll__graph.md5
+1 -1
View File
@@ -1 +1 @@
44e3860ca5ea088dcdbc253a2d4546a7
17d88516083d283b6b2b71a206782d19
latex/classcore_1_1TerminalSession__coll__graph.pdf
BIN
View File
Binary file not shown.
latex/classcore_1_1Thread.tex
+3 -3
View File
@@ -26,10 +26,10 @@ Collaboration diagram for core\+::Thread\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1Thread_acf8e7e682431fa6a4a3a77ce9b33aefc}\label{classcore_1_1Thread_acf8e7e682431fa6a4a3a77ce9b33aefc}}
{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll)
{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll)
\item
\mbox{\Hypertarget{classcore_1_1Thread_a88638bbc82ac8d05fc4400db90a89451}\label{classcore_1_1Thread_a88638bbc82ac8d05fc4400db90a89451}}
{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1ThreadScope}{Thread\+Scope}} $\ast$thread)
{\bfseries Thread} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1ThreadScope}{Thread\+Scope}} $\ast$thread)
\item
void \mbox{\hyperlink{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}{start}} ()
\item
@@ -54,7 +54,7 @@ void {\bfseries output} (std\+::stringstream \&data)
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1Thread}{Thread}}
This thread object is designed to be the thread processor for the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} object. It wraps the thread object to allow maintaining a status value for monitoring the thread activity. \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} will instantiate a \mbox{\hyperlink{classcore_1_1Thread}{Thread}} object for each thread specified in the \mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}}\textquotesingle{}s start method.
This thread object is designed to be the thread processor for the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} object. It wraps the thread object to allow maintaining a status value for monitoring the thread activity. \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} will instantiate a \mbox{\hyperlink{classcore_1_1Thread}{Thread}} object for each thread specified in the \mbox{\hyperlink{classcore_1_1EPoll}{EPoll}}\textquotesingle{}s start method.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}\label{classcore_1_1Thread_ae6885df9a9b9503669e5776518b19054}}
latex/classcore_1_1Timer.tex
+2 -2
View File
@@ -26,10 +26,10 @@ Collaboration diagram for core\+::Timer\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1Timer_aa12f319bab9c7a350244c4d47fe59de9}\label{classcore_1_1Timer_aa12f319bab9c7a350244c4d47fe59de9}}
{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll)
{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll)
\item
\mbox{\Hypertarget{classcore_1_1Timer_a6ba8de81f8e3b26fd132e29230646024}\label{classcore_1_1Timer_a6ba8de81f8e3b26fd132e29230646024}}
{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, double delay)
{\bfseries Timer} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, double delay)
\item
void \mbox{\hyperlink{classcore_1_1Timer_ac0a642cdcb76b7f995137162050d3d0b}{set\+Timer}} (double delay)
\item
latex/classcore_1_1UDPServerSocket.tex
+11 -11
View File
@@ -1,12 +1,12 @@
\hypertarget{classcore_1_1UDPServerSocket}{}\doxysection{core\+::U\+D\+P\+Server\+Socket Class Reference}
\hypertarget{classcore_1_1UDPServerSocket}{}\doxysection{core\+::UDPServer\+Socket Class Reference}
\label{classcore_1_1UDPServerSocket}\index{core::UDPServerSocket@{core::UDPServerSocket}}
{\ttfamily \#include $<$U\+D\+P\+Server\+Socket.\+h$>$}
{\ttfamily \#include $<$UDPServer\+Socket.\+h$>$}
Inheritance diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak
Inheritance diagram for core\+::UDPServer\+Socket\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -15,7 +15,7 @@ Inheritance diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak
Collaboration diagram for core\+::UDPServer\+Socket\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -26,7 +26,7 @@ Collaboration diagram for core\+::U\+D\+P\+Server\+Socket\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1UDPServerSocket_a6fee7bc6dc2f94d48734c07cbc918734}\label{classcore_1_1UDPServerSocket_a6fee7bc6dc2f94d48734c07cbc918734}}
{\bfseries U\+D\+P\+Server\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll, std\+::string url, short int port, std\+::string command\+Name)
{\bfseries UDPServer\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, std\+::string url, short int port, std\+::string command\+Name)
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
@@ -46,22 +46,22 @@ std\+::vector$<$ Session $\ast$ $>$ {\bfseries sessions}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1UDPSocket}{U\+D\+P\+Socket}}
\mbox{\hyperlink{classcore_1_1UDPSocket}{UDPSocket}}
Manage a socket connection as a U\+DP server type. Connections to the socket are processed through the session list functionality. A list of sessions is maintained in a vector object.
Manage a socket connection as a UDP server type. Connections to the socket are processed through the session list functionality. A list of sessions is maintained in a vector object.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}\label{classcore_1_1UDPServerSocket_a41933ca153c854a800e3d047ab18313e}}
\index{core::UDPServerSocket@{core::UDPServerSocket}!onDataReceived@{onDataReceived}}
\index{onDataReceived@{onDataReceived}!core::UDPServerSocket@{core::UDPServerSocket}}
\doxysubsubsection{\texorpdfstring{onDataReceived()}{onDataReceived()}}
{\footnotesize\ttfamily void core\+::\+U\+D\+P\+Server\+Socket\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
{\footnotesize\ttfamily void core\+::\+UDPServer\+Socket\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
Called when data is received from the socket.
The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. E\+P\+O\+L\+L\+IN
The on\+Connected method is called when the socket is ready to communicate. Writing to the socket can begin on this call to initiate a contact with the remote device. The on\+Data\+Received method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. EPOLLIN
\begin{DoxyParams}{Parameters}
@@ -76,5 +76,5 @@ Reimplemented from \mbox{\hyperlink{classcore_1_1Socket_ac8d6a2c54696eb6fc2024cf
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
U\+D\+P\+Server\+Socket.\+h\item
U\+D\+P\+Server\+Socket.\+cpp\end{DoxyCompactItemize}
UDPServer\+Socket.\+h\item
UDPServer\+Socket.\+cpp\end{DoxyCompactItemize}
latex/classcore_1_1UDPSocket.tex
+6 -6
View File
@@ -1,8 +1,8 @@
\hypertarget{classcore_1_1UDPSocket}{}\doxysection{core\+::U\+D\+P\+Socket Class Reference}
\hypertarget{classcore_1_1UDPSocket}{}\doxysection{core\+::UDPSocket Class Reference}
\label{classcore_1_1UDPSocket}\index{core::UDPSocket@{core::UDPSocket}}
Inheritance diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak
Inheritance diagram for core\+::UDPSocket\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -11,7 +11,7 @@ Inheritance diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak
\end{figure}
Collaboration diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak
Collaboration diagram for core\+::UDPSocket\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -22,12 +22,12 @@ Collaboration diagram for core\+::U\+D\+P\+Socket\+:\nopagebreak
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1UDPSocket_a9dcbe1203fea9c25400a391d3430e976}\label{classcore_1_1UDPSocket_a9dcbe1203fea9c25400a391d3430e976}}
{\bfseries U\+D\+P\+Socket} (\mbox{\hyperlink{classcore_1_1EPoll}{E\+Poll}} \&e\+Poll)
{\bfseries UDPSocket} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll)
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
U\+D\+P\+Socket.\+h\item
U\+D\+P\+Socket.\+cpp\end{DoxyCompactItemize}
UDPSocket.\+h\item
UDPSocket.\+cpp\end{DoxyCompactItemize}
latex/doxygen.sty
+3 -3
View File
@@ -13,6 +13,7 @@
\RequirePackage{tabu_doxygen}
\RequirePackage{fancyvrb}
\RequirePackage{tabularx}
\RequirePackage{multicol}
\RequirePackage{multirow}
\RequirePackage{hanging}
\RequirePackage{ifpdf}
@@ -186,9 +187,8 @@
% (only if caption is specified)
\newenvironment{DoxyImage}{%
\begin{figure}[H]%
\begin{center}%
\centering%
}{%
\end{center}%
\end{figure}%
}
@@ -571,6 +571,6 @@
% Define caption that is also suitable in a table
\makeatletter
\def\doxyfigcaption{%
\refstepcounter{figure}%
\H@refstepcounter{figure}%
\@dblarg{\@caption{figure}}}
\makeatother
latex/hierarchy.tex
+14 -14
View File
@@ -3,44 +3,44 @@ This inheritance list is sorted roughly, but not completely, alphabetically\+:\b
\item \contentsline{section}{core\+::Command}{\pageref{classcore_1_1Command}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{core\+::Command\+List}{\pageref{classcore_1_1CommandList}}{}
\item \contentsline{section}{core\+::E\+Poll}{\pageref{classcore_1_1EPoll}}{}
\item \contentsline{section}{core\+::EPoll}{\pageref{classcore_1_1EPoll}}{}
\item \contentsline{section}{core\+::Subscription\+Manager}{\pageref{classcore_1_1SubscriptionManager}}{}
\item \contentsline{section}{core\+::T\+C\+P\+Server}{\pageref{classcore_1_1TCPServer}}{}
\item \contentsline{section}{core\+::TCPServer}{\pageref{classcore_1_1TCPServer}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{core\+::Console\+Server}{\pageref{classcore_1_1ConsoleServer}}{}
\item \contentsline{section}{core\+::T\+L\+S\+Server}{\pageref{classcore_1_1TLSServer}}{}
\item \contentsline{section}{core\+::TLSServer}{\pageref{classcore_1_1TLSServer}}{}
\end{DoxyCompactList}
\item \contentsline{section}{core\+::U\+D\+P\+Server\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{}
\item \contentsline{section}{core\+::UDPServer\+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\+::IPAddress\+List}{\pageref{classcore_1_1IPAddressList}}{}
\item coreutils\+::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\+::IPAddress}{\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}}{}
\item \contentsline{section}{core\+::T\+C\+P\+Socket}{\pageref{classcore_1_1TCPSocket}}{}
\item \contentsline{section}{core\+::INotify}{\pageref{classcore_1_1INotify}}{}
\item \contentsline{section}{core\+::TCPSocket}{\pageref{classcore_1_1TCPSocket}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{core\+::T\+C\+P\+Server}{\pageref{classcore_1_1TCPServer}}{}
\item \contentsline{section}{core\+::T\+C\+P\+Session}{\pageref{classcore_1_1TCPSession}}{}
\item \contentsline{section}{core\+::TCPServer}{\pageref{classcore_1_1TCPServer}}{}
\item \contentsline{section}{core\+::TCPSession}{\pageref{classcore_1_1TCPSession}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{core\+::TLSSession}{\pageref{classcore_1_1TLSSession}}{}
\item \contentsline{section}{core\+::Terminal\+Session}{\pageref{classcore_1_1TerminalSession}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{core\+::Console\+Session}{\pageref{classcore_1_1ConsoleSession}}{}
\end{DoxyCompactList}
\item \contentsline{section}{core\+::T\+L\+S\+Session}{\pageref{classcore_1_1TLSSession}}{}
\end{DoxyCompactList}
\end{DoxyCompactList}
\item \contentsline{section}{core\+::Timer}{\pageref{classcore_1_1Timer}}{}
\item \contentsline{section}{core\+::U\+D\+P\+Socket}{\pageref{classcore_1_1UDPSocket}}{}
\item \contentsline{section}{core\+::UDPSocket}{\pageref{classcore_1_1UDPSocket}}{}
\begin{DoxyCompactList}
\item \contentsline{section}{core\+::U\+D\+P\+Server\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{}
\item \contentsline{section}{core\+::UDPServer\+Socket}{\pageref{classcore_1_1UDPServerSocket}}{}
\end{DoxyCompactList}
\end{DoxyCompactList}
\item \contentsline{section}{core\+::Subscription}{\pageref{classcore_1_1Subscription}}{}
latex/refman.tex
+20 -20
View File
@@ -10,26 +10,21 @@
%%
% Packages required by doxygen
\usepackage{fixltx2e}
\usepackage{calc}
\usepackage{doxygen}
\usepackage{graphicx}
\usepackage[utf8]{inputenc}
\usepackage{makeidx}
\usepackage{multicol}
\usepackage{multirow}
\PassOptionsToPackage{warn}{textcomp}
\usepackage{textcomp}
\usepackage[nointegrals]{wasysym}
\usepackage[table]{xcolor}
\usepackage{ifpdf,ifxetex}
\usepackage{ifxetex}
% Font selection
\usepackage[T1]{fontenc}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage{amssymb}
\usepackage{sectsty}
\renewcommand{\familydefault}{\sfdefault}
\usepackage{sectsty}
\allsectionsfont{%
\fontseries{bc}\selectfont%
\color{darkgray}%
@@ -84,19 +79,23 @@
% Headers & footers
\usepackage{fancyhdr}
\pagestyle{fancyplain}
\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
\fancyhead[CE]{\fancyplain{}{}}
\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
\fancyhead[CO]{\fancyplain{}{}}
\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
\fancyfoot[LE]{\fancyplain{}{}}
\fancyfoot[CE]{\fancyplain{}{}}
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
\fancyfoot[CO]{\fancyplain{}{}}
\fancyfoot[RO]{\fancyplain{}{}}
\renewcommand{\footrulewidth}{0.4pt}
%
\fancypagestyle{fancyplain}{
\fancyhf{}
\fancyhead[LE, RO]{\bfseries\thepage}
\fancyhead[LO]{\bfseries\rightmark}
\fancyhead[RE]{\bfseries\leftmark}
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
}
%
\fancypagestyle{plain}{
\fancyhf{}
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
\renewcommand{\headrulewidth}{0pt}}
%
\pagestyle{fancyplain}
%
\renewcommand{\chaptermark}[1]{%
\markboth{#1}{}%
}
@@ -148,6 +147,7 @@
%===== C O N T E N T S =====
\begin{document}
\raggedbottom
% Titlepage & ToC
\hypersetup{pageanchor=false,
@@ -160,7 +160,7 @@
\begin{center}%
{\Large My Project }\\
\vspace*{1cm}
{\large Generated by Doxygen 1.8.17}\\
{\large Generated by Doxygen 1.9.1}\\
\end{center}
\end{titlepage}
\clearemptydoublepage