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