ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 11:09:04 -04:00
Code Issues Packages Projects Releases Wiki Activity
inspircd/docs/module-doc/classserverrec.html
brain f326e475e3 Updated documentation (html) 
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@937 e03df62e-2008-0410-955e-edbf42e46eb7
2005-04-01 17:07:42 +00:00

528 lines
22 KiB
HTML
Raw Blame History

<!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>InspIRCd: serverrec class Reference</title>
<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<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>
Inherits <a class="el" href="classconnection.html">connection</a>.
<p>
<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 class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#a0">serverrec</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#a1">serverrec</a> (char *n, long ver, bool jupe)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor which initialises some of the main variables. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#a2">~serverrec</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o0">name</a> [MAXBUF]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">server name </em> <a href="#o0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o1">pingtime</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">last ping response (ms) </em> <a href="#o1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o2">usercount_i</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">invisible users on server </em> <a href="#o2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o3">usercount</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">non-invisible users on server </em> <a href="#o3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o4">opercount</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">opers on server </em> <a href="#o4"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o5">hops_away</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">number of hops away (for quick access) </em> <a href="#o5"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o6">version</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ircd version </em> <a href="#o6"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o7">jupiter</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">is a JUPE server (faked to enforce a server ban) </em> <a href="#o7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o8">description</a> [MAXBUF]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the server. </em> <a href="#o8"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o9">nickserv</a> [NICKMAX]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/). </em> <a href="#o9"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classserverrec.html#o10">sync_soon</a></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#l00030">30</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 class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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> </td>
<td class="md" valign="top">&nbsp;)&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#l00024">24</a> of file <a class="el" href="servers_8cpp-source.html">servers.cpp</a>.
<p>
References <a class="el" href="connection_8h-source.html#l00178">connection::fd</a>, <a class="el" href="servers_8h-source.html#l00051">hops_away</a>, <a class="el" href="servers_8h-source.html#l00057">jupiter</a>, <a class="el" href="connection_8h-source.html#l00228">connection::lastping</a>, <a class="el" href="servers_8h-source.html#l00036">name</a>, <a class="el" href="servers_8h-source.html#l00065">nickserv</a>, <a class="el" href="servers_8h-source.html#l00048">opercount</a>, <a class="el" href="servers_8h-source.html#l00039">pingtime</a>, <a class="el" href="connection_8h-source.html#l00232">connection::signon</a>, <a class="el" href="servers_8h-source.html#l00067">sync_soon</a>, <a class="el" href="servers_8h-source.html#l00045">usercount</a>, <a class="el" href="servers_8h-source.html#l00042">usercount_i</a>, and <a class="el" href="servers_8h-source.html#l00054">version</a>.
<p>
<div class="fragment"><pre>00025 {
00026 strlcpy(name,<span class="stringliteral">""</span>,256);
00027 <a class="code" href="classserverrec.html#o1">pingtime</a> = 0;
00028 <a class="code" href="classconnection.html#o12">lastping</a> = time(NULL);
00029 <a class="code" href="classserverrec.html#o2">usercount_i</a> = <a class="code" href="classserverrec.html#o3">usercount</a> = <a class="code" href="classserverrec.html#o4">opercount</a> = <a class="code" href="classserverrec.html#o6">version</a> = 0;
00030 <a class="code" href="classserverrec.html#o5">hops_away</a> = 1;
00031 <a class="code" href="classconnection.html#o13">signon</a> = time(NULL);
00032 <a class="code" href="classserverrec.html#o7">jupiter</a> = <span class="keyword">false</span>;
00033 <a class="code" href="classconnection.html#o0">fd</a> = 0;
00034 <a class="code" href="classserverrec.html#o10">sync_soon</a> = <span class="keyword">false</span>;
00035 strlcpy(nickserv,<span class="stringliteral">""</span>,NICKMAX);
00036 }
</pre></div> </td>
</tr>
</table>
<a name="a1" doxytag="serverrec::serverrec"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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> <em>n</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>long&nbsp;</td>
<td class="mdname" nowrap> <em>ver</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <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#l00043">43</a> of file <a class="el" href="servers_8cpp-source.html">servers.cpp</a>.
<p>
References <a class="el" href="connection_8h-source.html#l00178">connection::fd</a>, <a class="el" href="servers_8h-source.html#l00051">hops_away</a>, <a class="el" href="servers_8h-source.html#l00057">jupiter</a>, <a class="el" href="connection_8h-source.html#l00228">connection::lastping</a>, <a class="el" href="servers_8h-source.html#l00036">name</a>, <a class="el" href="servers_8h-source.html#l00065">nickserv</a>, <a class="el" href="servers_8h-source.html#l00048">opercount</a>, <a class="el" href="connection_8h-source.html#l00232">connection::signon</a>, <a class="el" href="servers_8h-source.html#l00067">sync_soon</a>, <a class="el" href="servers_8h-source.html#l00045">usercount</a>, <a class="el" href="servers_8h-source.html#l00042">usercount_i</a>, and <a class="el" href="servers_8h-source.html#l00054">version</a>.
<p>
<div class="fragment"><pre>00044 {
00045 strlcpy(name,n,256);
00046 <a class="code" href="classconnection.html#o12">lastping</a> = time(NULL);
00047 <a class="code" href="classserverrec.html#o2">usercount_i</a> = <a class="code" href="classserverrec.html#o3">usercount</a> = <a class="code" href="classserverrec.html#o4">opercount</a> = 0;
00048 <a class="code" href="classserverrec.html#o6">version</a> = ver;
00049 <a class="code" href="classserverrec.html#o5">hops_away</a> = 1;
00050 <a class="code" href="classconnection.html#o13">signon</a> = time(NULL);
00051 <a class="code" href="classserverrec.html#o7">jupiter</a> = jupe;
00052 <a class="code" href="classconnection.html#o0">fd</a> = 0;
00053 <a class="code" href="classserverrec.html#o10">sync_soon</a> = <span class="keyword">false</span>;
00054 strlcpy(nickserv,<span class="stringliteral">""</span>,NICKMAX);
00055 }
</pre></div> </td>
</tr>
</table>
<a name="a2" doxytag="serverrec::~serverrec"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> serverrec::~<a class="el" href="classserverrec.html">serverrec</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&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#l00039">39</a> of file <a class="el" href="servers_8cpp-source.html">servers.cpp</a>.
<p>
<div class="fragment"><pre>00040 {
00041 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="o8" doxytag="serverrec::description"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char <a class="el" href="classserverrec.html#o8">serverrec::description</a>[MAXBUF]
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Description of the server.
<p>
<p>
Definition at line <a class="el" href="servers_8h-source.html#l00061">61</a> of file <a class="el" href="servers_8h-source.html">servers.h</a>. </td>
</tr>
</table>
<a name="o5" doxytag="serverrec::hops_away"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="classserverrec.html#o5">serverrec::hops_away</a>
</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#l00051">51</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o7" doxytag="serverrec::jupiter"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classserverrec.html#o7">serverrec::jupiter</a>
</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#l00057">57</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o0" doxytag="serverrec::name"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char <a class="el" href="classserverrec.html#o0">serverrec::name</a>[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#l00036">36</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o9" doxytag="serverrec::nickserv"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char <a class="el" href="classserverrec.html#o9">serverrec::nickserv</a>[NICKMAX]
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/).
<p>
<p>
Definition at line <a class="el" href="servers_8h-source.html#l00065">65</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o4" doxytag="serverrec::opercount"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long <a class="el" href="classserverrec.html#o4">serverrec::opercount</a>
</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#l00048">48</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o1" doxytag="serverrec::pingtime"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long <a class="el" href="classserverrec.html#o1">serverrec::pingtime</a>
</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#l00039">39</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o10" doxytag="serverrec::sync_soon"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classserverrec.html#o10">serverrec::sync_soon</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="servers_8h-source.html#l00067">67</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o3" doxytag="serverrec::usercount"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long <a class="el" href="classserverrec.html#o3">serverrec::usercount</a>
</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#l00045">45</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o2" doxytag="serverrec::usercount_i"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long <a class="el" href="classserverrec.html#o2">serverrec::usercount_i</a>
</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#l00042">42</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#l00024">serverrec()</a>. </td>
</tr>
</table>
<a name="o6" doxytag="serverrec::version"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long <a class="el" href="classserverrec.html#o6">serverrec::version</a>
</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#l00054">54</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#l00024">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 size="1"><address style="align: right;"><small>Generated on Mon Mar 28 21:09:37 2005 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink