docs/man/serverrec.3

   1 .TH "serverrec" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 serverrec \- A class that defines the local server or a remote server.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <servers.h>\fP
  12 .PP
  13 Inherits \fBconnection\fP.
  14 .PP
  15 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBserverrec\fP ()"
  20 .br
  21 .RI "\fIConstructor.\fP"
  22 .ti -1c
  23 .RI "\fBserverrec\fP (char *n, long ver, bool jupe)"
  24 .br
  25 .RI "\fIConstructor which initialises some of the main variables.\fP"
  26 .ti -1c
  27 .RI "\fB~serverrec\fP ()"
  28 .br
  29 .RI "\fIDestructor.\fP"
  30 .in -1c
  31 .SS "Public Attributes"
  32
  33 .in +1c
  34 .ti -1c
  35 .RI "char \fBname\fP [MAXBUF]"
  36 .br
  37 .RI "\fIserver name\fP"
  38 .ti -1c
  39 .RI "long \fBpingtime\fP"
  40 .br
  41 .RI "\fIlast ping response (ms)\fP"
  42 .ti -1c
  43 .RI "long \fBusercount_i\fP"
  44 .br
  45 .RI "\fIinvisible users on server\fP"
  46 .ti -1c
  47 .RI "long \fBusercount\fP"
  48 .br
  49 .RI "\fInon-invisible users on server\fP"
  50 .ti -1c
  51 .RI "long \fBopercount\fP"
  52 .br
  53 .RI "\fIopers on server\fP"
  54 .ti -1c
  55 .RI "int \fBhops_away\fP"
  56 .br
  57 .RI "\fInumber of hops away (for quick access)\fP"
  58 .ti -1c
  59 .RI "long \fBversion\fP"
  60 .br
  61 .RI "\fIircd version\fP"
  62 .ti -1c
  63 .RI "bool \fBjupiter\fP"
  64 .br
  65 .RI "\fIis a JUPE server (faked to enforce a server ban)\fP"
  66 .ti -1c
  67 .RI "char \fBdescription\fP [MAXBUF]"
  68 .br
  69 .RI "\fIDescription of the server.\fP"
  70 .ti -1c
  71 .RI "bool \fBsync_soon\fP"
  72 .br
  73 .in -1c
  74 .SH "Detailed Description"
  75 .PP
  76 A class that defines the local server or a remote server.Definition at line 19 of file servers.h.
  77 .SH "Constructor & Destructor Documentation"
  78 .PP
  79 .SS "serverrec::serverrec ()"
  80 .PP
  81 Constructor.Definition at line 12 of file servers.cpp.
  82 .PP
  83 References connection::fd, hops_away, jupiter, connection::lastping, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version.
  84 .PP
  85 .nf
  86 13 {
  87 14         strcpy(name,'');
  88 15         pingtime = 0;
  89 16         lastping = time(NULL);
  90 17         usercount_i = usercount = opercount = version = 0;
  91 18         hops_away = 1;
  92 19         signon = time(NULL);
  93 20         jupiter = false;
  94 21         fd = 0;
  95 22         sync_soon = false;
  96 23 }
  97 .fi
  98 .SS "serverrec::serverrec (char * n, long ver, bool jupe)"
  99 .PP
 100 Constructor which initialises some of the main variables.Definition at line 30 of file servers.cpp.
 101 .PP
 102 References connection::fd, hops_away, jupiter, connection::lastping, opercount, connection::signon, sync_soon, usercount, usercount_i, and version.
 103 .PP
 104 .nf
 105 31 {
 106 32         strcpy(name,n);
 107 33         lastping = time(NULL);
 108 34         usercount_i = usercount = opercount = 0;
 109 35         version = ver;
 110 36         hops_away = 1;
 111 37         signon = time(NULL);
 112 38         jupiter = jupe;
 113 39         fd = 0;
 114 40         sync_soon = false;
 115 41 }
 116 .fi
 117 .SS "serverrec::~serverrec ()"
 118 .PP
 119 Destructor.Definition at line 26 of file servers.cpp.
 120 .PP
 121 .nf
 122 27 {
 123 28 }
 124 .fi
 125 .SH "Member Data Documentation"
 126 .PP
 127 .SS "char serverrec::description[MAXBUF]"
 128 .PP
 129 Description of the server.Definition at line 50 of file servers.h.
 130 .SS "int serverrec::hops_away"
 131 .PP
 132 number of hops away (for quick access)Definition at line 40 of file servers.h.
 133 .PP
 134 Referenced by serverrec().
 135 .SS "bool serverrec::jupiter"
 136 .PP
 137 is a JUPE server (faked to enforce a server ban)Definition at line 46 of file servers.h.
 138 .PP
 139 Referenced by serverrec().
 140 .SS "char serverrec::name[MAXBUF]"
 141 .PP
 142 server nameDefinition at line 25 of file servers.h.
 143 .SS "long serverrec::opercount"
 144 .PP
 145 opers on serverDefinition at line 37 of file servers.h.
 146 .PP
 147 Referenced by serverrec().
 148 .SS "long serverrec::pingtime"
 149 .PP
 150 last ping response (ms)Definition at line 28 of file servers.h.
 151 .PP
 152 Referenced by serverrec().
 153 .SS "bool serverrec::sync_soon"
 154 .PP
 155 Definition at line 52 of file servers.h.
 156 .PP
 157 Referenced by serverrec().
 158 .SS "long serverrec::usercount"
 159 .PP
 160 non-invisible users on serverDefinition at line 34 of file servers.h.
 161 .PP
 162 Referenced by serverrec().
 163 .SS "long serverrec::usercount_i"
 164 .PP
 165 invisible users on serverDefinition at line 31 of file servers.h.
 166 .PP
 167 Referenced by serverrec().
 168 .SS "long serverrec::version"
 169 .PP
 170 ircd versionDefinition at line 43 of file servers.h.
 171 .PP
 172 Referenced by serverrec().
 173
 174 .SH "Author"
 175 .PP
 176 Generated automatically by Doxygen for InspIRCd from the source code.