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" --><!-- doxytag: inherits="Extensible" -->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="11,81,93,108" alt="">
  16 <area href="classclassbase.html" shape="rect" coords="12,7,92,33" 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="80,97,163,124" alt="">
  21 <area href="classclassbase.html" shape="rect" coords="7,7,87,33" 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#command_5BMAXBUF_5D">command</a> [MAXBUF]</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command name.  <a href="#command_5BMAXBUF_5D"></a><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#handler_5Ffunction">handler_function</a></td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handler function as in typedef.  <a href="#handler_5Ffunction"></a><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#flags_5Fneeded">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.  <a href="#flags_5Fneeded"></a><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#min_5Fparams">min_params</a></td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum number of parameters command takes.  <a href="#min_5Fparams"></a><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#use_5Fcount">use_count</a></td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used by /stats m  <a href="#use_5Fcount"></a><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#total_5Fbytes">total_bytes</a></td></tr>
  42
  43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used by /stats m  <a href="#total_5Fbytes"></a><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#source_5BMAXBUF_5D">source</a> [MAXBUF]</td></tr>
  45
  46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">used for resource tracking between modules  <a href="#source_5BMAXBUF_5D"></a><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 class="anchor" name="command_5BMAXBUF_5D"></a><!-- doxytag: member="command_t::command" ref="command_5BMAXBUF_5D" args="[MAXBUF]" --><p>
  55 <table class="mdTable" 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#command_5BMAXBUF_5D">command_t::command</a>[MAXBUF]          </td>
  61         </tr>
  62       </table>
  63     </td>
  64   </tr>
  65 </table>
  66 <table cellspacing="5" cellpadding="0" border="0">
  67   <tr>
  68     <td>
  69       &nbsp;
  70     </td>
  71     <td>
  72
  73 <p>
  74 Command name.
  75 <p>
  76
  77 <p>
  78 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>
  79   </tr>
  80 </table>
  81 <a class="anchor" name="flags_5Fneeded"></a><!-- doxytag: member="command_t::flags_needed" ref="flags_5Fneeded" args="" --><p>
  82 <table class="mdTable" cellpadding="2" cellspacing="0">
  83   <tr>
  84     <td class="mdRow">
  85       <table cellpadding="0" cellspacing="0" border="0">
  86         <tr>
  87           <td class="md" nowrap valign="top">char <a class="el" href="classcommand__t.html#flags_5Fneeded">command_t::flags_needed</a>          </td>
  88         </tr>
  89       </table>
  90     </td>
  91   </tr>
  92 </table>
  93 <table cellspacing="5" cellpadding="0" border="0">
  94   <tr>
  95     <td>
  96       &nbsp;
  97     </td>
  98     <td>
  99
 100 <p>
 101 User flags needed to execute the command or 0.
 102 <p>
 103
 104 <p>
 105 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>
 106   </tr>
 107 </table>
 108 <a class="anchor" name="handler_5Ffunction"></a><!-- doxytag: member="command_t::handler_function" ref="handler_5Ffunction" args="" --><p>
 109 <table class="mdTable" cellpadding="2" cellspacing="0">
 110   <tr>
 111     <td class="mdRow">
 112       <table cellpadding="0" cellspacing="0" border="0">
 113         <tr>
 114           <td class="md" nowrap valign="top">handlerfunc* <a class="el" href="classcommand__t.html#handler_5Ffunction">command_t::handler_function</a>          </td>
 115         </tr>
 116       </table>
 117     </td>
 118   </tr>
 119 </table>
 120 <table cellspacing="5" cellpadding="0" border="0">
 121   <tr>
 122     <td>
 123       &nbsp;
 124     </td>
 125     <td>
 126
 127 <p>
 128 Handler function as in typedef.
 129 <p>
 130
 131 <p>
 132 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>
 133   </tr>
 134 </table>
 135 <a class="anchor" name="min_5Fparams"></a><!-- doxytag: member="command_t::min_params" ref="min_5Fparams" args="" --><p>
 136 <table class="mdTable" cellpadding="2" cellspacing="0">
 137   <tr>
 138     <td class="mdRow">
 139       <table cellpadding="0" cellspacing="0" border="0">
 140         <tr>
 141           <td class="md" nowrap valign="top">int <a class="el" href="classcommand__t.html#min_5Fparams">command_t::min_params</a>          </td>
 142         </tr>
 143       </table>
 144     </td>
 145   </tr>
 146 </table>
 147 <table cellspacing="5" cellpadding="0" border="0">
 148   <tr>
 149     <td>
 150       &nbsp;
 151     </td>
 152     <td>
 153
 154 <p>
 155 Minimum number of parameters command takes.
 156 <p>
 157
 158 <p>
 159 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>
 160   </tr>
 161 </table>
 162 <a class="anchor" name="source_5BMAXBUF_5D"></a><!-- doxytag: member="command_t::source" ref="source_5BMAXBUF_5D" args="[MAXBUF]" --><p>
 163 <table class="mdTable" cellpadding="2" cellspacing="0">
 164   <tr>
 165     <td class="mdRow">
 166       <table cellpadding="0" cellspacing="0" border="0">
 167         <tr>
 168           <td class="md" nowrap valign="top">char <a class="el" href="classcommand__t.html#source_5BMAXBUF_5D">command_t::source</a>[MAXBUF]          </td>
 169         </tr>
 170       </table>
 171     </td>
 172   </tr>
 173 </table>
 174 <table cellspacing="5" cellpadding="0" border="0">
 175   <tr>
 176     <td>
 177       &nbsp;
 178     </td>
 179     <td>
 180
 181 <p>
 182 used for resource tracking between modules
 183 <p>
 184
 185 <p>
 186 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>
 187   </tr>
 188 </table>
 189 <a class="anchor" name="total_5Fbytes"></a><!-- doxytag: member="command_t::total_bytes" ref="total_5Fbytes" args="" --><p>
 190 <table class="mdTable" cellpadding="2" cellspacing="0">
 191   <tr>
 192     <td class="mdRow">
 193       <table cellpadding="0" cellspacing="0" border="0">
 194         <tr>
 195           <td class="md" nowrap valign="top">long <a class="el" href="classcommand__t.html#total_5Fbytes">command_t::total_bytes</a>          </td>
 196         </tr>
 197       </table>
 198     </td>
 199   </tr>
 200 </table>
 201 <table cellspacing="5" cellpadding="0" border="0">
 202   <tr>
 203     <td>
 204       &nbsp;
 205     </td>
 206     <td>
 207
 208 <p>
 209 used by /stats m
 210 <p>
 211
 212 <p>
 213 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>
 214   </tr>
 215 </table>
 216 <a class="anchor" name="use_5Fcount"></a><!-- doxytag: member="command_t::use_count" ref="use_5Fcount" args="" --><p>
 217 <table class="mdTable" cellpadding="2" cellspacing="0">
 218   <tr>
 219     <td class="mdRow">
 220       <table cellpadding="0" cellspacing="0" border="0">
 221         <tr>
 222           <td class="md" nowrap valign="top">long <a class="el" href="classcommand__t.html#use_5Fcount">command_t::use_count</a>          </td>
 223         </tr>
 224       </table>
 225     </td>
 226   </tr>
 227 </table>
 228 <table cellspacing="5" cellpadding="0" border="0">
 229   <tr>
 230     <td>
 231       &nbsp;
 232     </td>
 233     <td>
 234
 235 <p>
 236 used by /stats m
 237 <p>
 238
 239 <p>
 240 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>
 241   </tr>
 242 </table>
 243 <hr>The documentation for this class was generated from the following file:<ul>
 244 <li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
 245 <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
 246 <a href="http://www.doxygen.org/index.html">
 247 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 248 </body>
 249 </html>