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