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">CM_TOPICLOCK</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">CM_NOEXTERNAL</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">CM_INVITEONLY</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">CM_MODERATED</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">CM_SECRET</a>&nbsp;&nbsp;&nbsp;16</td></tr>
  49
  50 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a5">CM_PRIVATE</a>&nbsp;&nbsp;&nbsp;32</td></tr>
  51
  52 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a6">UCMODE_OP</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  53
  54 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a7">UCMODE_VOICE</a>&nbsp;&nbsp;&nbsp;2</td></tr>
  55
  56 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a8">UCMODE_HOP</a>&nbsp;&nbsp;&nbsp;4</td></tr>
  57
  58 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a9">UCMODE_PROTECT</a>&nbsp;&nbsp;&nbsp;8</td></tr>
  59
  60 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a10">UCMODE_FOUNDER</a>&nbsp;&nbsp;&nbsp;16</td></tr>
  61
  62 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  63 <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#a11">BanList</a></td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete ban list. </em> <a href="#a11"></a><em><br><br></td></tr>
  66 <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#a12">ExemptList</a></td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete exempt list. </em> <a href="#a12"></a><em><br><br></td></tr>
  69 <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#a13">InviteList</a></td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete invite list. </em> <a href="#a13"></a><em><br><br></td></tr>
  72 </table>
  73 <hr><h2>Define Documentation</h2>
  74 <a name="a2" doxytag="channels.h::CM_INVITEONLY"></a><p>
  75 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  76   <tr>
  77     <td class="mdRow">
  78       <table cellpadding="0" cellspacing="0" border="0">
  79         <tr>
  80           <td class="md" nowrap valign="top"> #define CM_INVITEONLY&nbsp;&nbsp;&nbsp;4
  81       </table>
  82     </td>
  83   </tr>
  84 </table>
  85 <table cellspacing=5 cellpadding=0 border=0>
  86   <tr>
  87     <td>
  88       &nbsp;
  89     </td>
  90     <td>
  91
  92 <p>
  93
  94 <p>
  95 Definition at line <a class="el" href="channels_8h-source.html#l00028">28</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
  96   </tr>
  97 </table>
  98 <a name="a3" doxytag="channels.h::CM_MODERATED"></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"> #define CM_MODERATED&nbsp;&nbsp;&nbsp;8
 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
 118 <p>
 119 Definition at line <a class="el" href="channels_8h-source.html#l00029">29</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 120   </tr>
 121 </table>
 122 <a name="a1" doxytag="channels.h::CM_NOEXTERNAL"></a><p>
 123 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 124   <tr>
 125     <td class="mdRow">
 126       <table cellpadding="0" cellspacing="0" border="0">
 127         <tr>
 128           <td class="md" nowrap valign="top"> #define CM_NOEXTERNAL&nbsp;&nbsp;&nbsp;2
 129       </table>
 130     </td>
 131   </tr>
 132 </table>
 133 <table cellspacing=5 cellpadding=0 border=0>
 134   <tr>
 135     <td>
 136       &nbsp;
 137     </td>
 138     <td>
 139
 140 <p>
 141
 142 <p>
 143 Definition at line <a class="el" href="channels_8h-source.html#l00027">27</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 144   </tr>
 145 </table>
 146 <a name="a5" doxytag="channels.h::CM_PRIVATE"></a><p>
 147 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 148   <tr>
 149     <td class="mdRow">
 150       <table cellpadding="0" cellspacing="0" border="0">
 151         <tr>
 152           <td class="md" nowrap valign="top"> #define CM_PRIVATE&nbsp;&nbsp;&nbsp;32
 153       </table>
 154     </td>
 155   </tr>
 156 </table>
 157 <table cellspacing=5 cellpadding=0 border=0>
 158   <tr>
 159     <td>
 160       &nbsp;
 161     </td>
 162     <td>
 163
 164 <p>
 165
 166 <p>
 167 Definition at line <a class="el" href="channels_8h-source.html#l00031">31</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 168   </tr>
 169 </table>
 170 <a name="a4" doxytag="channels.h::CM_SECRET"></a><p>
 171 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 172   <tr>
 173     <td class="mdRow">
 174       <table cellpadding="0" cellspacing="0" border="0">
 175         <tr>
 176           <td class="md" nowrap valign="top"> #define CM_SECRET&nbsp;&nbsp;&nbsp;16
 177       </table>
 178     </td>
 179   </tr>
 180 </table>
 181 <table cellspacing=5 cellpadding=0 border=0>
 182   <tr>
 183     <td>
 184       &nbsp;
 185     </td>
 186     <td>
 187
 188 <p>
 189
 190 <p>
 191 Definition at line <a class="el" href="channels_8h-source.html#l00030">30</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 192   </tr>
 193 </table>
 194 <a name="a0" doxytag="channels.h::CM_TOPICLOCK"></a><p>
 195 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 196   <tr>
 197     <td class="mdRow">
 198       <table cellpadding="0" cellspacing="0" border="0">
 199         <tr>
 200           <td class="md" nowrap valign="top"> #define CM_TOPICLOCK&nbsp;&nbsp;&nbsp;1
 201       </table>
 202     </td>
 203   </tr>
 204 </table>
 205 <table cellspacing=5 cellpadding=0 border=0>
 206   <tr>
 207     <td>
 208       &nbsp;
 209     </td>
 210     <td>
 211
 212 <p>
 213
 214 <p>
 215 Definition at line <a class="el" href="channels_8h-source.html#l00026">26</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 216   </tr>
 217 </table>
 218 <a name="a10" doxytag="channels.h::UCMODE_FOUNDER"></a><p>
 219 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 220   <tr>
 221     <td class="mdRow">
 222       <table cellpadding="0" cellspacing="0" border="0">
 223         <tr>
 224           <td class="md" nowrap valign="top"> #define UCMODE_FOUNDER&nbsp;&nbsp;&nbsp;16
 225       </table>
 226     </td>
 227   </tr>
 228 </table>
 229 <table cellspacing=5 cellpadding=0 border=0>
 230   <tr>
 231     <td>
 232       &nbsp;
 233     </td>
 234     <td>
 235
 236 <p>
 237
 238 <p>
 239 Definition at line <a class="el" href="channels_8h-source.html#l00215">215</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 240   </tr>
 241 </table>
 242 <a name="a8" doxytag="channels.h::UCMODE_HOP"></a><p>
 243 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 244   <tr>
 245     <td class="mdRow">
 246       <table cellpadding="0" cellspacing="0" border="0">
 247         <tr>
 248           <td class="md" nowrap valign="top"> #define UCMODE_HOP&nbsp;&nbsp;&nbsp;4
 249       </table>
 250     </td>
 251   </tr>
 252 </table>
 253 <table cellspacing=5 cellpadding=0 border=0>
 254   <tr>
 255     <td>
 256       &nbsp;
 257     </td>
 258     <td>
 259
 260 <p>
 261
 262 <p>
 263 Definition at line <a class="el" href="channels_8h-source.html#l00213">213</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 264   </tr>
 265 </table>
 266 <a name="a6" doxytag="channels.h::UCMODE_OP"></a><p>
 267 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 268   <tr>
 269     <td class="mdRow">
 270       <table cellpadding="0" cellspacing="0" border="0">
 271         <tr>
 272           <td class="md" nowrap valign="top"> #define UCMODE_OP&nbsp;&nbsp;&nbsp;1
 273       </table>
 274     </td>
 275   </tr>
 276 </table>
 277 <table cellspacing=5 cellpadding=0 border=0>
 278   <tr>
 279     <td>
 280       &nbsp;
 281     </td>
 282     <td>
 283
 284 <p>
 285
 286 <p>
 287 Definition at line <a class="el" href="channels_8h-source.html#l00211">211</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 288   </tr>
 289 </table>
 290 <a name="a9" doxytag="channels.h::UCMODE_PROTECT"></a><p>
 291 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 292   <tr>
 293     <td class="mdRow">
 294       <table cellpadding="0" cellspacing="0" border="0">
 295         <tr>
 296           <td class="md" nowrap valign="top"> #define UCMODE_PROTECT&nbsp;&nbsp;&nbsp;8
 297       </table>
 298     </td>
 299   </tr>
 300 </table>
 301 <table cellspacing=5 cellpadding=0 border=0>
 302   <tr>
 303     <td>
 304       &nbsp;
 305     </td>
 306     <td>
 307
 308 <p>
 309
 310 <p>
 311 Definition at line <a class="el" href="channels_8h-source.html#l00214">214</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 312   </tr>
 313 </table>
 314 <a name="a7" doxytag="channels.h::UCMODE_VOICE"></a><p>
 315 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 316   <tr>
 317     <td class="mdRow">
 318       <table cellpadding="0" cellspacing="0" border="0">
 319         <tr>
 320           <td class="md" nowrap valign="top"> #define UCMODE_VOICE&nbsp;&nbsp;&nbsp;2
 321       </table>
 322     </td>
 323   </tr>
 324 </table>
 325 <table cellspacing=5 cellpadding=0 border=0>
 326   <tr>
 327     <td>
 328       &nbsp;
 329     </td>
 330     <td>
 331
 332 <p>
 333
 334 <p>
 335 Definition at line <a class="el" href="channels_8h-source.html#l00212">212</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 336   </tr>
 337 </table>
 338 <hr><h2>Typedef Documentation</h2>
 339 <a name="a11" doxytag="channels.h::BanList"></a><p>
 340 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 341   <tr>
 342     <td class="mdRow">
 343       <table cellpadding="0" cellspacing="0" border="0">
 344         <tr>
 345           <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#a11">BanList</a>
 346       </table>
 347     </td>
 348   </tr>
 349 </table>
 350 <table cellspacing=5 cellpadding=0 border=0>
 351   <tr>
 352     <td>
 353       &nbsp;
 354     </td>
 355     <td>
 356
 357 <p>
 358 Holds a complete ban list.
 359 <p>
 360
 361 <p>
 362 Definition at line <a class="el" href="channels_8h-source.html#l00087">87</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 363   </tr>
 364 </table>
 365 <a name="a12" doxytag="channels.h::ExemptList"></a><p>
 366 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 367   <tr>
 368     <td class="mdRow">
 369       <table cellpadding="0" cellspacing="0" border="0">
 370         <tr>
 371           <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#a12">ExemptList</a>
 372       </table>
 373     </td>
 374   </tr>
 375 </table>
 376 <table cellspacing=5 cellpadding=0 border=0>
 377   <tr>
 378     <td>
 379       &nbsp;
 380     </td>
 381     <td>
 382
 383 <p>
 384 Holds a complete exempt list.
 385 <p>
 386
 387 <p>
 388 Definition at line <a class="el" href="channels_8h-source.html#l00091">91</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 389   </tr>
 390 </table>
 391 <a name="a13" doxytag="channels.h::InviteList"></a><p>
 392 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 393   <tr>
 394     <td class="mdRow">
 395       <table cellpadding="0" cellspacing="0" border="0">
 396         <tr>
 397           <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#a13">InviteList</a>
 398       </table>
 399     </td>
 400   </tr>
 401 </table>
 402 <table cellspacing=5 cellpadding=0 border=0>
 403   <tr>
 404     <td>
 405       &nbsp;
 406     </td>
 407     <td>
 408
 409 <p>
 410 Holds a complete invite list.
 411 <p>
 412
 413 <p>
 414 Definition at line <a class="el" href="channels_8h-source.html#l00095">95</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 415   </tr>
 416 </table>
 417 <hr size="1"><address style="align: right;"><small>Generated on Thu May 12 22:58:59 2005 for InspIRCd by
 418 <a href="http://www.doxygen.org/index.html">
 419 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 420 </a>1.3.3 </small></address>
 421 </body>
 422 </html>