docs/module-doc/classcommand__t.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 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.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   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">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>command_t Class Reference</h1>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="classExtensible.html" shape="rect" coords="12,82,94,109" alt="">
  16 <area href="classclassbase.html" shape="rect" coords="13,8,93,34" alt="">
  17 </map>
  18 <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>
  19 <map name="command__t__coll__map">
  20 <area href="classExtensible.html" shape="rect" coords="81,98,164,125" alt="">
  21 <area href="classclassbase.html" shape="rect" coords="8,8,88,34" alt="">
  22 </map>
  23 <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>
  24 <tr><td></td></tr>
  25 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o0">command</a> [MAXBUF]</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command name. </em> <a href="#o0"></a><em><br><br></td></tr>
  29 <tr><td class="memItemLeft" nowrap align=right valign=top>handlerfunc *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o1">handler_function</a></td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handler function as in typedef. </em> <a href="#o1"></a><em><br><br></td></tr>
  32 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o2">flags_needed</a></td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">User flags needed to execute the command or 0. </em> <a href="#o2"></a><em><br><br></td></tr>
  35 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o3">min_params</a></td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum number of parameters command takes. </em> <a href="#o3"></a><em><br><br></td></tr>
  38 <tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o4">use_count</a></td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used by /stats m </em> <a href="#o4"></a><em><br><br></td></tr>
  41 <tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o5">total_bytes</a></td></tr>
  42
  43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used by /stats m </em> <a href="#o5"></a><em><br><br></td></tr>
  44 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o6">source</a> [MAXBUF]</td></tr>
  45
  46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used for resource tracking between modules </em> <a href="#o6"></a><em><br><br></td></tr>
  47 </table>
  48 <hr><a name="_details"></a><h2>Detailed Description</h2>
  49 A structure that defines a command.
  50 <p>
  51
  52 <p>
  53 Definition at line <a class="el" href="ctables_8h-source.html#l00026">26</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<hr><h2>Member Data Documentation</h2>
  54 <a name="o0" doxytag="command_t::command"></a><p>
  55 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  56   <tr>
  57     <td class="mdRow">
  58       <table cellpadding="0" cellspacing="0" border="0">
  59         <tr>
  60           <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o0">command_t::command</a>[MAXBUF]
  61       </table>
  62     </td>
  63   </tr>
  64 </table>
  65 <table cellspacing=5 cellpadding=0 border=0>
  66   <tr>
  67     <td>
  68       &nbsp;
  69     </td>
  70     <td>
  71
  72 <p>
  73 Command name.
  74 <p>
  75
  76 <p>
  77 Definition at line <a class="el" href="ctables_8h-source.html#l00031">31</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
  78   </tr>
  79 </table>
  80 <a name="o2" doxytag="command_t::flags_needed"></a><p>
  81 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  82   <tr>
  83     <td class="mdRow">
  84       <table cellpadding="0" cellspacing="0" border="0">
  85         <tr>
  86           <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o2">command_t::flags_needed</a>
  87       </table>
  88     </td>
  89   </tr>
  90 </table>
  91 <table cellspacing=5 cellpadding=0 border=0>
  92   <tr>
  93     <td>
  94       &nbsp;
  95     </td>
  96     <td>
  97
  98 <p>
  99 User flags needed to execute the command or 0.
 100 <p>
 101
 102 <p>
 103 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>
 104   </tr>
 105 </table>
 106 <a name="o1" doxytag="command_t::handler_function"></a><p>
 107 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 108   <tr>
 109     <td class="mdRow">
 110       <table cellpadding="0" cellspacing="0" border="0">
 111         <tr>
 112           <td class="md" nowrap valign="top"> handlerfunc* <a class="el" href="classcommand__t.html#o1">command_t::handler_function</a>
 113       </table>
 114     </td>
 115   </tr>
 116 </table>
 117 <table cellspacing=5 cellpadding=0 border=0>
 118   <tr>
 119     <td>
 120       &nbsp;
 121     </td>
 122     <td>
 123
 124 <p>
 125 Handler function as in typedef.
 126 <p>
 127
 128 <p>
 129 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>
 130   </tr>
 131 </table>
 132 <a name="o3" doxytag="command_t::min_params"></a><p>
 133 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 134   <tr>
 135     <td class="mdRow">
 136       <table cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td class="md" nowrap valign="top"> int <a class="el" href="classcommand__t.html#o3">command_t::min_params</a>
 139       </table>
 140     </td>
 141   </tr>
 142 </table>
 143 <table cellspacing=5 cellpadding=0 border=0>
 144   <tr>
 145     <td>
 146       &nbsp;
 147     </td>
 148     <td>
 149
 150 <p>
 151 Minimum number of parameters command takes.
 152 <p>
 153
 154 <p>
 155 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>
 156   </tr>
 157 </table>
 158 <a name="o6" doxytag="command_t::source"></a><p>
 159 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 160   <tr>
 161     <td class="mdRow">
 162       <table cellpadding="0" cellspacing="0" border="0">
 163         <tr>
 164           <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o6">command_t::source</a>[MAXBUF]
 165       </table>
 166     </td>
 167   </tr>
 168 </table>
 169 <table cellspacing=5 cellpadding=0 border=0>
 170   <tr>
 171     <td>
 172       &nbsp;
 173     </td>
 174     <td>
 175
 176 <p>
 177 used for resource tracking between modules
 178 <p>
 179
 180 <p>
 181 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>.    </td>
 182   </tr>
 183 </table>
 184 <a name="o5" doxytag="command_t::total_bytes"></a><p>
 185 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 186   <tr>
 187     <td class="mdRow">
 188       <table cellpadding="0" cellspacing="0" border="0">
 189         <tr>
 190           <td class="md" nowrap valign="top"> long <a class="el" href="classcommand__t.html#o5">command_t::total_bytes</a>
 191       </table>
 192     </td>
 193   </tr>
 194 </table>
 195 <table cellspacing=5 cellpadding=0 border=0>
 196   <tr>
 197     <td>
 198       &nbsp;
 199     </td>
 200     <td>
 201
 202 <p>
 203 used by /stats m
 204 <p>
 205
 206 <p>
 207 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>.    </td>
 208   </tr>
 209 </table>
 210 <a name="o4" doxytag="command_t::use_count"></a><p>
 211 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 212   <tr>
 213     <td class="mdRow">
 214       <table cellpadding="0" cellspacing="0" border="0">
 215         <tr>
 216           <td class="md" nowrap valign="top"> long <a class="el" href="classcommand__t.html#o4">command_t::use_count</a>
 217       </table>
 218     </td>
 219   </tr>
 220 </table>
 221 <table cellspacing=5 cellpadding=0 border=0>
 222   <tr>
 223     <td>
 224       &nbsp;
 225     </td>
 226     <td>
 227
 228 <p>
 229 used by /stats m
 230 <p>
 231
 232 <p>
 233 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>.    </td>
 234   </tr>
 235 </table>
 236 <hr>The documentation for this class was generated from the following file:<ul>
 237 <li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
 238 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:30 2005 for InspIRCd by
 239 <a href="http://www.doxygen.org/index.html">
 240 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 241 </a>1.3.3 </small></address>
 242 </body>
 243 </html>