From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classserverrec.html | 365 ++++++++++++++++++++---------------- 1 file changed, 202 insertions(+), 163 deletions(-) (limited to 'docs/module-doc/classserverrec.html') diff --git a/docs/module-doc/classserverrec.html b/docs/module-doc/classserverrec.html index e762c3878..aed076b09 100644 --- a/docs/module-doc/classserverrec.html +++ b/docs/module-doc/classserverrec.html @@ -1,72 +1,79 @@ -serverrec class Reference +InspIRCd: serverrec class Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

serverrec Class Reference

A class that defines the local server or a remote server. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

serverrec Class Reference

A class that defines the local server or a remote server. More...

#include <servers.h>

-Inheritance diagram for serverrec:

Inheritance graph
- - - - - -
[legend]
Collaboration diagram for serverrec:

Collaboration graph
- - - -
[legend]
List of all members. +Inherits connection. +

+List of all members.

- - - - - - + + + + + + + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 serverrec ()
 Constructor.

 serverrec (char *n, long ver, bool jupe)
 Constructor which initialises some of the main variables.

 ~serverrec ()
 Destructor.

 serverrec ()
 Constructor.

 serverrec (char *n, long ver, bool jupe)
 Constructor which initialises some of the main variables.

 ~serverrec ()
 Destructor.


Public Attributes

char name [MAXBUF]
 server name

long pingtime
 last ping response (ms)

long usercount_i
 invisible users on server

long usercount
 non-invisible users on server

long opercount
 opers on server

int hops_away
 number of hops away (for quick access)

long version
 ircd version

bool jupiter
 is a JUPE server (faked to enforce a server ban)

char description [MAXBUF]
 Description of the server.

bool sync_soon
char name [MAXBUF]
 server name

long pingtime
 last ping response (ms)

long usercount_i
 invisible users on server

long usercount
 non-invisible users on server

long opercount
 opers on server

int hops_away
 number of hops away (for quick access)

long version
 ircd version

bool jupiter
 is a JUPE server (faked to enforce a server ban)

char description [MAXBUF]
 Description of the server.

char nickserv [NICKMAX]
 Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/).

bool sync_soon

Detailed Description

-A class that defines the local server or a remote server. +A class that defines the local server or a remote server.

-Definition at line 19 of file servers.h.

Constructor & Destructor Documentation

+Definition at line 30 of file servers.h.

Constructor & Destructor Documentation

- +
-
+ - - + + @@ -82,50 +89,51 @@ Definition at line 19 of
serverrec::serverrec (   )   ) 

-Constructor. +Constructor.

-Definition at line 12 of file servers.cpp. -

-References connection::fd, hops_away, jupiter, connection::lastping, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version. -

-

00013 {
-00014         strcpy(name,"");
-00015         pingtime = 0;
-00016         lastping = time(NULL);
-00017         usercount_i = usercount = opercount = version = 0;
-00018         hops_away = 1;
-00019         signon = time(NULL);
-00020         jupiter = false;
-00021         fd = 0;
-00022         sync_soon = false;
-00023 }
+Definition at line 23 of file servers.cpp.
+

+References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version.
+

+
00024 {
+00025         strlcpy(name,"",256);
+00026         pingtime = 0;
+00027         lastping = time(NULL);
+00028         usercount_i = usercount = opercount = version = 0;
+00029         hops_away = 1;
+00030         signon = time(NULL);
+00031         jupiter = false;
+00032         fd = 0;
+00033         sync_soon = false;
+00034         strlcpy(nickserv,"",NICKMAX);
+00035 }

- +
-
+ - + - + - + @@ -145,38 +153,39 @@ References connection::fd<
serverrec::serverrec (  char *   n, n,
long   ver, ver,
bool   jupe jupe

-Constructor which initialises some of the main variables. +Constructor which initialises some of the main variables.

-Definition at line 30 of file servers.cpp. -

-References connection::fd, hops_away, jupiter, connection::lastping, opercount, connection::signon, sync_soon, usercount, usercount_i, and version. -

-

00031 {
-00032         strcpy(name,n);
-00033         lastping = time(NULL);
-00034         usercount_i = usercount = opercount = 0;
-00035         version = ver;
-00036         hops_away = 1;
-00037         signon = time(NULL);
-00038         jupiter = jupe;
-00039         fd = 0;
-00040         sync_soon = false;
-00041 }
+Definition at line 42 of file servers.cpp.
+

+References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, usercount, usercount_i, and version.
+

+
00043 {
+00044         strlcpy(name,n,256);
+00045         lastping = time(NULL);
+00046         usercount_i = usercount = opercount = 0;
+00047         version = ver;
+00048         hops_away = 1;
+00049         signon = time(NULL);
+00050         jupiter = jupe;
+00051         fd = 0;
+00052         sync_soon = false;
+00053         strlcpy(nickserv,"",NICKMAX);
+00054 }

- +
-
+ - + - - + + @@ -192,25 +201,25 @@ References connection::fd<
serverrec::~serverrec serverrec::~serverrec (   )   ) 

-Destructor. +Destructor.

-Definition at line 26 of file servers.cpp. +Definition at line 38 of file servers.cpp.

-

00027 {
-00028 }
+
00039 {
+00040 }

Member Data Documentation

-

- +

+

- @@ -223,20 +232,20 @@ Definition at line 26 o +Definition at line 61 of file servers.h.
+ -
char serverrec::description[MAXBUF] + char serverrec::description[MAXBUF]

-Description of the server. +Description of the server.

-Definition at line 50 of file servers.h.

-

- +

+

- @@ -249,22 +258,22 @@ Definition at line 50 of +Referenced by serverrec().
+ -
int serverrec::hops_away + int serverrec::hops_away

-number of hops away (for quick access) +number of hops away (for quick access)

-Definition at line 40 of file servers.h. +Definition at line 51 of file servers.h.

-Referenced by serverrec().

-

- +

+

- @@ -277,22 +286,22 @@ Referenced by serverrec()

-is a JUPE server (faked to enforce a server ban) +is a JUPE server (faked to enforce a server ban)

-Definition at line 46 of file servers.h. +Definition at line 57 of file servers.h.

-Referenced by serverrec(). +Referenced by serverrec().

+ -
bool serverrec::jupiter + bool serverrec::jupiter
-

- +

+

- @@ -305,20 +314,50 @@ Referenced by serverrec()

-server name +server name

-Definition at line 25 of file servers.h. +Definition at line 36 of file servers.h. +

+Referenced by serverrec(). + +

+ -
char serverrec::name[MAXBUF] + char serverrec::name[MAXBUF]
+

+ + + + +
+ + +
char serverrec::nickserv[NICKMAX] +
+
+ + + +
+   + + +

+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. +

+Referenced by serverrec().

-

- +

+

- @@ -331,22 +370,22 @@ Definition at line 25 of +Referenced by serverrec().
+ -
long serverrec::opercount + long serverrec::opercount

-opers on server +opers on server

-Definition at line 37 of file servers.h. +Definition at line 48 of file servers.h.

-Referenced by serverrec().

-

- +

+

- @@ -359,22 +398,22 @@ Referenced by serverrec()

-last ping response (ms) +last ping response (ms)

-Definition at line 28 of file servers.h. +Definition at line 39 of file servers.h.

-Referenced by serverrec(). +Referenced by serverrec().

+ -
long serverrec::pingtime + long serverrec::pingtime
-

- +

+

- @@ -389,18 +428,18 @@ Referenced by serverrec()

-Definition at line 52 of file servers.h. +Definition at line 67 of file servers.h.

-Referenced by serverrec(). +Referenced by serverrec().

+ -
bool serverrec::sync_soon + bool serverrec::sync_soon
-

- +

+

- @@ -413,22 +452,22 @@ Referenced by serverrec()

-non-invisible users on server +non-invisible users on server

-Definition at line 34 of file servers.h. +Definition at line 45 of file servers.h.

-Referenced by serverrec(). +Referenced by serverrec().

+ -
long serverrec::usercount + long serverrec::usercount
-

- +

+

- @@ -441,22 +480,22 @@ Referenced by serverrec()

-invisible users on server +invisible users on server

-Definition at line 31 of file servers.h. +Definition at line 42 of file servers.h.

-Referenced by serverrec(). +Referenced by serverrec().

+ -
long serverrec::usercount_i + long serverrec::usercount_i
-

- +

+

- @@ -469,20 +508,20 @@ Referenced by serverrec()

-ircd version +ircd version

-Definition at line 43 of file servers.h. +Definition at line 54 of file servers.h.

-Referenced by serverrec(). +Referenced by serverrec().

+ -
long serverrec::version + long serverrec::version

The documentation for this class was generated from the following files: -
Generated on Sun May 2 00:09:44 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
-- cgit v1.3.1-10-gc9f91