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>chanrec class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3-rc2 -->
8 <a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
9 <hr><h1>chanrec Class Reference</h1>Holds all relevent information for a channel.
10 <a href="#_details">More...</a>
12 <code>#include <<a class="el" href="channels_8h-source.html">channels.h</a>></code>
14 <p>Inheritance diagram for chanrec:
15 <p><center><img src="classchanrec.png" usemap="#chanrec_map" border="0" alt=""></center>
16 <map name="chanrec_map">
17 <area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,68,24">
19 <a href="classchanrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
22 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classchanrec.html#a0">chanrec</a> ()</td></tr>
23 <tr><td> </td><td><font size=-1><em>Creates a channel record and initialises it with default values.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
24 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classchanrec.html#a1">~chanrec</a> ()</td></tr>
25 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
26 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m0">name</a> [CHANMAX]</td></tr>
27 <tr><td> </td><td><font size=-1><em>The channels name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
28 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m1">custom_modes</a> [MAXMODES]</td></tr>
29 <tr><td> </td><td><font size=-1><em>Custom modes for the channel.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
30 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m2">topic</a> [MAXBUF]</td></tr>
31 <tr><td> </td><td><font size=-1><em>Channel topic.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
32 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m3">created</a></td></tr>
33 <tr><td> </td><td><font size=-1><em>Creation time.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
34 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m4">topicset</a></td></tr>
35 <tr><td> </td><td><font size=-1><em>Time topic was set.</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
36 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m5">setby</a> [NICKMAX]</td></tr>
37 <tr><td> </td><td><font size=-1><em>The last user to set the topic.</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
38 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classchanrec.html#m6">limit</a></td></tr>
39 <tr><td> </td><td><font size=-1><em>Contains the channel user limit.</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
40 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m7">key</a> [32]</td></tr>
41 <tr><td> </td><td><font size=-1><em>Contains the channel key.</em> <a href="#m7"></a><em></em></font><br><br></td></tr>
42 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m8">topiclock</a></td></tr>
43 <tr><td> </td><td><font size=-1><em>Nonzero if the mode +t is set.</em> <a href="#m8"></a><em></em></font><br><br></td></tr>
44 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m9">noexternal</a></td></tr>
45 <tr><td> </td><td><font size=-1><em>Nonzero if the mode +n is set.</em> <a href="#m9"></a><em></em></font><br><br></td></tr>
46 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m10">inviteonly</a></td></tr>
47 <tr><td> </td><td><font size=-1><em>Nonzero if the mode +i is set.</em> <a href="#m10"></a><em></em></font><br><br></td></tr>
48 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m11">moderated</a></td></tr>
49 <tr><td> </td><td><font size=-1><em>Nonzero if the mode +m is set.</em> <a href="#m11"></a><em></em></font><br><br></td></tr>
50 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m12">secret</a></td></tr>
51 <tr><td> </td><td><font size=-1><em>Nonzero if the mode +s is set.</em> <a href="#m12"></a><em></em></font><br><br></td></tr>
52 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m13">c_private</a></td></tr>
53 <tr><td> </td><td><font size=-1><em>Nonzero if the mode +p is set.</em> <a href="#m13"></a><em></em></font><br><br></td></tr>
54 <tr><td nowrap align=right valign=top><a class="el" href="channels_8h.html#a5">BanList</a> </td><td valign=bottom><a class="el" href="classchanrec.html#m14">bans</a></td></tr>
55 <tr><td> </td><td><font size=-1><em>The list of all bans set on the channel.</em> <a href="#m14"></a><em></em></font><br><br></td></tr>
57 <hr><a name="_details"></a><h2>Detailed Description</h2>
58 Holds all relevent information for a channel.
60 This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.
64 Definition at line <a class="el" href="channels_8h-source.html#l00090">90</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
65 <a name="a0" doxytag="chanrec::chanrec"></a><p>
66 <table width="100%" cellpadding="2" cellspacing="0" border="0">
69 <table cellpadding="0" cellspacing="0" border="0">
71 <td class="md" nowrap valign="top"> chanrec::chanrec </td>
72 <td class="md" valign="top">( </td>
73 <td class="mdname1" valign="top" nowrap> </td>
74 <td class="md" valign="top">) </td>
75 <td class="md" nowrap><code> [inline]</code></td>
82 <table cellspacing=5 cellpadding=0 border=0>
90 Creates a channel record and initialises it with default values.
94 Definition at line <a class="el" href="channels_8h-source.html#l00158">158</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
96 <div class="fragment"><pre>00159 {
97 00160 strcpy(name,<span class="stringliteral">""</span>);
98 00161 strcpy(custom_modes,<span class="stringliteral">""</span>);
99 00162 strcpy(topic,<span class="stringliteral">""</span>);
100 00163 strcpy(setby,<span class="stringliteral">""</span>);
101 00164 strcpy(key,<span class="stringliteral">""</span>);
102 00165 <a class="code" href="classchanrec.html#m3">created</a> = <a class="code" href="classchanrec.html#m4">topicset</a> = <a class="code" href="classchanrec.html#m6">limit</a> = 0;
103 00166 <a class="code" href="classchanrec.html#m8">topiclock</a> = <a class="code" href="classchanrec.html#m9">noexternal</a> = <a class="code" href="classchanrec.html#m10">inviteonly</a> = <a class="code" href="classchanrec.html#m11">moderated</a> = <a class="code" href="classchanrec.html#m12">secret</a> = <a class="code" href="classchanrec.html#m13">c_private</a> = <span class="keyword">false</span>;
108 <a name="a1" doxytag="chanrec::~chanrec"></a><p>
109 <table width="100%" cellpadding="2" cellspacing="0" border="0">
112 <table cellpadding="0" cellspacing="0" border="0">
114 <td class="md" nowrap valign="top"> virtual chanrec::~chanrec </td>
115 <td class="md" valign="top">( </td>
116 <td class="mdname1" valign="top" nowrap> </td>
117 <td class="md" valign="top">) </td>
118 <td class="md" nowrap><code> [inline, virtual]</code></td>
125 <table cellspacing=5 cellpadding=0 border=0>
135 Definition at line <a class="el" href="channels_8h-source.html#l00169">169</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
137 <div class="fragment"><pre>00169 { <span class="comment">/* stub */</span> }
141 <hr><h2>Member Data Documentation</h2>
142 <a name="m14" doxytag="chanrec::bans"></a><p>
143 <table width="100%" cellpadding="2" cellspacing="0" border="0">
146 <table cellpadding="0" cellspacing="0" border="0">
148 <td class="md" nowrap valign="top"> <a class="el" href="channels_8h.html#a5">BanList</a> chanrec::bans
153 <table cellspacing=5 cellpadding=0 border=0>
161 The list of all bans set on the channel.
165 Definition at line <a class="el" href="channels_8h-source.html#l00154">154</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
168 <a name="m13" doxytag="chanrec::c_private"></a><p>
169 <table width="100%" cellpadding="2" cellspacing="0" border="0">
172 <table cellpadding="0" cellspacing="0" border="0">
174 <td class="md" nowrap valign="top"> short int chanrec::c_private
179 <table cellspacing=5 cellpadding=0 border=0>
187 Nonzero if the mode +p is set.
189 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a>
191 Definition at line <a class="el" href="channels_8h-source.html#l00150">150</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
194 <a name="m3" doxytag="chanrec::created"></a><p>
195 <table width="100%" cellpadding="2" cellspacing="0" border="0">
198 <table cellpadding="0" cellspacing="0" border="0">
200 <td class="md" nowrap valign="top"> time_t chanrec::created
205 <table cellspacing=5 cellpadding=0 border=0>
217 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>. </td>
220 <a name="m1" doxytag="chanrec::custom_modes"></a><p>
221 <table width="100%" cellpadding="2" cellspacing="0" border="0">
224 <table cellpadding="0" cellspacing="0" border="0">
226 <td class="md" nowrap valign="top"> char chanrec::custom_modes[MAXMODES]
231 <table cellspacing=5 cellpadding=0 border=0>
239 Custom modes for the channel.
241 Plugins may use this field in any way they see fit.
243 Definition at line <a class="el" href="channels_8h-source.html#l00099">99</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
246 <a name="m10" doxytag="chanrec::inviteonly"></a><p>
247 <table width="100%" cellpadding="2" cellspacing="0" border="0">
250 <table cellpadding="0" cellspacing="0" border="0">
252 <td class="md" nowrap valign="top"> short int chanrec::inviteonly
257 <table cellspacing=5 cellpadding=0 border=0>
265 Nonzero if the mode +i is set.
269 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>. </td>
272 <a name="m7" doxytag="chanrec::key"></a><p>
273 <table width="100%" cellpadding="2" cellspacing="0" border="0">
276 <table cellpadding="0" cellspacing="0" border="0">
278 <td class="md" nowrap valign="top"> char chanrec::key[32]
283 <table cellspacing=5 cellpadding=0 border=0>
291 Contains the channel key.
293 If this value is an empty string, there is no channel key in place.
295 Definition at line <a class="el" href="channels_8h-source.html#l00124">124</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
298 <a name="m6" doxytag="chanrec::limit"></a><p>
299 <table width="100%" cellpadding="2" cellspacing="0" border="0">
302 <table cellpadding="0" cellspacing="0" border="0">
304 <td class="md" nowrap valign="top"> long chanrec::limit
309 <table cellspacing=5 cellpadding=0 border=0>
317 Contains the channel user limit.
319 If this value is zero, there is no limit in place.
321 Definition at line <a class="el" href="channels_8h-source.html#l00119">119</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
324 <a name="m11" doxytag="chanrec::moderated"></a><p>
325 <table width="100%" cellpadding="2" cellspacing="0" border="0">
328 <table cellpadding="0" cellspacing="0" border="0">
330 <td class="md" nowrap valign="top"> short int chanrec::moderated
335 <table cellspacing=5 cellpadding=0 border=0>
343 Nonzero if the mode +m is set.
347 Definition at line <a class="el" href="channels_8h-source.html#l00140">140</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
350 <a name="m0" doxytag="chanrec::name"></a><p>
351 <table width="100%" cellpadding="2" cellspacing="0" border="0">
354 <table cellpadding="0" cellspacing="0" border="0">
356 <td class="md" nowrap valign="top"> char chanrec::name[CHANMAX]
361 <table cellspacing=5 cellpadding=0 border=0>
373 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>
376 <a name="m9" doxytag="chanrec::noexternal"></a><p>
377 <table width="100%" cellpadding="2" cellspacing="0" border="0">
380 <table cellpadding="0" cellspacing="0" border="0">
382 <td class="md" nowrap valign="top"> short int chanrec::noexternal
387 <table cellspacing=5 cellpadding=0 border=0>
395 Nonzero if the mode +n is set.
399 Definition at line <a class="el" href="channels_8h-source.html#l00132">132</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
402 <a name="m12" doxytag="chanrec::secret"></a><p>
403 <table width="100%" cellpadding="2" cellspacing="0" border="0">
406 <table cellpadding="0" cellspacing="0" border="0">
408 <td class="md" nowrap valign="top"> short int chanrec::secret
413 <table cellspacing=5 cellpadding=0 border=0>
421 Nonzero if the mode +s is set.
423 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a>
425 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>. </td>
428 <a name="m5" doxytag="chanrec::setby"></a><p>
429 <table width="100%" cellpadding="2" cellspacing="0" border="0">
432 <table cellpadding="0" cellspacing="0" border="0">
434 <td class="md" nowrap valign="top"> char chanrec::setby[NICKMAX]
439 <table cellspacing=5 cellpadding=0 border=0>
447 The last user to set the topic.
449 If this member is an empty string, no topic was ever set.
451 Definition at line <a class="el" href="channels_8h-source.html#l00114">114</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
454 <a name="m2" doxytag="chanrec::topic"></a><p>
455 <table width="100%" cellpadding="2" cellspacing="0" border="0">
458 <table cellpadding="0" cellspacing="0" border="0">
460 <td class="md" nowrap valign="top"> char chanrec::topic[MAXBUF]
465 <table cellspacing=5 cellpadding=0 border=0>
475 If this is an empty string, no channel topic is set.
477 Definition at line <a class="el" href="channels_8h-source.html#l00103">103</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
480 <a name="m8" doxytag="chanrec::topiclock"></a><p>
481 <table width="100%" cellpadding="2" cellspacing="0" border="0">
484 <table cellpadding="0" cellspacing="0" border="0">
486 <td class="md" nowrap valign="top"> short int chanrec::topiclock
491 <table cellspacing=5 cellpadding=0 border=0>
499 Nonzero if the mode +t is set.
503 Definition at line <a class="el" href="channels_8h-source.html#l00128">128</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
506 <a name="m4" doxytag="chanrec::topicset"></a><p>
507 <table width="100%" cellpadding="2" cellspacing="0" border="0">
510 <table cellpadding="0" cellspacing="0" border="0">
512 <td class="md" nowrap valign="top"> time_t chanrec::topicset
517 <table cellspacing=5 cellpadding=0 border=0>
527 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a>
529 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>. </td>
532 <hr>The documentation for this class was generated from the following file:<ul>
533 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
534 <hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:41 2003 for InspIRCd by
535 <a href="http://www.doxygen.org/index.html">
536 <img src="doxygen.png" alt="doxygen" align="middle" border=0
537 width=110 height=53></a>1.3-rc2 </small></address>