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