]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classchanrec.html
Modified documentation
[user/henk/code/inspircd.git] / docs / module-doc / classchanrec.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>chanrec class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3-rc2 -->
7 <center>
8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
9 <hr><h1>chanrec Class Reference</h1>Holds all relevent information for a channel. 
10 <a href="#_details">More...</a>
11 <p>
12 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
13 <p>
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">
18 </map>
19 <a href="classchanrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
20 <tr><td></td></tr>
21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
22 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a0">chanrec</a> ()</td></tr>
23 <tr><td>&nbsp;</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&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m0">name</a> [CHANMAX]</td></tr>
27 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m1">custom_modes</a> [MAXMODES]</td></tr>
29 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m2">topic</a> [MAXBUF]</td></tr>
31 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m3">created</a></td></tr>
33 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m4">topicset</a></td></tr>
35 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m5">setby</a> [NICKMAX]</td></tr>
37 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m6">limit</a></td></tr>
39 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m7">key</a> [32]</td></tr>
41 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m8">topiclock</a></td></tr>
43 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m9">noexternal</a></td></tr>
45 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m10">inviteonly</a></td></tr>
47 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m11">moderated</a></td></tr>
49 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m12">secret</a></td></tr>
51 <tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m13">c_private</a></td></tr>
53 <tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m14">bans</a></td></tr>
55 <tr><td>&nbsp;</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>
56 </table>
57 <hr><a name="_details"></a><h2>Detailed Description</h2>
58 Holds all relevent information for a channel.
59 <p>
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. 
61 <p>
62
63 <p>
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 &amp; Destructor Documentation</h2>
65 <a name="a0" doxytag="chanrec::chanrec"></a><p>
66 <table width="100%" cellpadding="2" cellspacing="0" border="0">
67   <tr>
68     <td class="md">
69       <table cellpadding="0" cellspacing="0" border="0">
70         <tr>
71           <td class="md" nowrap valign="top"> chanrec::chanrec </td>
72           <td class="md" valign="top">(&nbsp;</td>
73           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
74           <td class="md" valign="top">)&nbsp;</td>
75           <td class="md" nowrap><code> [inline]</code></td>
76         </tr>
77
78       </table>
79     </td>
80   </tr>
81 </table>
82 <table cellspacing=5 cellpadding=0 border=0>
83   <tr>
84     <td>
85       &nbsp;
86     </td>
87     <td>
88
89 <p>
90 Creates a channel record and initialises it with default values.
91 <p>
92
93 <p>
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>.
95 <p>
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>;
104 00167         }
105 </pre></div>    </td>
106   </tr>
107 </table>
108 <a name="a1" doxytag="chanrec::~chanrec"></a><p>
109 <table width="100%" cellpadding="2" cellspacing="0" border="0">
110   <tr>
111     <td class="md">
112       <table cellpadding="0" cellspacing="0" border="0">
113         <tr>
114           <td class="md" nowrap valign="top"> virtual chanrec::~chanrec </td>
115           <td class="md" valign="top">(&nbsp;</td>
116           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
117           <td class="md" valign="top">)&nbsp;</td>
118           <td class="md" nowrap><code> [inline, virtual]</code></td>
119         </tr>
120
121       </table>
122     </td>
123   </tr>
124 </table>
125 <table cellspacing=5 cellpadding=0 border=0>
126   <tr>
127     <td>
128       &nbsp;
129     </td>
130     <td>
131
132 <p>
133
134 <p>
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>.
136 <p>
137 <div class="fragment"><pre>00169 { <span class="comment">/* stub */</span> }
138 </pre></div>    </td>
139   </tr>
140 </table>
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">
144   <tr>
145     <td class="md">
146       <table cellpadding="0" cellspacing="0" border="0">
147         <tr>
148           <td class="md" nowrap valign="top"> <a class="el" href="channels_8h.html#a5">BanList</a> chanrec::bans
149       </table>
150     </td>
151   </tr>
152 </table>
153 <table cellspacing=5 cellpadding=0 border=0>
154   <tr>
155     <td>
156       &nbsp;
157     </td>
158     <td>
159
160 <p>
161 The list of all bans set on the channel.
162 <p>
163
164 <p>
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>
166   </tr>
167 </table>
168 <a name="m13" doxytag="chanrec::c_private"></a><p>
169 <table width="100%" cellpadding="2" cellspacing="0" border="0">
170   <tr>
171     <td class="md">
172       <table cellpadding="0" cellspacing="0" border="0">
173         <tr>
174           <td class="md" nowrap valign="top"> short int chanrec::c_private
175       </table>
176     </td>
177   </tr>
178 </table>
179 <table cellspacing=5 cellpadding=0 border=0>
180   <tr>
181     <td>
182       &nbsp;
183     </td>
184     <td>
185
186 <p>
187 Nonzero if the mode +p is set.
188 <p>
189 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a>
190 <p>
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>
192   </tr>
193 </table>
194 <a name="m3" doxytag="chanrec::created"></a><p>
195 <table width="100%" cellpadding="2" cellspacing="0" border="0">
196   <tr>
197     <td class="md">
198       <table cellpadding="0" cellspacing="0" border="0">
199         <tr>
200           <td class="md" nowrap valign="top"> time_t chanrec::created
201       </table>
202     </td>
203   </tr>
204 </table>
205 <table cellspacing=5 cellpadding=0 border=0>
206   <tr>
207     <td>
208       &nbsp;
209     </td>
210     <td>
211
212 <p>
213 Creation time.
214 <p>
215
216 <p>
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>
218   </tr>
219 </table>
220 <a name="m1" doxytag="chanrec::custom_modes"></a><p>
221 <table width="100%" cellpadding="2" cellspacing="0" border="0">
222   <tr>
223     <td class="md">
224       <table cellpadding="0" cellspacing="0" border="0">
225         <tr>
226           <td class="md" nowrap valign="top"> char chanrec::custom_modes[MAXMODES]
227       </table>
228     </td>
229   </tr>
230 </table>
231 <table cellspacing=5 cellpadding=0 border=0>
232   <tr>
233     <td>
234       &nbsp;
235     </td>
236     <td>
237
238 <p>
239 Custom modes for the channel.
240 <p>
241 Plugins may use this field in any way they see fit.
242 <p>
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>
244   </tr>
245 </table>
246 <a name="m10" doxytag="chanrec::inviteonly"></a><p>
247 <table width="100%" cellpadding="2" cellspacing="0" border="0">
248   <tr>
249     <td class="md">
250       <table cellpadding="0" cellspacing="0" border="0">
251         <tr>
252           <td class="md" nowrap valign="top"> short int chanrec::inviteonly
253       </table>
254     </td>
255   </tr>
256 </table>
257 <table cellspacing=5 cellpadding=0 border=0>
258   <tr>
259     <td>
260       &nbsp;
261     </td>
262     <td>
263
264 <p>
265 Nonzero if the mode +i is set.
266 <p>
267
268 <p>
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>
270   </tr>
271 </table>
272 <a name="m7" doxytag="chanrec::key"></a><p>
273 <table width="100%" cellpadding="2" cellspacing="0" border="0">
274   <tr>
275     <td class="md">
276       <table cellpadding="0" cellspacing="0" border="0">
277         <tr>
278           <td class="md" nowrap valign="top"> char chanrec::key[32]
279       </table>
280     </td>
281   </tr>
282 </table>
283 <table cellspacing=5 cellpadding=0 border=0>
284   <tr>
285     <td>
286       &nbsp;
287     </td>
288     <td>
289
290 <p>
291 Contains the channel key.
292 <p>
293 If this value is an empty string, there is no channel key in place.
294 <p>
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>
296   </tr>
297 </table>
298 <a name="m6" doxytag="chanrec::limit"></a><p>
299 <table width="100%" cellpadding="2" cellspacing="0" border="0">
300   <tr>
301     <td class="md">
302       <table cellpadding="0" cellspacing="0" border="0">
303         <tr>
304           <td class="md" nowrap valign="top"> long chanrec::limit
305       </table>
306     </td>
307   </tr>
308 </table>
309 <table cellspacing=5 cellpadding=0 border=0>
310   <tr>
311     <td>
312       &nbsp;
313     </td>
314     <td>
315
316 <p>
317 Contains the channel user limit.
318 <p>
319 If this value is zero, there is no limit in place.
320 <p>
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>
322   </tr>
323 </table>
324 <a name="m11" doxytag="chanrec::moderated"></a><p>
325 <table width="100%" cellpadding="2" cellspacing="0" border="0">
326   <tr>
327     <td class="md">
328       <table cellpadding="0" cellspacing="0" border="0">
329         <tr>
330           <td class="md" nowrap valign="top"> short int chanrec::moderated
331       </table>
332     </td>
333   </tr>
334 </table>
335 <table cellspacing=5 cellpadding=0 border=0>
336   <tr>
337     <td>
338       &nbsp;
339     </td>
340     <td>
341
342 <p>
343 Nonzero if the mode +m is set.
344 <p>
345
346 <p>
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>
348   </tr>
349 </table>
350 <a name="m0" doxytag="chanrec::name"></a><p>
351 <table width="100%" cellpadding="2" cellspacing="0" border="0">
352   <tr>
353     <td class="md">
354       <table cellpadding="0" cellspacing="0" border="0">
355         <tr>
356           <td class="md" nowrap valign="top"> char chanrec::name[CHANMAX]
357       </table>
358     </td>
359   </tr>
360 </table>
361 <table cellspacing=5 cellpadding=0 border=0>
362   <tr>
363     <td>
364       &nbsp;
365     </td>
366     <td>
367
368 <p>
369 The channels name.
370 <p>
371
372 <p>
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>
374   </tr>
375 </table>
376 <a name="m9" doxytag="chanrec::noexternal"></a><p>
377 <table width="100%" cellpadding="2" cellspacing="0" border="0">
378   <tr>
379     <td class="md">
380       <table cellpadding="0" cellspacing="0" border="0">
381         <tr>
382           <td class="md" nowrap valign="top"> short int chanrec::noexternal
383       </table>
384     </td>
385   </tr>
386 </table>
387 <table cellspacing=5 cellpadding=0 border=0>
388   <tr>
389     <td>
390       &nbsp;
391     </td>
392     <td>
393
394 <p>
395 Nonzero if the mode +n is set.
396 <p>
397
398 <p>
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>
400   </tr>
401 </table>
402 <a name="m12" doxytag="chanrec::secret"></a><p>
403 <table width="100%" cellpadding="2" cellspacing="0" border="0">
404   <tr>
405     <td class="md">
406       <table cellpadding="0" cellspacing="0" border="0">
407         <tr>
408           <td class="md" nowrap valign="top"> short int chanrec::secret
409       </table>
410     </td>
411   </tr>
412 </table>
413 <table cellspacing=5 cellpadding=0 border=0>
414   <tr>
415     <td>
416       &nbsp;
417     </td>
418     <td>
419
420 <p>
421 Nonzero if the mode +s is set.
422 <p>
423 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a>
424 <p>
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>
426   </tr>
427 </table>
428 <a name="m5" doxytag="chanrec::setby"></a><p>
429 <table width="100%" cellpadding="2" cellspacing="0" border="0">
430   <tr>
431     <td class="md">
432       <table cellpadding="0" cellspacing="0" border="0">
433         <tr>
434           <td class="md" nowrap valign="top"> char chanrec::setby[NICKMAX]
435       </table>
436     </td>
437   </tr>
438 </table>
439 <table cellspacing=5 cellpadding=0 border=0>
440   <tr>
441     <td>
442       &nbsp;
443     </td>
444     <td>
445
446 <p>
447 The last user to set the topic.
448 <p>
449 If this member is an empty string, no topic was ever set.
450 <p>
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>
452   </tr>
453 </table>
454 <a name="m2" doxytag="chanrec::topic"></a><p>
455 <table width="100%" cellpadding="2" cellspacing="0" border="0">
456   <tr>
457     <td class="md">
458       <table cellpadding="0" cellspacing="0" border="0">
459         <tr>
460           <td class="md" nowrap valign="top"> char chanrec::topic[MAXBUF]
461       </table>
462     </td>
463   </tr>
464 </table>
465 <table cellspacing=5 cellpadding=0 border=0>
466   <tr>
467     <td>
468       &nbsp;
469     </td>
470     <td>
471
472 <p>
473 Channel topic.
474 <p>
475 If this is an empty string, no channel topic is set.
476 <p>
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>
478   </tr>
479 </table>
480 <a name="m8" doxytag="chanrec::topiclock"></a><p>
481 <table width="100%" cellpadding="2" cellspacing="0" border="0">
482   <tr>
483     <td class="md">
484       <table cellpadding="0" cellspacing="0" border="0">
485         <tr>
486           <td class="md" nowrap valign="top"> short int chanrec::topiclock
487       </table>
488     </td>
489   </tr>
490 </table>
491 <table cellspacing=5 cellpadding=0 border=0>
492   <tr>
493     <td>
494       &nbsp;
495     </td>
496     <td>
497
498 <p>
499 Nonzero if the mode +t is set.
500 <p>
501
502 <p>
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>
504   </tr>
505 </table>
506 <a name="m4" doxytag="chanrec::topicset"></a><p>
507 <table width="100%" cellpadding="2" cellspacing="0" border="0">
508   <tr>
509     <td class="md">
510       <table cellpadding="0" cellspacing="0" border="0">
511         <tr>
512           <td class="md" nowrap valign="top"> time_t chanrec::topicset
513       </table>
514     </td>
515   </tr>
516 </table>
517 <table cellspacing=5 cellpadding=0 border=0>
518   <tr>
519     <td>
520       &nbsp;
521     </td>
522     <td>
523
524 <p>
525 Time topic was set.
526 <p>
527 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a>
528 <p>
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>
530   </tr>
531 </table>
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>
538 </body>
539 </html>