]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classserverrec.html
Added manpages, extra docs
[user/henk/code/inspircd.git] / docs / module-doc / classserverrec.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>serverrec class Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3-rc3 -->
7 <center>
8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</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>serverrec Class Reference</h1>A class that defines the local server or a remote server. 
10 <a href="#_details">More...</a>
11 <p>
12 <code>#include &lt;<a class="el" href="servers_8h-source.html">servers.h</a>&gt;</code>
13 <p>
14 Inheritance diagram for serverrec:<p><center><img src="classserverrec__inherit__graph.gif" border="0" usemap="#serverrec__inherit__map" alt="Inheritance graph"></center>
15 <map name="serverrec__inherit__map">
16 <area href="classconnection.html" shape="rect" coords="7,155,76,176" alt="">
17 <area href="classExtensible.html" shape="rect" coords="7,86,76,107" alt="">
18 <area href="classclassbase.html" shape="rect" coords="8,16,75,38" alt="">
19 </map>
20 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for serverrec:<p><center><img src="classserverrec__coll__graph.gif" border="0" usemap="#serverrec__coll__map" alt="Collaboration graph"></center>
21 <map name="serverrec__coll__map">
22 <area href="classconnection.html" shape="rect" coords="197,320,267,342" alt="">
23 </map>
24 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classserverrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
25 <tr><td></td></tr>
26 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
27 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#a0">serverrec</a> ()</td></tr>
28 <tr><td>&nbsp;</td><td><font size=-1><em>Constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
29 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#a1">serverrec</a> (char *n, long ver, bool jupe)</td></tr>
30 <tr><td>&nbsp;</td><td><font size=-1><em>Constructor which initialises some of the main variables.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
31 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#a2">~serverrec</a> ()</td></tr>
32 <tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
33 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
34 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m0">name</a> [MAXBUF]</td></tr>
35 <tr><td>&nbsp;</td><td><font size=-1><em>server name</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
36 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m1">pingtime</a></td></tr>
37 <tr><td>&nbsp;</td><td><font size=-1><em>last ping response (ms)</em> <a href="#m1"></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="classserverrec.html#m2">usercount_i</a></td></tr>
39 <tr><td>&nbsp;</td><td><font size=-1><em>invisible users on server</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
40 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m3">usercount</a></td></tr>
41 <tr><td>&nbsp;</td><td><font size=-1><em>non-invisible users on server</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
42 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m4">opercount</a></td></tr>
43 <tr><td>&nbsp;</td><td><font size=-1><em>opers on server</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
44 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m5">hops_away</a></td></tr>
45 <tr><td>&nbsp;</td><td><font size=-1><em>number of hops away (for quick access)</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
46 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m6">version</a></td></tr>
47 <tr><td>&nbsp;</td><td><font size=-1><em>ircd version</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
48 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m7">jupiter</a></td></tr>
49 <tr><td>&nbsp;</td><td><font size=-1><em>is a JUPE server (faked to enforce a server ban)</em> <a href="#m7"></a><em></em></font><br><br></td></tr>
50 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m8">description</a> [MAXBUF]</td></tr>
51 <tr><td>&nbsp;</td><td><font size=-1><em>Description of the server.</em> <a href="#m8"></a><em></em></font><br><br></td></tr>
52 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m9">sync_soon</a></td></tr>
53 </table>
54 <hr><a name="_details"></a><h2>Detailed Description</h2>
55 A class that defines the local server or a remote server.
56 <p>
57
58 <p>
59 Definition at line <a class="el" href="servers_8h-source.html#l00019">19</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
60 <a name="a0" doxytag="serverrec::serverrec"></a><p>
61 <table width="100%" cellpadding="2" cellspacing="0" border="0">
62   <tr>
63     <td class="md">
64       <table cellpadding="0" cellspacing="0" border="0">
65         <tr>
66           <td class="md" nowrap valign="top"> serverrec::serverrec </td>
67           <td class="md" valign="top">(&nbsp;</td>
68           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
69           <td class="md" valign="top">)&nbsp;</td>
70           <td class="md" nowrap></td>
71         </tr>
72
73       </table>
74     </td>
75   </tr>
76 </table>
77 <table cellspacing=5 cellpadding=0 border=0>
78   <tr>
79     <td>
80       &nbsp;
81     </td>
82     <td>
83
84 <p>
85 Constructor.
86 <p>
87
88 <p>
89 Definition at line <a class="el" href="servers_8cpp-source.html#l00012">12</a> of file <a class="el" href="servers_8cpp-source.html">servers.cpp</a>.
90 <p>
91 References <a class="el" href="connection_8h-source.html#l00166">connection::fd</a>, <a class="el" href="servers_8h-source.html#l00040">hops_away</a>, <a class="el" href="servers_8h-source.html#l00046">jupiter</a>, <a class="el" href="connection_8h-source.html#l00216">connection::lastping</a>, <a class="el" href="servers_8h-source.html#l00037">opercount</a>, <a class="el" href="servers_8h-source.html#l00028">pingtime</a>, <a class="el" href="connection_8h-source.html#l00220">connection::signon</a>, <a class="el" href="servers_8h-source.html#l00052">sync_soon</a>, <a class="el" href="servers_8h-source.html#l00034">usercount</a>, <a class="el" href="servers_8h-source.html#l00031">usercount_i</a>, and <a class="el" href="servers_8h-source.html#l00043">version</a>.
92 <p>
93 <div class="fragment"><pre>00013 {
94 00014         strcpy(name,<span class="stringliteral">""</span>);
95 00015         <a class="code" href="classserverrec.html#m1">pingtime</a> = 0;
96 00016         <a class="code" href="classconnection.html#m12">lastping</a> = time(NULL);
97 00017         <a class="code" href="classserverrec.html#m2">usercount_i</a> = <a class="code" href="classserverrec.html#m3">usercount</a> = <a class="code" href="classserverrec.html#m4">opercount</a> = <a class="code" href="classserverrec.html#m6">version</a> = 0;
98 00018         <a class="code" href="classserverrec.html#m5">hops_away</a> = 1;
99 00019         <a class="code" href="classconnection.html#m13">signon</a> = time(NULL);
100 00020         <a class="code" href="classserverrec.html#m7">jupiter</a> = <span class="keyword">false</span>;
101 00021         <a class="code" href="classconnection.html#m0">fd</a> = 0;
102 00022         <a class="code" href="classserverrec.html#m9">sync_soon</a> = <span class="keyword">false</span>;
103 00023 }
104 </pre></div>    </td>
105   </tr>
106 </table>
107 <a name="a1" doxytag="serverrec::serverrec"></a><p>
108 <table width="100%" cellpadding="2" cellspacing="0" border="0">
109   <tr>
110     <td class="md">
111       <table cellpadding="0" cellspacing="0" border="0">
112         <tr>
113           <td class="md" nowrap valign="top"> serverrec::serverrec </td>
114           <td class="md" valign="top">(&nbsp;</td>
115           <td class="md" nowrap valign="top">char *&nbsp;</td>
116           <td class="mdname" nowrap>&nbsp; <em>n</em>, </td>
117         </tr>
118         <tr>
119           <td></td>
120           <td></td>
121           <td class="md" nowrap>long&nbsp;</td>
122           <td class="mdname" nowrap>&nbsp; <em>ver</em>, </td>
123         </tr>
124         <tr>
125           <td></td>
126           <td></td>
127           <td class="md" nowrap>bool&nbsp;</td>
128           <td class="mdname" nowrap>&nbsp; <em>jupe</em></td>
129         </tr>
130         <tr>
131           <td></td>
132           <td class="md">)&nbsp;</td>
133           <td class="md" colspan="2"></td>
134         </tr>
135
136       </table>
137     </td>
138   </tr>
139 </table>
140 <table cellspacing=5 cellpadding=0 border=0>
141   <tr>
142     <td>
143       &nbsp;
144     </td>
145     <td>
146
147 <p>
148 Constructor which initialises some of the main variables.
149 <p>
150
151 <p>
152 Definition at line <a class="el" href="servers_8cpp-source.html#l00030">30</a> of file <a class="el" href="servers_8cpp-source.html">servers.cpp</a>.
153 <p>
154 References <a class="el" href="connection_8h-source.html#l00166">connection::fd</a>, <a class="el" href="servers_8h-source.html#l00040">hops_away</a>, <a class="el" href="servers_8h-source.html#l00046">jupiter</a>, <a class="el" href="connection_8h-source.html#l00216">connection::lastping</a>, <a class="el" href="servers_8h-source.html#l00037">opercount</a>, <a class="el" href="connection_8h-source.html#l00220">connection::signon</a>, <a class="el" href="servers_8h-source.html#l00052">sync_soon</a>, <a class="el" href="servers_8h-source.html#l00034">usercount</a>, <a class="el" href="servers_8h-source.html#l00031">usercount_i</a>, and <a class="el" href="servers_8h-source.html#l00043">version</a>.
155 <p>
156 <div class="fragment"><pre>00031 {
157 00032         strcpy(name,n);
158 00033         <a class="code" href="classconnection.html#m12">lastping</a> = time(NULL);
159 00034         <a class="code" href="classserverrec.html#m2">usercount_i</a> = <a class="code" href="classserverrec.html#m3">usercount</a> = <a class="code" href="classserverrec.html#m4">opercount</a> = 0;
160 00035         <a class="code" href="classserverrec.html#m6">version</a> = ver;
161 00036         <a class="code" href="classserverrec.html#m5">hops_away</a> = 1;
162 00037         <a class="code" href="classconnection.html#m13">signon</a> = time(NULL);
163 00038         <a class="code" href="classserverrec.html#m7">jupiter</a> = jupe;
164 00039         <a class="code" href="classconnection.html#m0">fd</a> = 0;
165 00040         <a class="code" href="classserverrec.html#m9">sync_soon</a> = <span class="keyword">false</span>;
166 00041 }
167 </pre></div>    </td>
168   </tr>
169 </table>
170 <a name="a2" doxytag="serverrec::~serverrec"></a><p>
171 <table width="100%" cellpadding="2" cellspacing="0" border="0">
172   <tr>
173     <td class="md">
174       <table cellpadding="0" cellspacing="0" border="0">
175         <tr>
176           <td class="md" nowrap valign="top"> serverrec::~serverrec </td>
177           <td class="md" valign="top">(&nbsp;</td>
178           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
179           <td class="md" valign="top">)&nbsp;</td>
180           <td class="md" nowrap></td>
181         </tr>
182
183       </table>
184     </td>
185   </tr>
186 </table>
187 <table cellspacing=5 cellpadding=0 border=0>
188   <tr>
189     <td>
190       &nbsp;
191     </td>
192     <td>
193
194 <p>
195 Destructor.
196 <p>
197
198 <p>
199 Definition at line <a class="el" href="servers_8cpp-source.html#l00026">26</a> of file <a class="el" href="servers_8cpp-source.html">servers.cpp</a>.
200 <p>
201 <div class="fragment"><pre>00027 {
202 00028 }
203 </pre></div>    </td>
204   </tr>
205 </table>
206 <hr><h2>Member Data Documentation</h2>
207 <a name="m8" doxytag="serverrec::description"></a><p>
208 <table width="100%" cellpadding="2" cellspacing="0" border="0">
209   <tr>
210     <td class="md">
211       <table cellpadding="0" cellspacing="0" border="0">
212         <tr>
213           <td class="md" nowrap valign="top"> char serverrec::description[MAXBUF]
214       </table>
215     </td>
216   </tr>
217 </table>
218 <table cellspacing=5 cellpadding=0 border=0>
219   <tr>
220     <td>
221       &nbsp;
222     </td>
223     <td>
224
225 <p>
226 Description of the server.
227 <p>
228
229 <p>
230 Definition at line <a class="el" href="servers_8h-source.html#l00050">50</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.    </td>
231   </tr>
232 </table>
233 <a name="m5" doxytag="serverrec::hops_away"></a><p>
234 <table width="100%" cellpadding="2" cellspacing="0" border="0">
235   <tr>
236     <td class="md">
237       <table cellpadding="0" cellspacing="0" border="0">
238         <tr>
239           <td class="md" nowrap valign="top"> int serverrec::hops_away
240       </table>
241     </td>
242   </tr>
243 </table>
244 <table cellspacing=5 cellpadding=0 border=0>
245   <tr>
246     <td>
247       &nbsp;
248     </td>
249     <td>
250
251 <p>
252 number of hops away (for quick access)
253 <p>
254
255 <p>
256 Definition at line <a class="el" href="servers_8h-source.html#l00040">40</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
257 <p>
258 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
259   </tr>
260 </table>
261 <a name="m7" doxytag="serverrec::jupiter"></a><p>
262 <table width="100%" cellpadding="2" cellspacing="0" border="0">
263   <tr>
264     <td class="md">
265       <table cellpadding="0" cellspacing="0" border="0">
266         <tr>
267           <td class="md" nowrap valign="top"> bool serverrec::jupiter
268       </table>
269     </td>
270   </tr>
271 </table>
272 <table cellspacing=5 cellpadding=0 border=0>
273   <tr>
274     <td>
275       &nbsp;
276     </td>
277     <td>
278
279 <p>
280 is a JUPE server (faked to enforce a server ban)
281 <p>
282
283 <p>
284 Definition at line <a class="el" href="servers_8h-source.html#l00046">46</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
285 <p>
286 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
287   </tr>
288 </table>
289 <a name="m0" doxytag="serverrec::name"></a><p>
290 <table width="100%" cellpadding="2" cellspacing="0" border="0">
291   <tr>
292     <td class="md">
293       <table cellpadding="0" cellspacing="0" border="0">
294         <tr>
295           <td class="md" nowrap valign="top"> char serverrec::name[MAXBUF]
296       </table>
297     </td>
298   </tr>
299 </table>
300 <table cellspacing=5 cellpadding=0 border=0>
301   <tr>
302     <td>
303       &nbsp;
304     </td>
305     <td>
306
307 <p>
308 server name
309 <p>
310
311 <p>
312 Definition at line <a class="el" href="servers_8h-source.html#l00025">25</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.    </td>
313   </tr>
314 </table>
315 <a name="m4" doxytag="serverrec::opercount"></a><p>
316 <table width="100%" cellpadding="2" cellspacing="0" border="0">
317   <tr>
318     <td class="md">
319       <table cellpadding="0" cellspacing="0" border="0">
320         <tr>
321           <td class="md" nowrap valign="top"> long serverrec::opercount
322       </table>
323     </td>
324   </tr>
325 </table>
326 <table cellspacing=5 cellpadding=0 border=0>
327   <tr>
328     <td>
329       &nbsp;
330     </td>
331     <td>
332
333 <p>
334 opers on server
335 <p>
336
337 <p>
338 Definition at line <a class="el" href="servers_8h-source.html#l00037">37</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
339 <p>
340 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
341   </tr>
342 </table>
343 <a name="m1" doxytag="serverrec::pingtime"></a><p>
344 <table width="100%" cellpadding="2" cellspacing="0" border="0">
345   <tr>
346     <td class="md">
347       <table cellpadding="0" cellspacing="0" border="0">
348         <tr>
349           <td class="md" nowrap valign="top"> long serverrec::pingtime
350       </table>
351     </td>
352   </tr>
353 </table>
354 <table cellspacing=5 cellpadding=0 border=0>
355   <tr>
356     <td>
357       &nbsp;
358     </td>
359     <td>
360
361 <p>
362 last ping response (ms)
363 <p>
364
365 <p>
366 Definition at line <a class="el" href="servers_8h-source.html#l00028">28</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
367 <p>
368 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
369   </tr>
370 </table>
371 <a name="m9" doxytag="serverrec::sync_soon"></a><p>
372 <table width="100%" cellpadding="2" cellspacing="0" border="0">
373   <tr>
374     <td class="md">
375       <table cellpadding="0" cellspacing="0" border="0">
376         <tr>
377           <td class="md" nowrap valign="top"> bool serverrec::sync_soon
378       </table>
379     </td>
380   </tr>
381 </table>
382 <table cellspacing=5 cellpadding=0 border=0>
383   <tr>
384     <td>
385       &nbsp;
386     </td>
387     <td>
388
389 <p>
390
391 <p>
392 Definition at line <a class="el" href="servers_8h-source.html#l00052">52</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
393 <p>
394 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
395   </tr>
396 </table>
397 <a name="m3" doxytag="serverrec::usercount"></a><p>
398 <table width="100%" cellpadding="2" cellspacing="0" border="0">
399   <tr>
400     <td class="md">
401       <table cellpadding="0" cellspacing="0" border="0">
402         <tr>
403           <td class="md" nowrap valign="top"> long serverrec::usercount
404       </table>
405     </td>
406   </tr>
407 </table>
408 <table cellspacing=5 cellpadding=0 border=0>
409   <tr>
410     <td>
411       &nbsp;
412     </td>
413     <td>
414
415 <p>
416 non-invisible users on server
417 <p>
418
419 <p>
420 Definition at line <a class="el" href="servers_8h-source.html#l00034">34</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
421 <p>
422 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
423   </tr>
424 </table>
425 <a name="m2" doxytag="serverrec::usercount_i"></a><p>
426 <table width="100%" cellpadding="2" cellspacing="0" border="0">
427   <tr>
428     <td class="md">
429       <table cellpadding="0" cellspacing="0" border="0">
430         <tr>
431           <td class="md" nowrap valign="top"> long serverrec::usercount_i
432       </table>
433     </td>
434   </tr>
435 </table>
436 <table cellspacing=5 cellpadding=0 border=0>
437   <tr>
438     <td>
439       &nbsp;
440     </td>
441     <td>
442
443 <p>
444 invisible users on server
445 <p>
446
447 <p>
448 Definition at line <a class="el" href="servers_8h-source.html#l00031">31</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
449 <p>
450 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
451   </tr>
452 </table>
453 <a name="m6" doxytag="serverrec::version"></a><p>
454 <table width="100%" cellpadding="2" cellspacing="0" border="0">
455   <tr>
456     <td class="md">
457       <table cellpadding="0" cellspacing="0" border="0">
458         <tr>
459           <td class="md" nowrap valign="top"> long serverrec::version
460       </table>
461     </td>
462   </tr>
463 </table>
464 <table cellspacing=5 cellpadding=0 border=0>
465   <tr>
466     <td>
467       &nbsp;
468     </td>
469     <td>
470
471 <p>
472 ircd version
473 <p>
474
475 <p>
476 Definition at line <a class="el" href="servers_8h-source.html#l00043">43</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>.
477 <p>
478 Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>.    </td>
479   </tr>
480 </table>
481 <hr>The documentation for this class was generated from the following files:<ul>
482 <li><a class="el" href="servers_8h-source.html">servers.h</a><li><a class="el" href="servers_8cpp-source.html">servers.cpp</a></ul>
483 <hr><address style="align: right;"><small>Generated on Fri Apr 30 13:23:39 2004 for InspIRCd by
484 <a href="http://www.doxygen.org/index.html">
485 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
486 width=110 height=53></a>1.3-rc3 </small></address>
487 </body>
488 </html>