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 Include dependency graph for channels.h:<p><center><img src="channels_8h__incl.gif" border="0" usemap="#channels.h_map" alt="Include dependency graph"></center>
  16 <map name="channels.h_map">
  17 <area href="base_8h.html" shape="rect" coords="157,82,218,109" alt="">
  18 </map>
  19
  20 <p>
  21 This graph shows which files directly or indirectly include this file:<p><center><img src="channels_8h__dep__incl.gif" border="0" usemap="#channels.hdep_map" alt="Included by dependency graph"></center>
  22 <map name="channels.hdep_map">
  23 <area href="users_8cpp.html" shape="rect" coords="7,82,87,109" alt="">
  24 <area href="users_8h.html" shape="rect" coords="226,157,290,184" alt="">
  25 <area href="channels_8cpp.html" shape="rect" coords="426,8,525,34" alt="">
  26 <area href="message_8h.html" shape="rect" coords="370,82,455,109" alt="">
  27 <area href="mode_8h.html" shape="rect" coords="479,82,546,109" alt="">
  28 <area href="xline_8h.html" shape="rect" coords="285,82,346,109" alt="">
  29 <area href="modules_8cpp.html" shape="rect" coords="266,8,365,34" alt="">
  30 <area href="commands_8h.html" shape="rect" coords="111,82,210,109" alt="">
  31 </map>
  32
  33 <p>
  34 <a href="channels_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  35 <tr><td></td></tr>
  36 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  37 <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>
  38
  39 <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>
  40 <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>
  41
  42 <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>
  43 <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>
  44
  45 <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>
  46 <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>
  47
  48 <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>
  49 <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>
  50
  51 <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>
  52 <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>
  53
  54 <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>
  55 <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>
  56
  57 <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>
  58 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  59 <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>
  60
  61 <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>
  62
  63 <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>
  64
  65 <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>
  66
  67 <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>
  68
  69 <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>
  70
  71 <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>
  72
  73 <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>
  74
  75 <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>
  76
  77 <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>
  78
  79 <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>
  80
  81 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  82 <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>
  83
  84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete ban list. </em> <a href="#a11"></a><em><br><br></td></tr>
  85 <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>
  86
  87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete exempt list. </em> <a href="#a12"></a><em><br><br></td></tr>
  88 <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>
  89
  90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete invite list. </em> <a href="#a13"></a><em><br><br></td></tr>
  91 </table>
  92 <hr><h2>Define Documentation</h2>
  93 <a name="a2" doxytag="channels.h::CM_INVITEONLY"></a><p>
  94 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  95   <tr>
  96     <td class="mdRow">
  97       <table cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  99           <td class="md" nowrap valign="top"> #define CM_INVITEONLY&nbsp;&nbsp;&nbsp;4
 100       </table>
 101     </td>
 102   </tr>
 103 </table>
 104 <table cellspacing=5 cellpadding=0 border=0>
 105   <tr>
 106     <td>
 107       &nbsp;
 108     </td>
 109     <td>
 110
 111 <p>
 112
 113 <p>
 114 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>
 115   </tr>
 116 </table>
 117 <a name="a3" doxytag="channels.h::CM_MODERATED"></a><p>
 118 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 119   <tr>
 120     <td class="mdRow">
 121       <table cellpadding="0" cellspacing="0" border="0">
 122         <tr>
 123           <td class="md" nowrap valign="top"> #define CM_MODERATED&nbsp;&nbsp;&nbsp;8
 124       </table>
 125     </td>
 126   </tr>
 127 </table>
 128 <table cellspacing=5 cellpadding=0 border=0>
 129   <tr>
 130     <td>
 131       &nbsp;
 132     </td>
 133     <td>
 134
 135 <p>
 136
 137 <p>
 138 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>
 139   </tr>
 140 </table>
 141 <a name="a1" doxytag="channels.h::CM_NOEXTERNAL"></a><p>
 142 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 143   <tr>
 144     <td class="mdRow">
 145       <table cellpadding="0" cellspacing="0" border="0">
 146         <tr>
 147           <td class="md" nowrap valign="top"> #define CM_NOEXTERNAL&nbsp;&nbsp;&nbsp;2
 148       </table>
 149     </td>
 150   </tr>
 151 </table>
 152 <table cellspacing=5 cellpadding=0 border=0>
 153   <tr>
 154     <td>
 155       &nbsp;
 156     </td>
 157     <td>
 158
 159 <p>
 160
 161 <p>
 162 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>
 163   </tr>
 164 </table>
 165 <a name="a5" doxytag="channels.h::CM_PRIVATE"></a><p>
 166 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 167   <tr>
 168     <td class="mdRow">
 169       <table cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <td class="md" nowrap valign="top"> #define CM_PRIVATE&nbsp;&nbsp;&nbsp;32
 172       </table>
 173     </td>
 174   </tr>
 175 </table>
 176 <table cellspacing=5 cellpadding=0 border=0>
 177   <tr>
 178     <td>
 179       &nbsp;
 180     </td>
 181     <td>
 182
 183 <p>
 184
 185 <p>
 186 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>
 187   </tr>
 188 </table>
 189 <a name="a4" doxytag="channels.h::CM_SECRET"></a><p>
 190 <table class="mdTable" width="100%" 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"> #define CM_SECRET&nbsp;&nbsp;&nbsp;16
 196       </table>
 197     </td>
 198   </tr>
 199 </table>
 200 <table cellspacing=5 cellpadding=0 border=0>
 201   <tr>
 202     <td>
 203       &nbsp;
 204     </td>
 205     <td>
 206
 207 <p>
 208
 209 <p>
 210 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>
 211   </tr>
 212 </table>
 213 <a name="a0" doxytag="channels.h::CM_TOPICLOCK"></a><p>
 214 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 215   <tr>
 216     <td class="mdRow">
 217       <table cellpadding="0" cellspacing="0" border="0">
 218         <tr>
 219           <td class="md" nowrap valign="top"> #define CM_TOPICLOCK&nbsp;&nbsp;&nbsp;1
 220       </table>
 221     </td>
 222   </tr>
 223 </table>
 224 <table cellspacing=5 cellpadding=0 border=0>
 225   <tr>
 226     <td>
 227       &nbsp;
 228     </td>
 229     <td>
 230
 231 <p>
 232
 233 <p>
 234 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>
 235   </tr>
 236 </table>
 237 <a name="a10" doxytag="channels.h::UCMODE_FOUNDER"></a><p>
 238 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 239   <tr>
 240     <td class="mdRow">
 241       <table cellpadding="0" cellspacing="0" border="0">
 242         <tr>
 243           <td class="md" nowrap valign="top"> #define UCMODE_FOUNDER&nbsp;&nbsp;&nbsp;16
 244       </table>
 245     </td>
 246   </tr>
 247 </table>
 248 <table cellspacing=5 cellpadding=0 border=0>
 249   <tr>
 250     <td>
 251       &nbsp;
 252     </td>
 253     <td>
 254
 255 <p>
 256
 257 <p>
 258 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>
 259   </tr>
 260 </table>
 261 <a name="a8" doxytag="channels.h::UCMODE_HOP"></a><p>
 262 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 263   <tr>
 264     <td class="mdRow">
 265       <table cellpadding="0" cellspacing="0" border="0">
 266         <tr>
 267           <td class="md" nowrap valign="top"> #define UCMODE_HOP&nbsp;&nbsp;&nbsp;4
 268       </table>
 269     </td>
 270   </tr>
 271 </table>
 272 <table cellspacing=5 cellpadding=0 border=0>
 273   <tr>
 274     <td>
 275       &nbsp;
 276     </td>
 277     <td>
 278
 279 <p>
 280
 281 <p>
 282 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>
 283   </tr>
 284 </table>
 285 <a name="a6" doxytag="channels.h::UCMODE_OP"></a><p>
 286 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 287   <tr>
 288     <td class="mdRow">
 289       <table cellpadding="0" cellspacing="0" border="0">
 290         <tr>
 291           <td class="md" nowrap valign="top"> #define UCMODE_OP&nbsp;&nbsp;&nbsp;1
 292       </table>
 293     </td>
 294   </tr>
 295 </table>
 296 <table cellspacing=5 cellpadding=0 border=0>
 297   <tr>
 298     <td>
 299       &nbsp;
 300     </td>
 301     <td>
 302
 303 <p>
 304
 305 <p>
 306 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>
 307   </tr>
 308 </table>
 309 <a name="a9" doxytag="channels.h::UCMODE_PROTECT"></a><p>
 310 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 311   <tr>
 312     <td class="mdRow">
 313       <table cellpadding="0" cellspacing="0" border="0">
 314         <tr>
 315           <td class="md" nowrap valign="top"> #define UCMODE_PROTECT&nbsp;&nbsp;&nbsp;8
 316       </table>
 317     </td>
 318   </tr>
 319 </table>
 320 <table cellspacing=5 cellpadding=0 border=0>
 321   <tr>
 322     <td>
 323       &nbsp;
 324     </td>
 325     <td>
 326
 327 <p>
 328
 329 <p>
 330 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>
 331   </tr>
 332 </table>
 333 <a name="a7" doxytag="channels.h::UCMODE_VOICE"></a><p>
 334 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 335   <tr>
 336     <td class="mdRow">
 337       <table cellpadding="0" cellspacing="0" border="0">
 338         <tr>
 339           <td class="md" nowrap valign="top"> #define UCMODE_VOICE&nbsp;&nbsp;&nbsp;2
 340       </table>
 341     </td>
 342   </tr>
 343 </table>
 344 <table cellspacing=5 cellpadding=0 border=0>
 345   <tr>
 346     <td>
 347       &nbsp;
 348     </td>
 349     <td>
 350
 351 <p>
 352
 353 <p>
 354 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>
 355   </tr>
 356 </table>
 357 <hr><h2>Typedef Documentation</h2>
 358 <a name="a11" doxytag="channels.h::BanList"></a><p>
 359 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 360   <tr>
 361     <td class="mdRow">
 362       <table cellpadding="0" cellspacing="0" border="0">
 363         <tr>
 364           <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>
 365       </table>
 366     </td>
 367   </tr>
 368 </table>
 369 <table cellspacing=5 cellpadding=0 border=0>
 370   <tr>
 371     <td>
 372       &nbsp;
 373     </td>
 374     <td>
 375
 376 <p>
 377 Holds a complete ban list.
 378 <p>
 379
 380 <p>
 381 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>
 382   </tr>
 383 </table>
 384 <a name="a12" doxytag="channels.h::ExemptList"></a><p>
 385 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 386   <tr>
 387     <td class="mdRow">
 388       <table cellpadding="0" cellspacing="0" border="0">
 389         <tr>
 390           <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>
 391       </table>
 392     </td>
 393   </tr>
 394 </table>
 395 <table cellspacing=5 cellpadding=0 border=0>
 396   <tr>
 397     <td>
 398       &nbsp;
 399     </td>
 400     <td>
 401
 402 <p>
 403 Holds a complete exempt list.
 404 <p>
 405
 406 <p>
 407 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>
 408   </tr>
 409 </table>
 410 <a name="a13" doxytag="channels.h::InviteList"></a><p>
 411 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 412   <tr>
 413     <td class="mdRow">
 414       <table cellpadding="0" cellspacing="0" border="0">
 415         <tr>
 416           <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>
 417       </table>
 418     </td>
 419   </tr>
 420 </table>
 421 <table cellspacing=5 cellpadding=0 border=0>
 422   <tr>
 423     <td>
 424       &nbsp;
 425     </td>
 426     <td>
 427
 428 <p>
 429 Holds a complete invite list.
 430 <p>
 431
 432 <p>
 433 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>
 434   </tr>
 435 </table>
 436 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:58:55 2005 for InspIRCd by
 437 <a href="http://www.doxygen.org/index.html">
 438 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 439 </a>1.3.3 </small></address>
 440 </body>
 441 </html>