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