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