Update changes.
This commit is contained in:
1 parent
86bd62221f
commit
608f8a2b0c
249 files changed
+1562
-1734
No files matched your search
@@ -79,56 +79,36 @@ Inheritance diagram for core::Command:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="classcore_1_1Command__inherit__graph.png" border="0" usemap="#core_1_1Command_inherit__map" alt="Inheritance graph"/></div>
|
||||
<map name="core_1_1Command_inherit__map" id="core_1_1Command_inherit__map">
|
||||
<area shape="rect" title=" " alt="" coords="226,80,351,107"/>
|
||||
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="5,155,153,181"/>
|
||||
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="178,155,269,181"/>
|
||||
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="293,155,418,181"/>
|
||||
<area shape="rect" href="classcore_1_1UDPServerSocket.html" title=" " alt="" coords="442,155,613,181"/>
|
||||
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="239,5,339,32"/>
|
||||
<area shape="rect" href="classcore_1_1ConsoleServer.html" title=" " alt="" coords="199,229,351,256"/>
|
||||
<area shape="rect" href="classcore_1_1TLSServer.html" title=" " alt="" coords="375,229,498,256"/>
|
||||
</map>
|
||||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||||
<div class="dynheader">
|
||||
Collaboration diagram for core::Command:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="classcore_1_1Command__coll__graph.png" border="0" usemap="#core_1_1Command_coll__map" alt="Collaboration graph"/></div>
|
||||
<map name="core_1_1Command_coll__map" id="core_1_1Command_coll__map">
|
||||
<area shape="rect" title=" " alt="" coords="5,80,131,107"/>
|
||||
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="18,5,118,32"/>
|
||||
<area shape="rect" title=" " alt="" coords="226,5,351,32"/>
|
||||
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="5,80,153,107"/>
|
||||
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="178,80,269,107"/>
|
||||
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="293,80,418,107"/>
|
||||
<area shape="rect" href="classcore_1_1UDPServerSocket.html" title=" " alt="" coords="442,80,613,107"/>
|
||||
<area shape="rect" href="classcore_1_1ConsoleServer.html" title=" " alt="" coords="198,155,350,181"/>
|
||||
<area shape="rect" href="classcore_1_1TLSServer.html" title=" " alt="" coords="374,155,497,181"/>
|
||||
</map>
|
||||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:af9b8d8b3a6d6566f86e0abcb0d10f905"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#af9b8d8b3a6d6566f86e0abcb0d10f905">check</a> (coreutils::ZString request)</td></tr>
|
||||
<tr class="separator:af9b8d8b3a6d6566f86e0abcb0d10f905"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad8eecee5b179a0030d2f34bcfa30d4f4"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#ad8eecee5b179a0030d2f34bcfa30d4f4">processCommand</a> (coreutils::ZString request, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> *session, std::stringstream &data)</td></tr>
|
||||
<tr class="separator:ad8eecee5b179a0030d2f34bcfa30d4f4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a314aef05f78aacb802097f8ae0875291"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#a314aef05f78aacb802097f8ae0875291">output</a> (Session *session)</td></tr>
|
||||
<tr class="separator:a314aef05f78aacb802097f8ae0875291"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3bec2a324e71b72f1525a28b2bb028fe"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#a3bec2a324e71b72f1525a28b2bb028fe">check</a> (coreutils::ZString &request)</td></tr>
|
||||
<tr class="separator:a3bec2a324e71b72f1525a28b2bb028fe"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a95176f2532c38ee14e3fee40ee28b1bd"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#a95176f2532c38ee14e3fee40ee28b1bd">processCommand</a> (coreutils::ZString &request, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &session)</td></tr>
|
||||
<tr class="separator:a95176f2532c38ee14e3fee40ee28b1bd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab6352ce5650e70a5c76c3d6e4eefd292"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#ab6352ce5650e70a5c76c3d6e4eefd292">output</a> (std::stringstream &out)</td></tr>
|
||||
<tr class="separator:ab6352ce5650e70a5c76c3d6e4eefd292"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad8b0321c64838f4d5c8f93461b97cfef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#ad8b0321c64838f4d5c8f93461b97cfef">setName</a> (std::string name)</td></tr>
|
||||
<tr class="separator:ad8b0321c64838f4d5c8f93461b97cfef"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa63cf88493b2a1b775b5b93b07e79324"><td class="memItemLeft" align="right" valign="top"><a id="aa63cf88493b2a1b775b5b93b07e79324"></a>
|
||||
std::string </td><td class="memItemRight" valign="bottom"><b>getName</b> ()</td></tr>
|
||||
<tr class="separator:aa63cf88493b2a1b775b5b93b07e79324"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
||||
Additional Inherited Members</h2></td></tr>
|
||||
<tr class="inherit_header pub_attribs_classcore_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1Object')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classcore_1_1Object.html">core::Object</a></td></tr>
|
||||
<tr class="memitem:aa096b2bab35f1019c91077ef3ec106ce inherit pub_attribs_classcore_1_1Object"><td class="memItemLeft" align="right" valign="top"><a id="aa096b2bab35f1019c91077ef3ec106ce"></a>
|
||||
std::string </td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
|
||||
<tr class="separator:aa096b2bab35f1019c91077ef3ec106ce inherit pub_attribs_classcore_1_1Object"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad503c264c529c41c25528c34421c83df inherit pub_attribs_classcore_1_1Object"><td class="memItemLeft" align="right" valign="top"><a id="ad503c264c529c41c25528c34421c83df"></a>
|
||||
std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></tr>
|
||||
<tr class="separator:ad503c264c529c41c25528c34421c83df inherit pub_attribs_classcore_1_1Object"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p><a class="el" href="classcore_1_1Command.html">Command</a></p>
|
||||
<p>Use the <a class="el" href="classcore_1_1Command.html">Command</a> object in combination with a <a class="el" href="classcore_1_1CommandList.html">CommandList</a> object to maintain a list of functions that can be invoked as a result of processing a request. </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="af9b8d8b3a6d6566f86e0abcb0d10f905"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#af9b8d8b3a6d6566f86e0abcb0d10f905">◆ </a></span>check()</h2>
|
||||
<a id="a3bec2a324e71b72f1525a28b2bb028fe"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3bec2a324e71b72f1525a28b2bb028fe">◆ </a></span>check()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -139,7 +119,7 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
<tr>
|
||||
<td class="memname">bool core::Command::check </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">coreutils::ZString </td>
|
||||
<td class="paramtype">coreutils::ZString & </td>
|
||||
<td class="paramname"><em>request</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
@@ -151,7 +131,7 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Implement check method to provide a special check rule upon the request to see if the command should be processed.</p>
|
||||
<p>The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the <a class="el" href="classcore_1_1CommandList.html">CommandList</a>. This can be overridden by implementing the <a class="el" href="classcore_1_1Command.html#af9b8d8b3a6d6566f86e0abcb0d10f905">check()</a> method to perform the test and return the condition of the command.</p>
|
||||
<p>The default rule is to verify that the first token in the request string matches the name given on the registration of the command to the <a class="el" href="classcore_1_1CommandList.html">CommandList</a>. This can be overridden by implementing the <a class="el" href="classcore_1_1Command.html#a3bec2a324e71b72f1525a28b2bb028fe">check()</a> method to perform the test and return the condition of the command.</p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">request</td><td>The request passed to the parser to check the rule. </td></tr>
|
||||
@@ -162,8 +142,8 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a314aef05f78aacb802097f8ae0875291"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a314aef05f78aacb802097f8ae0875291">◆ </a></span>output()</h2>
|
||||
<a id="ab6352ce5650e70a5c76c3d6e4eefd292"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab6352ce5650e70a5c76c3d6e4eefd292">◆ </a></span>output()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -174,8 +154,8 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
<tr>
|
||||
<td class="memname">void core::Command::output </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">Session * </td>
|
||||
<td class="paramname"><em>session</em></td><td>)</td>
|
||||
<td class="paramtype">std::stringstream & </td>
|
||||
<td class="paramname"><em>out</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -193,10 +173,12 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p>Reimplemented in <a class="el" href="classcore_1_1TCPServer.html#a49e3ead1bf4e7830685780e73c4db5db">core::TCPServer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad8eecee5b179a0030d2f34bcfa30d4f4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad8eecee5b179a0030d2f34bcfa30d4f4">◆ </a></span>processCommand()</h2>
|
||||
<a id="a95176f2532c38ee14e3fee40ee28b1bd"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a95176f2532c38ee14e3fee40ee28b1bd">◆ </a></span>processCommand()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -207,20 +189,14 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
<tr>
|
||||
<td class="memname">int core::Command::processCommand </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">coreutils::ZString </td>
|
||||
<td class="paramtype">coreutils::ZString & </td>
|
||||
<td class="paramname"><em>request</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> * </td>
|
||||
<td class="paramname"><em>session</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">std::stringstream & </td>
|
||||
<td class="paramname"><em>data</em> </td>
|
||||
<td class="paramtype"><a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> & </td>
|
||||
<td class="paramname"><em>session</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -244,7 +220,7 @@ std::string </td><td class="memItemRight" valign="bottom"><b>tag</b></td></
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Returns 0 if execution of the command was successful. Otherwise returns a non-zero value indicating an error condition. </dd></dl>
|
||||
|
||||
<p>Reimplemented in <a class="el" href="classcore_1_1EPoll.html#a5cb8a89fb45922c8c88472ec3eae7858">core::EPoll</a>, and <a class="el" href="classcore_1_1TCPServer.html#ad08e04a2ff44c9c40419cdc6bd0e4b79">core::TCPServer</a>.</p>
|
||||
<p>Reimplemented in <a class="el" href="classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437">core::TCPServer</a>, <a class="el" href="classcore_1_1EPoll.html#a22b5f1545aff3162040844be043abcce">core::EPoll</a>, and <a class="el" href="classcore_1_1CommandList.html#a1819e1cb377b5d8e5e00b4777e2b4aba">core::CommandList</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in new issue
Block a user