From 5c87225c6fbfc892cb56f1cd5cc8d92a6d5d3ef0 Mon Sep 17 00:00:00 2001 From: Brad Arant Date: Thu, 28 Jul 2022 09:54:31 -0700 Subject: [PATCH] Documentation updates. --- html/CommandList_8h_source.html | 4 ++-- html/classcore_1_1CommandList-members.html | 2 +- html/classcore_1_1CommandList.html | 10 +++++----- html/functions.html | 2 +- html/functions_func.html | 2 +- html/search/all_8.js | 2 +- html/search/functions_6.js | 2 +- latex/classcore_1_1CommandList.tex | 6 +++--- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/html/CommandList_8h_source.html b/html/CommandList_8h_source.html index 4ed110d..b013265 100644 --- a/html/CommandList_8h_source.html +++ b/html/CommandList_8h_source.html @@ -88,7 +88,7 @@ $(function() {
34  void remove(Command &command);
35 
42 
-
43  bool processRequest(coreutils::ZString &request, TCPSession &session);
+
43  int processRequest(coreutils::ZString &request, TCPSession &session);
44 
50 
51  bool grabInput(TCPSession &session, Command &command);
@@ -115,8 +115,8 @@ $(function() {
core::CommandList::processCommand
int processCommand(coreutils::ZString &request, TCPSession &session)
Definition: CommandList.cpp:42
core::CommandList::grabInput
bool grabInput(TCPSession &session, Command &command)
Definition: CommandList.cpp:33
core::CommandList::add
void add(Command &command, std::string name="")
Definition: CommandList.cpp:8
-
core::CommandList::processRequest
bool processRequest(coreutils::ZString &request, TCPSession &session)
Definition: CommandList.cpp:14
core::CommandList::remove
void remove(Command &command)
Definition: CommandList.cpp:12
+
core::CommandList::processRequest
int processRequest(coreutils::ZString &request, TCPSession &session)
Definition: CommandList.cpp:14
core::CommandList::commands
std::map< std::string, Command * > commands
Definition: CommandList.h:71
core::Command
Definition: Command.h:22
core::TCPSession
Definition: TCPSession.h:24
diff --git a/html/classcore_1_1CommandList-members.html b/html/classcore_1_1CommandList-members.html index 3d4fd38..ae803e0 100644 --- a/html/classcore_1_1CommandList-members.html +++ b/html/classcore_1_1CommandList-members.html @@ -81,7 +81,7 @@ $(function() { grabInput(TCPSession &session, Command &command)core::CommandList output(std::stringstream &out)core::Commandvirtual processCommand(coreutils::ZString &request, TCPSession &session)core::CommandListvirtual - processRequest(coreutils::ZString &request, TCPSession &session)core::CommandList + processRequest(coreutils::ZString &request, TCPSession &session)core::CommandList remove(Command &command)core::CommandList diff --git a/html/classcore_1_1CommandList.html b/html/classcore_1_1CommandList.html index 5044d61..1599308 100644 --- a/html/classcore_1_1CommandList.html +++ b/html/classcore_1_1CommandList.html @@ -103,8 +103,8 @@ Public Member Functions   void remove (Command &command)   -bool processRequest (coreutils::ZString &request, TCPSession &session) -  +int processRequest (coreutils::ZString &request, TCPSession &session) +  bool grabInput (TCPSession &session, Command &command)   @@ -236,14 +236,14 @@ int depth - -

◆ processRequest()

+ +

◆ processRequest()

- + diff --git a/html/functions.html b/html/functions.html index 3817e37..70577a1 100644 --- a/html/functions.html +++ b/html/functions.html @@ -199,7 +199,7 @@ $(function() { , core::TCPServer
  • processRequest() -: core::CommandList +: core::CommandList
  • protocol() : core::ConsoleSession diff --git a/html/functions_func.html b/html/functions_func.html index ff8d96c..ac7756c 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -178,7 +178,7 @@ $(function() { , core::TCPServer
  • processRequest() -: core::CommandList +: core::CommandList
  • protocol() : core::ConsoleSession diff --git a/html/search/all_8.js b/html/search/all_8.js index 5f37b67..26055c1 100644 --- a/html/search/all_8.js +++ b/html/search/all_8.js @@ -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()']]] ]; diff --git a/html/search/functions_6.js b/html/search/functions_6.js index 479aeac..5a56dac 100644 --- a/html/search/functions_6.js +++ b/html/search/functions_6.js @@ -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()']]] ]; diff --git a/latex/classcore_1_1CommandList.tex b/latex/classcore_1_1CommandList.tex index 02aeab7..06d74cd 100644 --- a/latex/classcore_1_1CommandList.tex +++ b/latex/classcore_1_1CommandList.tex @@ -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}}
    • bool core::CommandList::processRequest int core::CommandList::processRequest ( coreutils::ZString &  request,