docs/module-doc/classchanrec.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: chanrec 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>chanrec Class Reference</h1><!-- doxytag: class="chanrec" --><!-- doxytag: inherits="Extensible" -->Holds all relevent information for a channel.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
  12 <p>
  13 Inheritance diagram for chanrec:<p><center><img src="classchanrec__inherit__graph.gif" border="0" usemap="#chanrec__inherit__map" alt="Inheritance graph"></center>
  14 <map name="chanrec__inherit__map">
  15 <area href="classExtensible.html" shape="rect" coords="7,81,89,108" alt="">
  16 <area href="classclassbase.html" shape="rect" coords="8,7,88,33" alt="">
  17 </map>
  18 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for chanrec:<p><center><img src="classchanrec__coll__graph.gif" border="0" usemap="#chanrec__coll__map" alt="Collaboration graph"></center>
  19 <map name="chanrec__coll__map">
  20 <area href="classExtensible.html" shape="rect" coords="68,204,151,231" alt="">
  21 <area href="classclassbase.html" shape="rect" coords="68,97,148,124" alt="">
  22 </map>
  23 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classchanrec-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 Member Functions</h2></td></tr>
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#SetCustomMode_28char_20mode_2C_20bool_20mode_5Fon_29">SetCustomMode</a> (char mode, bool mode_on)</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets or unsets a custom mode in the channels info.  <a href="#SetCustomMode_28char_20mode_2C_20bool_20mode_5Fon_29"></a><br></td></tr>
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#SetCustomModeParam_28char_20mode_2C_20char_20_2Aparameter_2C_20bool_20mode_5Fon_29">SetCustomModeParam</a> (char mode, char *parameter, bool mode_on)</td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets or unsets the parameters for a custom mode in a channels info.  <a href="#SetCustomModeParam_28char_20mode_2C_20char_20_2Aparameter_2C_20bool_20mode_5Fon_29"></a><br></td></tr>
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#IsCustomModeSet_28char_20mode_29">IsCustomModeSet</a> (char mode)</td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if a custom mode is set on a channel.  <a href="#IsCustomModeSet_28char_20mode_29"></a><br></td></tr>
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#GetModeParameter_28char_20mode_29">GetModeParameter</a> (char mode)</td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the parameter for a custom mode on a channel.  <a href="#GetModeParameter_28char_20mode_29"></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="classchanrec.html#GetUserCounter_28_29">GetUserCounter</a> ()</td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain the channel "user counter" This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks.  <a href="#GetUserCounter_28_29"></a><br></td></tr>
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#AddUser_28char_20_2Acastuser_29">AddUser</a> (char *castuser)</td></tr>
  42
  43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a user pointer to the internal reference list.  <a href="#AddUser_28char_20_2Acastuser_29"></a><br></td></tr>
  44 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#DelUser_28char_20_2Acastuser_29">DelUser</a> (char *castuser)</td></tr>
  45
  46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete a user pointer to the internal reference list.  <a href="#DelUser_28char_20_2Acastuser_29"></a><br></td></tr>
  47 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; char * &gt; *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#GetUsers_28_29">GetUsers</a> ()</td></tr>
  48
  49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*.  <a href="#GetUsers_28_29"></a><br></td></tr>
  50 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#chanrec_28_29">chanrec</a> ()</td></tr>
  51
  52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a channel record and initialises it with default values.  <a href="#chanrec_28_29"></a><br></td></tr>
  53 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#_7Echanrec_28_29">~chanrec</a> ()</td></tr>
  54
  55 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  56 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#name_5BCHANMAX_5D">name</a> [CHANMAX]</td></tr>
  57
  58 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The channels name.  <a href="#name_5BCHANMAX_5D"></a><br></td></tr>
  59 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">custom_modes</a> [MAXMODES]</td></tr>
  60
  61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Custom modes for the channel.  <a href="#custom_5Fmodes_5BMAXMODES_5D"></a><br></td></tr>
  62 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; char * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a></td></tr>
  63
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">User list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!).  <a href="#internal_5Fuserlist"></a><br></td></tr>
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#topic_5BMAXBUF_5D">topic</a> [MAXBUF]</td></tr>
  66
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel topic.  <a href="#topic_5BMAXBUF_5D"></a><br></td></tr>
  68 <tr><td class="memItemLeft" nowrap align="right" valign="top">time_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#created">created</a></td></tr>
  69
  70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creation time.  <a href="#created"></a><br></td></tr>
  71 <tr><td class="memItemLeft" nowrap align="right" valign="top">time_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#topicset">topicset</a></td></tr>
  72
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Time topic was set.  <a href="#topicset"></a><br></td></tr>
  74 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#setby_5BNICKMAX_5D">setby</a> [NICKMAX]</td></tr>
  75
  76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The last user to set the topic.  <a href="#setby_5BNICKMAX_5D"></a><br></td></tr>
  77 <tr><td class="memItemLeft" nowrap align="right" valign="top">short int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#limit">limit</a></td></tr>
  78
  79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contains the channel user limit.  <a href="#limit"></a><br></td></tr>
  80 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#key_5B_33_32_5D">key</a> [32]</td></tr>
  81
  82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contains the channel key.  <a href="#key_5B_33_32_5D"></a><br></td></tr>
  83 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#binarymodes">binarymodes</a></td></tr>
  84
  85 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contains a bitmask of the CM_* builtin (RFC) binary mode symbols.  <a href="#binarymodes"></a><br></td></tr>
  86 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="channels_8h.html#BanList">BanList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchanrec.html#bans">bans</a></td></tr>
  87
  88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of all bans set on the channel.  <a href="#bans"></a><br></td></tr>
  89 </table>
  90 <hr><a name="_details"></a><h2>Detailed Description</h2>
  91 Holds all relevent information for a channel.
  92 <p>
  93 This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.
  94 <p>
  95
  96 <p>
  97 Definition at line <a class="el" href="channels_8h-source.html#l00101">101</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  98 <a class="anchor" name="chanrec_28_29"></a><!-- doxytag: member="chanrec::chanrec" ref="chanrec_28_29" args="()" --><p>
  99 <table class="mdTable" 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">chanrec::chanrec           </td>
 105           <td class="md" valign="top">(&nbsp;</td>
 106           <td class="mdname1" valign="top" nowrap>          </td>
 107           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 108           <td class="md" nowrap></td>
 109         </tr>
 110       </table>
 111     </td>
 112   </tr>
 113 </table>
 114 <table cellspacing="5" cellpadding="0" border="0">
 115   <tr>
 116     <td>
 117       &nbsp;
 118     </td>
 119     <td>
 120
 121 <p>
 122 Creates a channel record and initialises it with default values.
 123 <p>
 124
 125 <p>
 126 Definition at line <a class="el" href="channels_8cpp-source.html#l00101">101</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 127 <p>
 128 References <a class="el" href="channels_8h-source.html#l00145">binarymodes</a>, <a class="el" href="channels_8h-source.html#l00123">created</a>, <a class="el" href="channels_8h-source.html#l00110">custom_modes</a>, <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>, <a class="el" href="channels_8h-source.html#l00141">key</a>, <a class="el" href="channels_8h-source.html#l00136">limit</a>, <a class="el" href="channels_8h-source.html#l00106">name</a>, <a class="el" href="channels_8h-source.html#l00131">setby</a>, <a class="el" href="channels_8h-source.html#l00120">topic</a>, and <a class="el" href="channels_8h-source.html#l00127">topicset</a>.<div class="fragment"><pre class="fragment"><a name="l00102"></a>00102 {
 129 <a name="l00103"></a>00103         strcpy(<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>,<span class="stringliteral">""</span>);
 130 <a name="l00104"></a>00104         strcpy(<a class="code" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">custom_modes</a>,<span class="stringliteral">""</span>);
 131 <a name="l00105"></a>00105         strcpy(<a class="code" href="classchanrec.html#topic_5BMAXBUF_5D">topic</a>,<span class="stringliteral">""</span>);
 132 <a name="l00106"></a>00106         strcpy(<a class="code" href="classchanrec.html#setby_5BNICKMAX_5D">setby</a>,<span class="stringliteral">""</span>);
 133 <a name="l00107"></a>00107         strcpy(<a class="code" href="classchanrec.html#key_5B_33_32_5D">key</a>,<span class="stringliteral">""</span>);
 134 <a name="l00108"></a>00108         <a class="code" href="classchanrec.html#created">created</a> = <a class="code" href="classchanrec.html#topicset">topicset</a> = <a class="code" href="classchanrec.html#limit">limit</a> = 0;
 135 <a name="l00109"></a>00109         <a class="code" href="classchanrec.html#binarymodes">binarymodes</a> = 0;
 136 <a name="l00110"></a>00110         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.clear();
 137 <a name="l00111"></a>00111 }
 138 </pre></div>
 139 <p>
 140     </td>
 141   </tr>
 142 </table>
 143 <a class="anchor" name="_7Echanrec_28_29"></a><!-- doxytag: member="chanrec::~chanrec" ref="_7Echanrec_28_29" args="()" --><p>
 144 <table class="mdTable" cellpadding="2" cellspacing="0">
 145   <tr>
 146     <td class="mdRow">
 147       <table cellpadding="0" cellspacing="0" border="0">
 148         <tr>
 149           <td class="md" nowrap valign="top">virtual chanrec::~chanrec           </td>
 150           <td class="md" valign="top">(&nbsp;</td>
 151           <td class="mdname1" valign="top" nowrap>          </td>
 152           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 153           <td class="md" nowrap><code> [inline, virtual]</code></td>
 154         </tr>
 155       </table>
 156     </td>
 157   </tr>
 158 </table>
 159 <table cellspacing="5" cellpadding="0" border="0">
 160   <tr>
 161     <td>
 162       &nbsp;
 163     </td>
 164     <td>
 165
 166 <p>
 167
 168 <p>
 169 Definition at line <a class="el" href="channels_8h-source.html#l00224">224</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<div class="fragment"><pre class="fragment"><a name="l00224"></a>00224 { <span class="comment">/* stub */</span> }
 170 </pre></div>
 171 <p>
 172     </td>
 173   </tr>
 174 </table>
 175 <hr><h2>Member Function Documentation</h2>
 176 <a class="anchor" name="AddUser_28char_20_2Acastuser_29"></a><!-- doxytag: member="chanrec::AddUser" ref="AddUser_28char_20_2Acastuser_29" args="(char *castuser)" --><p>
 177 <table class="mdTable" cellpadding="2" cellspacing="0">
 178   <tr>
 179     <td class="mdRow">
 180       <table cellpadding="0" cellspacing="0" border="0">
 181         <tr>
 182           <td class="md" nowrap valign="top">void chanrec::AddUser           </td>
 183           <td class="md" valign="top">(&nbsp;</td>
 184           <td class="md" nowrap valign="top">char *&nbsp;</td>
 185           <td class="mdname1" valign="top" nowrap> <em>castuser</em>          </td>
 186           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 187           <td class="md" nowrap></td>
 188         </tr>
 189       </table>
 190     </td>
 191   </tr>
 192 </table>
 193 <table cellspacing="5" cellpadding="0" border="0">
 194   <tr>
 195     <td>
 196       &nbsp;
 197     </td>
 198     <td>
 199
 200 <p>
 201 Add a user pointer to the internal reference list.
 202 <p>
 203 <dl compact><dt><b>Parameters:</b></dt><dd>
 204   <table border="0" cellspacing="2" cellpadding="0">
 205     <tr><td valign="top"></td><td valign="top"><em>castuser</em>&nbsp;</td><td>This should be a pointer to a userrec, casted to char*</td></tr>
 206   </table>
 207 </dl>
 208 The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
 209 <p>
 210 Definition at line <a class="el" href="channels_8cpp-source.html#l00194">194</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 211 <p>
 212 References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>.<div class="fragment"><pre class="fragment"><a name="l00195"></a>00195 {
 213 <a name="l00196"></a>00196         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.push_back(castuser);
 214 <a name="l00197"></a>00197         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Added casted user to channel's internal list"</span>);
 215 <a name="l00198"></a>00198 }
 216 </pre></div>
 217 <p>
 218     </td>
 219   </tr>
 220 </table>
 221 <a class="anchor" name="DelUser_28char_20_2Acastuser_29"></a><!-- doxytag: member="chanrec::DelUser" ref="DelUser_28char_20_2Acastuser_29" args="(char *castuser)" --><p>
 222 <table class="mdTable" cellpadding="2" cellspacing="0">
 223   <tr>
 224     <td class="mdRow">
 225       <table cellpadding="0" cellspacing="0" border="0">
 226         <tr>
 227           <td class="md" nowrap valign="top">void chanrec::DelUser           </td>
 228           <td class="md" valign="top">(&nbsp;</td>
 229           <td class="md" nowrap valign="top">char *&nbsp;</td>
 230           <td class="mdname1" valign="top" nowrap> <em>castuser</em>          </td>
 231           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 232           <td class="md" nowrap></td>
 233         </tr>
 234       </table>
 235     </td>
 236   </tr>
 237 </table>
 238 <table cellspacing="5" cellpadding="0" border="0">
 239   <tr>
 240     <td>
 241       &nbsp;
 242     </td>
 243     <td>
 244
 245 <p>
 246 Delete a user pointer to the internal reference list.
 247 <p>
 248 <dl compact><dt><b>Parameters:</b></dt><dd>
 249   <table border="0" cellspacing="2" cellpadding="0">
 250     <tr><td valign="top"></td><td valign="top"><em>castuser</em>&nbsp;</td><td>This should be a pointer to a userrec, casted to char*</td></tr>
 251   </table>
 252 </dl>
 253 The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
 254 <p>
 255 Definition at line <a class="el" href="channels_8cpp-source.html#l00200">200</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 256 <p>
 257 References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>, and <a class="el" href="channels_8h-source.html#l00106">name</a>.<div class="fragment"><pre class="fragment"><a name="l00201"></a>00201 {
 258 <a name="l00202"></a>00202         <span class="keywordflow">for</span> (std::vector&lt;char*&gt;::iterator a = <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.begin(); a &lt; <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.end(); a++)
 259 <a name="l00203"></a>00203         {
 260 <a name="l00204"></a>00204                 <span class="keywordflow">if</span> (*a == castuser)
 261 <a name="l00205"></a>00205                 {
 262 <a name="l00206"></a>00206                         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Removed casted user from channel's internal list"</span>);
 263 <a name="l00207"></a>00207                         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.erase(a);
 264 <a name="l00208"></a>00208                         <span class="keywordflow">return</span>;
 265 <a name="l00209"></a>00209                 }
 266 <a name="l00210"></a>00210         }
 267 <a name="l00211"></a>00211         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!"</span>,<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>);
 268 <a name="l00212"></a>00212 }
 269 </pre></div>
 270 <p>
 271     </td>
 272   </tr>
 273 </table>
 274 <a class="anchor" name="GetModeParameter_28char_20mode_29"></a><!-- doxytag: member="chanrec::GetModeParameter" ref="GetModeParameter_28char_20mode_29" args="(char mode)" --><p>
 275 <table class="mdTable" cellpadding="2" cellspacing="0">
 276   <tr>
 277     <td class="mdRow">
 278       <table cellpadding="0" cellspacing="0" border="0">
 279         <tr>
 280           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> chanrec::GetModeParameter           </td>
 281           <td class="md" valign="top">(&nbsp;</td>
 282           <td class="md" nowrap valign="top">char&nbsp;</td>
 283           <td class="mdname1" valign="top" nowrap> <em>mode</em>          </td>
 284           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 285           <td class="md" nowrap></td>
 286         </tr>
 287       </table>
 288     </td>
 289   </tr>
 290 </table>
 291 <table cellspacing="5" cellpadding="0" border="0">
 292   <tr>
 293     <td>
 294       &nbsp;
 295     </td>
 296     <td>
 297
 298 <p>
 299 Returns the parameter for a custom mode on a channel.
 300 <p>
 301 <dl compact><dt><b>Parameters:</b></dt><dd>
 302   <table border="0" cellspacing="2" cellpadding="0">
 303     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The mode character you wish to query</td></tr>
 304   </table>
 305 </dl>
 306 For example if "+L #foo" is set, and you pass this method 'L', it will return 'foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.<p>
 307 <dl compact><dt><b>Returns:</b></dt><dd>The parameter for this mode is returned, or an empty string</dd></dl>
 308
 309 <p>
 310 Definition at line <a class="el" href="channels_8cpp-source.html#l00174">174</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 311 <p>
 312 References <a class="el" href="channels_8cpp-source.html#l00099">custom_mode_params</a>.<div class="fragment"><pre class="fragment"><a name="l00175"></a>00175 {
 313 <a name="l00176"></a>00176         <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.size())
 314 <a name="l00177"></a>00177         {
 315 <a name="l00178"></a>00178                 <span class="keywordflow">for</span> (vector&lt;ModeParameter&gt;::iterator i = <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.begin(); i &lt; <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.end(); i++)
 316 <a name="l00179"></a>00179                 {
 317 <a name="l00180"></a>00180                         <span class="keywordflow">if</span> ((i-&gt;mode == mode) &amp;&amp; (!strcasecmp(this-&gt;name,i-&gt;channel)))
 318 <a name="l00181"></a>00181                         {
 319 <a name="l00182"></a>00182                                 <span class="keywordflow">return</span> i-&gt;parameter;
 320 <a name="l00183"></a>00183                         }
 321 <a name="l00184"></a>00184                 }
 322 <a name="l00185"></a>00185         }
 323 <a name="l00186"></a>00186         <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
 324 <a name="l00187"></a>00187 }
 325 </pre></div>
 326 <p>
 327     </td>
 328   </tr>
 329 </table>
 330 <a class="anchor" name="GetUserCounter_28_29"></a><!-- doxytag: member="chanrec::GetUserCounter" ref="GetUserCounter_28_29" args="()" --><p>
 331 <table class="mdTable" cellpadding="2" cellspacing="0">
 332   <tr>
 333     <td class="mdRow">
 334       <table cellpadding="0" cellspacing="0" border="0">
 335         <tr>
 336           <td class="md" nowrap valign="top">long chanrec::GetUserCounter           </td>
 337           <td class="md" valign="top">(&nbsp;</td>
 338           <td class="mdname1" valign="top" nowrap>          </td>
 339           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 340           <td class="md" nowrap></td>
 341         </tr>
 342       </table>
 343     </td>
 344   </tr>
 345 </table>
 346 <table cellspacing="5" cellpadding="0" border="0">
 347   <tr>
 348     <td>
 349       &nbsp;
 350     </td>
 351     <td>
 352
 353 <p>
 354 Obtain the channel "user counter" This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks.
 355 <p>
 356 <dl compact><dt><b>Returns:</b></dt><dd>The number of users on this channel</dd></dl>
 357
 358 <p>
 359 Definition at line <a class="el" href="channels_8cpp-source.html#l00189">189</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00190"></a>00190 {
 360 <a name="l00191"></a>00191         <span class="keywordflow">return</span> (this-&gt;internal_userlist.size());
 361 <a name="l00192"></a>00192 }
 362 </pre></div>
 363 <p>
 364     </td>
 365   </tr>
 366 </table>
 367 <a class="anchor" name="GetUsers_28_29"></a><!-- doxytag: member="chanrec::GetUsers" ref="GetUsers_28_29" args="()" --><p>
 368 <table class="mdTable" cellpadding="2" cellspacing="0">
 369   <tr>
 370     <td class="mdRow">
 371       <table cellpadding="0" cellspacing="0" border="0">
 372         <tr>
 373           <td class="md" nowrap valign="top">std::vector&lt; char * &gt; * chanrec::GetUsers           </td>
 374           <td class="md" valign="top">(&nbsp;</td>
 375           <td class="mdname1" valign="top" nowrap>          </td>
 376           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 377           <td class="md" nowrap></td>
 378         </tr>
 379       </table>
 380     </td>
 381   </tr>
 382 </table>
 383 <table cellspacing="5" cellpadding="0" border="0">
 384   <tr>
 385     <td>
 386       &nbsp;
 387     </td>
 388     <td>
 389
 390 <p>
 391 Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*.
 392 <p>
 393 These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.<p>
 394 <dl compact><dt><b>Returns:</b></dt><dd>This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references</dd></dl>
 395
 396 <p>
 397 Definition at line <a class="el" href="channels_8cpp-source.html#l00214">214</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 398 <p>
 399 References <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>.
 400 <p>
 401 Referenced by <a class="el" href="modules_8cpp-source.html#l00445">Server::GetUsers()</a>.<div class="fragment"><pre class="fragment"><a name="l00215"></a>00215 {
 402 <a name="l00216"></a>00216         <span class="keywordflow">return</span> &amp;<a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>;
 403 <a name="l00217"></a>00217 }
 404 </pre></div>
 405 <p>
 406     </td>
 407   </tr>
 408 </table>
 409 <a class="anchor" name="IsCustomModeSet_28char_20mode_29"></a><!-- doxytag: member="chanrec::IsCustomModeSet" ref="IsCustomModeSet_28char_20mode_29" args="(char mode)" --><p>
 410 <table class="mdTable" cellpadding="2" cellspacing="0">
 411   <tr>
 412     <td class="mdRow">
 413       <table cellpadding="0" cellspacing="0" border="0">
 414         <tr>
 415           <td class="md" nowrap valign="top">bool chanrec::IsCustomModeSet           </td>
 416           <td class="md" valign="top">(&nbsp;</td>
 417           <td class="md" nowrap valign="top">char&nbsp;</td>
 418           <td class="mdname1" valign="top" nowrap> <em>mode</em>          </td>
 419           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 420           <td class="md" nowrap></td>
 421         </tr>
 422       </table>
 423     </td>
 424   </tr>
 425 </table>
 426 <table cellspacing="5" cellpadding="0" border="0">
 427   <tr>
 428     <td>
 429       &nbsp;
 430     </td>
 431     <td>
 432
 433 <p>
 434 Returns true if a custom mode is set on a channel.
 435 <p>
 436 <dl compact><dt><b>Parameters:</b></dt><dd>
 437   <table border="0" cellspacing="2" cellpadding="0">
 438     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The mode character you wish to query </td></tr>
 439   </table>
 440 </dl>
 441 <dl compact><dt><b>Returns:</b></dt><dd>True if the custom mode is set, false if otherwise</dd></dl>
 442
 443 <p>
 444 Definition at line <a class="el" href="channels_8cpp-source.html#l00169">169</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00170"></a>00170 {
 445 <a name="l00171"></a>00171         <span class="keywordflow">return</span> (strchr(this-&gt;custom_modes,mode));
 446 <a name="l00172"></a>00172 }
 447 </pre></div>
 448 <p>
 449     </td>
 450   </tr>
 451 </table>
 452 <a class="anchor" name="SetCustomMode_28char_20mode_2C_20bool_20mode_5Fon_29"></a><!-- doxytag: member="chanrec::SetCustomMode" ref="SetCustomMode_28char_20mode_2C_20bool_20mode_5Fon_29" args="(char mode, bool mode_on)" --><p>
 453 <table class="mdTable" cellpadding="2" cellspacing="0">
 454   <tr>
 455     <td class="mdRow">
 456       <table cellpadding="0" cellspacing="0" border="0">
 457         <tr>
 458           <td class="md" nowrap valign="top">void chanrec::SetCustomMode           </td>
 459           <td class="md" valign="top">(&nbsp;</td>
 460           <td class="md" nowrap valign="top">char&nbsp;</td>
 461           <td class="mdname" nowrap> <em>mode</em>, </td>
 462         </tr>
 463         <tr>
 464           <td class="md" nowrap align="right"></td>
 465           <td class="md"></td>
 466           <td class="md" nowrap>bool&nbsp;</td>
 467           <td class="mdname" nowrap> <em>mode_on</em></td>
 468         </tr>
 469         <tr>
 470           <td class="md"></td>
 471           <td class="md">)&nbsp;</td>
 472           <td class="md" colspan="2"></td>
 473         </tr>
 474       </table>
 475     </td>
 476   </tr>
 477 </table>
 478 <table cellspacing="5" cellpadding="0" border="0">
 479   <tr>
 480     <td>
 481       &nbsp;
 482     </td>
 483     <td>
 484
 485 <p>
 486 Sets or unsets a custom mode in the channels info.
 487 <p>
 488 <dl compact><dt><b>Parameters:</b></dt><dd>
 489   <table border="0" cellspacing="2" cellpadding="0">
 490     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The mode character to set or unset </td></tr>
 491     <tr><td valign="top"></td><td valign="top"><em>mode_on</em>&nbsp;</td><td>True if you want to set the mode or false if you want to remove it</td></tr>
 492   </table>
 493 </dl>
 494
 495 <p>
 496 Definition at line <a class="el" href="channels_8cpp-source.html#l00113">113</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 497 <p>
 498 References <a class="el" href="channels_8h-source.html#l00110">custom_modes</a>, <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="channels_8cpp-source.html#l00138">SetCustomModeParam()</a>.<div class="fragment"><pre class="fragment"><a name="l00114"></a>00114 {
 499 <a name="l00115"></a>00115         <span class="keywordflow">if</span> (mode_on) {
 500 <a name="l00116"></a>00116                 <span class="keyword">static</span> <span class="keywordtype">char</span> m[3];
 501 <a name="l00117"></a>00117                 m[0] = mode;
 502 <a name="l00118"></a>00118                 m[1] = <span class="charliteral">'\0'</span>;
 503 <a name="l00119"></a>00119                 <span class="keywordflow">if</span> (!strchr(this-&gt;custom_modes,mode))
 504 <a name="l00120"></a>00120                 {
 505 <a name="l00121"></a>00121                         strlcat(<a class="code" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">custom_modes</a>,m,MAXMODES);
 506 <a name="l00122"></a>00122                 }
 507 <a name="l00123"></a>00123                 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Custom mode %c set"</span>,mode);
 508 <a name="l00124"></a>00124         }
 509 <a name="l00125"></a>00125         <span class="keywordflow">else</span> {
 510 <a name="l00126"></a>00126
 511 <a name="l00127"></a>00127                 <a class="code" href="namespaceirc.html#string">std::string</a> a = this-&gt;<a class="code" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">custom_modes</a>;
 512 <a name="l00128"></a>00128                 <span class="keywordtype">int</span> pos = a.find(mode);
 513 <a name="l00129"></a>00129                 a.erase(pos,1);
 514 <a name="l00130"></a>00130                 strncpy(this-&gt;custom_modes,a.c_str(),MAXMODES);
 515 <a name="l00131"></a>00131
 516 <a name="l00132"></a>00132                 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Custom mode %c removed: modelist='%s'"</span>,mode,this-&gt;custom_modes);
 517 <a name="l00133"></a>00133                 this-&gt;<a class="code" href="classchanrec.html#SetCustomModeParam_28char_20mode_2C_20char_20_2Aparameter_2C_20bool_20mode_5Fon_29">SetCustomModeParam</a>(mode,<span class="stringliteral">""</span>,<span class="keyword">false</span>);
 518 <a name="l00134"></a>00134         }
 519 <a name="l00135"></a>00135 }
 520 </pre></div>
 521 <p>
 522     </td>
 523   </tr>
 524 </table>
 525 <a class="anchor" name="SetCustomModeParam_28char_20mode_2C_20char_20_2Aparameter_2C_20bool_20mode_5Fon_29"></a><!-- doxytag: member="chanrec::SetCustomModeParam" ref="SetCustomModeParam_28char_20mode_2C_20char_20_2Aparameter_2C_20bool_20mode_5Fon_29" args="(char mode, char *parameter, bool mode_on)" --><p>
 526 <table class="mdTable" cellpadding="2" cellspacing="0">
 527   <tr>
 528     <td class="mdRow">
 529       <table cellpadding="0" cellspacing="0" border="0">
 530         <tr>
 531           <td class="md" nowrap valign="top">void chanrec::SetCustomModeParam           </td>
 532           <td class="md" valign="top">(&nbsp;</td>
 533           <td class="md" nowrap valign="top">char&nbsp;</td>
 534           <td class="mdname" nowrap> <em>mode</em>, </td>
 535         </tr>
 536         <tr>
 537           <td class="md" nowrap align="right"></td>
 538           <td class="md"></td>
 539           <td class="md" nowrap>char *&nbsp;</td>
 540           <td class="mdname" nowrap> <em>parameter</em>, </td>
 541         </tr>
 542         <tr>
 543           <td class="md" nowrap align="right"></td>
 544           <td class="md"></td>
 545           <td class="md" nowrap>bool&nbsp;</td>
 546           <td class="mdname" nowrap> <em>mode_on</em></td>
 547         </tr>
 548         <tr>
 549           <td class="md"></td>
 550           <td class="md">)&nbsp;</td>
 551           <td class="md" colspan="2"></td>
 552         </tr>
 553       </table>
 554     </td>
 555   </tr>
 556 </table>
 557 <table cellspacing="5" cellpadding="0" border="0">
 558   <tr>
 559     <td>
 560       &nbsp;
 561     </td>
 562     <td>
 563
 564 <p>
 565 Sets or unsets the parameters for a custom mode in a channels info.
 566 <p>
 567 <dl compact><dt><b>Parameters:</b></dt><dd>
 568   <table border="0" cellspacing="2" cellpadding="0">
 569     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The mode character to set or unset </td></tr>
 570     <tr><td valign="top"></td><td valign="top"><em>parameter</em>&nbsp;</td><td>The parameter string to associate with this mode character </td></tr>
 571     <tr><td valign="top"></td><td valign="top"><em>mode_on</em>&nbsp;</td><td>True if you want to set the mode or false if you want to remove it</td></tr>
 572   </table>
 573 </dl>
 574
 575 <p>
 576 Definition at line <a class="el" href="channels_8cpp-source.html#l00138">138</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 577 <p>
 578 References <a class="el" href="channels_8h-source.html#l00082">ModeParameter::channel</a>, <a class="el" href="channels_8cpp-source.html#l00099">custom_mode_params</a>, <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="channels_8h-source.html#l00080">ModeParameter::mode</a>, and <a class="el" href="channels_8h-source.html#l00081">ModeParameter::parameter</a>.
 579 <p>
 580 Referenced by <a class="el" href="channels_8cpp-source.html#l00113">SetCustomMode()</a>.<div class="fragment"><pre class="fragment"><a name="l00139"></a>00139 {
 581 <a name="l00140"></a>00140
 582 <a name="l00141"></a>00141         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"SetCustomModeParam called"</span>);
 583 <a name="l00142"></a>00142         <a class="code" href="classModeParameter.html">ModeParameter</a> M;
 584 <a name="l00143"></a>00143         M.<a class="code" href="classModeParameter.html#mode">mode</a> = mode;
 585 <a name="l00144"></a>00144         strlcpy(M.<a class="code" href="classModeParameter.html#channel_5BCHANMAX_5D">channel</a>,this-&gt;name,CHANMAX);
 586 <a name="l00145"></a>00145         strlcpy(M.<a class="code" href="classModeParameter.html#parameter_5BMAXBUF_5D">parameter</a>,parameter,MAXBUF);
 587 <a name="l00146"></a>00146         <span class="keywordflow">if</span> (mode_on)
 588 <a name="l00147"></a>00147         {
 589 <a name="l00148"></a>00148                 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Custom mode parameter %c %s added"</span>,mode,parameter);
 590 <a name="l00149"></a>00149                 <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.push_back(M);
 591 <a name="l00150"></a>00150         }
 592 <a name="l00151"></a>00151         <span class="keywordflow">else</span>
 593 <a name="l00152"></a>00152         {
 594 <a name="l00153"></a>00153                 <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.size())
 595 <a name="l00154"></a>00154                 {
 596 <a name="l00155"></a>00155                         <span class="keywordflow">for</span> (vector&lt;ModeParameter&gt;::iterator i = <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.begin(); i &lt; <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.end(); i++)
 597 <a name="l00156"></a>00156                         {
 598 <a name="l00157"></a>00157                                 <span class="keywordflow">if</span> ((i-&gt;mode == mode) &amp;&amp; (!strcasecmp(this-&gt;name,i-&gt;channel)))
 599 <a name="l00158"></a>00158                                 {
 600 <a name="l00159"></a>00159                                         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Custom mode parameter %c %s removed"</span>,mode,parameter);
 601 <a name="l00160"></a>00160                                         <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.erase(i);
 602 <a name="l00161"></a>00161                                         <span class="keywordflow">return</span>;
 603 <a name="l00162"></a>00162                                 }
 604 <a name="l00163"></a>00163                         }
 605 <a name="l00164"></a>00164                 }
 606 <a name="l00165"></a>00165                 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** BUG *** Attempt to remove non-existent mode parameter!"</span>);
 607 <a name="l00166"></a>00166         }
 608 <a name="l00167"></a>00167 }
 609 </pre></div>
 610 <p>
 611     </td>
 612   </tr>
 613 </table>
 614 <hr><h2>Member Data Documentation</h2>
 615 <a class="anchor" name="bans"></a><!-- doxytag: member="chanrec::bans" ref="bans" args="" --><p>
 616 <table class="mdTable" cellpadding="2" cellspacing="0">
 617   <tr>
 618     <td class="mdRow">
 619       <table cellpadding="0" cellspacing="0" border="0">
 620         <tr>
 621           <td class="md" nowrap valign="top"><a class="el" href="channels_8h.html#BanList">BanList</a> <a class="el" href="classchanrec.html#bans">chanrec::bans</a>          </td>
 622         </tr>
 623       </table>
 624     </td>
 625   </tr>
 626 </table>
 627 <table cellspacing="5" cellpadding="0" border="0">
 628   <tr>
 629     <td>
 630       &nbsp;
 631     </td>
 632     <td>
 633
 634 <p>
 635 The list of all bans set on the channel.
 636 <p>
 637
 638 <p>
 639 Definition at line <a class="el" href="channels_8h-source.html#l00149">149</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 640   </tr>
 641 </table>
 642 <a class="anchor" name="binarymodes"></a><!-- doxytag: member="chanrec::binarymodes" ref="binarymodes" args="" --><p>
 643 <table class="mdTable" cellpadding="2" cellspacing="0">
 644   <tr>
 645     <td class="mdRow">
 646       <table cellpadding="0" cellspacing="0" border="0">
 647         <tr>
 648           <td class="md" nowrap valign="top">char <a class="el" href="classchanrec.html#binarymodes">chanrec::binarymodes</a>          </td>
 649         </tr>
 650       </table>
 651     </td>
 652   </tr>
 653 </table>
 654 <table cellspacing="5" cellpadding="0" border="0">
 655   <tr>
 656     <td>
 657       &nbsp;
 658     </td>
 659     <td>
 660
 661 <p>
 662 Contains a bitmask of the CM_* builtin (RFC) binary mode symbols.
 663 <p>
 664
 665 <p>
 666 Definition at line <a class="el" href="channels_8h-source.html#l00145">145</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 667 <p>
 668 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>.    </td>
 669   </tr>
 670 </table>
 671 <a class="anchor" name="created"></a><!-- doxytag: member="chanrec::created" ref="created" args="" --><p>
 672 <table class="mdTable" cellpadding="2" cellspacing="0">
 673   <tr>
 674     <td class="mdRow">
 675       <table cellpadding="0" cellspacing="0" border="0">
 676         <tr>
 677           <td class="md" nowrap valign="top">time_t <a class="el" href="classchanrec.html#created">chanrec::created</a>          </td>
 678         </tr>
 679       </table>
 680     </td>
 681   </tr>
 682 </table>
 683 <table cellspacing="5" cellpadding="0" border="0">
 684   <tr>
 685     <td>
 686       &nbsp;
 687     </td>
 688     <td>
 689
 690 <p>
 691 Creation time.
 692 <p>
 693
 694 <p>
 695 Definition at line <a class="el" href="channels_8h-source.html#l00123">123</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 696 <p>
 697 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>.    </td>
 698   </tr>
 699 </table>
 700 <a class="anchor" name="custom_5Fmodes_5BMAXMODES_5D"></a><!-- doxytag: member="chanrec::custom_modes" ref="custom_5Fmodes_5BMAXMODES_5D" args="[MAXMODES]" --><p>
 701 <table class="mdTable" cellpadding="2" cellspacing="0">
 702   <tr>
 703     <td class="mdRow">
 704       <table cellpadding="0" cellspacing="0" border="0">
 705         <tr>
 706           <td class="md" nowrap valign="top">char <a class="el" href="classchanrec.html#custom_5Fmodes_5BMAXMODES_5D">chanrec::custom_modes</a>[MAXMODES]          </td>
 707         </tr>
 708       </table>
 709     </td>
 710   </tr>
 711 </table>
 712 <table cellspacing="5" cellpadding="0" border="0">
 713   <tr>
 714     <td>
 715       &nbsp;
 716     </td>
 717     <td>
 718
 719 <p>
 720 Custom modes for the channel.
 721 <p>
 722 Plugins may use this field in any way they see fit.
 723 <p>
 724 Definition at line <a class="el" href="channels_8h-source.html#l00110">110</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 725 <p>
 726 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, and <a class="el" href="channels_8cpp-source.html#l00113">SetCustomMode()</a>.    </td>
 727   </tr>
 728 </table>
 729 <a class="anchor" name="internal_5Fuserlist"></a><!-- doxytag: member="chanrec::internal_userlist" ref="internal_5Fuserlist" args="" --><p>
 730 <table class="mdTable" cellpadding="2" cellspacing="0">
 731   <tr>
 732     <td class="mdRow">
 733       <table cellpadding="0" cellspacing="0" border="0">
 734         <tr>
 735           <td class="md" nowrap valign="top">std::vector&lt;char*&gt; <a class="el" href="classchanrec.html#internal_5Fuserlist">chanrec::internal_userlist</a>          </td>
 736         </tr>
 737       </table>
 738     </td>
 739   </tr>
 740 </table>
 741 <table cellspacing="5" cellpadding="0" border="0">
 742   <tr>
 743     <td>
 744       &nbsp;
 745     </td>
 746     <td>
 747
 748 <p>
 749 User list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!).
 750 <p>
 751
 752 <p>
 753 Definition at line <a class="el" href="channels_8h-source.html#l00115">115</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 754 <p>
 755 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">AddUser()</a>, <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, <a class="el" href="channels_8cpp-source.html#l00200">DelUser()</a>, and <a class="el" href="channels_8cpp-source.html#l00214">GetUsers()</a>.    </td>
 756   </tr>
 757 </table>
 758 <a class="anchor" name="key_5B_33_32_5D"></a><!-- doxytag: member="chanrec::key" ref="key_5B_33_32_5D" args="[32]" --><p>
 759 <table class="mdTable" cellpadding="2" cellspacing="0">
 760   <tr>
 761     <td class="mdRow">
 762       <table cellpadding="0" cellspacing="0" border="0">
 763         <tr>
 764           <td class="md" nowrap valign="top">char <a class="el" href="classchanrec.html#key_5B_33_32_5D">chanrec::key</a>[32]          </td>
 765         </tr>
 766       </table>
 767     </td>
 768   </tr>
 769 </table>
 770 <table cellspacing="5" cellpadding="0" border="0">
 771   <tr>
 772     <td>
 773       &nbsp;
 774     </td>
 775     <td>
 776
 777 <p>
 778 Contains the channel key.
 779 <p>
 780 If this value is an empty string, there is no channel key in place.
 781 <p>
 782 Definition at line <a class="el" href="channels_8h-source.html#l00141">141</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 783 <p>
 784 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>.    </td>
 785   </tr>
 786 </table>
 787 <a class="anchor" name="limit"></a><!-- doxytag: member="chanrec::limit" ref="limit" args="" --><p>
 788 <table class="mdTable" cellpadding="2" cellspacing="0">
 789   <tr>
 790     <td class="mdRow">
 791       <table cellpadding="0" cellspacing="0" border="0">
 792         <tr>
 793           <td class="md" nowrap valign="top">short int <a class="el" href="classchanrec.html#limit">chanrec::limit</a>          </td>
 794         </tr>
 795       </table>
 796     </td>
 797   </tr>
 798 </table>
 799 <table cellspacing="5" cellpadding="0" border="0">
 800   <tr>
 801     <td>
 802       &nbsp;
 803     </td>
 804     <td>
 805
 806 <p>
 807 Contains the channel user limit.
 808 <p>
 809 If this value is zero, there is no limit in place.
 810 <p>
 811 Definition at line <a class="el" href="channels_8h-source.html#l00136">136</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 812 <p>
 813 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>.    </td>
 814   </tr>
 815 </table>
 816 <a class="anchor" name="name_5BCHANMAX_5D"></a><!-- doxytag: member="chanrec::name" ref="name_5BCHANMAX_5D" args="[CHANMAX]" --><p>
 817 <table class="mdTable" cellpadding="2" cellspacing="0">
 818   <tr>
 819     <td class="mdRow">
 820       <table cellpadding="0" cellspacing="0" border="0">
 821         <tr>
 822           <td class="md" nowrap valign="top">char <a class="el" href="classchanrec.html#name_5BCHANMAX_5D">chanrec::name</a>[CHANMAX]          </td>
 823         </tr>
 824       </table>
 825     </td>
 826   </tr>
 827 </table>
 828 <table cellspacing="5" cellpadding="0" border="0">
 829   <tr>
 830     <td>
 831       &nbsp;
 832     </td>
 833     <td>
 834
 835 <p>
 836 The channels name.
 837 <p>
 838
 839 <p>
 840 Definition at line <a class="el" href="channels_8h-source.html#l00106">106</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 841 <p>
 842 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, <a class="el" href="channels_8cpp-source.html#l00200">DelUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>.    </td>
 843   </tr>
 844 </table>
 845 <a class="anchor" name="setby_5BNICKMAX_5D"></a><!-- doxytag: member="chanrec::setby" ref="setby_5BNICKMAX_5D" args="[NICKMAX]" --><p>
 846 <table class="mdTable" cellpadding="2" cellspacing="0">
 847   <tr>
 848     <td class="mdRow">
 849       <table cellpadding="0" cellspacing="0" border="0">
 850         <tr>
 851           <td class="md" nowrap valign="top">char <a class="el" href="classchanrec.html#setby_5BNICKMAX_5D">chanrec::setby</a>[NICKMAX]          </td>
 852         </tr>
 853       </table>
 854     </td>
 855   </tr>
 856 </table>
 857 <table cellspacing="5" cellpadding="0" border="0">
 858   <tr>
 859     <td>
 860       &nbsp;
 861     </td>
 862     <td>
 863
 864 <p>
 865 The last user to set the topic.
 866 <p>
 867 If this member is an empty string, no topic was ever set.
 868 <p>
 869 Definition at line <a class="el" href="channels_8h-source.html#l00131">131</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 870 <p>
 871 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>.    </td>
 872   </tr>
 873 </table>
 874 <a class="anchor" name="topic_5BMAXBUF_5D"></a><!-- doxytag: member="chanrec::topic" ref="topic_5BMAXBUF_5D" args="[MAXBUF]" --><p>
 875 <table class="mdTable" cellpadding="2" cellspacing="0">
 876   <tr>
 877     <td class="mdRow">
 878       <table cellpadding="0" cellspacing="0" border="0">
 879         <tr>
 880           <td class="md" nowrap valign="top">char <a class="el" href="classchanrec.html#topic_5BMAXBUF_5D">chanrec::topic</a>[MAXBUF]          </td>
 881         </tr>
 882       </table>
 883     </td>
 884   </tr>
 885 </table>
 886 <table cellspacing="5" cellpadding="0" border="0">
 887   <tr>
 888     <td>
 889       &nbsp;
 890     </td>
 891     <td>
 892
 893 <p>
 894 Channel topic.
 895 <p>
 896 If this is an empty string, no channel topic is set.
 897 <p>
 898 Definition at line <a class="el" href="channels_8h-source.html#l00120">120</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 899 <p>
 900 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>.    </td>
 901   </tr>
 902 </table>
 903 <a class="anchor" name="topicset"></a><!-- doxytag: member="chanrec::topicset" ref="topicset" args="" --><p>
 904 <table class="mdTable" cellpadding="2" cellspacing="0">
 905   <tr>
 906     <td class="mdRow">
 907       <table cellpadding="0" cellspacing="0" border="0">
 908         <tr>
 909           <td class="md" nowrap valign="top">time_t <a class="el" href="classchanrec.html#topicset">chanrec::topicset</a>          </td>
 910         </tr>
 911       </table>
 912     </td>
 913   </tr>
 914 </table>
 915 <table cellspacing="5" cellpadding="0" border="0">
 916   <tr>
 917     <td>
 918       &nbsp;
 919     </td>
 920     <td>
 921
 922 <p>
 923 Time topic was set.
 924 <p>
 925 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#created">chanrec::created</a>
 926 <p>
 927 Definition at line <a class="el" href="channels_8h-source.html#l00127">127</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 928 <p>
 929 Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>.    </td>
 930   </tr>
 931 </table>
 932 <hr>The documentation for this class was generated from the following files:<ul>
 933 <li><a class="el" href="channels_8h-source.html">channels.h</a><li><a class="el" href="channels_8cpp-source.html">channels.cpp</a></ul>
 934 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 18:31:01 2005 for InspIRCd by&nbsp;
 935 <a href="http://www.doxygen.org/index.html">
 936 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 937 </body>
 938 </html>