199 lines
9.4 KiB
HTML
199 lines
9.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>My Project: core::Command Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">My Project
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>core</b></li><li class="navelem"><a class="el" href="classcore_1_1Command.html">Command</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classcore_1_1Command-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">core::Command Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="Command_8h_source.html">Command.h</a>></code></p>
|
|
<div class="dynheader">
|
|
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="5,107,131,133"/>
|
|
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="202,5,350,32"/>
|
|
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="231,56,321,83"/>
|
|
<area shape="rect" href="classcore_1_1SubscriptionManager.html" title=" " alt="" coords="179,107,373,133"/>
|
|
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="213,157,339,184"/>
|
|
<area shape="rect" href="classcore_1_1UDPServerSocket.html" title=" " alt="" coords="191,208,361,235"/>
|
|
<area shape="rect" href="classcore_1_1ConsoleServer.html" title=" " alt="" coords="421,132,573,159"/>
|
|
<area shape="rect" href="classcore_1_1TLSServer.html" title=" " alt="" coords="436,183,559,209"/>
|
|
</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: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>
|
|
</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="ab6352ce5650e70a5c76c3d6e4eefd292"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6352ce5650e70a5c76c3d6e4eefd292">◆ </a></span>output()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void core::Command::output </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::stringstream & </td>
|
|
<td class="paramname"><em>out</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specify the output that will occur to the specified session.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">session</td><td>The session that will receive the output. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classcore_1_1TCPServer.html#a49e3ead1bf4e7830685780e73c4db5db">core::TCPServer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95176f2532c38ee14e3fee40ee28b1bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95176f2532c38ee14e3fee40ee28b1bd">◆ </a></span>processCommand()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int core::Command::processCommand </td>
|
|
<td>(</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></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">request</td><td>The request that was entered by the user to invoke this command. </td></tr>
|
|
<tr><td class="paramname">session</td><td>Specify the requesting session so that the execution of the command process can return its output to the session. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</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_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437">core::TCPServer</a>, <a class="el" href="classcore_1_1EPoll.html#a22b5f1545aff3162040844be043abcce">core::EPoll</a>, <a class="el" href="classcore_1_1SubscriptionManager.html#aaa30bf772ad72b3f319a790662e4f8ae">core::SubscriptionManager</a>, and <a class="el" href="classcore_1_1CommandList.html#a1819e1cb377b5d8e5e00b4777e2b4aba">core::CommandList</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="Command_8h_source.html">Command.h</a></li>
|
|
<li>Command.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|