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">
6 <!-- Generated by Doxygen 1.3.3 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
8 <h1>command_t Class Reference</h1>A structure that defines a command.
9 <a href="#_details">More...</a>
11 <code>#include <<a class="el" href="ctables_8h-source.html">ctables.h</a>></code>
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="">
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="">
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>
25 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
26 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o0">command</a> [MAXBUF]</td></tr>
28 <tr><td class="mdescLeft"> </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 * </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o1">handler_function</a></td></tr>
31 <tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o2">flags_needed</a></td></tr>
34 <tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o3">min_params</a></td></tr>
37 <tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o4">use_count</a></td></tr>
40 <tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o5">total_bytes</a></td></tr>
43 <tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o6">source</a> [MAXBUF]</td></tr>
46 <tr><td class="mdescLeft"> </td><td class="mdescRight">used for resource tracking between modules </em> <a href="#o6"></a><em><br><br></td></tr>
48 <hr><a name="_details"></a><h2>Detailed Description</h2>
49 A structure that defines a command.
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">
58 <table cellpadding="0" cellspacing="0" border="0">
60 <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o0">command_t::command</a>[MAXBUF]
65 <table cellspacing=5 cellpadding=0 border=0>
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>
80 <a name="o2" doxytag="command_t::flags_needed"></a><p>
81 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
84 <table cellpadding="0" cellspacing="0" border="0">
86 <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o2">command_t::flags_needed</a>
91 <table cellspacing=5 cellpadding=0 border=0>
99 User flags needed to execute the command or 0.
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>
106 <a name="o1" doxytag="command_t::handler_function"></a><p>
107 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
110 <table cellpadding="0" cellspacing="0" border="0">
112 <td class="md" nowrap valign="top"> handlerfunc* <a class="el" href="classcommand__t.html#o1">command_t::handler_function</a>
117 <table cellspacing=5 cellpadding=0 border=0>
125 Handler function as in typedef.
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>
132 <a name="o3" doxytag="command_t::min_params"></a><p>
133 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136 <table cellpadding="0" cellspacing="0" border="0">
138 <td class="md" nowrap valign="top"> int <a class="el" href="classcommand__t.html#o3">command_t::min_params</a>
143 <table cellspacing=5 cellpadding=0 border=0>
151 Minimum number of parameters command takes.
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>
158 <a name="o6" doxytag="command_t::source"></a><p>
159 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
162 <table cellpadding="0" cellspacing="0" border="0">
164 <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o6">command_t::source</a>[MAXBUF]
169 <table cellspacing=5 cellpadding=0 border=0>
177 used for resource tracking between modules
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>
184 <a name="o5" doxytag="command_t::total_bytes"></a><p>
185 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
188 <table cellpadding="0" cellspacing="0" border="0">
190 <td class="md" nowrap valign="top"> long <a class="el" href="classcommand__t.html#o5">command_t::total_bytes</a>
195 <table cellspacing=5 cellpadding=0 border=0>
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>
210 <a name="o4" doxytag="command_t::use_count"></a><p>
211 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
214 <table cellpadding="0" cellspacing="0" border="0">
216 <td class="md" nowrap valign="top"> long <a class="el" href="classcommand__t.html#o4">command_t::use_count</a>
221 <table cellspacing=5 cellpadding=0 border=0>
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>
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>