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>void </td><td valign=bottom><a class="el" href="classchanrec.html#a0">SetCustomMode</a> (char mode, bool mode_on)</td></tr>
26 <tr><td> </td><td><font size=-1><em>Sets or unsets a custom mode in the channels info.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
27 <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classchanrec.html#a1">SetCustomModeParam</a> (char mode, char *parameter, bool mode_on)</td></tr>
28 <tr><td> </td><td><font size=-1><em>Sets or unsets the parameterrs for a custom mode in a channels info.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
29 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classchanrec.html#a2">chanrec</a> ()</td></tr>
30 <tr><td> </td><td><font size=-1><em>Creates a channel record and initialises it with default values.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
31 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classchanrec.html#a3">~chanrec</a> ()</td></tr>
32 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
33 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m0">name</a> [CHANMAX]</td></tr>
34 <tr><td> </td><td><font size=-1><em>The channels name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
35 <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>
36 <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>
37 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m2">topic</a> [MAXBUF]</td></tr>
38 <tr><td> </td><td><font size=-1><em>Channel topic.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
39 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m3">created</a></td></tr>
40 <tr><td> </td><td><font size=-1><em>Creation time.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
41 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m4">topicset</a></td></tr>
42 <tr><td> </td><td><font size=-1><em>Time topic was set.</em> <a href="#m4"></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#m5">setby</a> [NICKMAX]</td></tr>
44 <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>
45 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classchanrec.html#m6">limit</a></td></tr>
46 <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>
47 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m7">key</a> [32]</td></tr>
48 <tr><td> </td><td><font size=-1><em>Contains the channel key.</em> <a href="#m7"></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#m8">topiclock</a></td></tr>
50 <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>
51 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m9">noexternal</a></td></tr>
52 <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>
53 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m10">inviteonly</a></td></tr>
54 <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>
55 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m11">moderated</a></td></tr>
56 <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>
57 <tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m12">secret</a></td></tr>
58 <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>
59 <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>
60 <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>
61 <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>
62 <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>
64 <hr><a name="_details"></a><h2>Detailed Description</h2>
65 Holds all relevent information for a channel.
67 This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.
71 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>
72 <a name="a2" doxytag="chanrec::chanrec"></a><p>
73 <table width="100%" cellpadding="2" cellspacing="0" border="0">
76 <table cellpadding="0" cellspacing="0" border="0">
78 <td class="md" nowrap valign="top"> chanrec::chanrec </td>
79 <td class="md" valign="top">( </td>
80 <td class="mdname1" valign="top" nowrap> </td>
81 <td class="md" valign="top">) </td>
82 <td class="md" nowrap></td>
89 <table cellspacing=5 cellpadding=0 border=0>
97 Creates a channel record and initialises it with default values.
101 Definition at line <a class="el" href="channels_8cpp-source.html#l00006">6</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
103 References <a class="el" href="channels_8h-source.html#l00130">c_private</a>, <a class="el" href="channels_8h-source.html#l00086">created</a>, <a class="el" href="channels_8h-source.html#l00116">inviteonly</a>, <a class="el" href="channels_8h-source.html#l00099">limit</a>, <a class="el" href="channels_8h-source.html#l00120">moderated</a>, <a class="el" href="channels_8h-source.html#l00112">noexternal</a>, <a class="el" href="channels_8h-source.html#l00125">secret</a>, <a class="el" href="channels_8h-source.html#l00108">topiclock</a>, and <a class="el" href="channels_8h-source.html#l00090">topicset</a>.
105 <div class="fragment"><pre>00007 {
106 00008 strcpy(name,<span class="stringliteral">""</span>);
107 00009 strcpy(custom_modes,<span class="stringliteral">""</span>);
108 00010 strcpy(topic,<span class="stringliteral">""</span>);
109 00011 strcpy(setby,<span class="stringliteral">""</span>);
110 00012 strcpy(key,<span class="stringliteral">""</span>);
111 00013 <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;
112 00014 <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>;
117 <a name="a3" doxytag="chanrec::~chanrec"></a><p>
118 <table width="100%" cellpadding="2" cellspacing="0" border="0">
121 <table cellpadding="0" cellspacing="0" border="0">
123 <td class="md" nowrap valign="top"> virtual chanrec::~chanrec </td>
124 <td class="md" valign="top">( </td>
125 <td class="mdname1" valign="top" nowrap> </td>
126 <td class="md" valign="top">) </td>
127 <td class="md" nowrap><code> [inline, virtual]</code></td>
134 <table cellspacing=5 cellpadding=0 border=0>
144 Definition at line <a class="el" href="channels_8h-source.html#l00148">148</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
146 <div class="fragment"><pre>00148 { <span class="comment">/* stub */</span> }
150 <hr><h2>Member Function Documentation</h2>
151 <a name="a0" doxytag="chanrec::SetCustomMode"></a><p>
152 <table width="100%" cellpadding="2" cellspacing="0" border="0">
155 <table cellpadding="0" cellspacing="0" border="0">
157 <td class="md" nowrap valign="top"> void chanrec::SetCustomMode </td>
158 <td class="md" valign="top">( </td>
159 <td class="md" nowrap valign="top">char </td>
160 <td class="mdname" nowrap> <em>mode</em>, </td>
165 <td class="md" nowrap>bool </td>
166 <td class="mdname" nowrap> <em>mode_on</em></td>
170 <td class="md">) </td>
171 <td class="md" colspan="2"></td>
178 <table cellspacing=5 cellpadding=0 border=0>
186 Sets or unsets a custom mode in the channels info.
190 Definition at line <a class="el" href="channels_8cpp-source.html#l00017">17</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
192 <div class="fragment"><pre>00018 {
197 <a name="a1" doxytag="chanrec::SetCustomModeParam"></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"> void chanrec::SetCustomModeParam </td>
204 <td class="md" valign="top">( </td>
205 <td class="md" nowrap valign="top">char </td>
206 <td class="mdname" nowrap> <em>mode</em>, </td>
211 <td class="md" nowrap>char * </td>
212 <td class="mdname" nowrap> <em>parameter</em>, </td>
217 <td class="md" nowrap>bool </td>
218 <td class="mdname" nowrap> <em>mode_on</em></td>
222 <td class="md">) </td>
223 <td class="md" colspan="2"></td>
230 <table cellspacing=5 cellpadding=0 border=0>
238 Sets or unsets the parameterrs for a custom mode in a channels info.
242 Definition at line <a class="el" href="channels_8cpp-source.html#l00021">21</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
244 <div class="fragment"><pre>00022 {
249 <hr><h2>Member Data Documentation</h2>
250 <a name="m14" doxytag="chanrec::bans"></a><p>
251 <table width="100%" cellpadding="2" cellspacing="0" border="0">
254 <table cellpadding="0" cellspacing="0" border="0">
256 <td class="md" nowrap valign="top"> <a class="el" href="channels_8h.html#a5">BanList</a> chanrec::bans
261 <table cellspacing=5 cellpadding=0 border=0>
269 The list of all bans set on the channel.
273 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>
276 <a name="m13" doxytag="chanrec::c_private"></a><p>
277 <table width="100%" cellpadding="2" cellspacing="0" border="0">
280 <table cellpadding="0" cellspacing="0" border="0">
282 <td class="md" nowrap valign="top"> short int chanrec::c_private
287 <table cellspacing=5 cellpadding=0 border=0>
295 Nonzero if the mode +p is set.
297 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a>
299 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>.
301 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
304 <a name="m3" doxytag="chanrec::created"></a><p>
305 <table width="100%" cellpadding="2" cellspacing="0" border="0">
308 <table cellpadding="0" cellspacing="0" border="0">
310 <td class="md" nowrap valign="top"> time_t chanrec::created
315 <table cellspacing=5 cellpadding=0 border=0>
327 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>.
329 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
332 <a name="m1" doxytag="chanrec::custom_modes"></a><p>
333 <table width="100%" cellpadding="2" cellspacing="0" border="0">
336 <table cellpadding="0" cellspacing="0" border="0">
338 <td class="md" nowrap valign="top"> char chanrec::custom_modes[MAXMODES]
343 <table cellspacing=5 cellpadding=0 border=0>
351 Custom modes for the channel.
353 Plugins may use this field in any way they see fit.
355 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>
358 <a name="m10" doxytag="chanrec::inviteonly"></a><p>
359 <table width="100%" cellpadding="2" cellspacing="0" border="0">
362 <table cellpadding="0" cellspacing="0" border="0">
364 <td class="md" nowrap valign="top"> short int chanrec::inviteonly
369 <table cellspacing=5 cellpadding=0 border=0>
377 Nonzero if the mode +i is set.
381 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>.
383 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
386 <a name="m7" doxytag="chanrec::key"></a><p>
387 <table width="100%" cellpadding="2" cellspacing="0" border="0">
390 <table cellpadding="0" cellspacing="0" border="0">
392 <td class="md" nowrap valign="top"> char chanrec::key[32]
397 <table cellspacing=5 cellpadding=0 border=0>
405 Contains the channel key.
407 If this value is an empty string, there is no channel key in place.
409 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>
412 <a name="m6" doxytag="chanrec::limit"></a><p>
413 <table width="100%" cellpadding="2" cellspacing="0" border="0">
416 <table cellpadding="0" cellspacing="0" border="0">
418 <td class="md" nowrap valign="top"> long chanrec::limit
423 <table cellspacing=5 cellpadding=0 border=0>
431 Contains the channel user limit.
433 If this value is zero, there is no limit in place.
435 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>.
437 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
440 <a name="m11" doxytag="chanrec::moderated"></a><p>
441 <table width="100%" cellpadding="2" cellspacing="0" border="0">
444 <table cellpadding="0" cellspacing="0" border="0">
446 <td class="md" nowrap valign="top"> short int chanrec::moderated
451 <table cellspacing=5 cellpadding=0 border=0>
459 Nonzero if the mode +m is set.
463 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>.
465 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
468 <a name="m0" doxytag="chanrec::name"></a><p>
469 <table width="100%" cellpadding="2" cellspacing="0" border="0">
472 <table cellpadding="0" cellspacing="0" border="0">
474 <td class="md" nowrap valign="top"> char chanrec::name[CHANMAX]
479 <table cellspacing=5 cellpadding=0 border=0>
491 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>
494 <a name="m9" doxytag="chanrec::noexternal"></a><p>
495 <table width="100%" cellpadding="2" cellspacing="0" border="0">
498 <table cellpadding="0" cellspacing="0" border="0">
500 <td class="md" nowrap valign="top"> short int chanrec::noexternal
505 <table cellspacing=5 cellpadding=0 border=0>
513 Nonzero if the mode +n is set.
517 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>.
519 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
522 <a name="m12" doxytag="chanrec::secret"></a><p>
523 <table width="100%" cellpadding="2" cellspacing="0" border="0">
526 <table cellpadding="0" cellspacing="0" border="0">
528 <td class="md" nowrap valign="top"> short int chanrec::secret
533 <table cellspacing=5 cellpadding=0 border=0>
541 Nonzero if the mode +s is set.
543 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a>
545 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>.
547 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
550 <a name="m5" doxytag="chanrec::setby"></a><p>
551 <table width="100%" cellpadding="2" cellspacing="0" border="0">
554 <table cellpadding="0" cellspacing="0" border="0">
556 <td class="md" nowrap valign="top"> char chanrec::setby[NICKMAX]
561 <table cellspacing=5 cellpadding=0 border=0>
569 The last user to set the topic.
571 If this member is an empty string, no topic was ever set.
573 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>
576 <a name="m2" doxytag="chanrec::topic"></a><p>
577 <table width="100%" cellpadding="2" cellspacing="0" border="0">
580 <table cellpadding="0" cellspacing="0" border="0">
582 <td class="md" nowrap valign="top"> char chanrec::topic[MAXBUF]
587 <table cellspacing=5 cellpadding=0 border=0>
597 If this is an empty string, no channel topic is set.
599 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>
602 <a name="m8" doxytag="chanrec::topiclock"></a><p>
603 <table width="100%" cellpadding="2" cellspacing="0" border="0">
606 <table cellpadding="0" cellspacing="0" border="0">
608 <td class="md" nowrap valign="top"> short int chanrec::topiclock
613 <table cellspacing=5 cellpadding=0 border=0>
621 Nonzero if the mode +t is set.
625 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>.
627 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
630 <a name="m4" doxytag="chanrec::topicset"></a><p>
631 <table width="100%" cellpadding="2" cellspacing="0" border="0">
634 <table cellpadding="0" cellspacing="0" border="0">
636 <td class="md" nowrap valign="top"> time_t chanrec::topicset
641 <table cellspacing=5 cellpadding=0 border=0>
651 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a>
653 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>.
655 Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td>
658 <hr>The documentation for this class was generated from the following files:<ul>
659 <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>
660 <hr><address style="align: right;"><small>Generated on Fri Apr 2 14:46:12 2004 for InspIRCd by
661 <a href="http://www.doxygen.org/index.html">
662 <img src="doxygen.png" alt="doxygen" align="middle" border=0
663 width=110 height=53></a>1.3-rc3 </small></address>