From 767b12b0ab6a0d4ed5f7335b26d1c0f842d99543 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 26 Jan 2003 23:52:48 +0000 Subject: Modified documentation for base classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@150 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/annotated.html | 6 +- docs/module-doc/base_8h-source.html | 40 ++ docs/module-doc/base_8h.html | 23 + docs/module-doc/channels_8h-source.html | 219 ++++----- docs/module-doc/channels_8h.html | 19 +- docs/module-doc/classAdmin-members.html | 5 +- docs/module-doc/classAdmin.html | 15 +- docs/module-doc/classAdmin.png | Bin 0 -> 297 bytes docs/module-doc/classBanItem-members.html | 5 +- docs/module-doc/classBanItem.html | 7 +- docs/module-doc/classBanItem.png | Bin 303 -> 395 bytes docs/module-doc/classConfigReader-members.html | 5 +- docs/module-doc/classConfigReader.html | 17 +- docs/module-doc/classConfigReader.png | Bin 0 -> 366 bytes docs/module-doc/classConnectClass-members.html | 2 +- docs/module-doc/classConnectClass.html | 10 +- docs/module-doc/classExemptItem-members.html | 5 +- docs/module-doc/classExemptItem.html | 7 +- docs/module-doc/classExemptItem.png | Bin 333 -> 419 bytes docs/module-doc/classFileReader-members.html | 5 +- docs/module-doc/classFileReader.html | 19 +- docs/module-doc/classFileReader.png | Bin 0 -> 329 bytes docs/module-doc/classHostItem-members.html | 5 +- docs/module-doc/classHostItem.html | 25 +- docs/module-doc/classHostItem.png | Bin 511 -> 641 bytes docs/module-doc/classInviteItem-members.html | 5 +- docs/module-doc/classInviteItem.html | 7 +- docs/module-doc/classInviteItem.png | Bin 318 -> 402 bytes docs/module-doc/classInvited-members.html | 2 +- docs/module-doc/classInvited.html | 6 +- docs/module-doc/classModule-members.html | 5 +- docs/module-doc/classModule.html | 9 +- docs/module-doc/classModule.png | Bin 0 -> 305 bytes docs/module-doc/classModuleFactory-members.html | 5 +- docs/module-doc/classModuleFactory.html | 17 +- docs/module-doc/classModuleFactory.png | Bin 0 -> 367 bytes docs/module-doc/classServer-members.html | 5 +- docs/module-doc/classServer.html | 9 +- docs/module-doc/classServer.png | Bin 0 -> 320 bytes docs/module-doc/classVersion-members.html | 5 +- docs/module-doc/classVersion.html | 17 +- docs/module-doc/classVersion.png | Bin 0 -> 311 bytes docs/module-doc/classchanrec-members.html | 5 +- docs/module-doc/classchanrec.html | 65 +-- docs/module-doc/classchanrec.png | Bin 0 -> 308 bytes docs/module-doc/classclassbase-members.html | 18 + docs/module-doc/classclassbase.html | 134 ++++++ docs/module-doc/classclassbase.png | Bin 0 -> 1546 bytes docs/module-doc/classcommand__t-members.html | 24 + docs/module-doc/classcommand__t.html | 178 +++++++ docs/module-doc/classcommand__t.png | Bin 0 -> 324 bytes docs/module-doc/classconnection-members.html | 33 ++ docs/module-doc/classconnection.html | 433 +++++++++++++++++ docs/module-doc/classconnection.png | Bin 0 -> 536 bytes docs/module-doc/classes.html | 14 +- docs/module-doc/classserverrec-members.html | 49 ++ docs/module-doc/classserverrec.html | 591 ++++++++++++++++++++++++ docs/module-doc/classserverrec.png | Bin 0 -> 413 bytes docs/module-doc/classucrec-members.html | 5 +- docs/module-doc/classucrec.html | 21 +- docs/module-doc/classucrec.png | Bin 0 -> 296 bytes docs/module-doc/classuserrec-members.html | 51 +- docs/module-doc/classuserrec.html | 557 +++------------------- docs/module-doc/classuserrec.png | Bin 0 -> 395 bytes docs/module-doc/connection_8h-source.html | 57 +++ docs/module-doc/connection_8h.html | 25 + docs/module-doc/ctables_8h-source.html | 73 +++ docs/module-doc/ctables_8h.html | 51 ++ docs/module-doc/files.html | 7 +- docs/module-doc/functions.html | 112 +++-- docs/module-doc/globals.html | 16 +- docs/module-doc/hierarchy.html | 16 +- docs/module-doc/main.html | 2 +- docs/module-doc/modules_8cpp-source.html | 6 +- docs/module-doc/modules_8cpp.html | 2 +- docs/module-doc/modules_8h-source.html | 209 ++++----- docs/module-doc/modules_8h.html | 7 +- docs/module-doc/servers_8cpp-source.html | 78 ++++ docs/module-doc/servers_8cpp.html | 24 + docs/module-doc/servers_8h-source.html | 67 +++ docs/module-doc/servers_8h.html | 106 +++++ docs/module-doc/tree.js | 41 +- docs/module-doc/users_8cpp-source.html | 20 +- docs/module-doc/users_8cpp.html | 2 +- docs/module-doc/users_8h-source.html | 185 ++++---- docs/module-doc/users_8h.html | 19 +- 86 files changed, 2764 insertions(+), 1070 deletions(-) create mode 100644 docs/module-doc/base_8h-source.html create mode 100644 docs/module-doc/base_8h.html create mode 100644 docs/module-doc/classAdmin.png create mode 100644 docs/module-doc/classConfigReader.png create mode 100644 docs/module-doc/classFileReader.png create mode 100644 docs/module-doc/classModule.png create mode 100644 docs/module-doc/classModuleFactory.png create mode 100644 docs/module-doc/classServer.png create mode 100644 docs/module-doc/classVersion.png create mode 100644 docs/module-doc/classchanrec.png create mode 100644 docs/module-doc/classclassbase-members.html create mode 100644 docs/module-doc/classclassbase.html create mode 100644 docs/module-doc/classclassbase.png create mode 100644 docs/module-doc/classcommand__t-members.html create mode 100644 docs/module-doc/classcommand__t.html create mode 100644 docs/module-doc/classcommand__t.png create mode 100644 docs/module-doc/classconnection-members.html create mode 100644 docs/module-doc/classconnection.html create mode 100644 docs/module-doc/classconnection.png create mode 100644 docs/module-doc/classserverrec-members.html create mode 100644 docs/module-doc/classserverrec.html create mode 100644 docs/module-doc/classserverrec.png create mode 100644 docs/module-doc/classucrec.png create mode 100644 docs/module-doc/classuserrec.png create mode 100644 docs/module-doc/connection_8h-source.html create mode 100644 docs/module-doc/connection_8h.html create mode 100644 docs/module-doc/ctables_8h-source.html create mode 100644 docs/module-doc/ctables_8h.html create mode 100644 docs/module-doc/servers_8cpp-source.html create mode 100644 docs/module-doc/servers_8cpp.html create mode 100644 docs/module-doc/servers_8h-source.html create mode 100644 docs/module-doc/servers_8h.html (limited to 'docs/module-doc') diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index d4f18b45f..2d8e7baf1 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -10,8 +10,11 @@ AdminHolds /ADMIN data This class contains the admin details of the local server BanItemA subclass of HostItem designed to hold channel bans (+b) chanrecHolds all relevent information for a channel + classbase + command_t ConfigReaderAllows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file ConnectClassHolds information relevent to <connect allow> and <connect deny> tags in the config file + connection ExemptItemA subclass of HostItem designed to hold channel exempts (+e) FileReaderCaches a text file into memory and can be used to retrieve lines from it HostItemHolds an entry for a ban list, exemption list, or invite list @@ -20,11 +23,12 @@ ModuleBase class for all InspIRCd modules This class is the base class for InspIRCd modules ModuleFactoryInstantiates classes inherited from Module This class creates a class inherited from type Module, using new ServerAllows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers + serverrec ucrecHolds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class userrecHolds all information about a user This class stores all information about a user connected to the irc server VersionHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module -
Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/base_8h-source.html b/docs/module-doc/base_8h-source.html new file mode 100644 index 000000000..fe451b786 --- /dev/null +++ b/docs/module-doc/base_8h-source.html @@ -0,0 +1,40 @@ + + +base.h Source File + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

base.h

Go to the documentation of this file.
00001 /*
+00002 
+00003 $Log$
+00003 Revision 1.1  2003/01/26 23:52:47  brain
+00003 Modified documentation for base classes
+00003 
+00004 
+00005 */
+00006 
+00007 #include "inspircd_config.h" 
+00008 #include <time.h>
+00009  
+00010 #ifndef __BASE_H__ 
+00011 #define __BASE_H__ 
+00012  
+00013 class classbase
+00014 {
+00015  public:
+00016         time_t age;
+00017 
+00018         classbase() { age = time(NULL); }
+00019         ~classbase() { }
+00020 };
+00021 
+00022 #endif
+00023 
+

Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/base_8h.html b/docs/module-doc/base_8h.html new file mode 100644 index 000000000..0f004027d --- /dev/null +++ b/docs/module-doc/base_8h.html @@ -0,0 +1,23 @@ + + +base.h File Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

base.h File Reference

#include "inspircd_config.h"
+#include <time.h>
+ +

+Go to the source code of this file. + + + +

Compounds

class  classbase
+


Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html index e7ec3e226..bb38ba5e9 100644 --- a/docs/module-doc/channels_8h-source.html +++ b/docs/module-doc/channels_8h-source.html @@ -9,8 +9,8 @@

channels.h

Go to the documentation of this file.
00001 /*
 00002 
 00003 $Log$
-00003 Revision 1.2  2003/01/23 20:38:00  brain
-00003 Updated documentation scripts
+00003 Revision 1.3  2003/01/26 23:52:47  brain
+00003 Modified documentation for base classes
 00003 
 00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
 00005 InspIRCd second source tree
@@ -31,114 +31,115 @@
 00020 */
 00021 
 00022 #include "inspircd_config.h"
-00023 #include <time.h>
-00024 #include <vector>
-00025 
-00026 #ifndef __CHANNELS_H__
-00027 #define __CHANNELS_H__
-00028 
-00032 class HostItem
-00033 {
-00034  public:
-00035         time_t set_time;
-00036         char set_by[NICKMAX];
-00037         char data[MAXBUF];
-00038 
-00039         HostItem() { /* stub */ }
-00040         virtual ~HostItem() { /* stub */ }
-00041 };
-00042 
-00043 // banlist is inherited from HostList mainly for readability
-00044 // reasons only
-00045 
-00048 class BanItem : public HostItem
-00049 {
-00050 };
-00051 
-00052 // same with this...
-00053 
-00056 class ExemptItem : public HostItem
-00057 {
-00058 };
-00059 
-00060 // and this...
-00061 
-00064 class InviteItem : public HostItem
-00065 {
-00066 };
-00067 
+00023 #include "base.h"
+00024 #include <time.h>
+00025 #include <vector>
+00026 
+00027 #ifndef __CHANNELS_H__
+00028 #define __CHANNELS_H__
+00029 
+00033 class HostItem : public classbase
+00034 {
+00035  public:
+00036         time_t set_time;
+00037         char set_by[NICKMAX];
+00038         char data[MAXBUF];
+00039 
+00040         HostItem() { /* stub */ }
+00041         virtual ~HostItem() { /* stub */ }
+00042 };
+00043 
+00044 // banlist is inherited from HostList mainly for readability
+00045 // reasons only
+00046 
+00049 class BanItem : public HostItem
+00050 {
+00051 };
+00052 
+00053 // same with this...
+00054 
+00057 class ExemptItem : public HostItem
+00058 {
+00059 };
+00060 
+00061 // and this...
+00062 
+00065 class InviteItem : public HostItem
+00066 {
+00067 };
 00068 
-00071 typedef vector<BanItem>         BanList;
-00072 
-00075 typedef vector<ExemptItem>      ExemptList;
-00076 
-00079 typedef vector<InviteItem>      InviteList;
-00080 
-00085 class chanrec
-00086 {
-00087  public:
-00090         char name[CHANMAX]; /* channel name */
-00094         char custom_modes[MAXMODES];     /* modes handled by modules */
-00098         char topic[MAXBUF];
-00101         time_t created;
-00105         time_t topicset;
-00109         char setby[NICKMAX];
-00110 
-00114         long limit;
-00115         
-00119         char key[32];
-00120         
-00123         short int topiclock;
-00124         
-00127         short int noexternal;
-00128         
-00131         short int inviteonly;
-00132         
-00135         short int moderated;
-00136         
-00140         short int secret;
-00141         
-00145         short int c_private;
-00146         
-00149         BanList bans;
-00150 
-00153         chanrec()
-00154         {
-00155                 strcpy(name,"");
-00156                 strcpy(custom_modes,"");
-00157                 strcpy(topic,"");
-00158                 strcpy(setby,"");
-00159                 strcpy(key,"");
-00160                 created = topicset = limit = 0;
-00161                 topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
-00162         }
-00163 
-00164         virtual ~chanrec() { /* stub */ }
-00165 };
-00166 
-00167 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
-00168  * needs to come AFTER struct chanrec */
-00169 
-00170 #define UCMODE_OP      1
-00171 #define UCMODE_VOICE   2
-00172 #define UCMODE_HOP     4
-00173 #define UCMODE_PROTECT 8
-00174 #define UCMODE_FOUNDER 16
-00175  
-00181 class ucrec
-00182 {
-00183  public:
-00187         long uc_modes;
-00188         
-00192         chanrec *channel;
-00193 
-00194         ucrec() { /* stub */ }
-00195         virtual ~ucrec() { /* stub */ }
-00196 };
-00197 
-00198 #endif
-00199 
-

Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +00069 +00072 typedef vector<BanItem> BanList; +00073 +00076 typedef vector<ExemptItem> ExemptList; +00077 +00080 typedef vector<InviteItem> InviteList; +00081 +00086 class chanrec : public classbase +00087 { +00088 public: +00091 char name[CHANMAX]; /* channel name */ +00095 char custom_modes[MAXMODES]; /* modes handled by modules */ +00099 char topic[MAXBUF]; +00102 time_t created; +00106 time_t topicset; +00110 char setby[NICKMAX]; +00111 +00115 long limit; +00116 +00120 char key[32]; +00121 +00124 short int topiclock; +00125 +00128 short int noexternal; +00129 +00132 short int inviteonly; +00133 +00136 short int moderated; +00137 +00141 short int secret; +00142 +00146 short int c_private; +00147 +00150 BanList bans; +00151 +00154 chanrec() +00155 { +00156 strcpy(name,""); +00157 strcpy(custom_modes,""); +00158 strcpy(topic,""); +00159 strcpy(setby,""); +00160 strcpy(key,""); +00161 created = topicset = limit = 0; +00162 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; +00163 } +00164 +00165 virtual ~chanrec() { /* stub */ } +00166 }; +00167 +00168 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o +00169 * needs to come AFTER struct chanrec */ +00170 +00171 #define UCMODE_OP 1 +00172 #define UCMODE_VOICE 2 +00173 #define UCMODE_HOP 4 +00174 #define UCMODE_PROTECT 8 +00175 #define UCMODE_FOUNDER 16 +00176 +00182 class ucrec : public classbase +00183 { +00184 public: +00188 long uc_modes; +00189 +00193 chanrec *channel; +00194 +00195 ucrec() { /* stub */ } +00196 virtual ~ucrec() { /* stub */ } +00197 }; +00198 +00199 #endif +00200 +
Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html index 63eca174c..ef679999e 100644 --- a/docs/module-doc/channels_8h.html +++ b/docs/module-doc/channels_8h.html @@ -7,6 +7,7 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

channels.h File Reference

#include "inspircd_config.h"
+#include "base.h"
#include <time.h>
#include <vector>
@@ -62,7 +63,7 @@

-Definition at line 174 of file channels.h. +Definition at line 175 of file channels.h.

@@ -86,7 +87,7 @@ Definition at line 174 o

-Definition at line 172 of file channels.h. +Definition at line 173 of file channels.h.

@@ -110,7 +111,7 @@ Definition at line 172 o

-Definition at line 170 of file channels.h. +Definition at line 171 of file channels.h.

@@ -134,7 +135,7 @@ Definition at line 170 o

-Definition at line 173 of file channels.h. +Definition at line 174 of file channels.h.

@@ -158,7 +159,7 @@ Definition at line 173 o

-Definition at line 171 of file channels.h. +Definition at line 172 of file channels.h.


Typedef Documentation

@@ -185,7 +186,7 @@ Holds a complete ban list.

-Definition at line 71 of file channels.h. +Definition at line 72 of file channels.h.

@@ -211,7 +212,7 @@ Holds a complete exempt list.

-Definition at line 75 of file channels.h. +Definition at line 76 of file channels.h.

@@ -237,10 +238,10 @@ Holds a complete invite list.

-Definition at line 79 of file channels.h. +Definition at line 80 of file channels.h. -


Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html index c83a2591b..1daa1b5b0 100644 --- a/docs/module-doc/classAdmin-members.html +++ b/docs/module-doc/classAdmin-members.html @@ -8,10 +8,13 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Admin Member List

This is the complete list of members for Admin, including all inherited members. + + -
Admin(string name, string email, string nick)Admin
ageclassbase
classbase()classbase [inline]
EmailAdmin
NameAdmin
NickAdmin

Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by + ~classbase()classbase [inline] +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html index bd8b5fe31..85dab0f85 100644 --- a/docs/module-doc/classAdmin.html +++ b/docs/module-doc/classAdmin.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for Admin: +

+ +classbase + List of all members. @@ -27,7 +32,7 @@ It is constructed by class Server, and

-Definition at line 73 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 74 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -99,7 +104,7 @@ Definition at line 36 o

-Definition at line 76 of file modules.h. +Definition at line 77 of file modules.h.

@@ -123,7 +128,7 @@ Definition at line 76 of

-Definition at line 76 of file modules.h. +Definition at line 77 of file modules.h.

@@ -147,12 +152,12 @@ Definition at line 76 of

-Definition at line 76 of file modules.h. +Definition at line 77 of file modules.h.


The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classAdmin.png b/docs/module-doc/classAdmin.png new file mode 100644 index 000000000..0f63279cc Binary files /dev/null and b/docs/module-doc/classAdmin.png differ diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html index a78f2f8f7..5954da3ac 100644 --- a/docs/module-doc/classBanItem-members.html +++ b/docs/module-doc/classBanItem-members.html @@ -7,12 +7,15 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

BanItem Member List

This is the complete list of members for BanItem, including all inherited members. + + + -
ageclassbase
classbase()classbase [inline]
dataHostItem
HostItem()HostItem [inline]
set_byHostItem
set_timeHostItem
~classbase()classbase [inline]
~HostItem()HostItem [inline, virtual]

Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html index 00ab8839e..f0cabdbd2 100644 --- a/docs/module-doc/classBanItem.html +++ b/docs/module-doc/classBanItem.html @@ -14,7 +14,8 @@

Inheritance diagram for BanItem:

-HostItem +HostItem +classbase List of all members. @@ -24,9 +25,9 @@ A subclass of HostItem designed to h

-Definition at line 48 of file channels.h.


The documentation for this class was generated from the following file:
    +Definition at line 49 of file channels.h.
    The documentation for this class was generated from the following file: -
    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/classBanItem.png b/docs/module-doc/classBanItem.png index e0a7f35b2..e8da224a0 100644 Binary files a/docs/module-doc/classBanItem.png and b/docs/module-doc/classBanItem.png differ diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html index 1559b9b12..b3f6ced5e 100644 --- a/docs/module-doc/classConfigReader-members.html +++ b/docs/module-doc/classConfigReader-members.html @@ -7,14 +7,17 @@
    Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    ConfigReader Member List

    This is the complete list of members for ConfigReader, including all inherited members.
+ + + -
ageclassbase
classbase()classbase [inline]
ConfigReader()ConfigReader
ConfigReader(string filename)ConfigReader
Enumerate(string tag)ConfigReader
fnameConfigReader [protected]
ReadValue(string tag, string name, int index)ConfigReader
Verify()ConfigReader
~classbase()classbase [inline]
~ConfigReader()ConfigReader

Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index b0f5848a6..5e10ed3b5 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for ConfigReader: +

+ +classbase + List of all members. @@ -37,7 +42,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 232 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 233 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -69,7 +74,7 @@ This constructor initialises the ConfigReader class to read the inspircd.conf fi

Definition at line 164 of file modules.cpp.

-References fname. +References fname.

00165 {
 00166         fname = CONFIG_FILE;
@@ -182,7 +187,7 @@ This method counts the number of times a tag appears in a config file, for use w
 

Definition at line 186 of file modules.cpp.

-References fname. +References fname.

00187 {
 00188         return EnumConf(fname.c_str(),tag.c_str());
@@ -237,7 +242,7 @@ This method retrieves a value from the config file. Where multiple copies of the
 

Definition at line 177 of file modules.cpp.

-References fname. +References fname.

00178 {
 00179         char val[MAXBUF];
@@ -309,14 +314,14 @@ The filename of the configuration file, as set by the constructor.
 

-Definition at line 237 of file modules.h. +Definition at line 238 of file modules.h.

Referenced by ConfigReader(), Enumerate(), and ReadValue().


The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classConfigReader.png b/docs/module-doc/classConfigReader.png new file mode 100644 index 000000000..00a56d3e3 Binary files /dev/null and b/docs/module-doc/classConfigReader.png differ diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html index 94847bf83..4528e3094 100644 --- a/docs/module-doc/classConnectClass-members.html +++ b/docs/module-doc/classConnectClass-members.html @@ -10,7 +10,7 @@ hostConnectClass passConnectClass typeConnectClass -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html index 2c4690186..0b37bf760 100644 --- a/docs/module-doc/classConnectClass.html +++ b/docs/module-doc/classConnectClass.html @@ -23,7 +23,7 @@ Holds information relevent to <connect allow> and <connect deny> tag

-Definition at line 59 of file users.h.


Member Data Documentation

+Definition at line 60 of file users.h.

Member Data Documentation

@@ -45,7 +45,7 @@ Definition at line 59 of fi

-Definition at line 63 of file users.h. +Definition at line 64 of file users.h.

@@ -69,7 +69,7 @@ Definition at line 63 of fi

-Definition at line 64 of file users.h. +Definition at line 65 of file users.h.

@@ -93,12 +93,12 @@ Definition at line 64 of fi

-Definition at line 62 of file users.h. +Definition at line 63 of file users.h.


The documentation for this class was generated from the following file: -
Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html index 31ca9025c..e299a5639 100644 --- a/docs/module-doc/classExemptItem-members.html +++ b/docs/module-doc/classExemptItem-members.html @@ -7,12 +7,15 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ExemptItem Member List

This is the complete list of members for ExemptItem, including all inherited members. + + + -
ageclassbase
classbase()classbase [inline]
dataHostItem
HostItem()HostItem [inline]
set_byHostItem
set_timeHostItem
~classbase()classbase [inline]
~HostItem()HostItem [inline, virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html index cb674c035..6e2185565 100644 --- a/docs/module-doc/classExemptItem.html +++ b/docs/module-doc/classExemptItem.html @@ -14,7 +14,8 @@

Inheritance diagram for ExemptItem:

-HostItem +HostItem +classbase List of all members. @@ -24,9 +25,9 @@ A subclass of HostItem designed to h

-Definition at line 56 of file channels.h.


The documentation for this class was generated from the following file:
    +Definition at line 57 of file channels.h.
    The documentation for this class was generated from the following file: -
    Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/classExemptItem.png b/docs/module-doc/classExemptItem.png index 6aa67a9ef..dd417793b 100644 Binary files a/docs/module-doc/classExemptItem.png and b/docs/module-doc/classExemptItem.png differ diff --git a/docs/module-doc/classFileReader-members.html b/docs/module-doc/classFileReader-members.html index 74cbb18fc..29ab2db82 100644 --- a/docs/module-doc/classFileReader-members.html +++ b/docs/module-doc/classFileReader-members.html @@ -7,14 +7,17 @@
    Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    FileReader Member List

    This is the complete list of members for FileReader, including all inherited members.
+ + + -
ageclassbase
classbase()classbase [inline]
fcFileReader [private]
FileReader()FileReader
FileReader(string filename)FileReader
FileSize()FileReader
GetLine(int x)FileReader
LoadFile(string filename)FileReader
~classbase()classbase [inline]
~FileReader()FileReader

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 9b2a4f528..b947824a3 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for FileReader: +

+ +classbase + List of all members. @@ -36,7 +41,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 277 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 278 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -105,7 +110,7 @@ This method initialises the class with a file loaded into it ready for GetLine a

Definition at line 198 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

00199 {
 00200         file_cache c;
@@ -183,7 +188,7 @@ This method returns the number of lines in the read file. If it is 0, no lines h
 

Definition at line 227 of file modules.cpp.

-References fc. +References fc.

00228 {
 00229         return fc.size();
@@ -223,7 +228,7 @@ This method retrieves one line from the text file. If an empty non-NULL string i
 

Definition at line 220 of file modules.cpp.

-References fc. +References fc.

00221 {
 00222         if ((x<0) || (x>fc.size()))
@@ -265,7 +270,7 @@ This method loads a file into the class ready for GetLine and and other methods
 

Definition at line 209 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

00210 {
 00211         file_cache c;
@@ -297,14 +302,14 @@ References fc, and 
 
 

-Definition at line 279 of file modules.h. +Definition at line 280 of file modules.h.

Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().


The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classFileReader.png b/docs/module-doc/classFileReader.png new file mode 100644 index 000000000..0c3caf58e Binary files /dev/null and b/docs/module-doc/classFileReader.png differ diff --git a/docs/module-doc/classHostItem-members.html b/docs/module-doc/classHostItem-members.html index d7f393919..765558192 100644 --- a/docs/module-doc/classHostItem-members.html +++ b/docs/module-doc/classHostItem-members.html @@ -7,12 +7,15 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

HostItem Member List

This is the complete list of members for HostItem, including all inherited members. + + + -
ageclassbase
classbase()classbase [inline]
dataHostItem
HostItem()HostItem [inline]
set_byHostItem
set_timeHostItem
~classbase()classbase [inline]
~HostItem()HostItem [inline, virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classHostItem.html b/docs/module-doc/classHostItem.html index 101dfcbd9..192877d28 100644 --- a/docs/module-doc/classHostItem.html +++ b/docs/module-doc/classHostItem.html @@ -14,9 +14,10 @@

Inheritance diagram for HostItem:

-BanItem -ExemptItem -InviteItem +classbase +BanItem +ExemptItem +InviteItem List of all members. @@ -35,7 +36,7 @@ This class contains a single element in a channel list, such as a banlist.

-Definition at line 32 of file channels.h.


Constructor & Destructor Documentation

+Definition at line 33 of file channels.h.

Constructor & Destructor Documentation

@@ -63,9 +64,9 @@ Definition at line 32 of

-Definition at line 39 of file channels.h. +Definition at line 40 of file channels.h.

-

00039 { /* stub */ }
+
00040 { /* stub */ }
 
@@ -96,9 +97,9 @@ Definition at line 39 of

-Definition at line 40 of file channels.h. +Definition at line 41 of file channels.h.

-

00040 { /* stub */ }
+
00041 { /* stub */ }
 
@@ -124,7 +125,7 @@ Definition at line 40 of

-Definition at line 37 of file channels.h. +Definition at line 38 of file channels.h.

@@ -148,7 +149,7 @@ Definition at line 37 of

-Definition at line 36 of file channels.h. +Definition at line 37 of file channels.h.

@@ -172,12 +173,12 @@ Definition at line 36 of

-Definition at line 35 of file channels.h. +Definition at line 36 of file channels.h.


The documentation for this class was generated from the following file: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classHostItem.png b/docs/module-doc/classHostItem.png index 99f88aacd..234a4693e 100644 Binary files a/docs/module-doc/classHostItem.png and b/docs/module-doc/classHostItem.png differ diff --git a/docs/module-doc/classInviteItem-members.html b/docs/module-doc/classInviteItem-members.html index 059800c47..726c4dba5 100644 --- a/docs/module-doc/classInviteItem-members.html +++ b/docs/module-doc/classInviteItem-members.html @@ -7,12 +7,15 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

InviteItem Member List

This is the complete list of members for InviteItem, including all inherited members. + + + -
ageclassbase
classbase()classbase [inline]
dataHostItem
HostItem()HostItem [inline]
set_byHostItem
set_timeHostItem
~classbase()classbase [inline]
~HostItem()HostItem [inline, virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classInviteItem.html b/docs/module-doc/classInviteItem.html index 378a39e1c..b2e4cba2a 100644 --- a/docs/module-doc/classInviteItem.html +++ b/docs/module-doc/classInviteItem.html @@ -14,7 +14,8 @@

Inheritance diagram for InviteItem:

-HostItem +HostItem +classbase List of all members. @@ -24,9 +25,9 @@ A subclass of HostItem designed to h

-Definition at line 64 of file channels.h.


The documentation for this class was generated from the following file:
    +Definition at line 65 of file channels.h.
    The documentation for this class was generated from the following file: -
    Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/classInviteItem.png b/docs/module-doc/classInviteItem.png index 8ebdd8403..0d913d8bb 100644 Binary files a/docs/module-doc/classInviteItem.png and b/docs/module-doc/classInviteItem.png differ diff --git a/docs/module-doc/classInvited-members.html b/docs/module-doc/classInvited-members.html index 3c6933fd6..d32697f37 100644 --- a/docs/module-doc/classInvited-members.html +++ b/docs/module-doc/classInvited-members.html @@ -8,7 +8,7 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    Invited Member List

    This is the complete list of members for Invited, including all inherited members.
-
channelInvited

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classInvited.html b/docs/module-doc/classInvited.html index e72b2ffae..3021a0ec0 100644 --- a/docs/module-doc/classInvited.html +++ b/docs/module-doc/classInvited.html @@ -21,7 +21,7 @@ Holds a channel name to which a user has been invited.

-Definition at line 50 of file users.h.


Member Data Documentation

+Definition at line 51 of file users.h.

Member Data Documentation

@@ -43,14 +43,14 @@ Definition at line 50 of fi

-Definition at line 53 of file users.h. +Definition at line 54 of file users.h.

Referenced by userrec::InviteTo().


The documentation for this class was generated from the following file: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classModule-members.html b/docs/module-doc/classModule-members.html index 43e881053..cdca891f2 100644 --- a/docs/module-doc/classModule-members.html +++ b/docs/module-doc/classModule-members.html @@ -7,14 +7,17 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Module Member List

This is the complete list of members for Module, including all inherited members. + + + -
ageclassbase
classbase()classbase [inline]
GetVersion()Module [virtual]
Module()Module
OnUserConnect(userrec *user)Module [virtual]
OnUserJoin(userrec *user, chanrec *channel)Module [virtual]
OnUserPart(userrec *user, chanrec *channel)Module [virtual]
OnUserQuit(userrec *user)Module [virtual]
~classbase()classbase [inline]
~Module()Module [virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 77f703241..64d44b3dd 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for Module: +

+ +classbase + List of all members. @@ -36,7 +41,7 @@ All modules must inherit from this class, its methods will be called when irc se

-Definition at line 85 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 86 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -307,7 +312,7 @@ Definition at line 46 o

The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classModule.png b/docs/module-doc/classModule.png new file mode 100644 index 000000000..6409d0a79 Binary files /dev/null and b/docs/module-doc/classModule.png differ diff --git a/docs/module-doc/classModuleFactory-members.html b/docs/module-doc/classModuleFactory-members.html index 62b87671d..6ed9f0344 100644 --- a/docs/module-doc/classModuleFactory-members.html +++ b/docs/module-doc/classModuleFactory-members.html @@ -7,10 +7,13 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ModuleFactory Member List

This is the complete list of members for ModuleFactory, including all inherited members. + + + -
ageclassbase
classbase()classbase [inline]
CreateModule()=0ModuleFactory [pure virtual]
ModuleFactory()ModuleFactory [inline]
~classbase()classbase [inline]
~ModuleFactory()ModuleFactory [inline, virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html index e3f4b4777..03381353b 100644 --- a/docs/module-doc/classModuleFactory.html +++ b/docs/module-doc/classModuleFactory.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for ModuleFactory: +

+ +classbase + List of all members. @@ -26,7 +31,7 @@ This is to allow for modules to create many different variants of

-Definition at line 322 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 323 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -54,9 +59,9 @@ Definition at line 322 of

-Definition at line 325 of file modules.h. +Definition at line 326 of file modules.h.

-

00325 { }
+
00326 { }
 
@@ -87,9 +92,9 @@ Definition at line 325 of

-Definition at line 326 of file modules.h. +Definition at line 327 of file modules.h.

-

00326 { }
+
00327 { }
 
@@ -126,7 +131,7 @@ Your inherited class of ModuleFactory must return a pointer to your modules.h -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classModuleFactory.png b/docs/module-doc/classModuleFactory.png new file mode 100644 index 000000000..80b4d4c1c Binary files /dev/null and b/docs/module-doc/classModuleFactory.png differ diff --git a/docs/module-doc/classServer-members.html b/docs/module-doc/classServer-members.html index 2cef181d3..7a8d5ce75 100644 --- a/docs/module-doc/classServer-members.html +++ b/docs/module-doc/classServer-members.html @@ -7,7 +7,9 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Server Member List

This is the complete list of members for Server, including all inherited members. + + @@ -25,8 +27,9 @@ + -
ageclassbase
ChanMode(userrec *User, chanrec *Chan)Server [virtual]
classbase()classbase [inline]
CommonChannels(userrec *u1, userrec *u2)Server [virtual]
Debug(string s)Server [virtual]
FindChannel(string channel)Server [virtual]
SendTo(userrec *Source, userrec *Dest, string s)Server [virtual]
SendWallops(userrec *User, string text)Server [virtual]
Server()Server
~classbase()classbase [inline]
~Server()Server [virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 9e7a519d6..2666302d8 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for Server: +

+ +classbase + List of all members. @@ -60,7 +65,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 127 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 128 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -905,7 +910,7 @@ Definition at line 122

The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classServer.png b/docs/module-doc/classServer.png new file mode 100644 index 000000000..e46d0d15d Binary files /dev/null and b/docs/module-doc/classServer.png differ diff --git a/docs/module-doc/classVersion-members.html b/docs/module-doc/classVersion-members.html index f0284a3b5..e4a6f3c8e 100644 --- a/docs/module-doc/classVersion-members.html +++ b/docs/module-doc/classVersion-members.html @@ -7,12 +7,15 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Version Member List

This is the complete list of members for Version, including all inherited members. + + -
ageclassbase
BuildVersion
classbase()classbase [inline]
MajorVersion
MinorVersion
RevisionVersion
Version(int major, int minor, int revision, int build)Version

Generated on Thu Jan 23 20:29:00 2003 for InspIRCd by + ~classbase()classbase [inline] +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classVersion.html b/docs/module-doc/classVersion.html index bb853c74a..d708524b5 100644 --- a/docs/module-doc/classVersion.html +++ b/docs/module-doc/classVersion.html @@ -11,6 +11,11 @@

#include <modules.h>

+

Inheritance diagram for Version: +

+ +classbase + List of all members. @@ -28,7 +33,7 @@ A class of type Version is returned by the GetVersion method of the 60 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 61 of file modules.h.

Constructor & Destructor Documentation


Public Methods

@@ -106,7 +111,7 @@ Definition at line 32 o

-Definition at line 63 of file modules.h. +Definition at line 64 of file modules.h.

@@ -130,7 +135,7 @@ Definition at line 63 of

-Definition at line 63 of file modules.h. +Definition at line 64 of file modules.h.

@@ -154,7 +159,7 @@ Definition at line 63 of

-Definition at line 63 of file modules.h. +Definition at line 64 of file modules.h.

@@ -178,12 +183,12 @@ Definition at line 63 of

-Definition at line 63 of file modules.h. +Definition at line 64 of file modules.h.


The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:29:00 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classVersion.png b/docs/module-doc/classVersion.png new file mode 100644 index 000000000..f94040c20 Binary files /dev/null and b/docs/module-doc/classVersion.png differ diff --git a/docs/module-doc/classchanrec-members.html b/docs/module-doc/classchanrec-members.html index 8801bdf44..d4f51cf10 100644 --- a/docs/module-doc/classchanrec-members.html +++ b/docs/module-doc/classchanrec-members.html @@ -7,9 +7,11 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

chanrec Member List

This is the complete list of members for chanrec, including all inherited members. + + @@ -24,7 +26,8 @@ -
ageclassbase
banschanrec
c_privatechanrec
chanrec()chanrec [inline]
classbase()classbase [inline]
createdchanrec
custom_modeschanrec
inviteonlychanrec
topiclockchanrec
topicsetchanrec
~chanrec()chanrec [inline, virtual]

Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by + ~classbase()classbase [inline] +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index 2c9e2efcb..0fe1d45bc 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -11,6 +11,11 @@

#include <channels.h>

+

Inheritance diagram for chanrec: +

+ +classbase + List of all members. @@ -56,7 +61,7 @@ This class represents a channel, and contains its name, modes, time created, top

-Definition at line 85 of file channels.h.


Constructor & Destructor Documentation

+Definition at line 86 of file channels.h.

Constructor & Destructor Documentation


Public Methods

@@ -86,17 +91,17 @@ Creates a channel record and initialises it with default values.

-Definition at line 153 of file channels.h. -

-

00154         {
-00155                 strcpy(name,"");
-00156                 strcpy(custom_modes,"");
-00157                 strcpy(topic,"");
-00158                 strcpy(setby,"");
-00159                 strcpy(key,"");
-00160                 created = topicset = limit = 0;
-00161                 topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
-00162         }
+Definition at line 154 of file channels.h.
+

+

00155         {
+00156                 strcpy(name,"");
+00157                 strcpy(custom_modes,"");
+00158                 strcpy(topic,"");
+00159                 strcpy(setby,"");
+00160                 strcpy(key,"");
+00161                 created = topicset = limit = 0;
+00162                 topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
+00163         }
 
@@ -127,9 +132,9 @@ Definition at line 153 o

-Definition at line 164 of file channels.h. +Definition at line 165 of file channels.h.

-

00164 { /* stub */ }
+
00165 { /* stub */ }
 
@@ -157,7 +162,7 @@ The list of all bans set on the channel.

-Definition at line 149 of file channels.h. +Definition at line 150 of file channels.h.

@@ -183,7 +188,7 @@ Nonzero if the mode +p is set.

This value cannot be set at the same time as chanrec::secret

-Definition at line 145 of file channels.h. +Definition at line 146 of file channels.h.

@@ -209,7 +214,7 @@ Creation time.

-Definition at line 101 of file channels.h. +Definition at line 102 of file channels.h.

@@ -235,7 +240,7 @@ Custom modes for the channel.

Plugins may use this field in any way they see fit.

-Definition at line 94 of file channels.h. +Definition at line 95 of file channels.h.

@@ -261,7 +266,7 @@ Nonzero if the mode +i is set.

-Definition at line 131 of file channels.h. +Definition at line 132 of file channels.h.

@@ -287,7 +292,7 @@ Contains the channel key.

If this value is an empty string, there is no channel key in place.

-Definition at line 119 of file channels.h. +Definition at line 120 of file channels.h.

@@ -313,7 +318,7 @@ Contains the channel user limit.

If this value is zero, there is no limit in place.

-Definition at line 114 of file channels.h. +Definition at line 115 of file channels.h.

@@ -339,7 +344,7 @@ Nonzero if the mode +m is set.

-Definition at line 135 of file channels.h. +Definition at line 136 of file channels.h.

@@ -365,7 +370,7 @@ The channels name.

-Definition at line 90 of file channels.h. +Definition at line 91 of file channels.h.

@@ -391,7 +396,7 @@ Nonzero if the mode +n is set.

-Definition at line 127 of file channels.h. +Definition at line 128 of file channels.h.

@@ -417,7 +422,7 @@ Nonzero if the mode +s is set.

This value cannot be set at the same time as chanrec::c_private

-Definition at line 140 of file channels.h. +Definition at line 141 of file channels.h.

@@ -443,7 +448,7 @@ The last user to set the topic.

If this member is an empty string, no topic was ever set.

-Definition at line 109 of file channels.h. +Definition at line 110 of file channels.h.

@@ -469,7 +474,7 @@ Channel topic.

If this is an empty string, no channel topic is set.

-Definition at line 98 of file channels.h. +Definition at line 99 of file channels.h.

@@ -495,7 +500,7 @@ Nonzero if the mode +t is set.

-Definition at line 123 of file channels.h. +Definition at line 124 of file channels.h.

@@ -521,12 +526,12 @@ Time topic was set.

If no topic was ever set, this will be equal to chanrec::created

-Definition at line 105 of file channels.h. +Definition at line 106 of file channels.h.


The documentation for this class was generated from the following file: -
Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classchanrec.png b/docs/module-doc/classchanrec.png new file mode 100644 index 000000000..08667d239 Binary files /dev/null and b/docs/module-doc/classchanrec.png differ diff --git a/docs/module-doc/classclassbase-members.html b/docs/module-doc/classclassbase-members.html new file mode 100644 index 000000000..504ba556c --- /dev/null +++ b/docs/module-doc/classclassbase-members.html @@ -0,0 +1,18 @@ + + +Member List + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

classbase Member List

This is the complete list of members for classbase, including all inherited members. + + + +
ageclassbase
classbase()classbase [inline]
~classbase()classbase [inline]

Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classclassbase.html b/docs/module-doc/classclassbase.html new file mode 100644 index 000000000..9aa669de8 --- /dev/null +++ b/docs/module-doc/classclassbase.html @@ -0,0 +1,134 @@ + + +classbase class Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

classbase Class Reference

#include <base.h> +

+

Inheritance diagram for classbase: +

+ +Admin +chanrec +command_t +ConfigReader +connection +FileReader +HostItem +Module +ModuleFactory +Server +ucrec +Version + +List of all members. + + + + + + +

Public Methods

 classbase ()
 ~classbase ()

Public Attributes

time_t age
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
classbase::classbase   [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 18 of file base.h. +

+

00018 { age = time(NULL); }
+
+

+ + + + +
+ + + + + + + + + +
classbase::~classbase   [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 19 of file base.h. +

+

00019 { }
+
+


Member Data Documentation

+

+ + + + +
+ + +
time_t classbase::age +
+
+ + + + + +
+   + + +

+ +

+Definition at line 16 of file base.h.

+


The documentation for this class was generated from the following file: +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classclassbase.png b/docs/module-doc/classclassbase.png new file mode 100644 index 000000000..34864a6e2 Binary files /dev/null and b/docs/module-doc/classclassbase.png differ diff --git a/docs/module-doc/classcommand__t-members.html b/docs/module-doc/classcommand__t-members.html new file mode 100644 index 000000000..49d874f21 --- /dev/null +++ b/docs/module-doc/classcommand__t-members.html @@ -0,0 +1,24 @@ + + +Member List + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

command_t Member List

This is the complete list of members for command_t, including all inherited members. + + + + + + + + + +
ageclassbase
classbase()classbase [inline]
commandcommand_t
flags_neededcommand_t
handler_functioncommand_t
min_paramscommand_t
total_bytescommand_t
use_countcommand_t
~classbase()classbase [inline]

Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classcommand__t.html b/docs/module-doc/classcommand__t.html new file mode 100644 index 000000000..92801fbef --- /dev/null +++ b/docs/module-doc/classcommand__t.html @@ -0,0 +1,178 @@ + + +command_t class Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

command_t Class Reference

#include <ctables.h> +

+

Inheritance diagram for command_t: +

+ +classbase + +List of all members. + + + + + + + + +

Public Attributes

char command [MAXBUF]
handlerfunchandler_function
char flags_needed
int min_params
long use_count
long total_bytes
+

Member Data Documentation

+

+ + + + +
+ + +
char command_t::command[MAXBUF] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file ctables.h.

+

+ + + + +
+ + +
char command_t::flags_needed +
+
+ + + + + +
+   + + +

+ +

+Definition at line 49 of file ctables.h.

+

+ + + + +
+ + +
handlerfunc* command_t::handler_function +
+
+ + + + + +
+   + + +

+ +

+Definition at line 48 of file ctables.h.

+

+ + + + +
+ + +
int command_t::min_params +
+
+ + + + + +
+   + + +

+ +

+Definition at line 50 of file ctables.h.

+

+ + + + +
+ + +
long command_t::total_bytes +
+
+ + + + + +
+   + + +

+ +

+Definition at line 52 of file ctables.h.

+

+ + + + +
+ + +
long command_t::use_count +
+
+ + + + + +
+   + + +

+ +

+Definition at line 51 of file ctables.h.

+


The documentation for this class was generated from the following file: +
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classcommand__t.png b/docs/module-doc/classcommand__t.png new file mode 100644 index 000000000..2bc666276 Binary files /dev/null and b/docs/module-doc/classcommand__t.png differ diff --git a/docs/module-doc/classconnection-members.html b/docs/module-doc/classconnection-members.html new file mode 100644 index 000000000..8f7d453b5 --- /dev/null +++ b/docs/module-doc/classconnection-members.html @@ -0,0 +1,33 @@ + + +Member List + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

connection Member List

This is the complete list of members for connection, including all inherited members. + + + + + + + + + + + + + + + + + + +
ageclassbase
bytes_inconnection
bytes_outconnection
classbase()classbase [inline]
cmds_inconnection
cmds_outconnection
fdconnection
haspassedconnection
hostconnection
idle_lastmsgconnection
inbufconnection
ipconnection
lastpingconnection
npingconnection
portconnection
registeredconnection
signonconnection
~classbase()classbase [inline]

Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html new file mode 100644 index 000000000..6c9a06e2d --- /dev/null +++ b/docs/module-doc/classconnection.html @@ -0,0 +1,433 @@ + + +connection class Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

connection Class Reference

#include <connection.h> +

+

Inheritance diagram for connection: +

+ +classbase +serverrec +userrec + +List of all members. + + + + + + + + + + + + + + + + + +

Public Attributes

int fd
char host [256]
long ip
char inbuf [MAXBUF]
long bytes_in
long bytes_out
long cmds_in
long cmds_out
bool haspassed
int port
int registered
time_t lastping
time_t signon
time_t idle_lastmsg
time_t nping
+

Member Data Documentation

+

+ + + + +
+ + +
long connection::bytes_in +
+
+ + + + + +
+   + + +

+ +

+Definition at line 25 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
long connection::bytes_out +
+
+ + + + + +
+   + + +

+ +

+Definition at line 26 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
long connection::cmds_in +
+
+ + + + + +
+   + + +

+ +

+Definition at line 27 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
long connection::cmds_out +
+
+ + + + + +
+   + + +

+ +

+Definition at line 28 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
int connection::fd +
+
+ + + + + +
+   + + +

+ +

+Definition at line 21 of file connection.h. +

+Referenced by serverrec::serverrec(), and userrec::userrec().

+

+ + + + +
+ + +
bool connection::haspassed +
+
+ + + + + +
+   + + +

+ +

+Definition at line 29 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
char connection::host[256] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 22 of file connection.h.

+

+ + + + +
+ + +
time_t connection::idle_lastmsg +
+
+ + + + + +
+   + + +

+ +

+Definition at line 34 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
char connection::inbuf[MAXBUF] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 24 of file connection.h.

+

+ + + + +
+ + +
long connection::ip +
+
+ + + + + +
+   + + +

+ +

+Definition at line 23 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
time_t connection::lastping +
+
+ + + + + +
+   + + +

+ +

+Reimplemented in serverrec. +

+Definition at line 32 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
time_t connection::nping +
+
+ + + + + +
+   + + +

+ +

+Definition at line 35 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
int connection::port +
+
+ + + + + +
+   + + +

+ +

+Definition at line 30 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
int connection::registered +
+
+ + + + + +
+   + + +

+ +

+Definition at line 31 of file connection.h. +

+Referenced by userrec::userrec().

+

+ + + + +
+ + +
time_t connection::signon +
+
+ + + + + +
+   + + +

+ +

+Definition at line 33 of file connection.h. +

+Referenced by userrec::userrec().

+


The documentation for this class was generated from the following file: +
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classconnection.png b/docs/module-doc/classconnection.png new file mode 100644 index 000000000..3f0f60532 Binary files /dev/null and b/docs/module-doc/classconnection.png differ diff --git a/docs/module-doc/classes.html b/docs/module-doc/classes.html index b6c75ff2d..57d4f5c29 100644 --- a/docs/module-doc/classes.html +++ b/docs/module-doc/classes.html @@ -8,17 +8,17 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

InspIRCd Compound Index

  A  
-
ConfigReader   
  H  
-
  M  
+
command_t   
  F  
+
InviteItem   serverrec   
Admin   ConfigReader   FileReader   
  M  
  U  
-
Admin   ConnectClass   HostItem   Module   ucrec   
  B  
+
  B  
+
ConnectClass   
  H  
+
Module   ucrec   
BanItem   connection   HostItem   ModuleFactory   userrec   
  C  
  E  
  I  
-
ModuleFactory   userrec   
BanItem   ExemptItem   Invited   
  S  
+
  S  
  V  
-
  C  
-
  F  
-
InviteItem   Server   Version   
chanrec   FileReader   

Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +chanrec   ExemptItem   Invited   Server   Version   classbase   
Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classserverrec-members.html b/docs/module-doc/classserverrec-members.html new file mode 100644 index 000000000..28738c867 --- /dev/null +++ b/docs/module-doc/classserverrec-members.html @@ -0,0 +1,49 @@ + + +Member List + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

serverrec Member List

This is the complete list of members for serverrec, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AddLeaf(serverrec *child)serverrec
ageclassbase
bytes_inconnection
bytes_outconnection
classbase()classbase [inline]
cmds_inconnection
cmds_outconnection
connected_atserverrec
DelLeaf(string n)serverrec
fdconnection
haspassedconnection
hops_awayserverrec
hostconnection
idle_lastmsgconnection
inbufconnection
ipconnection
jupiterserverrec
lastpingserverrec
leafserverrec [private]
linktypeserverrec
nameserverrec
npingconnection
opercountserverrec
pingtimeserverrec
portconnection
registeredconnection
serverrec()serverrec
serverrec(char *n, int link_t, long ver, bool jupe)serverrec
signonconnection
usercountserverrec
usercount_iserverrec
versionserverrec
~classbase()classbase [inline]
~serverrec()serverrec

Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classserverrec.html b/docs/module-doc/classserverrec.html new file mode 100644 index 000000000..ca596f9eb --- /dev/null +++ b/docs/module-doc/classserverrec.html @@ -0,0 +1,591 @@ + + +serverrec class Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

serverrec Class Reference

#include <servers.h> +

+

Inheritance diagram for serverrec: +

+ +connection +classbase + +List of all members. + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 serverrec ()
 serverrec (char *n, int link_t, long ver, bool jupe)
 ~serverrec ()
void AddLeaf (serverrec *child)
void DelLeaf (string n)

Public Attributes

char name [MAXBUF]
int pingtime
int linktype
time_t lastping
long usercount_i
long usercount
long opercount
time_t connected_at
time_t hops_away
long version
bool jupiter

Private Attributes

map< string, serverrec * > leaf
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
serverrec::serverrec  
+
+ + + + + +
+   + + +

+ +

+Definition at line 16 of file servers.cpp. +

+References connected_at, connection::fd, hops_away, jupiter, lastping, leaf, LINK_ACTIVE, linktype, opercount, pingtime, usercount, usercount_i, and version. +

+

00017 {
+00018         leaf.clear();
+00019         strcpy(name,"");
+00020         pingtime = 0;
+00021         linktype = LINK_ACTIVE;
+00022         lastping = time(NULL);
+00023         usercount_i = usercount = opercount = version = 0;
+00024         hops_away = 1;
+00025         connected_at = time(NULL);
+00026         jupiter = false;
+00027         fd = 0;
+00028 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
serverrec::serverrec char *   n,
int   link_t,
long   ver,
bool   jupe
+
+ + + + + +
+   + + +

+ +

+Definition at line 35 of file servers.cpp. +

+References connected_at, connection::fd, hops_away, jupiter, lastping, leaf, linktype, opercount, usercount, usercount_i, and version. +

+

00036 {
+00037         leaf.clear();
+00038         strcpy(name,n);
+00039         linktype = link_t;
+00040         lastping = time(NULL);
+00041         usercount_i = usercount = opercount = 0;
+00042         version = ver;
+00043         hops_away = 1;
+00044         connected_at = time(NULL);
+00045         jupiter = jupe;
+00046         fd = 0;
+00047 }
+
+

+ + + + +
+ + + + + + + + + +
serverrec::~serverrec  
+
+ + + + + +
+   + + +

+ +

+Definition at line 31 of file servers.cpp. +

+

00032 {
+00033 }
+
+


Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
void serverrec::AddLeaf serverrec *   child
+
+ + + + + +
+   + + +

+ +

+Definition at line 49 of file servers.cpp. +

+References leaf, and name. +

+

00050 {
+00051         leaf[child->name] = child;
+00052 }
+
+

+ + + + +
+ + + + + + + + + + +
void serverrec::DelLeaf string   n
+
+ + + + + +
+   + + +

+ +

+Definition at line 54 of file servers.cpp. +

+References leaf. +

+

00055 {
+00056         server_list::iterator i = leaf.find(n);
+00057 
+00058         if (i != leaf.end())
+00059                 leaf.erase(i);
+00060 }
+
+


Member Data Documentation

+

+ + + + +
+ + +
time_t serverrec::connected_at +
+
+ + + + + +
+   + + +

+ +

+Definition at line 33 of file servers.h. +

+Referenced by serverrec().

+

+ + + + +
+ + +
time_t serverrec::hops_away +
+
+ + + + + +
+   + + +

+ +

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

+Referenced by serverrec().

+

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

+ +

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

+Referenced by serverrec().

+

+ + + + +
+ + +
time_t serverrec::lastping +
+
+ + + + + +
+   + + +

+ +

+Reimplemented from connection. +

+Definition at line 29 of file servers.h. +

+Referenced by serverrec().

+

+ + + + +
+ + +
map<string, serverrec*> serverrec::leaf [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 24 of file servers.h. +

+Referenced by AddLeaf(), DelLeaf(), and serverrec().

+

+ + + + +
+ + +
int serverrec::linktype +
+
+ + + + + +
+   + + +

+ +

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

+Referenced by serverrec().

+

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

+ +

+Definition at line 26 of file servers.h. +

+Referenced by AddLeaf().

+

+ + + + +
+ + +
long serverrec::opercount +
+
+ + + + + +
+   + + +

+ +

+Definition at line 32 of file servers.h. +

+Referenced by serverrec().

+

+ + + + +
+ + +
int serverrec::pingtime +
+
+ + + + + +
+   + + +

+ +

+Definition at line 27 of file servers.h. +

+Referenced by serverrec().

+

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

+ +

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

+Referenced by serverrec().

+

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

+ +

+Definition at line 30 of file servers.h. +

+Referenced by serverrec().

+

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

+ +

+Definition at line 35 of file servers.h. +

+Referenced by serverrec().

+


The documentation for this class was generated from the following files: +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/classserverrec.png b/docs/module-doc/classserverrec.png new file mode 100644 index 000000000..5dde788a0 Binary files /dev/null and b/docs/module-doc/classserverrec.png differ diff --git a/docs/module-doc/classucrec-members.html b/docs/module-doc/classucrec-members.html index ffde8fdd4..504d50f4e 100644 --- a/docs/module-doc/classucrec-members.html +++ b/docs/module-doc/classucrec-members.html @@ -7,11 +7,14 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ucrec Member List

This is the complete list of members for ucrec, including all inherited members. + + + -
ageclassbase
channelucrec
classbase()classbase [inline]
uc_modesucrec
ucrec()ucrec [inline]
~classbase()classbase [inline]
~ucrec()ucrec [inline, virtual]

Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classucrec.html b/docs/module-doc/classucrec.html index 865b1a708..c601649fa 100644 --- a/docs/module-doc/classucrec.html +++ b/docs/module-doc/classucrec.html @@ -11,6 +11,11 @@

#include <channels.h>

+

Inheritance diagram for ucrec: +

+ +classbase + List of all members. @@ -29,7 +34,7 @@ The uc_modes member holds a bitmask of which privilages the user has on the chan

-Definition at line 181 of file channels.h.


Constructor & Destructor Documentation

+Definition at line 182 of file channels.h.

Constructor & Destructor Documentation


Public Methods

@@ -57,9 +62,9 @@ Definition at line 181 o

-Definition at line 194 of file channels.h. +Definition at line 195 of file channels.h.

-

00194 { /* stub */ }
+
00195 { /* stub */ }
 
@@ -90,9 +95,9 @@ Definition at line 194 o

-Definition at line 195 of file channels.h. +Definition at line 196 of file channels.h.

-

00195 { /* stub */ }
+
00196 { /* stub */ }
 
@@ -120,7 +125,7 @@ Points to the channel record where the given modes apply.

If the record is not in use, this value will be NULL.

-Definition at line 192 of file channels.h. +Definition at line 193 of file channels.h.

Referenced by userrec::userrec(). @@ -148,12 +153,12 @@ Contains a bitmask of the UCMODE_OP ...

UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.

-Definition at line 187 of file channels.h. +Definition at line 188 of file channels.h.


The documentation for this class was generated from the following file: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classucrec.png b/docs/module-doc/classucrec.png new file mode 100644 index 000000000..33cdf11fa Binary files /dev/null and b/docs/module-doc/classucrec.png differ diff --git a/docs/module-doc/classuserrec-members.html b/docs/module-doc/classuserrec-members.html index 72c404672..779e069c4 100644 --- a/docs/module-doc/classuserrec-members.html +++ b/docs/module-doc/classuserrec-members.html @@ -7,39 +7,42 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

userrec Member List

This is the complete list of members for userrec, including all inherited members. - - - - - - - - - + + + + + + + + + + + - - - - - + + + + + - + - - + + - - - + + + - - - + + + + -
awaymsguserrec
bytes_inuserrec
bytes_outuserrec
chansuserrec
cmds_inuserrec
cmds_outuserrec
dhostuserrec
fduserrec
fullnameuserrec
ageclassbase
awaymsguserrec
bytes_inconnection
bytes_outconnection
chansuserrec
classbase()classbase [inline]
cmds_inconnection
cmds_outconnection
dhostuserrec
fdconnection
fullnameuserrec
GetFullHost()userrec [virtual]
GetFullRealHost()userrec [virtual]
haspasseduserrec
hostuserrec
identuserrec
idle_lastmsguserrec
inbufuserrec
haspassedconnection
hostconnection
identuserrec
idle_lastmsgconnection
inbufconnection
invitesuserrec [private]
InviteTo(char *channel)userrec [virtual]
ipuserrec
ipconnection
IsInvited(char *channel)userrec [virtual]
lastpinguserrec
modesuserrec
lastpingconnection
modesuserrec
nickuserrec
npinguserrec
portuserrec
registereduserrec
npingconnection
portconnection
registeredconnection
RemoveInvite(char *channel)userrec [virtual]
resultuserrec
serveruserrec
signonuserrec
resultuserrec
serveruserrec
signonconnection
userrec()userrec
~classbase()classbase [inline]
~userrec()userrec [inline, virtual]

Generated on Thu Jan 23 20:29:00 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index c241c89f9..07d5cf5ed 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -11,6 +11,12 @@

#include <users.h>

+

Inheritance diagram for userrec: +

+ +connection +classbase + List of all members. @@ -29,52 +35,21 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + @@ -86,7 +61,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 83 of file users.h.


Constructor & Destructor Documentation

+Definition at line 84 of file users.h.

Constructor & Destructor Documentation


Public Methods


Public Attributes

char nick [NICKMAX]
 The users nickname.

unsigned long ip
 The users ip address in network order.

char ident [64]
 The users ident reply.

char host [256]
 The users hostname, or ip address in string form.

char dhost [256]
 The host displayed to non-opers (used for cloaking etc).

char fullname [128]
 The users full name.

int fd
 The users file descriptor.

char modes [32]
 The user's mode string.

char inbuf [MAXBUF]
 The users input buffer.

time_t lastping
 The last time the user was pinged by the core.

time_t signon
 The users signon time.

time_t idle_lastmsg
 The time the user last sent a message.

time_t nping
 True if the user replied to their last ping.

int registered
 Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.

ucrec chans [MAXCHANS]
 A list of the channels the user is currently on.

char server [256]
 The server the user is connected to.

char awaymsg [512]
 The user's away message.

int port
 The port that the user connected to.

long bytes_in
 Stores the number of incoming bytes from the connection.

long bytes_out
 Stores the number of outgoing bytes to the connection.

long cmds_in
 Stores the number of incoming commands from the connection.

long cmds_out
 Stores the number of outgoing commands to the connection.

char result [256]
 Stores the result of the last GetFullHost or GetRealHost call.

bool haspassed
 True if a correct password has been given using PASS command.

char ident [64]
 The users ident reply.

char dhost [256]
 The host displayed to non-opers (used for cloaking etc).

char fullname [128]
 The users full name.

char modes [32]
 The user's mode string.

ucrec chans [MAXCHANS]
char server [256]
 The server the user is connected to.

char awaymsg [512]
 The user's away message.

char result [256]
 Stores the result of the last GetFullHost or GetRealHost call.


Private Attributes

InvitedList invites
 A list of channels the user has a pending invite to.

@@ -116,12 +91,12 @@ Definition at line 83 of fi

Definition at line 26 of file users.cpp.

-References bytes_in, bytes_out, ucrec::channel, chans, cmds_in, cmds_out, fd, haspassed, idle_lastmsg, invites, ip, lastping, nping, port, registered, and signon. +References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, and connection::signon.

00027 {
 00028         // the PROPER way to do it, AVOID bzero at *ALL* costs
 00029         strcpy(nick,"");
-00030         ip = 0;
+00030         ip = 0;
 00031         strcpy(ident,"");
 00032         strcpy(host,"");
 00033         strcpy(dhost,"");
@@ -130,13 +105,13 @@ References bytes_in, "");
 00037         strcpy(server,"");
 00038         strcpy(awaymsg,"");
-00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00041         haspassed = false;
+00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
+00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
+00041         haspassed = false;
 00042         strcpy(result,"");
 00043         for (int i = 0; i < MAXCHANS; i++)
 00044         {
-00045                 chans[i].channel = NULL;
+00045                 chans[i].channel = NULL;
 00046         }
 00047         invites.clear();
 00048 }
@@ -170,9 +145,9 @@ References bytes_in, 
 
 

-Definition at line 216 of file users.h. +Definition at line 136 of file users.h.

-

00216 {  }
+
00136 {  }
 
@@ -208,11 +183,11 @@ Returns the full displayed host of the user This member function returns the hos

Definition at line 51 of file users.cpp.

-References result. +References result.

00052 {
 00053         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00054         return result;
+00054         return result;
 00055 }
 
@@ -248,11 +223,11 @@ If any form of hostname cloaking is in operation, e.g. through a module, then th

Definition at line 58 of file users.cpp.

-References result. +References result.

00059 {
 00060         sprintf(result,"%s!%s@%s",nick,ident,host);
-00061         return result;
+00061         return result;
 00062 }
 
@@ -289,7 +264,7 @@ Adds a channel to a users invite list (invites them to a channel).

Definition at line 75 of file users.cpp.

-References Invited::channel, and invites. +References Invited::channel, and invites.

00076 {
 00077         Invited i;
@@ -331,7 +306,7 @@ Returns true if a user is invited to a channel.
 

Definition at line 64 of file users.cpp.

-References invites. +References invites.

00065 {
 00066         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
@@ -377,7 +352,7 @@ This member function is called on successfully joining an invite only channel to
 

Definition at line 82 of file users.cpp.

-References invites. +References invites.

00083 {
 00084         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
@@ -393,7 +368,7 @@ References invites.
   
 
 

Member Data Documentation

-

+

+Definition at line 127 of file users.h.
@@ -416,66 +391,10 @@ The user's away message.

If this string is empty, the user is not marked as away.

-Definition at line 177 of file users.h.

-

- - - - -
- - -
long userrec::bytes_in -
-
- - - - - -
-   - - -

-Stores the number of incoming bytes from the connection. -

-Used by /STATS -

-Definition at line 186 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
long userrec::bytes_out -
-
- - - - - -
-   - - -

-Stores the number of outgoing bytes to the connection. -

-Used by /STATS -

-Definition at line 191 of file users.h. -

-Referenced by userrec().

-

+

- -
@@ -494,72 +413,14 @@ Referenced by userrec().

-A list of the channels the user is currently on. -

-If any of these values are NULL, the record is not in use and may be associated with a channel by the JOIN command. see RFC 1459. -

-Definition at line 168 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
long userrec::cmds_in -
-
- - - -
-   -

-Stores the number of incoming commands from the connection. -

-Used by /STATS -

-Definition at line 196 of file users.h. +Definition at line 118 of file users.h.

Referenced by userrec().

-

- - - - -
- - -
long userrec::cmds_out -
-
- - - - - -
-   - - -

-Stores the number of outgoing commands to the connection. -

-Used by /STATS -

-Definition at line 201 of file users.h. -

-Referenced by userrec().

-

+

+Definition at line 106 of file users.h.
@@ -580,40 +441,12 @@ Referenced by userrec().

The host displayed to non-opers (used for cloaking etc).

-This usually matches the value of userrec::host. +This usually matches the value of userrec::host.

-Definition at line 113 of file users.h.

-

- - - - -
- - -
int userrec::fd -
-
- - - - - -
-   - - -

-The users file descriptor. -

-If this is zero, the socket has been closed and the core has not yet realised and removed the record from memory. -

-Definition at line 123 of file users.h. -

-Referenced by userrec().

-

+

- -
@@ -636,64 +469,10 @@ The users full name.

-Definition at line 117 of file users.h.

-

- - - - -
- - -
bool userrec::haspassed -
-
- - - - - -
-   - - -

-True if a correct password has been given using PASS command. -

-If the user is a member of a connection class that does not require a password, the value stored here is of no use. -

-Definition at line 212 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
char userrec::host[256] -
-
- - - - +Definition at line 110 of file users.h.
-   - - -

-The users hostname, or ip address in string form. -

- -

-Definition at line 108 of file users.h.

-

+

- -
@@ -716,61 +495,7 @@ The users ident reply.

-Definition at line 104 of file users.h.

-

- - - - -
- - -
time_t userrec::idle_lastmsg -
-
- - - - - -
-   - - -

-The time the user last sent a message. -

-See also userrec::lastping and userrec::signon -

-Definition at line 150 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
char userrec::inbuf[MAXBUF] -
-
- - - - +Definition at line 101 of file users.h.
-   - - -

-The users input buffer. -

-Used by the C recv() function. -

-Definition at line 134 of file users.h.

@@ -796,68 +521,12 @@ A list of channels the user has a pending invite to.

-Definition at line 89 of file users.h. +Definition at line 90 of file users.h.

Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). -

- - - - -
- - -
unsigned long userrec::ip -
-
- - - - - -
-   - - -

-The users ip address in network order. -

- -

-Definition at line 100 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
time_t userrec::lastping -
-
- - - - - -
-   - - -

-The last time the user was pinged by the core. -

-When this value is more than 120 seconds difference from 'time(NULL)', a ping is sent to the client. If the user has an outstanding PING request the next time this event occurs after 4 total minutes, they are disconnected. -

-Definition at line 141 of file users.h. -

-Referenced by userrec().

-

+

+Definition at line 116 of file users.h.
@@ -880,7 +549,7 @@ The user's mode string.

This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.

-Definition at line 129 of file users.h.

@@ -906,94 +575,10 @@ The users nickname.

An invalid nickname indicates an unregistered connection prior to the NICK command.

-Definition at line 96 of file users.h. - - -

- - - - -
- - -
time_t userrec::nping -
-
- - - - - -
-   - - -

-True if the user replied to their last ping. -

-If this is true, the user can be sent another ping at the specified time, otherwise they will be discnnected. See also userrec::lastping -

-Definition at line 156 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
int userrec::port -
-
- - - - - -
-   - - -

-The port that the user connected to. -

- -

-Definition at line 181 of file users.h. -

-Referenced by userrec().

-

- - - - -
- - -
int userrec::registered -
-
- - - - +Definition at line 97 of file users.h.
-   - - -

-Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command. -

-If both bits are set then the connection is awaiting MOTD. Sending of MOTD sets bit 3, and makes the value of userrec::registered == 7, showing a fully established client session. -

-Definition at line 162 of file users.h. -

-Referenced by userrec().

-

+

@@ -1016,12 +601,12 @@ Stores the result of the last GetFullHost or GetRealHost call.

You may use this to increase the speed of use of this class.

-Definition at line 206 of file users.h. +Definition at line 132 of file users.h.

Referenced by GetFullHost(), and GetFullRealHost().

-

+

- -
@@ -1044,40 +629,12 @@ The server the user is connected to.

-Definition at line 172 of file users.h.

-

- - - - -
- - -
time_t userrec::signon -
-
- - - - +Definition at line 122 of file users.h.
-   - - -

-The users signon time. -

- -

-Definition at line 145 of file users.h. -

-Referenced by userrec().


The documentation for this class was generated from the following files: -
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classuserrec.png b/docs/module-doc/classuserrec.png new file mode 100644 index 000000000..6acddb00c Binary files /dev/null and b/docs/module-doc/classuserrec.png differ diff --git a/docs/module-doc/connection_8h-source.html b/docs/module-doc/connection_8h-source.html new file mode 100644 index 000000000..9eb394055 --- /dev/null +++ b/docs/module-doc/connection_8h-source.html @@ -0,0 +1,57 @@ + + +connection.h Source File + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

connection.h

Go to the documentation of this file.
00001 /*
+00002 
+00003 $Log$
+00003 Revision 1.1  2003/01/26 23:52:48  brain
+00003 Modified documentation for base classes
+00003 
+00004 Revision 1.1  2003/01/26 20:15:00  brain
+00005 Added server classes for linking
+00006 
+00007 
+00008 */
+00009 
+00010 #include "inspircd_config.h" 
+00011 #include "base.h"
+00012 #include <string>
+00013 #include <map.h>
+00014  
+00015 #ifndef __CONNECTION_H__ 
+00016 #define __CONNECTION_H__ 
+00017  
+00018 class connection : public classbase
+00019 {
+00020  public:
+00021         int fd;                 // file descriptor
+00022         char host[256];         // hostname
+00023         long ip;                // ipv4 address
+00024         char inbuf[MAXBUF];     // recvQ
+00025         long bytes_in;
+00026         long bytes_out;
+00027         long cmds_in;
+00028         long cmds_out;
+00029         bool haspassed;
+00030         int port;
+00031         int registered;
+00032         time_t lastping;
+00033         time_t signon;
+00034         time_t idle_lastmsg;
+00035         time_t nping;
+00036 };
+00037 
+00038 
+00039 #endif
+00040 
+

Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/connection_8h.html b/docs/module-doc/connection_8h.html new file mode 100644 index 000000000..a8037c127 --- /dev/null +++ b/docs/module-doc/connection_8h.html @@ -0,0 +1,25 @@ + + +connection.h File Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

connection.h File Reference

#include "inspircd_config.h"
+#include "base.h"
+#include <string>
+#include <map.h>
+ +

+Go to the source code of this file. + + + +

Compounds

class  connection
+


Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/ctables_8h-source.html b/docs/module-doc/ctables_8h-source.html new file mode 100644 index 000000000..78126d420 --- /dev/null +++ b/docs/module-doc/ctables_8h-source.html @@ -0,0 +1,73 @@ + + +ctables.h Source File + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

ctables.h

Go to the documentation of this file.
00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2003 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  
+00016  $Log$
+00016  Revision 1.1  2003/01/26 23:52:48  brain
+00016  Modified documentation for base classes
+00016 
+00017  Revision 1.1.1.1  2003/01/23 19:45:58  brain
+00018  InspIRCd second source tree
+00019 
+00020  Revision 1.3  2003/01/15 22:47:44  brain
+00021  Changed user and channel structs to classes (finally)
+00022 
+00023  Revision 1.2  2003/01/09 21:09:50  brain
+00024  added '/stats M' command
+00025 
+00026  Revision 1.1  2003/01/07 01:02:14  brain
+00027 
+00028  definitions for command table types
+00029 
+00030 
+00031  * ---------------------------------------------------
+00032  */
+00033 #include "inspircd_config.h"
+00034 #include "inspircd.h"
+00035 #include "base.h"
+00036 
+00037 #ifndef __CTABLES_H__
+00038 #define __CTABLES_H__
+00039 
+00040 typedef void (handlerfunc) (char**, int, userrec*);
+00041 
+00042 /* a structure that defines a command */
+00043 
+00044 class command_t : public classbase
+00045 {
+00046  public:
+00047         char command[MAXBUF]; /* command name */
+00048         handlerfunc *handler_function; /* handler function as in typedef */
+00049         char flags_needed; /* user flags needed to execute the command or 0 */
+00050         int min_params; /* minimum number of parameters command takes */
+00051         long use_count; /* used by /stats m */
+00052         long total_bytes; /* used by /stats m */
+00053 };
+00054 
+00055 #endif
+00056 
+

Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/ctables_8h.html b/docs/module-doc/ctables_8h.html new file mode 100644 index 000000000..de3b54e0f --- /dev/null +++ b/docs/module-doc/ctables_8h.html @@ -0,0 +1,51 @@ + + +ctables.h File Reference + + + +
+Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
+

ctables.h File Reference

#include "inspircd_config.h"
+#include "inspircd.h"
+#include "base.h"
+ +

+Go to the source code of this file. + + + + + +

Compounds

class  command_t

Typedefs

typedef void( handlerfunc )(char **, int, userrec *)
+


Typedef Documentation

+

+ + + + +
+ + +
typedef void( handlerfunc)(char**, int, userrec*) +
+
+ + + + + +
+   + + +

+ +

+Definition at line 40 of file ctables.h.

+


Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + diff --git a/docs/module-doc/files.html b/docs/module-doc/files.html index 31ac8df78..a790486b3 100644 --- a/docs/module-doc/files.html +++ b/docs/module-doc/files.html @@ -7,13 +7,18 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

InspIRCd File List

Here is a list of all files with brief descriptions: + + + + +
base.h [code]
channels.h [code]
connection.h [code]
ctables.h [code]
modules.cpp [code]
modules.h [code]
servers.cpp [code]
servers.h [code]
users.cpp [code]
users.h [code]
-
Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +
Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/functions.html b/docs/module-doc/functions.html index 027e56f17..c49e8dda7 100644 --- a/docs/module-doc/functions.html +++ b/docs/module-doc/functions.html @@ -7,21 +7,23 @@
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

InspIRCd Compound Members

-a | b | c | d | e | f | g | h | i | k | l | m | n | o | p | r | s | t | u | v | ~
+a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | r | s | t | u | v | ~

Here is a list of all class members with links to the classes they belong to:

- a -

+
  • AddLeaf() +: serverrec
  • Admin() +: Admin
  • age +: classbase
  • awaymsg +: userrec

    - b -

    +: connection
  • bytes_out +: connection

    - c -

    @@ -41,8 +46,9 @@ Here is a list of all class members with links to the classes they belong to:

    +: Server
  • DelLeaf() +: serverrec
  • dhost +: userrec

    - e -

    - g -

    • GetAdmin() @@ -71,22 +78,28 @@ Here is a list of all class members with links to the classes they belong to:

      Module

    - h -

    - i -

    +

    - j - +

    - k -

    - o -

    +: Module
  • opercount +: serverrec

    - p -

    +: ConnectClass
  • pingtime +: serverrec
  • port +: connection

    - r -

    - s -

    +: connection

    - t -

    - u -

    - v -

    +: Version
  • version +: serverrec

    - ~ -

    -
    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/globals.html b/docs/module-doc/globals.html index 9881f92d0..b317ae1ad 100644 --- a/docs/module-doc/globals.html +++ b/docs/module-doc/globals.html @@ -7,7 +7,7 @@
    Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    InspIRCd File Members

    -b | c | e | f | i | s | u
    +b | c | e | f | h | i | l | s | u

    Here is a list of all file members with links to the files they belong to:

    - b - @@ -29,14 +29,24 @@ Here is a list of all file members with links to the files they belong to:

    file_cache : modules.h
  • FOREACH_MOD : modules.h +

    - h - +

    - i -

    +

    - l - +

    - s -

    -
    Generated on Thu Jan 23 20:29:00 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/hierarchy.html b/docs/module-doc/hierarchy.html index cc9867d06..8330bcb63 100644 --- a/docs/module-doc/hierarchy.html +++ b/docs/module-doc/hierarchy.html @@ -7,10 +7,17 @@
    Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    InspIRCd Class Hierarchy

    This inheritance list is sorted roughly, but not completely, alphabetically: +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/main.html b/docs/module-doc/main.html index 9e672e9cc..419f75be6 100644 --- a/docs/module-doc/main.html +++ b/docs/module-doc/main.html @@ -8,7 +8,7 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    InspIRCd Documentation

    -


    Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/modules_8cpp-source.html b/docs/module-doc/modules_8cpp-source.html index 9b47e41e7..5db4fdd10 100644 --- a/docs/module-doc/modules_8cpp-source.html +++ b/docs/module-doc/modules_8cpp-source.html @@ -9,8 +9,8 @@

    modules.cpp

    Go to the documentation of this file.
    00001 /*
     00002 
     00003 $Log$
    -00003 Revision 1.2  2003/01/23 20:38:00  brain
    -00003 Updated documentation scripts
    +00003 Revision 1.3  2003/01/26 23:52:48  brain
    +00003 Modified documentation for base classes
     00003 
     00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
     00005 InspIRCd second source tree
    @@ -241,7 +241,7 @@
     00230 }
     00231 
     00232 
    -

    Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +

  • Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html index add6315ef..12899e13c 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -16,7 +16,7 @@ Go to the source code of this file.
    -
    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index 6c4a1e489..6d1bafadd 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -9,8 +9,8 @@

    modules.h

    Go to the documentation of this file.
    00001 /*
     00002 
     00003 $Log$
    -00003 Revision 1.2  2003/01/23 20:38:00  brain
    -00003 Updated documentation scripts
    +00003 Revision 1.3  2003/01/26 23:52:48  brain
    +00003 Modified documentation for base classes
     00003 
     00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
     00005 InspIRCd second source tree
    @@ -47,114 +47,115 @@
     00036 #define __PLUGIN_H
     00037 
     00038 #include "dynamic.h"
    -00039 #include <string>
    -00040 #include <deque>
    -00041 
    -00044 typedef deque<string> file_cache;
    -00045 
    +00039 #include "base.h"
    +00040 #include <string>
    +00041 #include <deque>
    +00042 
    +00045 typedef deque<string> file_cache;
     00046 
    -00047 // This #define allows us to call a method in all
    -00048 // loaded modules in a readable simple way, e.g.:
    -00049 // 'FOREACH_MOD OnConnect(user);'
    -00050 
    -00051 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
    -00052 
    -00053 // class Version holds the version information of a Module, returned
    -00054 // by Module::GetVersion (thanks RD)
    -00055 
    -00060 class Version
    -00061 {
    -00062  public:
    -00063          const int Major, Minor, Revision, Build;
    -00064          Version(int major, int minor, int revision, int build);
    -00065 };
    -00066 
    +00047 
    +00048 // This #define allows us to call a method in all
    +00049 // loaded modules in a readable simple way, e.g.:
    +00050 // 'FOREACH_MOD OnConnect(user);'
    +00051 
    +00052 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
    +00053 
    +00054 // class Version holds the version information of a Module, returned
    +00055 // by Module::GetVersion (thanks RD)
    +00056 
    +00061 class Version : public classbase
    +00062 {
    +00063  public:
    +00064          const int Major, Minor, Revision, Build;
    +00065          Version(int major, int minor, int revision, int build);
    +00066 };
     00067 
    -00073 class Admin
    -00074 {
    -00075  public:
    -00076          const string Name, Email, Nick;
    -00077          Admin(string name,string email,string nick);
    -00078 };
    -00079 
    -00085 class Module
    -00086 {
    -00087  public:
    -00091         Module();
    -00095         virtual ~Module();
    -00100         virtual Version GetVersion();
    -00104         virtual void OnUserConnect(userrec* user);
    -00108         virtual void OnUserQuit(userrec* user);
    -00113         virtual void OnUserJoin(userrec* user, chanrec* channel);
    -00118         virtual void OnUserPart(userrec* user, chanrec* channel);
    -00119 };
    -00120 
    +00068 
    +00074 class Admin : public classbase
    +00075 {
    +00076  public:
    +00077          const string Name, Email, Nick;
    +00078          Admin(string name,string email,string nick);
    +00079 };
    +00080 
    +00086 class Module : public classbase
    +00087 {
    +00088  public:
    +00092         Module();
    +00096         virtual ~Module();
    +00101         virtual Version GetVersion();
    +00105         virtual void OnUserConnect(userrec* user);
    +00109         virtual void OnUserQuit(userrec* user);
    +00114         virtual void OnUserJoin(userrec* user, chanrec* channel);
    +00119         virtual void OnUserPart(userrec* user, chanrec* channel);
    +00120 };
     00121 
    -00127 class Server
    -00128 {
    -00129  public:
    -00133         Server();
    -00137         virtual ~Server();
    -00138 
    -00142         virtual void SendOpers(string s);
    -00147         virtual void Debug(string s);
    -00152         virtual void Send(int Socket, string s);
    -00157         virtual void SendServ(int Socket, string s);
    -00162         virtual void SendFrom(int Socket, userrec* User, string s);
    -00167         virtual void SendTo(userrec* Source, userrec* Dest, string s);
    -00174         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
    -00179         virtual bool CommonChannels(userrec* u1, userrec* u2);
    -00187         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
    -00192         virtual void SendWallops(userrec* User, string text);
    -00193 
    -00197         virtual bool IsNick(string nick);
    -00201         virtual userrec* FindNick(string nick);
    -00205         virtual chanrec* FindChannel(string channel);
    -00210         virtual string ChanMode(userrec* User, chanrec* Chan);
    -00213         virtual string GetServerName();
    -00216         virtual string GetNetworkName();
    -00222         virtual Admin GetAdmin();
    -00223          
    -00224 };
    -00225 
    -00232 class ConfigReader
    -00233 {
    -00234   protected:
    -00237         string fname;
    -00238   public:
    -00243         ConfigReader();                 // default constructor reads ircd.conf
    -00247         ConfigReader(string filename);  // read a module-specific config
    -00251         ~ConfigReader();
    -00256         string ReadValue(string tag, string name, int index);
    -00263         int Enumerate(string tag);
    -00267         bool Verify();
    -00268 };
    -00269 
    +00122 
    +00128 class Server : public classbase
    +00129 {
    +00130  public:
    +00134         Server();
    +00138         virtual ~Server();
    +00139 
    +00143         virtual void SendOpers(string s);
    +00148         virtual void Debug(string s);
    +00153         virtual void Send(int Socket, string s);
    +00158         virtual void SendServ(int Socket, string s);
    +00163         virtual void SendFrom(int Socket, userrec* User, string s);
    +00168         virtual void SendTo(userrec* Source, userrec* Dest, string s);
    +00175         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
    +00180         virtual bool CommonChannels(userrec* u1, userrec* u2);
    +00188         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
    +00193         virtual void SendWallops(userrec* User, string text);
    +00194 
    +00198         virtual bool IsNick(string nick);
    +00202         virtual userrec* FindNick(string nick);
    +00206         virtual chanrec* FindChannel(string channel);
    +00211         virtual string ChanMode(userrec* User, chanrec* Chan);
    +00214         virtual string GetServerName();
    +00217         virtual string GetNetworkName();
    +00223         virtual Admin GetAdmin();
    +00224          
    +00225 };
    +00226 
    +00233 class ConfigReader : public classbase
    +00234 {
    +00235   protected:
    +00238         string fname;
    +00239   public:
    +00244         ConfigReader();                 // default constructor reads ircd.conf
    +00248         ConfigReader(string filename);  // read a module-specific config
    +00252         ~ConfigReader();
    +00257         string ReadValue(string tag, string name, int index);
    +00264         int Enumerate(string tag);
    +00268         bool Verify();
    +00269 };
     00270 
     00271 
    -00277 class FileReader
    -00278 {
    -00279  file_cache fc;
    -00280  public:
    -00285          FileReader();
    -00291          FileReader(string filename);
    -00295          ~FileReader();
    -00301          void LoadFile(string filename);
    -00306          string GetLine(int x);
    -00312          int FileSize();
    -00313 };
    -00314 
    +00272 
    +00278 class FileReader : public classbase
    +00279 {
    +00280  file_cache fc;
    +00281  public:
    +00286          FileReader();
    +00292          FileReader(string filename);
    +00296          ~FileReader();
    +00302          void LoadFile(string filename);
    +00307          string GetLine(int x);
    +00313          int FileSize();
    +00314 };
     00315 
    -00322 class ModuleFactory
    -00323 {
    -00324  public:
    -00325         ModuleFactory() { }
    -00326         virtual ~ModuleFactory() { }
    -00331         virtual Module * CreateModule() = 0;
    -00332 };
    -00333 
    -00334 #endif
    -

    Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +00316 +00323 class ModuleFactory : public classbase +00324 { +00325 public: +00326 ModuleFactory() { } +00327 virtual ~ModuleFactory() { } +00332 virtual Module * CreateModule() = 0; +00333 }; +00334 +00335 #endif +

    Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index e0fbb0817..0ff7716b3 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -7,6 +7,7 @@
    Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    modules.h File Reference

    #include "dynamic.h"
    +#include "base.h"
    #include <string>
    #include <deque>
    @@ -56,7 +57,7 @@

    -Definition at line 51 of file modules.h. +Definition at line 52 of file modules.h.


    Typedef Documentation

    @@ -83,12 +84,12 @@ Low level definition of a FileReader

    -Definition at line 44 of file modules.h. +Definition at line 45 of file modules.h.

    Referenced by FileReader::FileReader(), and FileReader::LoadFile(). -


    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/servers_8cpp-source.html b/docs/module-doc/servers_8cpp-source.html new file mode 100644 index 000000000..8200748b3 --- /dev/null +++ b/docs/module-doc/servers_8cpp-source.html @@ -0,0 +1,78 @@ + + +servers.cpp Source File + + + +
    +Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    +

    servers.cpp

    Go to the documentation of this file.
    00001 /*
    +00002 
    +00003 $Log$
    +00003 Revision 1.1  2003/01/26 23:52:48  brain
    +00003 Modified documentation for base classes
    +00003 
    +00004 Revision 1.1  2003/01/26 20:15:03  brain
    +00005 Added server classes for linking
    +00006 
    +00007 
    +00008 */
    +00009 
    +00010 #include "inspircd_config.h" 
    +00011 #include "servers.h"
    +00012 #include "inspircd.h"
    +00013 #include <stdio.h>
    +00014 #include <map.h>
    +00015 
    +00016 serverrec::serverrec()
    +00017 {
    +00018         leaf.clear();
    +00019         strcpy(name,"");
    +00020         pingtime = 0;
    +00021         linktype = LINK_ACTIVE;
    +00022         lastping = time(NULL);
    +00023         usercount_i = usercount = opercount = version = 0;
    +00024         hops_away = 1;
    +00025         connected_at = time(NULL);
    +00026         jupiter = false;
    +00027         fd = 0;
    +00028 }
    +00029 
    +00030  
    +00031 serverrec::~serverrec()
    +00032 {
    +00033 }
    +00034 
    +00035 serverrec::serverrec(char* n, int link_t,  long ver, bool jupe)
    +00036 {
    +00037         leaf.clear();
    +00038         strcpy(name,n);
    +00039         linktype = link_t;
    +00040         lastping = time(NULL);
    +00041         usercount_i = usercount = opercount = 0;
    +00042         version = ver;
    +00043         hops_away = 1;
    +00044         connected_at = time(NULL);
    +00045         jupiter = jupe;
    +00046         fd = 0;
    +00047 }
    +00048 
    +00049 void serverrec::AddLeaf(serverrec *child)
    +00050 {
    +00051         leaf[child->name] = child;
    +00052 }
    +00053 
    +00054 void serverrec::DelLeaf(string n)
    +00055 {
    +00056         server_list::iterator i = leaf.find(n);
    +00057 
    +00058         if (i != leaf.end())
    +00059                 leaf.erase(i);
    +00060 }
    +00061 
    +

    Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by + +doxygen1.3-rc2
    + + diff --git a/docs/module-doc/servers_8cpp.html b/docs/module-doc/servers_8cpp.html new file mode 100644 index 000000000..2d38d5a96 --- /dev/null +++ b/docs/module-doc/servers_8cpp.html @@ -0,0 +1,24 @@ + + +servers.cpp File Reference + + + +
    +Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    +

    servers.cpp File Reference

    #include "inspircd_config.h"
    +#include "servers.h"
    +#include "inspircd.h"
    +#include <stdio.h>
    +#include <map.h>
    + +

    +Go to the source code of this file. + +
    +


    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
    + + diff --git a/docs/module-doc/servers_8h-source.html b/docs/module-doc/servers_8h-source.html new file mode 100644 index 000000000..b73e6a898 --- /dev/null +++ b/docs/module-doc/servers_8h-source.html @@ -0,0 +1,67 @@ + + +servers.h Source File + + + +
    +Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    +

    servers.h

    Go to the documentation of this file.
    00001 /*
    +00002 
    +00003 $Log$
    +00003 Revision 1.1  2003/01/26 23:52:48  brain
    +00003 Modified documentation for base classes
    +00003 
    +00004 Revision 1.1  2003/01/26 20:15:00  brain
    +00005 Added server classes for linking
    +00006 
    +00007 
    +00008 */
    +00009 
    +00010 #include "inspircd_config.h" 
    +00011 #include "connection.h"
    +00012 #include <string>
    +00013 #include <map.h>
    +00014  
    +00015 #ifndef __SERVERS_H__ 
    +00016 #define __SERVERS_H__ 
    +00017  
    +00018 #define LINK_ACTIVE     1
    +00019 #define LINK_INACTIVE   0
    +00020 
    +00021 class serverrec : public connection
    +00022 {
    +00023  private:
    +00024         map<string, serverrec*> leaf; // list of child servers (leaves)
    +00025  public:
    +00026         char name[MAXBUF];      // server name
    +00027         int pingtime;           // last ping response (ms)
    +00028         int linktype;           // link type, LINK_ACTIVE or LINK_INACTIVE
    +00029         time_t lastping;        // time the link was last pinged
    +00030         long usercount_i;       // invisible users on server
    +00031         long usercount;         // non-invisible users on server
    +00032         long opercount;         // opers on server
    +00033         time_t connected_at;    // time server was connected into the network
    +00034         time_t hops_away;       // number of hops away (for quick access)
    +00035         long version;           // ircd version
    +00036         bool jupiter;           // is a JUPE server (faked to enforce a server ban)
    +00037 
    +00038         serverrec();
    +00039         serverrec(char* n, int link_t,  long ver, bool jupe);
    +00040         ~serverrec();
    +00041         void AddLeaf(serverrec *child);
    +00042         void DelLeaf(string n);
    +00043 };
    +00044 
    +00045 
    +00046 
    +00047 typedef map<string, serverrec*> server_list;
    +00048 
    +00049 #endif
    +00050 
    +

    Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by + +doxygen1.3-rc2
    + + diff --git a/docs/module-doc/servers_8h.html b/docs/module-doc/servers_8h.html new file mode 100644 index 000000000..0e695d7fe --- /dev/null +++ b/docs/module-doc/servers_8h.html @@ -0,0 +1,106 @@ + + +servers.h File Reference + + + +
    +Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    +

    servers.h File Reference

    #include "inspircd_config.h"
    +#include "connection.h"
    +#include <string>
    +#include <map.h>
    + +

    +Go to the source code of this file. + + + + + + + + +

    Compounds

    class  serverrec

    Defines

    #define LINK_ACTIVE   1
    #define LINK_INACTIVE   0

    Typedefs

    typedef map< string, serverrec * > server_list
    +


    Define Documentation

    +

    + + + + +
    + + +
    #define LINK_ACTIVE   1 +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 18 of file servers.h. +

    +Referenced by serverrec::serverrec().

    +

    + + + + +
    + + +
    #define LINK_INACTIVE   0 +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 19 of file servers.h.

    +


    Typedef Documentation

    +

    + + + + +
    + + +
    typedef map<string, serverrec*> server_list +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 47 of file servers.h.

    +


    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by + +doxygen1.3-rc2
    + + diff --git a/docs/module-doc/tree.js b/docs/module-doc/tree.js index ff40787d6..75de2211a 100644 --- a/docs/module-doc/tree.js +++ b/docs/module-doc/tree.js @@ -1,17 +1,25 @@ foldersTree = gFld("InspIRCd", "", "") insDoc(foldersTree, gLnk("Main Page", "", "main.html")) aux1 = insFld(foldersTree, gFld("File List", "", "files.html")) + insDoc(aux1, gLnk("base.h", "", "base_8h.html")) insDoc(aux1, gLnk("channels.h", "", "channels_8h.html")) + insDoc(aux1, gLnk("connection.h", "", "connection_8h.html")) + insDoc(aux1, gLnk("ctables.h", "", "ctables_8h.html")) insDoc(aux1, gLnk("modules.cpp", "", "modules_8cpp.html")) insDoc(aux1, gLnk("modules.h", "", "modules_8h.html")) + insDoc(aux1, gLnk("servers.cpp", "", "servers_8cpp.html")) + insDoc(aux1, gLnk("servers.h", "", "servers_8h.html")) insDoc(aux1, gLnk("users.cpp", "", "users_8cpp.html")) insDoc(aux1, gLnk("users.h", "", "users_8h.html")) aux1 = insFld(foldersTree, gFld("Compound List", "", "annotated.html")) insDoc(aux1, gLnk("Admin", "", "classAdmin.html")) insDoc(aux1, gLnk("BanItem", "", "classBanItem.html")) insDoc(aux1, gLnk("chanrec", "", "classchanrec.html")) + insDoc(aux1, gLnk("classbase", "", "classclassbase.html")) + insDoc(aux1, gLnk("command_t", "", "classcommand__t.html")) insDoc(aux1, gLnk("ConfigReader", "", "classConfigReader.html")) insDoc(aux1, gLnk("ConnectClass", "", "classConnectClass.html")) + insDoc(aux1, gLnk("connection", "", "classconnection.html")) insDoc(aux1, gLnk("ExemptItem", "", "classExemptItem.html")) insDoc(aux1, gLnk("FileReader", "", "classFileReader.html")) insDoc(aux1, gLnk("HostItem", "", "classHostItem.html")) @@ -20,25 +28,30 @@ aux1 = insFld(foldersTree, gFld("Compound List", "", "annotated.html")) insDoc(aux1, gLnk("Module", "", "classModule.html")) insDoc(aux1, gLnk("ModuleFactory", "", "classModuleFactory.html")) insDoc(aux1, gLnk("Server", "", "classServer.html")) + insDoc(aux1, gLnk("serverrec", "", "classserverrec.html")) insDoc(aux1, gLnk("ucrec", "", "classucrec.html")) insDoc(aux1, gLnk("userrec", "", "classuserrec.html")) insDoc(aux1, gLnk("Version", "", "classVersion.html")) aux1 = insFld(foldersTree, gFld("Class Hierarchy", "", "hierarchy.html")) - insDoc(aux1, gLnk("Admin", "", "classAdmin.html")) - insDoc(aux1, gLnk("chanrec", "", "classchanrec.html")) - insDoc(aux1, gLnk("ConfigReader", "", "classConfigReader.html")) + aux2 = insFld(aux1, gFld("classbase", "", "classclassbase.html")) + insDoc(aux2, gLnk("Admin", "", "classAdmin.html")) + insDoc(aux2, gLnk("chanrec", "", "classchanrec.html")) + insDoc(aux2, gLnk("command_t", "", "classcommand__t.html")) + insDoc(aux2, gLnk("ConfigReader", "", "classConfigReader.html")) + aux3 = insFld(aux2, gFld("connection", "", "classconnection.html")) + insDoc(aux3, gLnk("serverrec", "", "classserverrec.html")) + insDoc(aux3, gLnk("userrec", "", "classuserrec.html")) + insDoc(aux2, gLnk("FileReader", "", "classFileReader.html")) + aux3 = insFld(aux2, gFld("HostItem", "", "classHostItem.html")) + insDoc(aux3, gLnk("BanItem", "", "classBanItem.html")) + insDoc(aux3, gLnk("ExemptItem", "", "classExemptItem.html")) + insDoc(aux3, gLnk("InviteItem", "", "classInviteItem.html")) + insDoc(aux2, gLnk("Module", "", "classModule.html")) + insDoc(aux2, gLnk("ModuleFactory", "", "classModuleFactory.html")) + insDoc(aux2, gLnk("Server", "", "classServer.html")) + insDoc(aux2, gLnk("ucrec", "", "classucrec.html")) + insDoc(aux2, gLnk("Version", "", "classVersion.html")) insDoc(aux1, gLnk("ConnectClass", "", "classConnectClass.html")) - insDoc(aux1, gLnk("FileReader", "", "classFileReader.html")) - aux2 = insFld(aux1, gFld("HostItem", "", "classHostItem.html")) - insDoc(aux2, gLnk("BanItem", "", "classBanItem.html")) - insDoc(aux2, gLnk("ExemptItem", "", "classExemptItem.html")) - insDoc(aux2, gLnk("InviteItem", "", "classInviteItem.html")) insDoc(aux1, gLnk("Invited", "", "classInvited.html")) - insDoc(aux1, gLnk("Module", "", "classModule.html")) - insDoc(aux1, gLnk("ModuleFactory", "", "classModuleFactory.html")) - insDoc(aux1, gLnk("Server", "", "classServer.html")) - insDoc(aux1, gLnk("ucrec", "", "classucrec.html")) - insDoc(aux1, gLnk("userrec", "", "classuserrec.html")) - insDoc(aux1, gLnk("Version", "", "classVersion.html")) insDoc(foldersTree, gLnk("Compound Members", "", "functions.html")) insDoc(foldersTree, gLnk("File Members", "", "globals.html")) diff --git a/docs/module-doc/users_8cpp-source.html b/docs/module-doc/users_8cpp-source.html index 9557e2486..cca0d47c0 100644 --- a/docs/module-doc/users_8cpp-source.html +++ b/docs/module-doc/users_8cpp-source.html @@ -9,8 +9,8 @@

    users.cpp

    Go to the documentation of this file.
    00001 /*
     00002 
     00003 $Log$
    -00003 Revision 1.2  2003/01/23 20:38:00  brain
    -00003 Updated documentation scripts
    +00003 Revision 1.3  2003/01/26 23:52:48  brain
    +00003 Modified documentation for base classes
     00003 
     00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
     00005 InspIRCd second source tree
    @@ -38,7 +38,7 @@
     00027 {
     00028         // the PROPER way to do it, AVOID bzero at *ALL* costs
     00029         strcpy(nick,"");
    -00030         ip = 0;
    +00030         ip = 0;
     00031         strcpy(ident,"");
     00032         strcpy(host,"");
     00033         strcpy(dhost,"");
    @@ -47,13 +47,13 @@
     00036         strcpy(inbuf,"");
     00037         strcpy(server,"");
     00038         strcpy(awaymsg,"");
    -00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
    -00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
    -00041         haspassed = false;
    +00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
    +00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
    +00041         haspassed = false;
     00042         strcpy(result,"");
     00043         for (int i = 0; i < MAXCHANS; i++)
     00044         {
    -00045                 chans[i].channel = NULL;
    +00045                 chans[i].channel = NULL;
     00046         }
     00047         invites.clear();
     00048 }
    @@ -62,14 +62,14 @@
     00051 char* userrec::GetFullHost()
     00052 {
     00053         sprintf(result,"%s!%s@%s",nick,ident,dhost);
    -00054         return result;
    +00054         return result;
     00055 }
     00056 
     00057 
     00058 char* userrec::GetFullRealHost()
     00059 {
     00060         sprintf(result,"%s!%s@%s",nick,ident,host);
    -00061         return result;
    +00061         return result;
     00062 }
     00063 
     00064 bool userrec::IsInvited(char* channel)
    @@ -101,7 +101,7 @@
     00090                 }
     00091         }
     00092 }
    -

    Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +

    Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/users_8cpp.html b/docs/module-doc/users_8cpp.html index 10f8a7134..ece5198db 100644 --- a/docs/module-doc/users_8cpp.html +++ b/docs/module-doc/users_8cpp.html @@ -16,7 +16,7 @@ Go to the source code of this file.
    -
    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html index 966673141..9557b4d0a 100644 --- a/docs/module-doc/users_8h-source.html +++ b/docs/module-doc/users_8h-source.html @@ -9,8 +9,8 @@

    users.h

    Go to the documentation of this file.
    00001 /*
     00002 
     00003 $Log$
    -00003 Revision 1.2  2003/01/23 20:38:00  brain
    -00003 Updated documentation scripts
    +00003 Revision 1.3  2003/01/26 23:52:48  brain
    +00003 Modified documentation for base classes
     00003 
     00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
     00005 InspIRCd second source tree
    @@ -42,115 +42,86 @@
     00031 
     00032 #include "inspircd_config.h" 
     00033 #include "channels.h"
    -00034 
    -00035 #include <string>
    -00036  
    -00037 #ifndef __USERS_H__ 
    -00038 #define __USERS_H__ 
    -00039  
    -00040 #define STATUS_OP       4
    -00041 #define STATUS_HOP      2
    -00042 #define STATUS_VOICE    1
    -00043 #define STATUS_NORMAL   0
    -00044 
    -00045 #define CC_ALLOW        0
    -00046 #define CC_DENY         1
    -00047 
    -00050 class Invited
    -00051 {
    -00052  public:
    -00053         char channel[CHANMAX];
    -00054 };
    -00055 
    +00034 #include "connection.h"
    +00035 
    +00036 #include <string>
    +00037  
    +00038 #ifndef __USERS_H__ 
    +00039 #define __USERS_H__ 
    +00040  
    +00041 #define STATUS_OP       4
    +00042 #define STATUS_HOP      2
    +00043 #define STATUS_VOICE    1
    +00044 #define STATUS_NORMAL   0
    +00045 
    +00046 #define CC_ALLOW        0
    +00047 #define CC_DENY         1
    +00048 
    +00051 class Invited
    +00052 {
    +00053  public:
    +00054         char channel[CHANMAX];
    +00055 };
     00056 
    -00059 class ConnectClass
    -00060 {
    -00061  public:
    -00062         int type;
    -00063         char host[MAXBUF];
    -00064         char pass[MAXBUF];
    -00065 };
    -00066 
    -00069 typedef vector<Invited> InvitedList;
    -00070 
    +00057 
    +00060 class ConnectClass
    +00061 {
    +00062  public:
    +00063         int type;
    +00064         char host[MAXBUF];
    +00065         char pass[MAXBUF];
    +00066 };
    +00067 
    +00070 typedef vector<Invited> InvitedList;
     00071 
     00072 
    -00075 typedef vector<ConnectClass> ClassVector;
    -00076 
    -00083 class userrec
    -00084 {
    -00085  private:
    -00086 
    -00089         InvitedList invites;
    -00090  public:
    -00091         
    -00096         char nick[NICKMAX];
    -00097         
    -00100         unsigned long ip;
    -00101 
    -00104         char ident[64];
    -00105 
    -00108         char host[256];
    -00109         
    -00113         char dhost[256];
    -00114         
    -00117         char fullname[128];
    -00118         
    -00123         int fd;
    -00124         
    -00129         char modes[32];
    -00130         
    -00134         char inbuf[MAXBUF];
    +00073 
    +00076 typedef vector<ConnectClass> ClassVector;
    +00077 
    +00084 class userrec : public connection
    +00085 {
    +00086  private:
    +00087 
    +00090         InvitedList invites;
    +00091  public:
    +00092         
    +00097         char nick[NICKMAX];
    +00098         
    +00101         char ident[64];
    +00102 
    +00106         char dhost[256];
    +00107         
    +00110         char fullname[128];
    +00111         
    +00116         char modes[32];
    +00117         
    +00118         ucrec chans[MAXCHANS];
    +00119         
    +00122         char server[256];
    +00123         
    +00127         char awaymsg[512];
    +00128         
    +00132         char result[256];
    +00133         
    +00134         userrec();
     00135         
    -00141         time_t lastping;
    -00142         
    -00145         time_t signon;
    -00146         
    -00150         time_t idle_lastmsg;
    -00151         
    -00156         time_t nping;
    -00157         
    -00162         int registered;
    -00163         
    -00168         ucrec chans[MAXCHANS];
    -00169         
    -00172         char server[256];
    -00173         
    -00177         char awaymsg[512];
    -00178         
    -00181         int port;
    -00182         
    -00186         long bytes_in;
    -00187         
    -00191         long bytes_out;
    -00192         
    -00196         long cmds_in;
    -00197         
    -00201         long cmds_out;
    -00202         
    -00206         char result[256];
    -00207         
    -00212         bool haspassed;
    -00213 
    -00214         userrec();
    -00215         
    -00216         virtual ~userrec() {  }
    -00217         
    -00222         virtual char* GetFullHost();
    -00223         
    -00229         virtual char* GetFullRealHost();
    -00230         
    -00233         virtual bool IsInvited(char* channel);
    -00234         
    -00237         virtual void InviteTo(char* channel);
    -00238         
    -00243         virtual void RemoveInvite(char* channel);
    -00244         
    -00245 };
    -00246 
    -00247 
    -00248 #endif
    -

    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +00136 virtual ~userrec() { } +00137 +00142 virtual char* GetFullHost(); +00143 +00149 virtual char* GetFullRealHost(); +00150 +00153 virtual bool IsInvited(char* channel); +00154 +00157 virtual void InviteTo(char* channel); +00158 +00163 virtual void RemoveInvite(char* channel); +00164 +00165 }; +00166 +00167 +00168 #endif +

    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html index 7a13bf4a7..df1234c10 100644 --- a/docs/module-doc/users_8h.html +++ b/docs/module-doc/users_8h.html @@ -8,6 +8,7 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    users.h File Reference

    #include "inspircd_config.h"
    #include "channels.h"
    +#include "connection.h"
    #include <string>

    @@ -55,7 +56,7 @@

    -Definition at line 45 of file users.h. +Definition at line 46 of file users.h.

    @@ -79,7 +80,7 @@ Definition at line 45 of fi

    -Definition at line 46 of file users.h. +Definition at line 47 of file users.h.

    @@ -103,7 +104,7 @@ Definition at line 46 of fi

    -Definition at line 41 of file users.h. +Definition at line 42 of file users.h.

    @@ -127,7 +128,7 @@ Definition at line 41 of fi

    -Definition at line 43 of file users.h. +Definition at line 44 of file users.h.

    @@ -151,7 +152,7 @@ Definition at line 43 of fi

    -Definition at line 40 of file users.h. +Definition at line 41 of file users.h.

    @@ -175,7 +176,7 @@ Definition at line 40 of fi

    -Definition at line 42 of file users.h. +Definition at line 43 of file users.h.


    Typedef Documentation

    @@ -202,7 +203,7 @@ Holds a complete list of all allow and deny tags from the configuration file (co

    -Definition at line 75 of file users.h. +Definition at line 76 of file users.h.

    @@ -228,10 +229,10 @@ Holds a complete list of all channels to which a user has been invited and has n

    -Definition at line 69 of file users.h. +Definition at line 70 of file users.h. -


    Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by +
    Generated on Sun Jan 26 23:45:48 2003 for InspIRCd by doxygen1.3-rc2
    -- cgit v1.2.3