docs/module-doc/classcommand__t.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: command_t Class Reference</title>
   4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>command_t Class Reference</h1><!-- doxytag: class="command_t" -->A structure that defines a command.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="ctables_8h-source.html">ctables.h</a>&gt;</code>
  12 <p>
  13 Inheritance diagram for command_t:<p><center><img src="classcommand__t__inherit__graph.gif" border="0" usemap="#command__t__inherit__map" alt="Inheritance graph"></center>
  14 <map name="command__t__inherit__map">
  15 <area href="classcmd__mode.html" shape="rect" coords="8,82,96,108" alt="">
  16 </map>
  17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for command_t:<p><center><img src="classcommand__t__coll__graph.gif" border="0" usemap="#command__t__coll__map" alt="Collaboration graph"></center>
  18 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classcommand__t-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  19 <tr><td></td></tr>
  20 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  21 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#command_5Ft_28std_3A_3Astring_20cmd_2C_20char_20flags_2C_20int_20minpara_29">command_t</a> (<a class="el" href="namespaceirc.html#string">std::string</a> cmd, char flags, int minpara)</td></tr>
  22
  23 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#Handle_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29_3D_30">Handle</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)=0</td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#_7Ecommand_5Ft_28_29">~command_t</a> ()</td></tr>
  26
  27 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  28 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#command">command</a></td></tr>
  29
  30 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command name.  <a href="#command"></a><br></td></tr>
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#flags_5Fneeded">flags_needed</a></td></tr>
  32
  33 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">User flags needed to execute the command or 0.  <a href="#flags_5Fneeded"></a><br></td></tr>
  34 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#min_5Fparams">min_params</a></td></tr>
  35
  36 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum number of parameters command takes.  <a href="#min_5Fparams"></a><br></td></tr>
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#use_5Fcount">use_count</a></td></tr>
  38
  39 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used by /stats m  <a href="#use_5Fcount"></a><br></td></tr>
  40 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#total_5Fbytes">total_bytes</a></td></tr>
  41
  42 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used by /stats m  <a href="#total_5Fbytes"></a><br></td></tr>
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#source">source</a></td></tr>
  44
  45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used for resource tracking between modules  <a href="#source"></a><br></td></tr>
  46 </table>
  47 <hr><a name="_details"></a><h2>Detailed Description</h2>
  48 A structure that defines a command.
  49 <p>
  50
  51 <p>
  52 Definition at line <a class="el" href="ctables_8h-source.html#l00029">29</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  53 <a class="anchor" name="command_5Ft_28std_3A_3Astring_20cmd_2C_20char_20flags_2C_20int_20minpara_29"></a><!-- doxytag: member="command_t::command_t" ref="command_5Ft_28std_3A_3Astring_20cmd_2C_20char_20flags_2C_20int_20minpara_29" args="(std::string cmd, char flags, int minpara)" --><p>
  54 <table class="mdTable" cellpadding="2" cellspacing="0">
  55   <tr>
  56     <td class="mdRow">
  57       <table cellpadding="0" cellspacing="0" border="0">
  58         <tr>
  59           <td class="md" nowrap valign="top">command_t::command_t           </td>
  60           <td class="md" valign="top">(&nbsp;</td>
  61           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
  62           <td class="mdname" nowrap> <em>cmd</em>, </td>
  63         </tr>
  64         <tr>
  65           <td class="md" nowrap align="right"></td>
  66           <td class="md"></td>
  67           <td class="md" nowrap>char&nbsp;</td>
  68           <td class="mdname" nowrap> <em>flags</em>, </td>
  69         </tr>
  70         <tr>
  71           <td class="md" nowrap align="right"></td>
  72           <td class="md"></td>
  73           <td class="md" nowrap>int&nbsp;</td>
  74           <td class="mdname" nowrap> <em>minpara</em></td>
  75         </tr>
  76         <tr>
  77           <td class="md"></td>
  78           <td class="md">)&nbsp;</td>
  79           <td class="md" colspan="2"><code> [inline]</code></td>
  80         </tr>
  81       </table>
  82     </td>
  83   </tr>
  84 </table>
  85 <table cellspacing="5" cellpadding="0" border="0">
  86   <tr>
  87     <td>
  88       &nbsp;
  89     </td>
  90     <td>
  91
  92 <p>
  93
  94 <p>
  95 Definition at line <a class="el" href="ctables_8h-source.html#l00051">51</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.
  96 <p>
  97 References <a class="el" href="ctables_8h-source.html#l00049">source</a>, <a class="el" href="ctables_8h-source.html#l00046">total_bytes</a>, and <a class="el" href="ctables_8h-source.html#l00043">use_count</a>.<div class="fragment"><pre class="fragment"><a name="l00051"></a>00051                                                           : <a class="code" href="classcommand__t.html#command">command</a>(cmd), <a class="code" href="classcommand__t.html#flags_5Fneeded">flags_needed</a>(flags), <a class="code" href="classcommand__t.html#min_5Fparams">min_params</a>(minpara)
  98 <a name="l00052"></a>00052         {
  99 <a name="l00053"></a>00053                 <a class="code" href="classcommand__t.html#use_5Fcount">use_count</a> = <a class="code" href="classcommand__t.html#total_5Fbytes">total_bytes</a> = 0;
 100 <a name="l00054"></a>00054                 <a class="code" href="classcommand__t.html#source">source</a> = <span class="stringliteral">"&lt;core&gt;"</span>;
 101 <a name="l00055"></a>00055         }
 102 </pre></div>
 103 <p>
 104     </td>
 105   </tr>
 106 </table>
 107 <a class="anchor" name="_7Ecommand_5Ft_28_29"></a><!-- doxytag: member="command_t::~command_t" ref="_7Ecommand_5Ft_28_29" args="()" --><p>
 108 <table class="mdTable" cellpadding="2" cellspacing="0">
 109   <tr>
 110     <td class="mdRow">
 111       <table cellpadding="0" cellspacing="0" border="0">
 112         <tr>
 113           <td class="md" nowrap valign="top">virtual command_t::~command_t           </td>
 114           <td class="md" valign="top">(&nbsp;</td>
 115           <td class="mdname1" valign="top" nowrap>          </td>
 116           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 117           <td class="md" nowrap><code> [inline, virtual]</code></td>
 118         </tr>
 119       </table>
 120     </td>
 121   </tr>
 122 </table>
 123 <table cellspacing="5" cellpadding="0" border="0">
 124   <tr>
 125     <td>
 126       &nbsp;
 127     </td>
 128     <td>
 129
 130 <p>
 131
 132 <p>
 133 Definition at line <a class="el" href="ctables_8h-source.html#l00059">59</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<div class="fragment"><pre class="fragment"><a name="l00059"></a>00059 {}
 134 </pre></div>
 135 <p>
 136     </td>
 137   </tr>
 138 </table>
 139 <hr><h2>Member Function Documentation</h2>
 140 <a class="anchor" name="Handle_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29_3D_30"></a><!-- doxytag: member="command_t::Handle" ref="Handle_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29_3D_30" args="(char **parameters, int pcnt, userrec *user)=0" --><p>
 141 <table class="mdTable" cellpadding="2" cellspacing="0">
 142   <tr>
 143     <td class="mdRow">
 144       <table cellpadding="0" cellspacing="0" border="0">
 145         <tr>
 146           <td class="md" nowrap valign="top">virtual void command_t::Handle           </td>
 147           <td class="md" valign="top">(&nbsp;</td>
 148           <td class="md" nowrap valign="top">char **&nbsp;</td>
 149           <td class="mdname" nowrap> <em>parameters</em>, </td>
 150         </tr>
 151         <tr>
 152           <td class="md" nowrap align="right"></td>
 153           <td class="md"></td>
 154           <td class="md" nowrap>int&nbsp;</td>
 155           <td class="mdname" nowrap> <em>pcnt</em>, </td>
 156         </tr>
 157         <tr>
 158           <td class="md" nowrap align="right"></td>
 159           <td class="md"></td>
 160           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 161           <td class="mdname" nowrap> <em>user</em></td>
 162         </tr>
 163         <tr>
 164           <td class="md"></td>
 165           <td class="md">)&nbsp;</td>
 166           <td class="md" colspan="2"><code> [pure virtual]</code></td>
 167         </tr>
 168       </table>
 169     </td>
 170   </tr>
 171 </table>
 172 <table cellspacing="5" cellpadding="0" border="0">
 173   <tr>
 174     <td>
 175       &nbsp;
 176     </td>
 177     <td>
 178
 179 <p>
 180
 181 <p>
 182 Implemented in <a class="el" href="classcmd__mode.html#Handle_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">cmd_mode</a>.    </td>
 183   </tr>
 184 </table>
 185 <hr><h2>Member Data Documentation</h2>
 186 <a class="anchor" name="command"></a><!-- doxytag: member="command_t::command" ref="command" args="" --><p>
 187 <table class="mdTable" cellpadding="2" cellspacing="0">
 188   <tr>
 189     <td class="mdRow">
 190       <table cellpadding="0" cellspacing="0" border="0">
 191         <tr>
 192           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classcommand__t.html#command">command_t::command</a>          </td>
 193         </tr>
 194       </table>
 195     </td>
 196   </tr>
 197 </table>
 198 <table cellspacing="5" cellpadding="0" border="0">
 199   <tr>
 200     <td>
 201       &nbsp;
 202     </td>
 203     <td>
 204
 205 <p>
 206 Command name.
 207 <p>
 208
 209 <p>
 210 Definition at line <a class="el" href="ctables_8h-source.html#l00034">34</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 211   </tr>
 212 </table>
 213 <a class="anchor" name="flags_5Fneeded"></a><!-- doxytag: member="command_t::flags_needed" ref="flags_5Fneeded" args="" --><p>
 214 <table class="mdTable" cellpadding="2" cellspacing="0">
 215   <tr>
 216     <td class="mdRow">
 217       <table cellpadding="0" cellspacing="0" border="0">
 218         <tr>
 219           <td class="md" nowrap valign="top">char <a class="el" href="classcommand__t.html#flags_5Fneeded">command_t::flags_needed</a>          </td>
 220         </tr>
 221       </table>
 222     </td>
 223   </tr>
 224 </table>
 225 <table cellspacing="5" cellpadding="0" border="0">
 226   <tr>
 227     <td>
 228       &nbsp;
 229     </td>
 230     <td>
 231
 232 <p>
 233 User flags needed to execute the command or 0.
 234 <p>
 235
 236 <p>
 237 Definition at line <a class="el" href="ctables_8h-source.html#l00037">37</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 238   </tr>
 239 </table>
 240 <a class="anchor" name="min_5Fparams"></a><!-- doxytag: member="command_t::min_params" ref="min_5Fparams" args="" --><p>
 241 <table class="mdTable" cellpadding="2" cellspacing="0">
 242   <tr>
 243     <td class="mdRow">
 244       <table cellpadding="0" cellspacing="0" border="0">
 245         <tr>
 246           <td class="md" nowrap valign="top">int <a class="el" href="classcommand__t.html#min_5Fparams">command_t::min_params</a>          </td>
 247         </tr>
 248       </table>
 249     </td>
 250   </tr>
 251 </table>
 252 <table cellspacing="5" cellpadding="0" border="0">
 253   <tr>
 254     <td>
 255       &nbsp;
 256     </td>
 257     <td>
 258
 259 <p>
 260 Minimum number of parameters command takes.
 261 <p>
 262
 263 <p>
 264 Definition at line <a class="el" href="ctables_8h-source.html#l00040">40</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 265   </tr>
 266 </table>
 267 <a class="anchor" name="source"></a><!-- doxytag: member="command_t::source" ref="source" args="" --><p>
 268 <table class="mdTable" cellpadding="2" cellspacing="0">
 269   <tr>
 270     <td class="mdRow">
 271       <table cellpadding="0" cellspacing="0" border="0">
 272         <tr>
 273           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classcommand__t.html#source">command_t::source</a>          </td>
 274         </tr>
 275       </table>
 276     </td>
 277   </tr>
 278 </table>
 279 <table cellspacing="5" cellpadding="0" border="0">
 280   <tr>
 281     <td>
 282       &nbsp;
 283     </td>
 284     <td>
 285
 286 <p>
 287 used for resource tracking between modules
 288 <p>
 289
 290 <p>
 291 Definition at line <a class="el" href="ctables_8h-source.html#l00049">49</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.
 292 <p>
 293 Referenced by <a class="el" href="ctables_8h-source.html#l00051">command_t()</a>.    </td>
 294   </tr>
 295 </table>
 296 <a class="anchor" name="total_5Fbytes"></a><!-- doxytag: member="command_t::total_bytes" ref="total_5Fbytes" args="" --><p>
 297 <table class="mdTable" cellpadding="2" cellspacing="0">
 298   <tr>
 299     <td class="mdRow">
 300       <table cellpadding="0" cellspacing="0" border="0">
 301         <tr>
 302           <td class="md" nowrap valign="top">long <a class="el" href="classcommand__t.html#total_5Fbytes">command_t::total_bytes</a>          </td>
 303         </tr>
 304       </table>
 305     </td>
 306   </tr>
 307 </table>
 308 <table cellspacing="5" cellpadding="0" border="0">
 309   <tr>
 310     <td>
 311       &nbsp;
 312     </td>
 313     <td>
 314
 315 <p>
 316 used by /stats m
 317 <p>
 318
 319 <p>
 320 Definition at line <a class="el" href="ctables_8h-source.html#l00046">46</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.
 321 <p>
 322 Referenced by <a class="el" href="ctables_8h-source.html#l00051">command_t()</a>.    </td>
 323   </tr>
 324 </table>
 325 <a class="anchor" name="use_5Fcount"></a><!-- doxytag: member="command_t::use_count" ref="use_5Fcount" args="" --><p>
 326 <table class="mdTable" cellpadding="2" cellspacing="0">
 327   <tr>
 328     <td class="mdRow">
 329       <table cellpadding="0" cellspacing="0" border="0">
 330         <tr>
 331           <td class="md" nowrap valign="top">long <a class="el" href="classcommand__t.html#use_5Fcount">command_t::use_count</a>          </td>
 332         </tr>
 333       </table>
 334     </td>
 335   </tr>
 336 </table>
 337 <table cellspacing="5" cellpadding="0" border="0">
 338   <tr>
 339     <td>
 340       &nbsp;
 341     </td>
 342     <td>
 343
 344 <p>
 345 used by /stats m
 346 <p>
 347
 348 <p>
 349 Definition at line <a class="el" href="ctables_8h-source.html#l00043">43</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.
 350 <p>
 351 Referenced by <a class="el" href="ctables_8h-source.html#l00051">command_t()</a>.    </td>
 352   </tr>
 353 </table>
 354 <hr>The documentation for this class was generated from the following file:<ul>
 355 <li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
 356 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:15 2005 for InspIRCd by&nbsp;
 357 <a href="http://www.doxygen.org/index.html">
 358 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 359 </body>
 360 </html>