docs/module-doc/channels_8h.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: channels.h File 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>channels.h File Reference</h1><code>#include "inspircd_config.h"</code><br>
   9 <code>#include "<a class="el" href="base_8h-source.html">base.h</a>"</code><br>
  10 <code>#include &lt;time.h&gt;</code><br>
  11 <code>#include &lt;vector&gt;</code><br>
  12 <code>#include &lt;string&gt;</code><br>
  13
  14 <p>
  15 <a href="channels_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBanItem.html">BanItem</a></td></tr>
  19
  20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel bans (+b). </em> <a href="classBanItem.html#_details">More...</a><em><br><br></td></tr>
  21 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classchanrec.html">chanrec</a></td></tr>
  22
  23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds all relevent information for a channel. </em> <a href="classchanrec.html#_details">More...</a><em><br><br></td></tr>
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classExemptItem.html">ExemptItem</a></td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel exempts (+e). </em> <a href="classExemptItem.html#_details">More...</a><em><br><br></td></tr>
  27 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classHostItem.html">HostItem</a></td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds an entry for a ban list, exemption list, or invite list. </em> <a href="classHostItem.html#_details">More...</a><em><br><br></td></tr>
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInviteItem.html">InviteItem</a></td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel invites (+I). </em> <a href="classInviteItem.html#_details">More...</a><em><br><br></td></tr>
  33 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html">ModeParameter</a></td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a custom parameter to a module-defined channel mode e.g. </em> <a href="classModeParameter.html#_details">More...</a><em><br><br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classucrec.html">ucrec</a></td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class. </em> <a href="classucrec.html#_details">More...</a><em><br><br></td></tr>
  39 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  40 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a0">UCMODE_OP</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  41
  42 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a1">UCMODE_VOICE</a>&nbsp;&nbsp;&nbsp;2</td></tr>
  43
  44 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a2">UCMODE_HOP</a>&nbsp;&nbsp;&nbsp;4</td></tr>
  45
  46 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a3">UCMODE_PROTECT</a>&nbsp;&nbsp;&nbsp;8</td></tr>
  47
  48 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a4">UCMODE_FOUNDER</a>&nbsp;&nbsp;&nbsp;16</td></tr>
  49
  50 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  51 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classBanItem.html">BanItem</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a5">BanList</a></td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete ban list. </em> <a href="#a5"></a><em><br><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classExemptItem.html">ExemptItem</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a6">ExemptList</a></td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete exempt list. </em> <a href="#a6"></a><em><br><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classInviteItem.html">InviteItem</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a7">InviteList</a></td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete invite list. </em> <a href="#a7"></a><em><br><br></td></tr>
  60 </table>
  61 <hr><h2>Define Documentation</h2>
  62 <a name="a4" doxytag="channels.h::UCMODE_FOUNDER"></a><p>
  63 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  64   <tr>
  65     <td class="mdRow">
  66       <table cellpadding="0" cellspacing="0" border="0">
  67         <tr>
  68           <td class="md" nowrap valign="top"> #define UCMODE_FOUNDER&nbsp;&nbsp;&nbsp;16
  69       </table>
  70     </td>
  71   </tr>
  72 </table>
  73 <table cellspacing=5 cellpadding=0 border=0>
  74   <tr>
  75     <td>
  76       &nbsp;
  77     </td>
  78     <td>
  79
  80 <p>
  81
  82 <p>
  83 Definition at line <a class="el" href="channels_8h-source.html#l00250">250</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
  84   </tr>
  85 </table>
  86 <a name="a2" doxytag="channels.h::UCMODE_HOP"></a><p>
  87 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  88   <tr>
  89     <td class="mdRow">
  90       <table cellpadding="0" cellspacing="0" border="0">
  91         <tr>
  92           <td class="md" nowrap valign="top"> #define UCMODE_HOP&nbsp;&nbsp;&nbsp;4
  93       </table>
  94     </td>
  95   </tr>
  96 </table>
  97 <table cellspacing=5 cellpadding=0 border=0>
  98   <tr>
  99     <td>
 100       &nbsp;
 101     </td>
 102     <td>
 103
 104 <p>
 105
 106 <p>
 107 Definition at line <a class="el" href="channels_8h-source.html#l00248">248</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 108   </tr>
 109 </table>
 110 <a name="a0" doxytag="channels.h::UCMODE_OP"></a><p>
 111 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 112   <tr>
 113     <td class="mdRow">
 114       <table cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td class="md" nowrap valign="top"> #define UCMODE_OP&nbsp;&nbsp;&nbsp;1
 117       </table>
 118     </td>
 119   </tr>
 120 </table>
 121 <table cellspacing=5 cellpadding=0 border=0>
 122   <tr>
 123     <td>
 124       &nbsp;
 125     </td>
 126     <td>
 127
 128 <p>
 129
 130 <p>
 131 Definition at line <a class="el" href="channels_8h-source.html#l00246">246</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 132   </tr>
 133 </table>
 134 <a name="a3" doxytag="channels.h::UCMODE_PROTECT"></a><p>
 135 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 136   <tr>
 137     <td class="mdRow">
 138       <table cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td class="md" nowrap valign="top"> #define UCMODE_PROTECT&nbsp;&nbsp;&nbsp;8
 141       </table>
 142     </td>
 143   </tr>
 144 </table>
 145 <table cellspacing=5 cellpadding=0 border=0>
 146   <tr>
 147     <td>
 148       &nbsp;
 149     </td>
 150     <td>
 151
 152 <p>
 153
 154 <p>
 155 Definition at line <a class="el" href="channels_8h-source.html#l00249">249</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 156   </tr>
 157 </table>
 158 <a name="a1" doxytag="channels.h::UCMODE_VOICE"></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"> #define UCMODE_VOICE&nbsp;&nbsp;&nbsp;2
 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
 178 <p>
 179 Definition at line <a class="el" href="channels_8h-source.html#l00247">247</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 180   </tr>
 181 </table>
 182 <hr><h2>Typedef Documentation</h2>
 183 <a name="a5" doxytag="channels.h::BanList"></a><p>
 184 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 185   <tr>
 186     <td class="mdRow">
 187       <table cellpadding="0" cellspacing="0" border="0">
 188         <tr>
 189           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classBanItem.html">BanItem</a>&gt; <a class="el" href="channels_8h.html#a5">BanList</a>
 190       </table>
 191     </td>
 192   </tr>
 193 </table>
 194 <table cellspacing=5 cellpadding=0 border=0>
 195   <tr>
 196     <td>
 197       &nbsp;
 198     </td>
 199     <td>
 200
 201 <p>
 202 Holds a complete ban list.
 203 <p>
 204
 205 <p>
 206 Definition at line <a class="el" href="channels_8h-source.html#l00080">80</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 207   </tr>
 208 </table>
 209 <a name="a6" doxytag="channels.h::ExemptList"></a><p>
 210 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 211   <tr>
 212     <td class="mdRow">
 213       <table cellpadding="0" cellspacing="0" border="0">
 214         <tr>
 215           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classExemptItem.html">ExemptItem</a>&gt; <a class="el" href="channels_8h.html#a6">ExemptList</a>
 216       </table>
 217     </td>
 218   </tr>
 219 </table>
 220 <table cellspacing=5 cellpadding=0 border=0>
 221   <tr>
 222     <td>
 223       &nbsp;
 224     </td>
 225     <td>
 226
 227 <p>
 228 Holds a complete exempt list.
 229 <p>
 230
 231 <p>
 232 Definition at line <a class="el" href="channels_8h-source.html#l00084">84</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 233   </tr>
 234 </table>
 235 <a name="a7" doxytag="channels.h::InviteList"></a><p>
 236 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 237   <tr>
 238     <td class="mdRow">
 239       <table cellpadding="0" cellspacing="0" border="0">
 240         <tr>
 241           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classInviteItem.html">InviteItem</a>&gt; <a class="el" href="channels_8h.html#a7">InviteList</a>
 242       </table>
 243     </td>
 244   </tr>
 245 </table>
 246 <table cellspacing=5 cellpadding=0 border=0>
 247   <tr>
 248     <td>
 249       &nbsp;
 250     </td>
 251     <td>
 252
 253 <p>
 254 Holds a complete invite list.
 255 <p>
 256
 257 <p>
 258 Definition at line <a class="el" href="channels_8h-source.html#l00088">88</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 259   </tr>
 260 </table>
 261 <hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:45 2005 for InspIRCd by
 262 <a href="http://www.doxygen.org/index.html">
 263 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 264 </a>1.3.3 </small></address>
 265 </body>
 266 </html>