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

Documentation updates.

Browse Source
This commit is contained in:
Brad Arant 2022-07-28 09:54:31 -07:00
parent 9af17daed6
commit 5c87225c6f
8 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
html/CommandList_8h_source.html
View File

@ -88,7 +88,7 @@ $(function() {
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classcore_1_1CommandList.html#aaac684effb9ecf5238d23ca60d3fffaa">remove</a>(<a class="code" href="classcore_1_1Command.html">Command</a> &amp;command);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0">processRequest</a>(coreutils::ZString &amp;request, <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818">processRequest</a>(coreutils::ZString &amp;request, <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1CommandList.html#a72aea93a650f148c639ba25a724da243">grabInput</a>(<a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session, <a class="code" href="classcore_1_1Command.html">Command</a> &amp;command);</div>
@ -115,8 +115,8 @@ $(function() {
<div class="ttc" id="aclasscore_1_1CommandList_html_a1819e1cb377b5d8e5e00b4777e2b4aba"><div class="ttname"><a href="classcore_1_1CommandList.html#a1819e1cb377b5d8e5e00b4777e2b4aba">core::CommandList::processCommand</a></div><div class="ttdeci">int processCommand(coreutils::ZString &amp;request, TCPSession &amp;session)</div><div class="ttdef"><b>Definition:</b> CommandList.cpp:42</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html_a72aea93a650f148c639ba25a724da243"><div class="ttname"><a href="classcore_1_1CommandList.html#a72aea93a650f148c639ba25a724da243">core::CommandList::grabInput</a></div><div class="ttdeci">bool grabInput(TCPSession &amp;session, Command &amp;command)</div><div class="ttdef"><b>Definition:</b> CommandList.cpp:33</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html_a7a45e75e3d21a25fd3f7e887acf395e9"><div class="ttname"><a href="classcore_1_1CommandList.html#a7a45e75e3d21a25fd3f7e887acf395e9">core::CommandList::add</a></div><div class="ttdeci">void add(Command &amp;command, std::string name=&quot;&quot;)</div><div class="ttdef"><b>Definition:</b> CommandList.cpp:8</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html_aa9b789df8eed15dc037bd98d596fe6e0"><div class="ttname"><a href="classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0">core::CommandList::processRequest</a></div><div class="ttdeci">bool processRequest(coreutils::ZString &amp;request, TCPSession &amp;session)</div><div class="ttdef"><b>Definition:</b> CommandList.cpp:14</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html_aaac684effb9ecf5238d23ca60d3fffaa"><div class="ttname"><a href="classcore_1_1CommandList.html#aaac684effb9ecf5238d23ca60d3fffaa">core::CommandList::remove</a></div><div class="ttdeci">void remove(Command &amp;command)</div><div class="ttdef"><b>Definition:</b> CommandList.cpp:12</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html_abcfb26e37e1ee6ff5655ebc3d33b1818"><div class="ttname"><a href="classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818">core::CommandList::processRequest</a></div><div class="ttdeci">int processRequest(coreutils::ZString &amp;request, TCPSession &amp;session)</div><div class="ttdef"><b>Definition:</b> CommandList.cpp:14</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html_ad0aedf95828fe743908d8423f171ff36"><div class="ttname"><a href="classcore_1_1CommandList.html#ad0aedf95828fe743908d8423f171ff36">core::CommandList::commands</a></div><div class="ttdeci">std::map&lt; std::string, Command * &gt; commands</div><div class="ttdef"><b>Definition:</b> CommandList.h:71</div></div>
<div class="ttc" id="aclasscore_1_1Command_html"><div class="ttname"><a href="classcore_1_1Command.html">core::Command</a></div><div class="ttdef"><b>Definition:</b> Command.h:22</div></div>
<div class="ttc" id="aclasscore_1_1TCPSession_html"><div class="ttname"><a href="classcore_1_1TCPSession.html">core::TCPSession</a></div><div class="ttdef"><b>Definition:</b> TCPSession.h:24</div></div>

2
html/classcore_1_1CommandList-members.html
View File

@ -81,7 +81,7 @@ $(function() {
<tr class="even"><td class="entry"><a class="el" href="classcore_1_1CommandList.html#a72aea93a650f148c639ba25a724da243">grabInput</a>(TCPSession &amp;session, Command &amp;command)</td><td class="entry"><a class="el" href="classcore_1_1CommandList.html">core::CommandList</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classcore_1_1Command.html#ab6352ce5650e70a5c76c3d6e4eefd292">output</a>(std::stringstream &amp;out)</td><td class="entry"><a class="el" href="classcore_1_1Command.html">core::Command</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classcore_1_1CommandList.html#a1819e1cb377b5d8e5e00b4777e2b4aba">processCommand</a>(coreutils::ZString &amp;request, TCPSession &amp;session)</td><td class="entry"><a class="el" href="classcore_1_1CommandList.html">core::CommandList</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0">processRequest</a>(coreutils::ZString &amp;request, TCPSession &amp;session)</td><td class="entry"><a class="el" href="classcore_1_1CommandList.html">core::CommandList</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818">processRequest</a>(coreutils::ZString &amp;request, TCPSession &amp;session)</td><td class="entry"><a class="el" href="classcore_1_1CommandList.html">core::CommandList</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classcore_1_1CommandList.html#aaac684effb9ecf5238d23ca60d3fffaa">remove</a>(Command &amp;command)</td><td class="entry"><a class="el" href="classcore_1_1CommandList.html">core::CommandList</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->

10
html/classcore_1_1CommandList.html
View File

@ -103,8 +103,8 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a7a45e75e3d21a25fd3f7e887acf395e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaac684effb9ecf5238d23ca60d3fffaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1CommandList.html#aaac684effb9ecf5238d23ca60d3fffaa">remove</a> (<a class="el" href="classcore_1_1Command.html">Command</a> &amp;command)</td></tr>
<tr class="separator:aaac684effb9ecf5238d23ca60d3fffaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9b789df8eed15dc037bd98d596fe6e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0">processRequest</a> (coreutils::ZString &amp;request, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:aa9b789df8eed15dc037bd98d596fe6e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcfb26e37e1ee6ff5655ebc3d33b1818"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818">processRequest</a> (coreutils::ZString &amp;request, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:abcfb26e37e1ee6ff5655ebc3d33b1818"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72aea93a650f148c639ba25a724da243"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1CommandList.html#a72aea93a650f148c639ba25a724da243">grabInput</a> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session, <a class="el" href="classcore_1_1Command.html">Command</a> &amp;command)</td></tr>
<tr class="separator:a72aea93a650f148c639ba25a724da243"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9214dc76dbcde1520277d044c00cc1fc"><td class="memItemLeft" align="right" valign="top"><a id="a9214dc76dbcde1520277d044c00cc1fc"></a>
@ -236,14 +236,14 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>depth</b></td></tr>
</div>
</div>
<a id="aa9b789df8eed15dc037bd98d596fe6e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9b789df8eed15dc037bd98d596fe6e0">&#9670;&nbsp;</a></span>processRequest()</h2>
<a id="abcfb26e37e1ee6ff5655ebc3d33b1818"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcfb26e37e1ee6ff5655ebc3d33b1818">&#9670;&nbsp;</a></span>processRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool core::CommandList::processRequest </td>
<td class="memname">int core::CommandList::processRequest </td>
<td>(</td>
<td class="paramtype">coreutils::ZString &amp;&#160;</td>
<td class="paramname"><em>request</em>, </td>

2
html/functions.html
View File

@ -199,7 +199,7 @@ $(function() {
, <a class="el" href="classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437">core::TCPServer</a>
</li>
<li>processRequest()
: <a class="el" href="classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0">core::CommandList</a>
: <a class="el" href="classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818">core::CommandList</a>
</li>
<li>protocol()
: <a class="el" href="classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833">core::ConsoleSession</a>

2
html/functions_func.html
View File

@ -178,7 +178,7 @@ $(function() {
, <a class="el" href="classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437">core::TCPServer</a>
</li>
<li>processRequest()
: <a class="el" href="classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0">core::CommandList</a>
: <a class="el" href="classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818">core::CommandList</a>
</li>
<li>protocol()
: <a class="el" href="classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833">core::ConsoleSession</a>

2
html/search/all_8.js
View File

@ -1,6 +1,6 @@
var searchData=
[
['processcommand_35',['processCommand',['../classcore_1_1Command.html#a95176f2532c38ee14e3fee40ee28b1bd',1,'core::Command::processCommand()'],['../classcore_1_1CommandList.html#a1819e1cb377b5d8e5e00b4777e2b4aba',1,'core::CommandList::processCommand()'],['../classcore_1_1EPoll.html#a22b5f1545aff3162040844be043abcce',1,'core::EPoll::processCommand()'],['../classcore_1_1SubscriptionManager.html#aaa30bf772ad72b3f319a790662e4f8ae',1,'core::SubscriptionManager::processCommand()'],['../classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437',1,'core::TCPServer::processCommand()']]],
['processrequest_36',['processRequest',['../classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0',1,'core::CommandList']]],
['processrequest_36',['processRequest',['../classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818',1,'core::CommandList']]],
['protocol_37',['protocol',['../classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833',1,'core::ConsoleSession::protocol()'],['../classcore_1_1TCPSession.html#a98a65da2346b79bee659fca6902e94c7',1,'core::TCPSession::protocol()'],['../classcore_1_1TLSSession.html#a208145cc1fcdc14054602aacc2c51d91',1,'core::TLSSession::protocol()']]]
];

2
html/search/functions_6.js
View File

@ -1,6 +1,6 @@
var searchData=
[
['processcommand_122',['processCommand',['../classcore_1_1Command.html#a95176f2532c38ee14e3fee40ee28b1bd',1,'core::Command::processCommand()'],['../classcore_1_1CommandList.html#a1819e1cb377b5d8e5e00b4777e2b4aba',1,'core::CommandList::processCommand()'],['../classcore_1_1EPoll.html#a22b5f1545aff3162040844be043abcce',1,'core::EPoll::processCommand()'],['../classcore_1_1SubscriptionManager.html#aaa30bf772ad72b3f319a790662e4f8ae',1,'core::SubscriptionManager::processCommand()'],['../classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437',1,'core::TCPServer::processCommand()']]],
['processrequest_123',['processRequest',['../classcore_1_1CommandList.html#aa9b789df8eed15dc037bd98d596fe6e0',1,'core::CommandList']]],
['processrequest_123',['processRequest',['../classcore_1_1CommandList.html#abcfb26e37e1ee6ff5655ebc3d33b1818',1,'core::CommandList']]],
['protocol_124',['protocol',['../classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833',1,'core::ConsoleSession::protocol()'],['../classcore_1_1TCPSession.html#a98a65da2346b79bee659fca6902e94c7',1,'core::TCPSession::protocol()'],['../classcore_1_1TLSSession.html#a208145cc1fcdc14054602aacc2c51d91',1,'core::TLSSession::protocol()']]]
];

6
latex/classcore_1_1CommandList.tex
View File

@ -32,7 +32,7 @@ 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\+::\+ZString \&request, \mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&session)
int \mbox{\hyperlink{classcore_1_1CommandList_abcfb26e37e1ee6ff5655ebc3d33b1818}{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}{TCPSession}} \&session, \mbox{\hyperlink{classcore_1_1Command}{Command}} \&command)
\item
@ -94,11 +94,11 @@ Returns 0 if execution of the command was successful. Otherwise returns a non-\/
Reimplemented from \mbox{\hyperlink{classcore_1_1Command_a95176f2532c38ee14e3fee40ee28b1bd}{core\+::\+Command}}.
\mbox{\Hypertarget{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}\label{classcore_1_1CommandList_aa9b789df8eed15dc037bd98d596fe6e0}}
\mbox{\Hypertarget{classcore_1_1CommandList_abcfb26e37e1ee6ff5655ebc3d33b1818}\label{classcore_1_1CommandList_abcfb26e37e1ee6ff5655ebc3d33b1818}}
\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\+::\+ZString \&}]{request, }\item[{\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} \&}]{session }\end{DoxyParamCaption})}
{\footnotesize\ttfamily int 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 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}}