From 08e384bb24398224856c44baa51b51977644de9d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 9 Feb 2003 12:49:00 +0000 Subject: Documentation update, 09/02/03 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/annotated.html | 9 +- docs/module-doc/base_8h-source.html | 45 +-- docs/module-doc/base_8h.html | 3 +- docs/module-doc/channels_8h-source.html | 247 ++++++------ docs/module-doc/channels_8h.html | 18 +- docs/module-doc/classAdmin-members.html | 2 +- docs/module-doc/classAdmin.html | 14 +- docs/module-doc/classBanItem-members.html | 2 +- docs/module-doc/classBanItem.html | 4 +- docs/module-doc/classConfigReader-members.html | 2 +- docs/module-doc/classConfigReader.html | 62 +-- docs/module-doc/classConnectClass-members.html | 2 +- docs/module-doc/classConnectClass.html | 10 +- docs/module-doc/classExemptItem-members.html | 2 +- docs/module-doc/classExemptItem.html | 4 +- docs/module-doc/classFileReader-members.html | 2 +- docs/module-doc/classFileReader.html | 76 ++-- docs/module-doc/classHostItem-members.html | 2 +- docs/module-doc/classHostItem.html | 18 +- docs/module-doc/classInviteItem-members.html | 2 +- docs/module-doc/classInviteItem.html | 4 +- docs/module-doc/classInvited-members.html | 2 +- docs/module-doc/classInvited.html | 8 +- docs/module-doc/classModule-members.html | 5 +- docs/module-doc/classModule.html | 126 +++++- docs/module-doc/classModuleFactory-members.html | 2 +- docs/module-doc/classModuleFactory.html | 12 +- docs/module-doc/classServer-members.html | 4 +- docs/module-doc/classServer.html | 267 ++++++------- docs/module-doc/classVersion-members.html | 2 +- docs/module-doc/classVersion.html | 16 +- docs/module-doc/classchanrec-members.html | 2 +- docs/module-doc/classchanrec.html | 60 +-- docs/module-doc/classclassbase-members.html | 2 +- docs/module-doc/classclassbase.html | 35 +- docs/module-doc/classclassbase.png | Bin 1753 -> 1842 bytes docs/module-doc/classcommand__t-members.html | 2 +- docs/module-doc/classcommand__t.html | 44 ++- docs/module-doc/classconnection-members.html | 42 +- docs/module-doc/classconnection.html | 494 +++++++++++++++++++++--- docs/module-doc/classes.html | 17 +- docs/module-doc/classserverrec-members.html | 61 +-- docs/module-doc/classserverrec.html | 372 +++++------------- docs/module-doc/classucrec-members.html | 2 +- docs/module-doc/classucrec.html | 18 +- docs/module-doc/classuserrec-members.html | 42 +- docs/module-doc/classuserrec.html | 168 ++++---- docs/module-doc/connection_8h-source.html | 116 +++--- docs/module-doc/connection_8h.html | 87 ++++- docs/module-doc/ctables_8h-source.html | 74 ++-- docs/module-doc/ctables_8h.html | 5 +- docs/module-doc/files.html | 2 +- docs/module-doc/functions.html | 122 +++--- docs/module-doc/globals.html | 41 +- docs/module-doc/hierarchy.html | 3 +- docs/module-doc/main.html | 2 +- docs/module-doc/modules_8cpp-source.html | 432 ++++++++++----------- docs/module-doc/modules_8cpp.html | 91 ++++- docs/module-doc/modules_8h-source.html | 271 ++++++------- docs/module-doc/modules_8h.html | 170 +++++++- docs/module-doc/servers_8cpp-source.html | 104 ++--- docs/module-doc/servers_8cpp.html | 2 +- docs/module-doc/servers_8h-source.html | 93 ++--- docs/module-doc/servers_8h.html | 11 +- docs/module-doc/tree.js | 2 + docs/module-doc/users_8cpp-source.html | 170 ++++---- docs/module-doc/users_8cpp.html | 2 +- docs/module-doc/users_8h-source.html | 205 ++++------ docs/module-doc/users_8h.html | 18 +- include/base.h | 10 +- include/ctables.h | 28 +- include/servers.h | 40 +- 72 files changed, 2533 insertions(+), 1903 deletions(-) diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index 788dc101e..c3e7b5bdb 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -10,8 +10,8 @@ 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 + classbaseThe base class for all inspircd classes + command_tA structure that defines a command 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 @@ -22,13 +22,14 @@ InviteItemA subclass of HostItem designed to hold channel invites (+I) 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 + packet 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 + serverrecA class that defines the local server or a remote server 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 Mon Jan 27 00:23:11 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:16 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 index d98c95631..5580e7e0a 100644 --- a/docs/module-doc/base_8h-source.html +++ b/docs/module-doc/base_8h-source.html @@ -8,35 +8,28 @@ 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.3  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.1  2003/01/26 23:52:59  brain
-00005 Modified documentation for base classes
-00006 Added base classes
-00007 
-00008 
-00009 */
-00010 
-00011 #include "inspircd_config.h" 
-00012 #include <time.h>
-00013  
-00014 #ifndef __BASE_H__ 
-00015 #define __BASE_H__ 
-00016  
-00017 class classbase
-00018 {
-00019  public:
+00004 */
+00005 
+00006 #include "inspircd_config.h" 
+00007 #include <time.h>
+00008  
+00009 #ifndef __BASE_H__ 
+00010 #define __BASE_H__ 
+00011 
+00012 
+00015 class classbase
+00016 {
+00017  public:
 00020         time_t age;
 00021 
-00022         classbase() { age = time(NULL); }
-00023         ~classbase() { }
-00024 };
-00025 
-00026 #endif
-00027 
-
Generated on Mon Jan 27 00:23:10 2003 for InspIRCd by +00025 classbase() { age = time(NULL); } +00026 ~classbase() { } +00027 }; +00028 +00029 #endif +00030 +
Generated on Sun Feb 9 12:48:15 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/base_8h.html b/docs/module-doc/base_8h.html index 3e3f948aa..9128555d9 100644 --- a/docs/module-doc/base_8h.html +++ b/docs/module-doc/base_8h.html @@ -14,8 +14,9 @@

Compounds

class  classbase + The base class for all inspircd classes. More...

-
Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:16 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 3a203ce1f..63373103f 100644 --- a/docs/module-doc/channels_8h-source.html +++ b/docs/module-doc/channels_8h-source.html @@ -8,142 +8,119 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

channels.h

Go to the documentation of this file.
00001 /*
 00002 
-00003 $Log$
-00003 Revision 1.5  2003/01/27 00:28:57  brain
-00003 ...
-00003 
-00004 Revision 1.2  2003/01/26 23:52:59  brain
-00005 Modified documentation for base classes
-00006 Added base classes
-00007 
-00008 Revision 1.1.1.1  2003/01/23 19:45:58  brain
-00009 InspIRCd second source tree
-00010 
-00011 Revision 1.7  2003/01/22 00:44:26  brain
-00012 Added documentation comments
-00013 
-00014 Revision 1.6  2003/01/21 21:11:17  brain
-00015 Added documentation
-00016 
-00017 Revision 1.5  2003/01/16 20:11:55  brain
-00018 fixed some ugly pointer bugs (thanks dblack and a|KK|y!)
-00019 
-00020 Revision 1.4  2003/01/15 22:47:44  brain
-00021 Changed user and channel structs to classes (finally)
-00022 
-00023    
-00024 */
-00025 
-00026 #include "inspircd_config.h"
-00027 #include "base.h"
-00028 #include <time.h>
-00029 #include <vector>
+00003    
+00004 */
+00005 
+00006 #include "inspircd_config.h"
+00007 #include "base.h"
+00008 #include <time.h>
+00009 #include <vector>
+00010 
+00011 #ifndef __CHANNELS_H__
+00012 #define __CHANNELS_H__
+00013 
+00017 class HostItem : public classbase
+00018 {
+00019  public:
+00020         time_t set_time;
+00021         char set_by[NICKMAX];
+00022         char data[MAXBUF];
+00023 
+00024         HostItem() { /* stub */ }
+00025         virtual ~HostItem() { /* stub */ }
+00026 };
+00027 
+00028 // banlist is inherited from HostList mainly for readability
+00029 // reasons only
 00030 
-00031 #ifndef __CHANNELS_H__
-00032 #define __CHANNELS_H__
-00033 
-00037 class HostItem : public classbase
-00038 {
-00039  public:
-00040         time_t set_time;
-00041         char set_by[NICKMAX];
-00042         char data[MAXBUF];
-00043 
-00044         HostItem() { /* stub */ }
-00045         virtual ~HostItem() { /* stub */ }
-00046 };
-00047 
-00048 // banlist is inherited from HostList mainly for readability
-00049 // reasons only
-00050 
-00053 class BanItem : public HostItem
-00054 {
-00055 };
-00056 
-00057 // same with this...
-00058 
-00061 class ExemptItem : public HostItem
-00062 {
-00063 };
-00064 
-00065 // and this...
-00066 
-00069 class InviteItem : public HostItem
-00070 {
-00071 };
-00072 
-00073 
-00076 typedef vector<BanItem>         BanList;
-00077 
-00080 typedef vector<ExemptItem>      ExemptList;
-00081 
-00084 typedef vector<InviteItem>      InviteList;
-00085 
-00090 class chanrec : public classbase
-00091 {
-00092  public:
-00095         char name[CHANMAX]; /* channel name */
-00099         char custom_modes[MAXMODES];     /* modes handled by modules */
-00103         char topic[MAXBUF];
-00106         time_t created;
-00110         time_t topicset;
-00114         char setby[NICKMAX];
-00115 
-00119         long limit;
-00120         
-00124         char key[32];
-00125         
-00128         short int topiclock;
-00129         
-00132         short int noexternal;
-00133         
-00136         short int inviteonly;
-00137         
-00140         short int moderated;
-00141         
-00145         short int secret;
-00146         
-00150         short int c_private;
-00151         
-00154         BanList bans;
-00155 
-00158         chanrec()
-00159         {
-00160                 strcpy(name,"");
-00161                 strcpy(custom_modes,"");
-00162                 strcpy(topic,"");
-00163                 strcpy(setby,"");
-00164                 strcpy(key,"");
-00165                 created = topicset = limit = 0;
-00166                 topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
-00167         }
-00168 
-00169         virtual ~chanrec() { /* stub */ }
-00170 };
-00171 
-00172 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
-00173  * needs to come AFTER struct chanrec */
-00174 
-00175 #define UCMODE_OP      1
-00176 #define UCMODE_VOICE   2
-00177 #define UCMODE_HOP     4
-00178 #define UCMODE_PROTECT 8
-00179 #define UCMODE_FOUNDER 16
-00180  
-00186 class ucrec : public classbase
-00187 {
-00188  public:
-00192         long uc_modes;
-00193         
-00197         chanrec *channel;
-00198 
-00199         ucrec() { /* stub */ }
-00200         virtual ~ucrec() { /* stub */ }
-00201 };
-00202 
-00203 #endif
-00204 
-
Generated on Mon Jan 27 00:23:10 2003 for InspIRCd by +00033 class BanItem : public HostItem +00034 { +00035 }; +00036 +00037 // same with this... +00038 +00041 class ExemptItem : public HostItem +00042 { +00043 }; +00044 +00045 // and this... +00046 +00049 class InviteItem : public HostItem +00050 { +00051 }; +00052 +00053 +00056 typedef vector<BanItem> BanList; +00057 +00060 typedef vector<ExemptItem> ExemptList; +00061 +00064 typedef vector<InviteItem> InviteList; +00065 +00070 class chanrec : public classbase +00071 { +00072 public: +00075 char name[CHANMAX]; /* channel name */ +00079 char custom_modes[MAXMODES]; /* modes handled by modules */ +00083 char topic[MAXBUF]; +00086 time_t created; +00090 time_t topicset; +00094 char setby[NICKMAX]; +00095 +00099 long limit; +00100 +00104 char key[32]; +00105 +00108 short int topiclock; +00109 +00112 short int noexternal; +00113 +00116 short int inviteonly; +00117 +00120 short int moderated; +00121 +00125 short int secret; +00126 +00130 short int c_private; +00131 +00134 BanList bans; +00135 +00138 chanrec() +00139 { +00140 strcpy(name,""); +00141 strcpy(custom_modes,""); +00142 strcpy(topic,""); +00143 strcpy(setby,""); +00144 strcpy(key,""); +00145 created = topicset = limit = 0; +00146 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; +00147 } +00148 +00149 virtual ~chanrec() { /* stub */ } +00150 }; +00151 +00152 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o +00153 * needs to come AFTER struct chanrec */ +00154 +00155 #define UCMODE_OP 1 +00156 #define UCMODE_VOICE 2 +00157 #define UCMODE_HOP 4 +00158 #define UCMODE_PROTECT 8 +00159 #define UCMODE_FOUNDER 16 +00160 +00166 class ucrec : public classbase +00167 { +00168 public: +00172 long uc_modes; +00173 +00177 chanrec *channel; +00178 +00179 ucrec() { /* stub */ } +00180 virtual ~ucrec() { /* stub */ } +00181 }; +00182 +00183 #endif +00184 +
Generated on Sun Feb 9 12:48:15 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html index 181b61f62..a804e2684 100644 --- a/docs/module-doc/channels_8h.html +++ b/docs/module-doc/channels_8h.html @@ -63,7 +63,7 @@

-Definition at line 179 of file channels.h. +Definition at line 159 of file channels.h.

@@ -87,7 +87,7 @@ Definition at line 179 o

-Definition at line 177 of file channels.h. +Definition at line 157 of file channels.h.

@@ -111,7 +111,7 @@ Definition at line 177 o

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

@@ -135,7 +135,7 @@ Definition at line 175 o

-Definition at line 178 of file channels.h. +Definition at line 158 of file channels.h.

@@ -159,7 +159,7 @@ Definition at line 178 o

-Definition at line 176 of file channels.h. +Definition at line 156 of file channels.h.

Typedef Documentation

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

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

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

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

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

-Definition at line 84 of file channels.h. +Definition at line 64 of file channels.h. -

Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html index 84be3bb34..58b71a52e 100644 --- a/docs/module-doc/classAdmin-members.html +++ b/docs/module-doc/classAdmin-members.html @@ -14,7 +14,7 @@ NameAdmin NickAdmin ~classbase()classbase [inline] -
Generated on Mon Jan 27 00:23:12 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:17 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html index db34ff821..54cf85837 100644 --- a/docs/module-doc/classAdmin.html +++ b/docs/module-doc/classAdmin.html @@ -32,7 +32,7 @@ It is constructed by class Server, and

-Definition at line 78 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 53 of file modules.h.

Constructor & Destructor Documentation

@@ -76,9 +76,9 @@ Definition at line 78 of

-Definition at line 36 of file modules.cpp. +Definition at line 20 of file modules.cpp.

-

00036 : Name(name), Email(email), Nick(nick) { };
+
00020 : Name(name), Email(email), Nick(nick) { };
@@ -104,7 +104,7 @@ Definition at line 36 o

-Definition at line 81 of file modules.h. +Definition at line 56 of file modules.h.

@@ -128,7 +128,7 @@ Definition at line 81 of

-Definition at line 81 of file modules.h. +Definition at line 56 of file modules.h.

@@ -152,12 +152,12 @@ Definition at line 81 of

-Definition at line 81 of file modules.h. +Definition at line 56 of file modules.h.

The documentation for this class was generated from the following files: -
Generated on Mon Jan 27 00:23:12 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:17 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html index 479c3c0b2..13a1580a8 100644 --- a/docs/module-doc/classBanItem-members.html +++ b/docs/module-doc/classBanItem-members.html @@ -15,7 +15,7 @@ set_timeHostItem ~classbase()classbase [inline] ~HostItem()HostItem [inline, virtual] -
Generated on Mon Jan 27 00:23:12 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:17 2003 for InspIRCd by doxygen1.3-rc2
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html index c62638b42..abf3fa706 100644 --- a/docs/module-doc/classBanItem.html +++ b/docs/module-doc/classBanItem.html @@ -25,9 +25,9 @@ A subclass of HostItem designed to h

-Definition at line 53 of file channels.h.

The documentation for this class was generated from the following file:
    +Definition at line 33 of file channels.h.
    The documentation for this class was generated from the following file: -
    Generated on Mon Jan 27 00:23:12 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:17 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html index 93ae1013f..118ac4b89 100644 --- a/docs/module-doc/classConfigReader-members.html +++ b/docs/module-doc/classConfigReader-members.html @@ -17,7 +17,7 @@ Verify()ConfigReader ~classbase()classbase [inline] ~ConfigReader()ConfigReader -
    Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 800978c24..6ae16f47a 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -42,7 +42,7 @@ It may either be instantiated with one parameter or none. Constructing the class

    -Definition at line 237 of file modules.h.

    Constructor & Destructor Documentation

    +Definition at line 218 of file modules.h.

    Constructor & Destructor Documentation

    @@ -72,13 +72,13 @@ Default constructor.

    This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.

    -Definition at line 164 of file modules.cpp. +Definition at line 151 of file modules.cpp.

    -References fname. +References fname.

    -

    00165 {
-00166         fname = CONFIG_FILE;
-00167 }
+
    00152 {
+00153         fname = CONFIG_FILE;
+00154 }
    @@ -112,9 +112,9 @@ Overloaded constructor.

    This constructor initialises the ConfigReader class to read a user-specified config file

    -Definition at line 175 of file modules.cpp. +Definition at line 162 of file modules.cpp.

    -

    00175 : fname(filename) { };
+
    00162 : fname(filename) { };
 
        
   
 
@@ -147,10 +147,10 @@ Default destructor.
 
    
 This method destroys the ConfigReader class.
 
    
-Definition at line 170 of file modules.cpp.
+Definition at line 157 of file modules.cpp.
 
    
-
    00171 {
-00172 }
+
    00158 {
+00159 }
 
        
   
 
@@ -185,13 +185,13 @@ Counts the number of times a given tag appears in the config file.
 
    
 This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.
 
    
-Definition at line 186 of file modules.cpp.
+Definition at line 173 of file modules.cpp.
 
    
-References fname.
+References fname.
 
    
-
    00187 {
-00188         return EnumConf(fname.c_str(),tag.c_str());
-00189 }
+
    00174 {
+00175         return EnumConf(fname.c_str(),tag.c_str());
+00176 }
 
        
   
 
@@ -240,16 +240,16 @@ Retrieves a value from the config file.
 
    
 This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
 
    
-Definition at line 177 of file modules.cpp.
+Definition at line 164 of file modules.cpp.
 
    
-References fname.
+References fname.
 
    
-
    00178 {
-00179         char val[MAXBUF];
-00180         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00181         string s = val;
-00182         return s;
-00183 }
+
    00165 {
+00166         char val[MAXBUF];
+00167         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
+00168         string s = val;
+00169         return s;
+00170 }
 
        
   
 
@@ -282,11 +282,11 @@ Returns true if a config file is valid.
 
    
 This method is unimplemented and will always return true.
 
    
-Definition at line 192 of file modules.cpp.
+Definition at line 179 of file modules.cpp.
 
    
-
    00193 {
-00194         return true;
-00195 }
+
    00180 {
+00181         return true;
+00182 }
 
        
   
 
@@ -314,14 +314,14 @@ The filename of the configuration file, as set by the constructor.
 
    
 
 
    
-Definition at line 242 of file modules.h.
+Definition at line 223 of file modules.h.
 
    
-Referenced by ConfigReader(), Enumerate(), and ReadValue().    
+Referenced by ConfigReader(), Enumerate(), and ReadValue().    
   
 
 
    The documentation for this class was generated from the following files:
-
    Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
+
    Generated on Sun Feb 9 12:48:17 2003 for InspIRCd by
 
 doxygen1.3-rc2 
    
diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html
index 6dc9ed900..849b00f52 100644
--- a/docs/module-doc/classConnectClass-members.html
+++ b/docs/module-doc/classConnectClass-members.html
@@ -13,7 +13,7 @@
   passConnectClass
   typeConnectClass
   ~classbase()classbase [inline]
-
    Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
+
    Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by
 
 doxygen1.3-rc2 
    
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html
index dc8d24db6..ade7d3f0a 100644
--- a/docs/module-doc/classConnectClass.html
+++ b/docs/module-doc/classConnectClass.html
@@ -28,7 +28,7 @@ Holds information relevent to <connect allow> and <connect deny> tag
 
    
 
 
    
-Definition at line 68 of file users.h.
    Member Data Documentation
    
+Definition at line 34 of file users.h.
    Member Data Documentation
    
 
    
 
@@ -50,7 +50,7 @@ Definition at line 68 of fi
 
    
 
 
    
-Definition at line 72 of file users.h.    
+Definition at line 38 of file users.h.    
   
    
   
    
 
    
 
    
@@ -74,7 +74,7 @@ Definition at line 72 of fi
 
    
 
 
    
-Definition at line 73 of file users.h.    
+Definition at line 39 of file users.h.    
   
 
 
    
@@ -98,12 +98,12 @@ Definition at line 73 of fi
 
    
 
 
    
-Definition at line 71 of file users.h.    
+Definition at line 37 of file users.h.    
   
 
 
    The documentation for this class was generated from the following file:
-
    Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
+
    Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by
 
 doxygen1.3-rc2 
    
diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html
index 97864f2f3..19091ceb7 100644
--- a/docs/module-doc/classExemptItem-members.html
+++ b/docs/module-doc/classExemptItem-members.html
@@ -15,7 +15,7 @@
   set_timeHostItem
   ~classbase()classbase [inline]
   ~HostItem()HostItem [inline, virtual]
-
    Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
+
    Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by
 
 doxygen1.3-rc2 
    
diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html
index 8c56c9c18..daa23b034 100644
--- a/docs/module-doc/classExemptItem.html
+++ b/docs/module-doc/classExemptItem.html
@@ -25,9 +25,9 @@ A subclass of HostItem designed to h
 
    
 
 
    
-Definition at line 61 of file channels.h.
    The documentation for this class was generated from the following file:
 
    - c -
 
    
 
    - d -
 
    
 
    - e -
 
    
 
    - l -
 
    
+: connection
  • limit
+: chanrec
  • LoadFile()
+: FileReader
  • Log()
+: Server

- m -

  • Major @@ -120,36 +120,41 @@ Here is a list of all class members with links to the classes they belong to:

    Version
  • moderated : chanrec
  • modes : userrec
  • Module() -: Module
  • ModuleFactory() +: Module
  • Module::OnPacketReceive() +: Module
  • Module::OnPacketTransmit() +: Module
  • ModuleFactory() : ModuleFactory

- n -

+: connection

- o -

+: serverrec

- p -

+: connection

- r -

@@ -157,44 +162,48 @@ Here is a list of all class members with links to the classes they belong to:

+: connection

- t -

+: ConnectClass, packet

- u -

- v -

+: ConfigReader
  • version +: serverrec
  • Version() +: Version

    - ~ -

    -
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/globals.html b/docs/module-doc/globals.html index 42414102f..ecd46dd8d 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 | h | i | l | s | u
    +b | c | d | e | f | h | i | l | m | n | p | s | u | v

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

    - b - @@ -20,15 +20,21 @@ Here is a list of all file members with links to the files they belong to:

    users.h
  • CC_DENY : users.h
  • ClassVector : users.h +

    - d - +

    - e -

    - f -

    +
  • factory() +: modules.cpp
  • file_cache +: modules.h
  • FOREACH_MOD +: modules.h

    - h -

    - l -

    +

    - m - +

    +

    - n - +

    +

    - p - +

    - s -

    -
    Generated on Mon Jan 27 00:23:14 2003 for InspIRCd by +

    - v - +

    +
    Generated on Sun Feb 9 12:48:19 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/hierarchy.html b/docs/module-doc/hierarchy.html index 2676ef42f..f83770cf2 100644 --- a/docs/module-doc/hierarchy.html +++ b/docs/module-doc/hierarchy.html @@ -29,12 +29,13 @@
  • Invited
  • Module
  • ModuleFactory +
  • packet
  • Server
  • ucrec
  • Version -
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/main.html b/docs/module-doc/main.html index d1b681026..90917542e 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 Mon Jan 27 00:23:10 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:15 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 ad2a8f4ac..793cf2c10 100644 --- a/docs/module-doc/modules_8cpp-source.html +++ b/docs/module-doc/modules_8cpp-source.html @@ -8,240 +8,230 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    modules.cpp

    Go to the documentation of this file.
    00001 /*
 00002 
-00003 $Log$
-00003 Revision 1.5  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
-00005 InspIRCd second source tree
-00006 
-00007 Revision 1.7  2003/01/22 20:49:16  brain
-00008 Added FileReader file-caching class
-00009 Changed m_randquote to use FileReader class
-00010 
-00011 Revision 1.6  2003/01/21 20:31:24  brain
-00012 Modified to add documentation
-00013 Added ConfigReader class for modules
-00014 
-00015 Revision 1.5  2003/01/13 22:30:50  brain
-00016 Added Admin class (holds /admin info for modules)
-00017 Added methods to Server class
-00018 
-00019 
-00020 */
+00004 */
+00005 
+00006 
+00007 
+00008 #include <typeinfo>
+00009 #include <iostream.h>
+00010 #include "globals.h"
+00011 #include "modules.h"
+00012 #include "inspircd_io.h"
+00013 
+00014 // version is a simple class for holding a modules version number
+00015 
+00016 Version::Version(int major, int minor, int revision, int build) : Major(major), Minor(minor), Revision(revision), Build(build) { };
+00017 
+00018 // admin is a simple class for holding a server's administrative info
+00019 
+00020 Admin::Admin(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { };
 00021 
-00022 
-00023 
-00024 #include <typeinfo>
-00025 #include <iostream.h>
-00026 #include "globals.h"
-00027 #include "modules.h"
-00028 #include "inspircd_io.h"
-00029 
-00030 // version is a simple class for holding a modules version number
-00031 
-00032 Version::Version(int major, int minor, int revision, int build) : Major(major), Minor(minor), Revision(revision), Build(build) { };
-00033 
-00034 // admin is a simple class for holding a server's administrative info
-00035 
-00036 Admin::Admin(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { };
+00022 //
+00023 // Announce to the world that the Module base
+00024 // class has been created or destroyed
+00025 //
+00026 
+00027 Module::Module() { }
+00028 Module::~Module() { }
+00029 void Module::OnUserConnect(userrec* user) { }
+00030 void Module::OnUserQuit(userrec* user) { }
+00031 void Module::OnUserJoin(userrec* user, chanrec* channel) { }
+00032 void Module::OnUserPart(userrec* user, chanrec* channel) { }
+00033 void Module::OnPacketTransmit(char *p) { }
+00034 void Module::OnPacketReceive(char *p) { }
+00035 void Module::OnRehash() { }
+00036 Version Module::GetVersion() { return Version(1,0,0,0); }
 00037 
-00038 //
-00039 // Announce to the world that the Module base
-00040 // class has been created or destroyed
-00041 //
-00042 
-00043 Module::Module() { }
-00044 Module::~Module() { }
-00045 void Module::OnUserConnect(userrec* user) { }
-00046 void Module::OnUserQuit(userrec* user) { }
-00047 void Module::OnUserJoin(userrec* user, chanrec* channel) { }
-00048 void Module::OnUserPart(userrec* user, chanrec* channel) { }
-00049 Version Module::GetVersion() { return Version(1,0,0,0); }
-00050 
-00051 // server is a wrapper class that provides methods to all of the C-style
-00052 // exports in the core
-00053 //
+00038 // server is a wrapper class that provides methods to all of the C-style
+00039 // exports in the core
+00040 //
+00041 
+00042 Server::Server()
+00043 {
+00044 }
+00045 
+00046 Server::~Server()
+00047 {
+00048 }
+00049 
+00050 void Server::SendOpers(string s)
+00051 {
+00052         WriteOpers("%s",s.c_str());
+00053 }
 00054 
-00055 Server::Server()
+00055 void Server::Log(int level, string s)
 00056 {
-00057 }
-00058 
-00059 Server::~Server()
-00060 {
-00061 }
-00062 
-00063 void Server::SendOpers(string s)
-00064 {
-00065         WriteOpers("%s",s.c_str());
-00066 }
-00067 
-00068 void Server::Debug(string s)
-00069 {
-00070         debug("%s",s.c_str());
-00071 }
-00072 
-00073 void Server::Send(int Socket, string s)
-00074 {
-00075         Write(Socket,"%s",s.c_str());
-00076 }
-00077 
-00078 void Server::SendServ(int Socket, string s)
-00079 {
-00080         WriteServ(Socket,"%s",s.c_str());
-00081 }
-00082 
-00083 void Server::SendFrom(int Socket, userrec* User, string s)
-00084 {
-00085         WriteFrom(Socket,User,"%s",s.c_str());
-00086 }
-00087 
-00088 void Server::SendTo(userrec* Source, userrec* Dest, string s)
-00089 {
-00090         WriteTo(Source,Dest,"%s",s.c_str());
-00091 }
-00092 
-00093 void Server::SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender)
-00094 {
-00095         if (IncludeSender)
-00096         {
-00097                 WriteChannel(Channel,User,"%s",s.c_str());
-00098         }
-00099         else
+00057         log(level,"%s",s.c_str());
+00058 }
+00059 
+00060 void Server::Send(int Socket, string s)
+00061 {
+00062         Write(Socket,"%s",s.c_str());
+00063 }
+00064 
+00065 void Server::SendServ(int Socket, string s)
+00066 {
+00067         WriteServ(Socket,"%s",s.c_str());
+00068 }
+00069 
+00070 void Server::SendFrom(int Socket, userrec* User, string s)
+00071 {
+00072         WriteFrom(Socket,User,"%s",s.c_str());
+00073 }
+00074 
+00075 void Server::SendTo(userrec* Source, userrec* Dest, string s)
+00076 {
+00077         WriteTo(Source,Dest,"%s",s.c_str());
+00078 }
+00079 
+00080 void Server::SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender)
+00081 {
+00082         if (IncludeSender)
+00083         {
+00084                 WriteChannel(Channel,User,"%s",s.c_str());
+00085         }
+00086         else
+00087         {
+00088                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00089         }
+00090 }
+00091 
+00092 bool Server::CommonChannels(userrec* u1, userrec* u2)
+00093 {
+00094         return (common_channels(u1,u2) != 0);
+00095 }
+00096 
+00097 void Server::SendCommon(userrec* User, string text,bool IncludeSender)
+00098 {
+00099         if (IncludeSender)
 00100         {
-00101                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00101                 WriteCommon(User,"%s",text.c_str());
 00102         }
-00103 }
-00104 
-00105 bool Server::CommonChannels(userrec* u1, userrec* u2)
-00106 {
-00107         return (common_channels(u1,u2) != 0);
-00108 }
-00109 
-00110 void Server::SendCommon(userrec* User, string text,bool IncludeSender)
-00111 {
-00112         if (IncludeSender)
-00113         {
-00114                 WriteCommon(User,"%s",text.c_str());
-00115         }
-00116         else
-00117         {
-00118                 WriteCommonExcept(User,"%s",text.c_str());
-00119         }
-00120 }
-00121 
-00122 void Server::SendWallops(userrec* User, string text)
-00123 {
-00124         WriteWallOps(User,"%s",text.c_str());
-00125 }
-00126 
-00127 bool Server::IsNick(string nick)
-00128 {
-00129         return (isnick(nick.c_str()) != 0);
-00130 }
-00131 
-00132 userrec* Server::FindNick(string nick)
-00133 {
-00134         return Find(nick);
-00135 }
-00136 
-00137 chanrec* Server::FindChannel(string channel)
-00138 {
-00139         return FindChan(channel.c_str());
-00140 }
-00141 
-00142 string Server::ChanMode(userrec* User, chanrec* Chan)
-00143 {
-00144         string mode = cmode(User,Chan);
-00145         return mode;
-00146 }
-00147 
-00148 string Server::GetServerName()
-00149 {
-00150         return getservername();
-00151 }
-00152 
-00153 string Server::GetNetworkName()
-00154 {
-00155         return getnetworkname();
-00156 }
-00157 
-00158 Admin Server::GetAdmin()
-00159 {
-00160         return Admin(getadminname(),getadminemail(),getadminnick());
-00161 }
-00162 
+00103         else
+00104         {
+00105                 WriteCommonExcept(User,"%s",text.c_str());
+00106         }
+00107 }
+00108 
+00109 void Server::SendWallops(userrec* User, string text)
+00110 {
+00111         WriteWallOps(User,"%s",text.c_str());
+00112 }
+00113 
+00114 bool Server::IsNick(string nick)
+00115 {
+00116         return (isnick(nick.c_str()) != 0);
+00117 }
+00118 
+00119 userrec* Server::FindNick(string nick)
+00120 {
+00121         return Find(nick);
+00122 }
+00123 
+00124 chanrec* Server::FindChannel(string channel)
+00125 {
+00126         return FindChan(channel.c_str());
+00127 }
+00128 
+00129 string Server::ChanMode(userrec* User, chanrec* Chan)
+00130 {
+00131         string mode = cmode(User,Chan);
+00132         return mode;
+00133 }
+00134 
+00135 string Server::GetServerName()
+00136 {
+00137         return getservername();
+00138 }
+00139 
+00140 string Server::GetNetworkName()
+00141 {
+00142         return getnetworkname();
+00143 }
+00144 
+00145 Admin Server::GetAdmin()
+00146 {
+00147         return Admin(getadminname(),getadminemail(),getadminnick());
+00148 }
+00149 
+00150 
+00151 ConfigReader::ConfigReader()
+00152 {
+00153         fname = CONFIG_FILE;
+00154 }
+00155 
+00156 
+00157 ConfigReader::~ConfigReader()
+00158 {
+00159 }
+00160 
+00161 
+00162 ConfigReader::ConfigReader(string filename) : fname(filename) { };
 00163 
-00164 ConfigReader::ConfigReader()
+00164 string ConfigReader::ReadValue(string tag, string name, int index)
 00165 {
-00166         fname = CONFIG_FILE;
-00167 }
-00168 
-00169 
-00170 ConfigReader::~ConfigReader()
-00171 {
-00172 }
-00173 
-00174 
-00175 ConfigReader::ConfigReader(string filename) : fname(filename) { };
-00176 
-00177 string ConfigReader::ReadValue(string tag, string name, int index)
-00178 {
-00179         char val[MAXBUF];
-00180         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00181         string s = val;
-00182         return s;
-00183 }
+00166         char val[MAXBUF];
+00167         ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
+00168         string s = val;
+00169         return s;
+00170 }
+00171 
+00172 
+00173 int ConfigReader::Enumerate(string tag)
+00174 {
+00175         return EnumConf(fname.c_str(),tag.c_str());
+00176 }
+00177 
+00178 
+00179 bool ConfigReader::Verify()
+00180 {
+00181         return true;
+00182 }
+00183 
 00184 
-00185 
-00186 int ConfigReader::Enumerate(string tag)
-00187 {
-00188         return EnumConf(fname.c_str(),tag.c_str());
-00189 }
-00190 
+00185 FileReader::FileReader(string filename)
+00186 {
+00187         file_cache c;
+00188         readfile(c,filename.c_str());
+00189         this->fc = c;
+00190 }
 00191 
-00192 bool ConfigReader::Verify()
+00192 FileReader::FileReader()
 00193 {
-00194         return true;
-00195 }
-00196 
-00197 
-00198 FileReader::FileReader(string filename)
-00199 {
-00200         file_cache c;
-00201         readfile(c,filename.c_str());
-00202         this->fc = c;
-00203 }
-00204 
-00205 FileReader::FileReader()
-00206 {
-00207 }
-00208 
-00209 void FileReader::LoadFile(string filename)
-00210 {
-00211         file_cache c;
-00212         readfile(c,filename.c_str());
-00213         this->fc = c;
-00214 }
-00215 
-00216 FileReader::~FileReader()
-00217 {
-00218 }
+00194 }
+00195 
+00196 void FileReader::LoadFile(string filename)
+00197 {
+00198         file_cache c;
+00199         readfile(c,filename.c_str());
+00200         this->fc = c;
+00201 }
+00202 
+00203 FileReader::~FileReader()
+00204 {
+00205 }
+00206 
+00207 string FileReader::GetLine(int x)
+00208 {
+00209         if ((x<0) || (x>fc.size()))
+00210                 return "";
+00211         return fc[x];
+00212 }
+00213 
+00214 int FileReader::FileSize()
+00215 {
+00216         return fc.size();
+00217 }
+00218 
 00219 
-00220 string FileReader::GetLine(int x)
-00221 {
-00222         if ((x<0) || (x>fc.size()))
-00223                 return "";
-00224         return fc[x];
-00225 }
-00226 
-00227 int FileReader::FileSize()
-00228 {
-00229         return fc.size();
-00230 }
-00231 
-00232 
-
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00220 vector<Module*> modules(255); +00221 vector<ircd_module*> factory(255); +00222 +00223 int MODCOUNT = -1; +00224 +00225 +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html index ef7dc0fea..e0527a66e 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -15,8 +15,97 @@

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

    Functions

    vector< Module * > modules (255)
    vector< ircd_module * > factory (255)

    Variables

    int MODCOUNT = -1
    -

    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +

    Function Documentation

    +

    + + + + +
    + + + + + + + + + + +
    vector<ircd_module*> factory ( 255   ) 
    +
    + + + + + +
    +   + + +

    +

    +

    + + + + +
    + + + + + + + + + + +
    vector<Module*> modules ( 255   ) 
    +
    + + + + + +
    +   + + +

    +

    +

    Variable Documentation

    +

    + + + + +
    + + +
    int MODCOUNT = -1 +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 223 of file modules.cpp.

    +

    Generated on Sun Feb 9 12:48:16 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 d773cf20f..03ecb7fab 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -8,158 +8,139 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    modules.h

    Go to the documentation of this file.
    00001 /*
 00002 
-00003 $Log$
-00003 Revision 1.5  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.2  2003/01/26 23:52:59  brain
-00005 Modified documentation for base classes
-00006 Added base classes
-00007 
-00008 Revision 1.1.1.1  2003/01/23 19:45:58  brain
-00009 InspIRCd second source tree
-00010 
-00011 Revision 1.12  2003/01/22 20:59:10  brain
-00012 Added FileReader class documentation
-00013 
-00014 Revision 1.11  2003/01/22 20:49:16  brain
-00015 Added FileReader file-caching class
-00016 Changed m_randquote to use FileReader class
-00017 
-00018 Revision 1.10  2003/01/22 00:57:27  brain
-00019 Changes to documentation
-00020 
-00021 Revision 1.9  2003/01/22 00:44:26  brain
-00022 Added documentation comments
-00023 
-00024 Revision 1.8  2003/01/21 20:31:24  brain
-00025 Modified to add documentation
-00026 Added ConfigReader class for modules
-00027 
-00028 Revision 1.7  2003/01/15 22:47:44  brain
-00029 Changed user and channel structs to classes (finally)
-00030 
-00031 Revision 1.6  2003/01/13 22:30:50  brain
-00032 Added Admin class (holds /admin info for modules)
-00033 Added methods to Server class
-00034 
-00035 
-00036 */
-00037 
-00038 
-00039 #ifndef __PLUGIN_H
-00040 #define __PLUGIN_H
-00041 
-00042 #include "dynamic.h"
-00043 #include "base.h"
-00044 #include <string>
-00045 #include <deque>
+00004 
+00005 */
+00006 
+00007 
+00008 #ifndef __PLUGIN_H
+00009 #define __PLUGIN_H
+00010 
+00011 #define DEBUG 10
+00012 #define VERBOSE 20
+00013 #define DEFAULT 30
+00014 #define SPARSE 40
+00015 #define NONE 50
+00016 
+00017 #include "dynamic.h"
+00018 #include "base.h"
+00019 #include <string>
+00020 #include <deque>
+00021 
+00024 typedef deque<string> file_cache;
+00025 
+00026 
+00027 // This #define allows us to call a method in all
+00028 // loaded modules in a readable simple way, e.g.:
+00029 // 'FOREACH_MOD OnConnect(user);'
+00030 
+00031 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
+00032 
+00033 // class Version holds the version information of a Module, returned
+00034 // by Module::GetVersion (thanks RD)
+00035 
+00040 class Version : public classbase
+00041 {
+00042  public:
+00043          const int Major, Minor, Revision, Build;
+00044          Version(int major, int minor, int revision, int build);
+00045 };
 00046 
-00049 typedef deque<string> file_cache;
-00050 
-00051 
-00052 // This #define allows us to call a method in all
-00053 // loaded modules in a readable simple way, e.g.:
-00054 // 'FOREACH_MOD OnConnect(user);'
-00055 
-00056 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
-00057 
-00058 // class Version holds the version information of a Module, returned
-00059 // by Module::GetVersion (thanks RD)
-00060 
-00065 class Version : public classbase
+00047 
+00053 class Admin : public classbase
+00054 {
+00055  public:
+00056          const string Name, Email, Nick;
+00057          Admin(string name,string email,string nick);
+00058 };
+00059 
+00065 class Module : public classbase
 00066 {
 00067  public:
-00068          const int Major, Minor, Revision, Build;
-00069          Version(int major, int minor, int revision, int build);
-00070 };
-00071 
-00072 
-00078 class Admin : public classbase
-00079 {
-00080  public:
-00081          const string Name, Email, Nick;
-00082          Admin(string name,string email,string nick);
-00083 };
-00084 
-00090 class Module : public classbase
-00091 {
-00092  public:
-00096         Module();
-00100         virtual ~Module();
-00105         virtual Version GetVersion();
-00109         virtual void OnUserConnect(userrec* user);
-00113         virtual void OnUserQuit(userrec* user);
-00118         virtual void OnUserJoin(userrec* user, chanrec* channel);
-00123         virtual void OnUserPart(userrec* user, chanrec* channel);
-00124 };
-00125 
-00126 
-00132 class Server : public classbase
-00133 {
-00134  public:
-00138         Server();
-00142         virtual ~Server();
-00143 
-00147         virtual void SendOpers(string s);
-00152         virtual void Debug(string s);
-00157         virtual void Send(int Socket, string s);
-00162         virtual void SendServ(int Socket, string s);
-00167         virtual void SendFrom(int Socket, userrec* User, string s);
-00172         virtual void SendTo(userrec* Source, userrec* Dest, string s);
-00179         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
-00184         virtual bool CommonChannels(userrec* u1, userrec* u2);
-00192         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
-00197         virtual void SendWallops(userrec* User, string text);
-00198 
-00202         virtual bool IsNick(string nick);
-00206         virtual userrec* FindNick(string nick);
-00210         virtual chanrec* FindChannel(string channel);
-00215         virtual string ChanMode(userrec* User, chanrec* Chan);
-00218         virtual string GetServerName();
-00221         virtual string GetNetworkName();
-00227         virtual Admin GetAdmin();
-00228          
-00229 };
-00230 
-00237 class ConfigReader : public classbase
-00238 {
-00239   protected:
-00242         string fname;
-00243   public:
-00248         ConfigReader();                 // default constructor reads ircd.conf
-00252         ConfigReader(string filename);  // read a module-specific config
-00256         ~ConfigReader();
-00261         string ReadValue(string tag, string name, int index);
-00268         int Enumerate(string tag);
-00272         bool Verify();
-00273 };
-00274 
-00275 
-00276 
-00282 class FileReader : public classbase
-00283 {
-00284  file_cache fc;
-00285  public:
-00290          FileReader();
-00296          FileReader(string filename);
-00300          ~FileReader();
-00306          void LoadFile(string filename);
-00311          string GetLine(int x);
-00317          int FileSize();
+00071         Module();
+00075         virtual ~Module();
+00080         virtual Version GetVersion();
+00084         virtual void OnUserConnect(userrec* user);
+00088         virtual void OnUserQuit(userrec* user);
+00093         virtual void OnUserJoin(userrec* user, chanrec* channel);
+00098         virtual void OnUserPart(userrec* user, chanrec* channel);
+00099 
+00100 
+00101         virtual void Module::OnPacketTransmit(char *p);
+00102         virtual void Module::OnPacketReceive(char *p);
+00103         virtual void OnRehash();
+00104 
+00105 };
+00106 
+00107 
+00113 class Server : public classbase
+00114 {
+00115  public:
+00119         Server();
+00123         virtual ~Server();
+00124 
+00128         virtual void SendOpers(string s);
+00133         virtual void Log(int level, string s);
+00138         virtual void Send(int Socket, string s);
+00143         virtual void SendServ(int Socket, string s);
+00148         virtual void SendFrom(int Socket, userrec* User, string s);
+00153         virtual void SendTo(userrec* Source, userrec* Dest, string s);
+00160         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
+00165         virtual bool CommonChannels(userrec* u1, userrec* u2);
+00173         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
+00178         virtual void SendWallops(userrec* User, string text);
+00179 
+00183         virtual bool IsNick(string nick);
+00187         virtual userrec* FindNick(string nick);
+00191         virtual chanrec* FindChannel(string channel);
+00196         virtual string ChanMode(userrec* User, chanrec* Chan);
+00199         virtual string GetServerName();
+00202         virtual string GetNetworkName();
+00208         virtual Admin GetAdmin();
+00209          
+00210 };
+00211 
+00218 class ConfigReader : public classbase
+00219 {
+00220   protected:
+00223         string fname;
+00224   public:
+00229         ConfigReader();                 // default constructor reads ircd.conf
+00233         ConfigReader(string filename);  // read a module-specific config
+00237         ~ConfigReader();
+00242         string ReadValue(string tag, string name, int index);
+00249         int Enumerate(string tag);
+00253         bool Verify();
+00254 };
+00255 
+00256 
+00257 
+00263 class FileReader : public classbase
+00264 {
+00265  file_cache fc;
+00266  public:
+00271          FileReader();
+00277          FileReader(string filename);
+00281          ~FileReader();
+00287          void LoadFile(string filename);
+00292          string GetLine(int x);
+00298          int FileSize();
+00299 };
+00300 
+00301 
+00308 class ModuleFactory : public classbase
+00309 {
+00310  public:
+00311         ModuleFactory() { }
+00312         virtual ~ModuleFactory() { }
+00317         virtual Module * CreateModule() = 0;
 00318 };
 00319 
 00320 
-00327 class ModuleFactory : public classbase
-00328 {
-00329  public:
-00330         ModuleFactory() { }
-00331         virtual ~ModuleFactory() { }
-00336         virtual Module * CreateModule() = 0;
-00337 };
-00338 
-00339 #endif
-
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00321 typedef DLLFactory<ModuleFactory> ircd_module; +00322 +00323 #endif +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index a9f1f56fb..d9f97ade6 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -30,19 +30,25 @@ class  Version  Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. More...


    Defines

    -#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]-> +#define DEBUG   10 +#define VERBOSE   20 +#define DEFAULT   30 +#define SPARSE   40 +#define NONE   50 +#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->

    Typedefs

    -typedef deque< string > file_cache - Low level definition of a FileReader classes file cache area.

    +typedef deque< string > file_cache + Low level definition of a FileReader classes file cache area.

    +typedef DLLFactory< ModuleFactory > ircd_module

    Define Documentation

    -

    +

    @@ -57,11 +63,131 @@

    -Definition at line 56 of file modules.h. +Definition at line 11 of file modules.h. + +

    -
    #define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]-> + #define DEBUG   10
    +

    + + + + +
    + + +
    #define DEFAULT   30 +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 13 of file modules.h.

    +

    + + + + +
    + + +
    #define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]-> +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 31 of file modules.h.

    +

    + + + + +
    + + +
    #define NONE   50 +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 15 of file modules.h.

    +

    + + + + +
    + + +
    #define SPARSE   40 +
    +
    + + + + + +
    +   + + +

    + +

    +Definition at line 14 of file modules.h.

    +

    + + + + +
    + + +
    #define VERBOSE   20 +
    +
    + + + +
    +   + + +

    + +

    +Definition at line 12 of file modules.h.

    Typedef Documentation

    -

    +

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

    -Definition at line 49 of file modules.h. +Definition at line 24 of file modules.h. +

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

    +

    + + + + +
    + + +
    typedef DLLFactory<ModuleFactory> ircd_module +
    +
    + + + + +Definition at line 321 of file modules.h.
    +   + + +

    +

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

    -

    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 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 index a00781100..4e736e884 100644 --- a/docs/module-doc/servers_8cpp-source.html +++ b/docs/module-doc/servers_8cpp-source.html @@ -8,73 +8,45 @@ 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.3  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.2  2003/01/26 23:53:03  brain
-00005 Modified documentation for base classes
-00006 Added base classes
-00007 
-00008 Revision 1.1  2003/01/26 20:15:03  brain
-00009 Added server classes for linking
-00010 
-00011 
-00012 */
-00013 
-00014 #include "inspircd_config.h" 
-00015 #include "servers.h"
-00016 #include "inspircd.h"
-00017 #include <stdio.h>
-00018 #include <map.h>
-00019 
-00020 serverrec::serverrec()
-00021 {
-00022         leaf.clear();
-00023         strcpy(name,"");
-00024         pingtime = 0;
-00025         linktype = LINK_ACTIVE;
-00026         lastping = time(NULL);
-00027         usercount_i = usercount = opercount = version = 0;
-00028         hops_away = 1;
-00029         connected_at = time(NULL);
-00030         jupiter = false;
-00031         fd = 0;
-00032 }
-00033 
-00034  
-00035 serverrec::~serverrec()
-00036 {
-00037 }
-00038 
-00039 serverrec::serverrec(char* n, int link_t,  long ver, bool jupe)
-00040 {
-00041         leaf.clear();
-00042         strcpy(name,n);
-00043         linktype = link_t;
-00044         lastping = time(NULL);
-00045         usercount_i = usercount = opercount = 0;
-00046         version = ver;
-00047         hops_away = 1;
-00048         connected_at = time(NULL);
-00049         jupiter = jupe;
-00050         fd = 0;
-00051 }
-00052 
-00053 void serverrec::AddLeaf(serverrec *child)
-00054 {
-00055         leaf[child->name] = child;
-00056 }
-00057 
-00058 void serverrec::DelLeaf(string n)
-00059 {
-00060         server_list::iterator i = leaf.find(n);
-00061 
-00062         if (i != leaf.end())
-00063                 leaf.erase(i);
-00064 }
-00065 
-
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00004 */ +00005 +00006 #include "inspircd_config.h" +00007 #include "servers.h" +00008 #include "inspircd.h" +00009 #include <stdio.h> +00010 #include <map.h> +00011 +00012 serverrec::serverrec() +00013 { +00014 strcpy(name,""); +00015 pingtime = 0; +00016 lastping = time(NULL); +00017 usercount_i = usercount = opercount = version = 0; +00018 hops_away = 1; +00019 signon = time(NULL); +00020 jupiter = false; +00021 fd = 0; +00022 } +00023 +00024 +00025 serverrec::~serverrec() +00026 { +00027 } +00028 +00029 serverrec::serverrec(char* n, long ver, bool jupe) +00030 { +00031 strcpy(name,n); +00032 lastping = time(NULL); +00033 usercount_i = usercount = opercount = 0; +00034 version = ver; +00035 hops_away = 1; +00036 signon = time(NULL); +00037 jupiter = jupe; +00038 fd = 0; +00039 } +00040 +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/servers_8cpp.html b/docs/module-doc/servers_8cpp.html index 807697fc4..a2ec5d646 100644 --- a/docs/module-doc/servers_8cpp.html +++ b/docs/module-doc/servers_8cpp.html @@ -16,7 +16,7 @@ Go to the source code of this file.
    -
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 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 index ff90f5eac..ef55e9cde 100644 --- a/docs/module-doc/servers_8h-source.html +++ b/docs/module-doc/servers_8h-source.html @@ -8,62 +8,45 @@ 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.3  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.2  2003/01/26 23:52:59  brain
-00005 Modified documentation for base classes
-00006 Added base classes
-00007 
-00008 Revision 1.1  2003/01/26 20:15:00  brain
-00009 Added server classes for linking
-00010 
-00011 
-00012 */
-00013 
-00014 #include "inspircd_config.h" 
-00015 #include "connection.h"
-00016 #include <string>
-00017 #include <map.h>
-00018  
-00019 #ifndef __SERVERS_H__ 
-00020 #define __SERVERS_H__ 
-00021  
-00022 #define LINK_ACTIVE     1
-00023 #define LINK_INACTIVE   0
-00024 
-00025 class serverrec : public connection
-00026 {
-00027  private:
-00028         map<string, serverrec*> leaf; // list of child servers (leaves)
-00029  public:
-00030         char name[MAXBUF];      // server name
-00031         int pingtime;           // last ping response (ms)
-00032         int linktype;           // link type, LINK_ACTIVE or LINK_INACTIVE
-00033         time_t lastping;        // time the link was last pinged
-00034         long usercount_i;       // invisible users on server
-00035         long usercount;         // non-invisible users on server
-00036         long opercount;         // opers on server
-00037         time_t connected_at;    // time server was connected into the network
-00038         time_t hops_away;       // number of hops away (for quick access)
-00039         long version;           // ircd version
-00040         bool jupiter;           // is a JUPE server (faked to enforce a server ban)
-00041 
-00042         serverrec();
-00043         serverrec(char* n, int link_t,  long ver, bool jupe);
-00044         ~serverrec();
-00045         void AddLeaf(serverrec *child);
-00046         void DelLeaf(string n);
-00047 };
-00048 
-00049 
-00050 
-00051 typedef map<string, serverrec*> server_list;
-00052 
-00053 #endif
-00054 
-
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00004 */ +00005 +00006 #include "inspircd_config.h" +00007 #include "connection.h" +00008 #include <string> +00009 #include <map.h> +00010 +00011 #ifndef __SERVERS_H__ +00012 #define __SERVERS_H__ +00013 +00014 #define LINK_ACTIVE 1 +00015 #define LINK_INACTIVE 0 +00016 +00019 class serverrec : public connection +00020 { +00021 private: +00022 public: +00025 char name[MAXBUF]; +00028 long pingtime; +00031 long usercount_i; +00034 long usercount; +00037 long opercount; +00040 int hops_away; +00043 long version; +00046 bool jupiter; +00047 +00050 serverrec(); +00053 serverrec(char* n, long ver, bool jupe); +00056 ~serverrec(); +00057 }; +00058 +00059 +00060 +00061 typedef map<string, serverrec*> server_list; +00062 +00063 #endif +00064 +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/servers_8h.html b/docs/module-doc/servers_8h.html index dd70c5d61..80c2e9948 100644 --- a/docs/module-doc/servers_8h.html +++ b/docs/module-doc/servers_8h.html @@ -16,6 +16,7 @@

    Compounds

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


    Defines

    #define LINK_ACTIVE   1 #define LINK_INACTIVE   0 @@ -44,9 +45,7 @@

    -Definition at line 22 of file servers.h. -

    -Referenced by serverrec::serverrec(). +Definition at line 14 of file servers.h.

    @@ -70,7 +69,7 @@ Referenced by serverrec::se

    -Definition at line 23 of file servers.h. +Definition at line 15 of file servers.h.

    Typedef Documentation

    @@ -95,10 +94,10 @@ Definition at line 23 of

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

    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/tree.js b/docs/module-doc/tree.js index c2aab4b80..e96c794b3 100644 --- a/docs/module-doc/tree.js +++ b/docs/module-doc/tree.js @@ -27,6 +27,7 @@ aux1 = insFld(foldersTree, gFld("Compound List", "", "annotated.html")) insDoc(aux1, gLnk("InviteItem", "", "classInviteItem.html")) insDoc(aux1, gLnk("Module", "", "classModule.html")) insDoc(aux1, gLnk("ModuleFactory", "", "classModuleFactory.html")) + insDoc(aux1, gLnk("packet", "", "classpacket.html")) insDoc(aux1, gLnk("Server", "", "classServer.html")) insDoc(aux1, gLnk("serverrec", "", "classserverrec.html")) insDoc(aux1, gLnk("ucrec", "", "classucrec.html")) @@ -50,6 +51,7 @@ aux1 = insFld(foldersTree, gFld("Class Hierarchy", "", "hierarchy.html")) insDoc(aux2, gLnk("Invited", "", "classInvited.html")) insDoc(aux2, gLnk("Module", "", "classModule.html")) insDoc(aux2, gLnk("ModuleFactory", "", "classModuleFactory.html")) + insDoc(aux2, gLnk("packet", "", "classpacket.html")) insDoc(aux2, gLnk("Server", "", "classServer.html")) insDoc(aux2, gLnk("ucrec", "", "classucrec.html")) insDoc(aux2, gLnk("Version", "", "classVersion.html")) diff --git a/docs/module-doc/users_8cpp-source.html b/docs/module-doc/users_8cpp-source.html index ea0572d24..96133e230 100644 --- a/docs/module-doc/users_8cpp-source.html +++ b/docs/module-doc/users_8cpp-source.html @@ -8,100 +8,82 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    users.cpp

    Go to the documentation of this file.
    00001 /*
 00002 
-00003 $Log$
-00003 Revision 1.5  2003/01/27 00:28:57  brain
-00003 ...
-00003 
-00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
-00005 InspIRCd second source tree
-00006 
-00007 Revision 1.3  2003/01/17 13:21:38  brain
-00008 Added CONNECT ALLOW and CONNECT DENY config tags
-00009 Added PASS command
-00010 
-00011 Revision 1.2  2003/01/17 10:37:55  brain
-00012 Added /INVITE command and relevent structures
-00013 
-00014 Revision 1.1  2003/01/16 01:10:04  brain
-00015 forgot to add this
-00016 
-00017 
-00018 */
-00019 
-00020 #include "inspircd_config.h" 
-00021 #include "channels.h"
-00022 #include "users.h"
-00023 #include "inspircd.h"
-00024 #include <stdio.h>
-00025 
-00026 userrec::userrec()
-00027 {
-00028         // the PROPER way to do it, AVOID bzero at *ALL* costs
-00029         strcpy(nick,"");
-00030         ip = 0;
-00031         strcpy(ident,"");
-00032         strcpy(host,"");
-00033         strcpy(dhost,"");
-00034         strcpy(fullname,"");
-00035         strcpy(modes,"");
-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;
-00042         strcpy(result,"");
-00043         for (int i = 0; i < MAXCHANS; i++)
-00044         {
-00045                 chans[i].channel = NULL;
-00046         }
-00047         invites.clear();
-00048 }
-00049 
-00050  
-00051 char* userrec::GetFullHost()
-00052 {
-00053         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00054         return result;
-00055 }
-00056 
-00057 
-00058 char* userrec::GetFullRealHost()
-00059 {
-00060         sprintf(result,"%s!%s@%s",nick,ident,host);
-00061         return result;
-00062 }
-00063 
-00064 bool userrec::IsInvited(char* channel)
-00065 {
-00066         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00067         {
-00068                 if (!strcasecmp(i->channel,channel))
-00069                 {
-00070                         return true;
-00071                 }
-00072         }
-00073 }
-00074 
-00075 void userrec::InviteTo(char* channel)
-00076 {
-00077         Invited i;
-00078         strcpy(i.channel,channel);
-00079         invites.push_back(i);
-00080 }
-00081 
-00082 void userrec::RemoveInvite(char* channel)
-00083 {
-00084         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00085         {
-00086                 if (!strcasecmp(i->channel,channel))
-00087                 {
-00088                         invites.erase(i);
-00089                         return;
-00090                 }
-00091         }
-00092 }
-
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00003 */ +00004 +00005 #include "inspircd_config.h" +00006 #include "channels.h" +00007 #include "users.h" +00008 #include "inspircd.h" +00009 #include <stdio.h> +00010 +00011 userrec::userrec() +00012 { +00013 // the PROPER way to do it, AVOID bzero at *ALL* costs +00014 strcpy(nick,""); +00015 ip = 0; +00016 strcpy(ident,""); +00017 strcpy(host,""); +00018 strcpy(dhost,""); +00019 strcpy(fullname,""); +00020 strcpy(modes,""); +00021 strcpy(inbuf,""); +00022 strcpy(server,""); +00023 strcpy(awaymsg,""); +00024 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +00025 port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +00026 haspassed = false; +00027 strcpy(result,""); +00028 for (int i = 0; i < MAXCHANS; i++) +00029 { +00030 chans[i].channel = NULL; +00031 } +00032 invites.clear(); +00033 } +00034 +00035 +00036 char* userrec::GetFullHost() +00037 { +00038 sprintf(result,"%s!%s@%s",nick,ident,dhost); +00039 return result; +00040 } +00041 +00042 +00043 char* userrec::GetFullRealHost() +00044 { +00045 sprintf(result,"%s!%s@%s",nick,ident,host); +00046 return result; +00047 } +00048 +00049 bool userrec::IsInvited(char* channel) +00050 { +00051 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +00052 { +00053 if (!strcasecmp(i->channel,channel)) +00054 { +00055 return true; +00056 } +00057 } +00058 } +00059 +00060 void userrec::InviteTo(char* channel) +00061 { +00062 Invited i; +00063 strcpy(i.channel,channel); +00064 invites.push_back(i); +00065 } +00066 +00067 void userrec::RemoveInvite(char* channel) +00068 { +00069 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +00070 { +00071 if (!strcasecmp(i->channel,channel)) +00072 { +00073 invites.erase(i); +00074 return; +00075 } +00076 } +00077 } +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/users_8cpp.html b/docs/module-doc/users_8cpp.html index 38c77fff2..9b662d25d 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 Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 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 e923929aa..6bb848a39 100644 --- a/docs/module-doc/users_8h-source.html +++ b/docs/module-doc/users_8h-source.html @@ -8,128 +8,91 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

    users.h

    Go to the documentation of this file.
    00001 /*
 00002 
-00003 $Log$
-00003 Revision 1.5  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.3  2003/01/27 00:22:53  brain
-00005 Modified documentation
-00006 Moved some classes below base class
-00007 
-00008 Revision 1.2  2003/01/26 23:52:59  brain
-00009 Modified documentation for base classes
-00010 Added base classes
-00011 
-00012 Revision 1.1.1.1  2003/01/23 19:45:58  brain
-00013 InspIRCd second source tree
-00014 
-00015 Revision 1.9  2003/01/22 00:44:26  brain
-00016 Added documentation comments
-00017 
-00018 Revision 1.8  2003/01/21 21:11:17  brain
-00019 Added documentation
-00020 
-00021 Revision 1.7  2003/01/17 13:21:38  brain
-00022 Added CONNECT ALLOW and CONNECT DENY config tags
-00023 Added PASS command
-00024 
-00025 Revision 1.6  2003/01/17 10:37:55  brain
-00026 Added /INVITE command and relevent structures
-00027 
-00028 Revision 1.5  2003/01/16 20:11:56  brain
-00029 fixed some ugly pointer bugs (thanks dblack and a|KK|y!)
-00030 
-00031 Revision 1.4  2003/01/15 22:47:44  brain
-00032 Changed user and channel structs to classes (finally)
-00033 
-00034 Revision 1.3  2003/01/14 21:14:30  brain
-00035 added /ISON command (for mIRC etc basic notify)
-00036 
-00037 
-00038 */
-00039 
-00040 #include "inspircd_config.h" 
-00041 #include "channels.h"
-00042 #include "connection.h"
-00043 
-00044 #include <string>
-00045  
-00046 #ifndef __USERS_H__ 
-00047 #define __USERS_H__ 
-00048  
-00049 #define STATUS_OP       4
-00050 #define STATUS_HOP      2
-00051 #define STATUS_VOICE    1
-00052 #define STATUS_NORMAL   0
-00053 
-00054 #define CC_ALLOW        0
-00055 #define CC_DENY         1
-00056 
-00059 class Invited : public classbase
-00060 {
-00061  public:
-00062         char channel[CHANMAX];
-00063 };
-00064 
-00065 
-00068 class ConnectClass : public classbase
-00069 {
-00070  public:
-00071         int type;
-00072         char host[MAXBUF];
-00073         char pass[MAXBUF];
-00074 };
-00075 
-00078 typedef vector<Invited> InvitedList;
-00079 
-00080 
-00081 
-00084 typedef vector<ConnectClass> ClassVector;
-00085 
-00092 class userrec : public connection
-00093 {
-00094  private:
-00095 
-00098         InvitedList invites;
-00099  public:
-00100         
-00105         char nick[NICKMAX];
-00106         
-00109         char ident[64];
-00110 
-00114         char dhost[256];
-00115         
-00118         char fullname[128];
-00119         
-00124         char modes[32];
-00125         
-00126         ucrec chans[MAXCHANS];
-00127         
-00130         char server[256];
-00131         
-00135         char awaymsg[512];
-00136         
-00140         char result[256];
-00141         
-00142         userrec();
-00143         
-00144         virtual ~userrec() {  }
-00145         
-00150         virtual char* GetFullHost();
-00151         
-00157         virtual char* GetFullRealHost();
-00158         
-00161         virtual bool IsInvited(char* channel);
-00162         
-00165         virtual void InviteTo(char* channel);
-00166         
-00171         virtual void RemoveInvite(char* channel);
-00172         
-00173 };
-00174 
-00175 
-00176 #endif
-
    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00004 */ +00005 +00006 #include "inspircd_config.h" +00007 #include "channels.h" +00008 #include "connection.h" +00009 +00010 #include <string> +00011 +00012 #ifndef __USERS_H__ +00013 #define __USERS_H__ +00014 +00015 #define STATUS_OP 4 +00016 #define STATUS_HOP 2 +00017 #define STATUS_VOICE 1 +00018 #define STATUS_NORMAL 0 +00019 +00020 #define CC_ALLOW 0 +00021 #define CC_DENY 1 +00022 +00025 class Invited : public classbase +00026 { +00027 public: +00028 char channel[CHANMAX]; +00029 }; +00030 +00031 +00034 class ConnectClass : public classbase +00035 { +00036 public: +00037 int type; +00038 char host[MAXBUF]; +00039 char pass[MAXBUF]; +00040 }; +00041 +00044 typedef vector<Invited> InvitedList; +00045 +00046 +00047 +00050 typedef vector<ConnectClass> ClassVector; +00051 +00058 class userrec : public connection +00059 { +00060 private: +00061 +00064 InvitedList invites; +00065 public: +00066 +00071 char nick[NICKMAX]; +00072 +00075 char ident[64]; +00076 +00080 char dhost[256]; +00081 +00084 char fullname[128]; +00085 +00090 char modes[32]; +00091 +00092 ucrec chans[MAXCHANS]; +00093 +00096 char server[256]; +00097 +00101 char awaymsg[512]; +00102 +00106 char result[256]; +00107 +00108 userrec(); +00109 +00110 virtual ~userrec() { } +00111 +00116 virtual char* GetFullHost(); +00117 +00123 virtual char* GetFullRealHost(); +00124 +00127 virtual bool IsInvited(char* channel); +00128 +00131 virtual void InviteTo(char* channel); +00132 +00137 virtual void RemoveInvite(char* channel); +00138 +00139 }; +00140 +00141 +00142 #endif +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html index bef3bcb54..1b30e3661 100644 --- a/docs/module-doc/users_8h.html +++ b/docs/module-doc/users_8h.html @@ -56,7 +56,7 @@

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

    @@ -80,7 +80,7 @@ Definition at line 54 of fi

    -Definition at line 55 of file users.h. +Definition at line 21 of file users.h.

    @@ -104,7 +104,7 @@ Definition at line 55 of fi

    -Definition at line 50 of file users.h. +Definition at line 16 of file users.h.

    @@ -128,7 +128,7 @@ Definition at line 50 of fi

    -Definition at line 52 of file users.h. +Definition at line 18 of file users.h.

    @@ -152,7 +152,7 @@ Definition at line 52 of fi

    -Definition at line 49 of file users.h. +Definition at line 15 of file users.h.

    @@ -176,7 +176,7 @@ Definition at line 49 of fi

    -Definition at line 51 of file users.h. +Definition at line 17 of file users.h.

    Typedef Documentation

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

    -Definition at line 84 of file users.h. +Definition at line 50 of file users.h.

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

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

    Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +
    Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
    diff --git a/include/base.h b/include/base.h index c347aedb3..b0e264bac 100644 --- a/include/base.h +++ b/include/base.h @@ -8,12 +8,20 @@ #ifndef __BASE_H__ #define __BASE_H__ - + + +/** The base class for all inspircd classes +*/ class classbase { public: + /** Time that the object was instantiated (used for TS calculation etc) + */ time_t age; + /** Constructor, + * Sets the object's time + */ classbase() { age = time(NULL); } ~classbase() { } }; diff --git a/include/ctables.h b/include/ctables.h index e422e1661..5ca5e13b3 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -22,17 +22,29 @@ typedef void (handlerfunc) (char**, int, userrec*); -/* a structure that defines a command */ - +/** A structure that defines a command + */ class command_t : public classbase { public: - char command[MAXBUF]; /* command name */ - handlerfunc *handler_function; /* handler function as in typedef */ - char flags_needed; /* user flags needed to execute the command or 0 */ - int min_params; /* minimum number of parameters command takes */ - long use_count; /* used by /stats m */ - long total_bytes; /* used by /stats m */ + /** Command name + */ + char command[MAXBUF]; + /** Handler function as in typedef + */ + handlerfunc *handler_function; + /** User flags needed to execute the command or 0 + */ + char flags_needed; + /** Minimum number of parameters command takes + */ + int min_params; + /** used by /stats m + */ + long use_count; + /** used by /stats m + */ + long total_bytes; }; #endif diff --git a/include/servers.h b/include/servers.h index fc271b37e..9ce3e744d 100644 --- a/include/servers.h +++ b/include/servers.h @@ -14,21 +14,45 @@ #define LINK_ACTIVE 1 #define LINK_INACTIVE 0 +/** A class that defines the local server or a remote server + */ class serverrec : public connection { private: public: - char name[MAXBUF]; // server name - long pingtime; // last ping response (ms) - long usercount_i; // invisible users on server - long usercount; // non-invisible users on server - long opercount; // opers on server - int hops_away; // number of hops away (for quick access) - long version; // ircd version - bool jupiter; // is a JUPE server (faked to enforce a server ban) + /** server name + */ + char name[MAXBUF]; + /** last ping response (ms) + */ + long pingtime; + /** invisible users on server + */ + long usercount_i; + /** non-invisible users on server + */ + long usercount; + /** opers on server + */ + long opercount; + /** number of hops away (for quick access) + */ + int hops_away; + /** ircd version + */ + long version; + /** is a JUPE server (faked to enforce a server ban) + */ + bool jupiter; + /** Constructor + */ serverrec(); + /** Constructor which initialises some of the main variables + */ serverrec(char* n, long ver, bool jupe); + /** Destructor + */ ~serverrec(); }; -- cgit v1.2.3