docs/man/man3/serverrec.3

   1 .TH "serverrec" 3 "26 Apr 2005" "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 "char \fBnickserv\fP [NICKMAX]"
  72 .br
  73 .RI "\fIHolds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/). \fP"
  74 .ti -1c
  75 .RI "bool \fBsync_soon\fP"
  76 .br
  77 .in -1c
  78 .SH "Detailed Description"
  79 .PP
  80 A class that defines the local server or a remote server. Definition at line 30 of file servers.h.
  81 .SH "Constructor & Destructor Documentation"
  82 .PP
  83 .SS "serverrec::serverrec ()"
  84 .PP
  85 Constructor. Definition at line 26 of file servers.cpp.
  86 .PP
  87 References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, TIME, usercount, usercount_i, and version.
  88 .PP
  89 .nf
  90 27 {
  91 28         strlcpy(name,'',256);
  92 29         pingtime = 0;
  93 30         lastping = TIME;
  94 31         usercount_i = usercount = opercount = version = 0;
  95 32         hops_away = 1;
  96 33         signon = TIME;
  97 34         jupiter = false;
  98 35         fd = 0;
  99 36         sync_soon = false;
 100 37         strlcpy(nickserv,'',NICKMAX);
 101 38 }
 102 .fi
 103 .SS "serverrec::serverrec (char * n, long ver, bool jupe)"
 104 .PP
 105 Constructor which initialises some of the main variables. Definition at line 45 of file servers.cpp.
 106 .PP
 107 References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, TIME, usercount, usercount_i, and version.
 108 .PP
 109 .nf
 110 46 {
 111 47         strlcpy(name,n,256);
 112 48         lastping = TIME;
 113 49         usercount_i = usercount = opercount = 0;
 114 50         version = ver;
 115 51         hops_away = 1;
 116 52         signon = TIME;
 117 53         jupiter = jupe;
 118 54         fd = 0;
 119 55         sync_soon = false;
 120 56         strlcpy(nickserv,'',NICKMAX);
 121 57 }
 122 .fi
 123 .SS "serverrec::~\fBserverrec\fP ()"
 124 .PP
 125 Destructor. Definition at line 41 of file servers.cpp.
 126 .PP
 127 .nf
 128 42 {
 129 43 }
 130 .fi
 131 .SH "Member Data Documentation"
 132 .PP
 133 .SS "char \fBserverrec::description\fP[MAXBUF]"
 134 .PP
 135 Description of the server. Definition at line 61 of file servers.h.
 136 .SS "int \fBserverrec::hops_away\fP"
 137 .PP
 138 number of hops away (for quick access) Definition at line 51 of file servers.h.
 139 .PP
 140 Referenced by serverrec().
 141 .SS "bool \fBserverrec::jupiter\fP"
 142 .PP
 143 is a JUPE server (faked to enforce a server ban) Definition at line 57 of file servers.h.
 144 .PP
 145 Referenced by serverrec().
 146 .SS "char \fBserverrec::name\fP[MAXBUF]"
 147 .PP
 148 server name Definition at line 36 of file servers.h.
 149 .PP
 150 Referenced by serverrec().
 151 .SS "char \fBserverrec::nickserv\fP[NICKMAX]"
 152 .PP
 153 Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/). Definition at line 65 of file servers.h.
 154 .PP
 155 Referenced by serverrec().
 156 .SS "long \fBserverrec::opercount\fP"
 157 .PP
 158 opers on server Definition at line 48 of file servers.h.
 159 .PP
 160 Referenced by serverrec().
 161 .SS "long \fBserverrec::pingtime\fP"
 162 .PP
 163 last ping response (ms) Definition at line 39 of file servers.h.
 164 .PP
 165 Referenced by serverrec().
 166 .SS "bool \fBserverrec::sync_soon\fP"
 167 .PP
 168 Definition at line 67 of file servers.h.
 169 .PP
 170 Referenced by serverrec().
 171 .SS "long \fBserverrec::usercount\fP"
 172 .PP
 173 non-invisible users on server Definition at line 45 of file servers.h.
 174 .PP
 175 Referenced by serverrec().
 176 .SS "long \fBserverrec::usercount_i\fP"
 177 .PP
 178 invisible users on server Definition at line 42 of file servers.h.
 179 .PP
 180 Referenced by serverrec().
 181 .SS "long \fBserverrec::version\fP"
 182 .PP
 183 ircd version Definition at line 54 of file servers.h.
 184 .PP
 185 Referenced by serverrec().
 186
 187 .SH "Author"
 188 .PP
 189 Generated automatically by Doxygen for InspIRCd from the source code.