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-rc3 -->
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 Inheritance diagram for chanrec:<p><center><img src="classchanrec__inherit__graph.gif" border="0" usemap="#chanrec__inherit__map" alt="Inheritance graph"></center>
15 <map name="chanrec__inherit__map">
16 <area href="classclassbase.html" shape="rect" coords="7,16,73,37" alt="">
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="classclassbase.html" shape="rect" coords="149,91,216,112" alt="">
22 <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 colspan=2><br><h2>Public Member Functions</h2></td></tr>
25 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classchanrec.html#a0">chanrec</a> ()</td></tr>
26 <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>
27 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classchanrec.html#a1">~chanrec</a> ()</td></tr>
28 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
29 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m0">name</a> [CHANMAX]</td></tr>
30 <tr><td> </td><td><font size=-1><em>The channels name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
31 <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>
32 <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>
33 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m2">topic</a> [MAXBUF]</td></tr>
34 <tr><td> </td><td><font size=-1><em>Channel topic.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
35 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m3">created</a></td></tr>
36 <tr><td> </td><td><font size=-1><em>Creation time.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
37 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m4">topicset</a></td></tr>
38 <tr><td> </td><td><font size=-1><em>Time topic was set.</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
39 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m5">setby</a> [NICKMAX]</td></tr>
40 <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>
41 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classchanrec.html#m6">limit</a></td></tr>
42 <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>
43 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m7">key</a> [32]</td></tr>
44 <tr><td> </td><td><font size=-1><em>Contains the channel key.</em> <a href="#m7"></a><em></em></font><br><br></td></tr>
45 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m8">topiclock</a></td></tr>
46 <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>
47 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m9">noexternal</a></td></tr>
48 <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>
49 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m10">inviteonly</a></td></tr>
50 <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>
51 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m11">moderated</a></td></tr>
52 <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>
53 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m12">secret</a></td></tr>
54 <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>
55 <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>
56 <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>
57 <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>
58 <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>
60 <hr><a name="_details"></a><h2>Detailed Description</h2>
61 Holds all relevent information for a channel.
63 This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.
67 Definition at line <a class="el" href="channels_8h-source.html#l00070">70</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
68 <a name="a0" doxytag="chanrec::chanrec"></a><p>
69 <table width="100%" cellpadding="2" cellspacing="0" border="0">
72 <table cellpadding="0" cellspacing="0" border="0">
74 <td class="md" nowrap valign="top"> chanrec::chanrec </td>
75 <td class="md" valign="top">( </td>
76 <td class="mdname1" valign="top" nowrap> </td>
77 <td class="md" valign="top">) </td>
78 <td class="md" nowrap><code> [inline]</code></td>
85 <table cellspacing=5 cellpadding=0 border=0>
93 Creates a channel record and initialises it with default values.
97 Definition at line <a class="el" href="channels_8h-source.html#l00138">138</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
99 <div class="fragment"><pre>00139 {
100 00140 strcpy(name,<span class="stringliteral">""</span>);
101 00141 strcpy(custom_modes,<span class="stringliteral">""</span>);
102 00142 strcpy(topic,<span class="stringliteral">""</span>);
103 00143 strcpy(setby,<span class="stringliteral">""</span>);
104 00144 strcpy(key,<span class="stringliteral">""</span>);
105 00145 <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;
106 00146 <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>;
111 <a name="a1" doxytag="chanrec::~chanrec"></a><p>
112 <table width="100%" cellpadding="2" cellspacing="0" border="0">
115 <table cellpadding="0" cellspacing="0" border="0">
117 <td class="md" nowrap valign="top"> virtual chanrec::~chanrec </td>
118 <td class="md" valign="top">( </td>
119 <td class="mdname1" valign="top" nowrap> </td>
120 <td class="md" valign="top">) </td>
121 <td class="md" nowrap><code> [inline, virtual]</code></td>
128 <table cellspacing=5 cellpadding=0 border=0>
138 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>.
140 <div class="fragment"><pre>00149 { <span class="comment">/* stub */</span> }
144 <hr><h2>Member Data Documentation</h2>
145 <a name="m14" doxytag="chanrec::bans"></a><p>
146 <table width="100%" cellpadding="2" cellspacing="0" border="0">
149 <table cellpadding="0" cellspacing="0" border="0">
151 <td class="md" nowrap valign="top"> <a class="el" href="channels_8h.html#a5">BanList</a> chanrec::bans
156 <table cellspacing=5 cellpadding=0 border=0>
164 The list of all bans set on the channel.
168 Definition at line <a class="el" href="channels_8h-source.html#l00134">134</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
171 <a name="m13" doxytag="chanrec::c_private"></a><p>
172 <table width="100%" cellpadding="2" cellspacing="0" border="0">
175 <table cellpadding="0" cellspacing="0" border="0">
177 <td class="md" nowrap valign="top"> short int chanrec::c_private
182 <table cellspacing=5 cellpadding=0 border=0>
190 Nonzero if the mode +p is set.
192 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a>
194 Definition at line <a class="el" href="channels_8h-source.html#l00130">130</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
197 <a name="m3" doxytag="chanrec::created"></a><p>
198 <table width="100%" cellpadding="2" cellspacing="0" border="0">
201 <table cellpadding="0" cellspacing="0" border="0">
203 <td class="md" nowrap valign="top"> time_t chanrec::created
208 <table cellspacing=5 cellpadding=0 border=0>
220 Definition at line <a class="el" href="channels_8h-source.html#l00086">86</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
223 <a name="m1" doxytag="chanrec::custom_modes"></a><p>
224 <table width="100%" cellpadding="2" cellspacing="0" border="0">
227 <table cellpadding="0" cellspacing="0" border="0">
229 <td class="md" nowrap valign="top"> char chanrec::custom_modes[MAXMODES]
234 <table cellspacing=5 cellpadding=0 border=0>
242 Custom modes for the channel.
244 Plugins may use this field in any way they see fit.
246 Definition at line <a class="el" href="channels_8h-source.html#l00079">79</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
249 <a name="m10" doxytag="chanrec::inviteonly"></a><p>
250 <table width="100%" cellpadding="2" cellspacing="0" border="0">
253 <table cellpadding="0" cellspacing="0" border="0">
255 <td class="md" nowrap valign="top"> short int chanrec::inviteonly
260 <table cellspacing=5 cellpadding=0 border=0>
268 Nonzero if the mode +i is set.
272 Definition at line <a class="el" href="channels_8h-source.html#l00116">116</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
275 <a name="m7" doxytag="chanrec::key"></a><p>
276 <table width="100%" cellpadding="2" cellspacing="0" border="0">
279 <table cellpadding="0" cellspacing="0" border="0">
281 <td class="md" nowrap valign="top"> char chanrec::key[32]
286 <table cellspacing=5 cellpadding=0 border=0>
294 Contains the channel key.
296 If this value is an empty string, there is no channel key in place.
298 Definition at line <a class="el" href="channels_8h-source.html#l00104">104</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
301 <a name="m6" doxytag="chanrec::limit"></a><p>
302 <table width="100%" cellpadding="2" cellspacing="0" border="0">
305 <table cellpadding="0" cellspacing="0" border="0">
307 <td class="md" nowrap valign="top"> long chanrec::limit
312 <table cellspacing=5 cellpadding=0 border=0>
320 Contains the channel user limit.
322 If this value is zero, there is no limit in place.
324 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>
327 <a name="m11" doxytag="chanrec::moderated"></a><p>
328 <table width="100%" cellpadding="2" cellspacing="0" border="0">
331 <table cellpadding="0" cellspacing="0" border="0">
333 <td class="md" nowrap valign="top"> short int chanrec::moderated
338 <table cellspacing=5 cellpadding=0 border=0>
346 Nonzero if the mode +m is set.
350 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>. </td>
353 <a name="m0" doxytag="chanrec::name"></a><p>
354 <table width="100%" cellpadding="2" cellspacing="0" border="0">
357 <table cellpadding="0" cellspacing="0" border="0">
359 <td class="md" nowrap valign="top"> char chanrec::name[CHANMAX]
364 <table cellspacing=5 cellpadding=0 border=0>
376 Definition at line <a class="el" href="channels_8h-source.html#l00075">75</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
379 <a name="m9" doxytag="chanrec::noexternal"></a><p>
380 <table width="100%" cellpadding="2" cellspacing="0" border="0">
383 <table cellpadding="0" cellspacing="0" border="0">
385 <td class="md" nowrap valign="top"> short int chanrec::noexternal
390 <table cellspacing=5 cellpadding=0 border=0>
398 Nonzero if the mode +n is set.
402 Definition at line <a class="el" href="channels_8h-source.html#l00112">112</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
405 <a name="m12" doxytag="chanrec::secret"></a><p>
406 <table width="100%" cellpadding="2" cellspacing="0" border="0">
409 <table cellpadding="0" cellspacing="0" border="0">
411 <td class="md" nowrap valign="top"> short int chanrec::secret
416 <table cellspacing=5 cellpadding=0 border=0>
424 Nonzero if the mode +s is set.
426 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a>
428 Definition at line <a class="el" href="channels_8h-source.html#l00125">125</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
431 <a name="m5" doxytag="chanrec::setby"></a><p>
432 <table width="100%" cellpadding="2" cellspacing="0" border="0">
435 <table cellpadding="0" cellspacing="0" border="0">
437 <td class="md" nowrap valign="top"> char chanrec::setby[NICKMAX]
442 <table cellspacing=5 cellpadding=0 border=0>
450 The last user to set the topic.
452 If this member is an empty string, no topic was ever set.
454 Definition at line <a class="el" href="channels_8h-source.html#l00094">94</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
457 <a name="m2" doxytag="chanrec::topic"></a><p>
458 <table width="100%" cellpadding="2" cellspacing="0" border="0">
461 <table cellpadding="0" cellspacing="0" border="0">
463 <td class="md" nowrap valign="top"> char chanrec::topic[MAXBUF]
468 <table cellspacing=5 cellpadding=0 border=0>
478 If this is an empty string, no channel topic is set.
480 Definition at line <a class="el" href="channels_8h-source.html#l00083">83</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
483 <a name="m8" doxytag="chanrec::topiclock"></a><p>
484 <table width="100%" cellpadding="2" cellspacing="0" border="0">
487 <table cellpadding="0" cellspacing="0" border="0">
489 <td class="md" nowrap valign="top"> short int chanrec::topiclock
494 <table cellspacing=5 cellpadding=0 border=0>
502 Nonzero if the mode +t is set.
506 Definition at line <a class="el" href="channels_8h-source.html#l00108">108</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
509 <a name="m4" doxytag="chanrec::topicset"></a><p>
510 <table width="100%" cellpadding="2" cellspacing="0" border="0">
513 <table cellpadding="0" cellspacing="0" border="0">
515 <td class="md" nowrap valign="top"> time_t chanrec::topicset
520 <table cellspacing=5 cellpadding=0 border=0>
530 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a>
532 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>. </td>
535 <hr>The documentation for this class was generated from the following file:<ul>
536 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
537 <hr><address style="align: right;"><small>Generated on Sun Mar 30 13:28:36 2003 for InspIRCd by
538 <a href="http://www.doxygen.org/index.html">
539 <img src="doxygen.png" alt="doxygen" align="middle" border=0
540 width=110 height=53></a>1.3-rc3 </small></address>