inspircd/docs/module-doc/classserverrec.html
2004-04-04 22:03:32 +00:00

431 lines
17 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>serverrec class Reference</title>
<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc3 -->
<center>
<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>
<hr><h1>serverrec Class Reference</h1>A class that defines the local server or a remote server.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="servers_8h-source.html">servers.h</a>&gt;</code>
<p>
Inheritance diagram for serverrec:<p><center><img src="classserverrec__inherit__graph.gif" border="0" usemap="#serverrec__inherit__map" alt="Inheritance graph"></center>
<map name="serverrec__inherit__map">
<area href="classconnection.html" shape="rect" coords="7,85,76,106" alt="">
<area href="classclassbase.html" shape="rect" coords="8,16,75,37" alt="">
</map>
<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>
<map name="serverrec__coll__map">
<area href="classconnection.html" shape="rect" coords="197,304,267,326" alt="">
</map>
<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>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#a0">serverrec</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<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>
<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>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#a2">~serverrec</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<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>
<tr><td>&nbsp;</td><td><font size=-1><em>server name</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m1">pingtime</a></td></tr>
<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>
<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>
<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>
<tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m3">usercount</a></td></tr>
<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>
<tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m4">opercount</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>opers on server</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
<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>
<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>
<tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m6">version</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>ircd version</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classserverrec.html#m7">jupiter</a></td></tr>
<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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class that defines the local server or a remote server.
<p>
<p>
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>
<a name="a0" doxytag="serverrec::serverrec"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> serverrec::serverrec </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor.
<p>
<p>
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>.
<p>
References <a class="el" href="connection_8h-source.html#l00043">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#l00054">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#l00055">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>.
<p>
<div class="fragment"><pre>00013 {
00014 strcpy(name,<span class="stringliteral">""</span>);
00015 <a class="code" href="classserverrec.html#m1">pingtime</a> = 0;
00016 <a class="code" href="classconnection.html#m12">lastping</a> = time(NULL);
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;
00018 <a class="code" href="classserverrec.html#m5">hops_away</a> = 1;
00019 <a class="code" href="classconnection.html#m13">signon</a> = time(NULL);
00020 <a class="code" href="classserverrec.html#m7">jupiter</a> = <span class="keyword">false</span>;
00021 <a class="code" href="classconnection.html#m1">fd</a> = 0;
00022 }
</pre></div> </td>
</tr>
</table>
<a name="a1" doxytag="serverrec::serverrec"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> serverrec::serverrec </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">char *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>n</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>long&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>ver</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>jupe</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor which initialises some of the main variables.
<p>
<p>
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>.
<p>
References <a class="el" href="connection_8h-source.html#l00043">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#l00054">connection::lastping</a>, <a class="el" href="servers_8h-source.html#l00037">opercount</a>, <a class="el" href="connection_8h-source.html#l00055">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>.
<p>
<div class="fragment"><pre>00030 {
00031 strcpy(name,n);
00032 <a class="code" href="classconnection.html#m12">lastping</a> = time(NULL);
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;
00034 <a class="code" href="classserverrec.html#m6">version</a> = ver;
00035 <a class="code" href="classserverrec.html#m5">hops_away</a> = 1;
00036 <a class="code" href="classconnection.html#m13">signon</a> = time(NULL);
00037 <a class="code" href="classserverrec.html#m7">jupiter</a> = jupe;
00038 <a class="code" href="classconnection.html#m1">fd</a> = 0;
00039 }
</pre></div> </td>
</tr>
</table>
<a name="a2" doxytag="serverrec::~serverrec"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> serverrec::~serverrec </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor.
<p>
<p>
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>.
<p>
<div class="fragment"><pre>00026 {
00027 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m5" doxytag="serverrec::hops_away"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int serverrec::hops_away
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
number of hops away (for quick access)
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<a name="m7" doxytag="serverrec::jupiter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool serverrec::jupiter
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
is a JUPE server (faked to enforce a server ban)
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<a name="m0" doxytag="serverrec::name"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char serverrec::name[MAXBUF]
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
server name
<p>
<p>
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>
</tr>
</table>
<a name="m4" doxytag="serverrec::opercount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long serverrec::opercount
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
opers on server
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<a name="m1" doxytag="serverrec::pingtime"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long serverrec::pingtime
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
last ping response (ms)
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<a name="m3" doxytag="serverrec::usercount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long serverrec::usercount
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
non-invisible users on server
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<a name="m2" doxytag="serverrec::usercount_i"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long serverrec::usercount_i
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
invisible users on server
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<a name="m6" doxytag="serverrec::version"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long serverrec::version
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
ircd version
<p>
<p>
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>.
<p>
Referenced by <a class="el" href="servers_8cpp-source.html#l00012">serverrec()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<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>
<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:32 2004 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3-rc3 </small></address>
</body>
</html>