From 03be04a9a2d86a4568d09d5e1689dd7ef37c863a Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 14:52:12 +0000 Subject: Added extra docs for new config system git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8cpp.html | 1089 +++++-------------------------------- 1 file changed, 143 insertions(+), 946 deletions(-) (limited to 'docs/module-doc/modules_8cpp.html') diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html index fbf7a10f3..cbc72e984 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -9,7 +9,7 @@ home » brain » inspircd-cvs » inspircd » src

modules.cpp File Reference

#include "inspircd_config.h"
#include "inspircd.h"
-#include "inspircd_io.h"
+#include "inspircd_io.h"
#include "inspircd_util.h"
#include <unistd.h>
#include <sys/errno.h>
@@ -35,51 +35,28 @@ #include "hashcomp.h"
#include "socket.h"
#include "socketengine.h"
+#include "typedefs.h"

Include dependency graph for modules.cpp:

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

Go to the source code of this file. - - - - - - - - - - - - - - - - - - @@ -102,268 +79,44 @@ Include dependency graph for modules.cpp:


Variables

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

Classes

class  ExtMode

Typedefs

typedef nspace::hash_map<
- std::string, userrec *, nspace::hash<
- string >, irc::StrHashComp > 		user_hash
typedef nspace::hash_map<
- std::string, chanrec *, nspace::hash<
- string >, irc::StrHashComp > 		chan_hash
typedef nspace::hash_map<
- in_addr, string *, nspace::hash<
- in_addr >, irc::InAddr_HashComp > 		address_cache
typedef nspace::hash_map<
- std::string, WhoWasUser *,
- nspace::hash< string >, irc::StrHashComp > 		whowas_hash
typedef std::deque< command_t > command_table
typedef std::vector< ExtMode > ExtModeList
typedef ExtModeList::iterator ExtModeListIter

Functions

bool ModeDefined (char modechar, int type)
SocketEngine * SE
ServerConfig * Config
int MODCOUNT = -1
std::vector< Module * > modules
std::vector< ircd_module * > factory
std::vector< std::string > include_stack
std::vector< InspSocket * > module_sockets
time_t TIME
int LogLevel
char ServerName [MAXBUF]
char Network [MAXBUF]
char ServerDesc [MAXBUF]
char AdminName [MAXBUF]
char AdminEmail [MAXBUF]
char AdminNick [MAXBUF]
char diepass [MAXBUF]
char restartpass [MAXBUF]
char motd [MAXBUF]
char rules [MAXBUF]
char list [MAXBUF]
char PrefixQuit [MAXBUF]
char DieValue [MAXBUF]
int debugging
int WHOWAS_STALE
int WHOWAS_MAX
int DieDelay
time_t startup_time
int NetBufferSize
int MaxWhoResults
time_t nb_start
std::vector< std::string > module_names
int boundPortCount
int portCount
int ports [MAXSOCKS]
std::stringstream config_f
FILE * log_file
userrec * fd_ref_table [65536]
user_hash clientlist
chan_hash chanlist
whowas_hash whowas
command_table cmdlist
file_cache MOTD
file_cache RULES
address_cache IP
ExtModeList EMode
-

Typedef Documentation

-

- - - - -
- - - - -
typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, irc::InAddr_HashComp> address_cache
-
- - - - - -
-   - - -

- -

-Definition at line 117 of file modules.cpp.

-

- - - - -
- - - - -
typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, irc::StrHashComp> chan_hash
-
- - - - - -
-   - - -

- -

-Definition at line 116 of file modules.cpp.

-

- - - - -
- - - - -
typedef std::deque<command_t> command_table
-
- - - - - -
-   - - -

- -

-Definition at line 119 of file modules.cpp.

-

- - - - -
- - - - -
typedef std::vector<ExtMode> ExtModeList
-
- - - - - -
-   - - -

- -

-Definition at line 145 of file modules.cpp.

-

- - - - -
- - - - -
typedef ExtModeList::iterator ExtModeListIter
-
- - - - -

+

-

-Definition at line 146 of file modules.cpp. - -

-   - +
user_hash clientlist
chan_hash chanlist
-

- - - - -
- - - - -
typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, irc::StrHashComp> user_hash
-
- - - - -

+

-

-Definition at line 115 of file modules.cpp. - -

-   - +
whowas_hash whowas
command_table cmdlist
-

- - - - -
- - - - -
typedef nspace::hash_map<std::string, WhoWasUser*, nspace::hash<string>, irc::StrHashComp> whowas_hash
-
- - - - -

+

-

-Definition at line 118 of file modules.cpp. -

-   - +
address_cache IP
ExtModeList EMode

Function Documentation

@@ -420,17 +173,17 @@ Definition at line 118

-Definition at line 215 of file modules.cpp. +Definition at line 142 of file modules.cpp.

-References EMode, and ModeDefined(). +References EMode, and ModeDefined().

-Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode().

00216 {
-00217         if (ModeDefined(modechar,type)) {
-00218                 return false;
-00219         }
-00220         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
-00221         return true;
-00222 }
+Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode().
00143 {
+00144         if (ModeDefined(modechar,type)) {
+00145                 return false;
+00146         }
+00147         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
+00148         return true;
+00149 }
 

 

     
@@ -500,20 +253,20 @@ Referenced by Server::AddEx
 

 
 

-Definition at line 152 of file modules.cpp.
+Definition at line 79 of file modules.cpp.
 

-References EMode.
+References EMode.
 

-Referenced by DoAddExtendedMode().
00153 {
-00154         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00155         {
-00156                 if ((i->modechar == modechar) && (i->type == type))
-00157                 {
-00158                         return true;
-00159                 }
-00160         }
-00161         return false;
-00162 }
+Referenced by DoAddExtendedMode().
00080 {
+00081         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00082         {
+00083                 if ((i->modechar == modechar) && (i->type == type))
+00084                 {
+00085                         return true;
+00086                 }
+00087         }
+00088         return false;
+00089 }
 

 

     
@@ -555,18 +308,18 @@ Referenced by DoAddExtended
 

 
 

-Definition at line 202 of file modules.cpp.
+Definition at line 129 of file modules.cpp.
 

-References EMode.
00203 {
-00204         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00205         {
-00206                 if ((i->modechar == modechar) && (i->type == type))
-00207                 {
-00208                         return i->params_when_off;
-00209                 }
-00210         }
-00211         return 0;
-00212 }
+References EMode.
00130 {
+00131         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00132         {
+00133                 if ((i->modechar == modechar) && (i->type == type))
+00134                 {
+00135                         return i->params_when_off;
+00136                 }
+00137         }
+00138         return 0;
+00139 }
 

 

     
@@ -608,18 +361,18 @@ References EMode.

 
 

-Definition at line 189 of file modules.cpp.
+Definition at line 116 of file modules.cpp.
 

-References EMode.
00190 {
-00191         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00192         {
-00193                 if ((i->modechar == modechar) && (i->type == type))
-00194                 {
-00195                         return i->params_when_on;
-00196                 }
-00197         }
-00198         return 0;
-00199 }
+References EMode.
00117 {
+00118         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00119         {
+00120                 if ((i->modechar == modechar) && (i->type == type))
+00121                 {
+00122                         return i->params_when_on;
+00123                 }
+00124         }
+00125         return 0;
+00126 }
 

 

     
@@ -661,18 +414,18 @@ References EMode.

 
 

-Definition at line 176 of file modules.cpp.
+Definition at line 103 of file modules.cpp.
 

-References EMode.
00177 {
-00178         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00179         {
-00180                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-00181                 {
-00182                         return true;
-00183                 }
-00184         }
-00185         return false;
-00186 }
+References EMode.
00104 {
+00105         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00106         {
+00107                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+00108                 {
+00109                         return true;
+00110                 }
+00111         }
+00112         return false;
+00113 }
 

 

     
@@ -714,18 +467,18 @@ References EMode.

 
 

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

-References EMode.
00165 {
-00166         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00167         {
-00168                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
-00169                 {
-00170                         return true;
-00171                 }
-00172         }
-00173         return false;
-00174 }
+References EMode.
00092 {
+00093         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00094         {
+00095                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00096                 {
+00097                         return true;
+00098                 }
+00099         }
+00100         return false;
+00101 }
 

 

     
@@ -758,21 +511,21 @@ References EMode.

 
 

-Definition at line 225 of file modules.cpp.
+Definition at line 152 of file modules.cpp.
 

-References EMode, and MT_CHANNEL.
+References EMode, and MT_CHANNEL.
 

-Referenced by Server::AddExtendedListMode().
00226 {
-00227         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00228         {
-00229                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-00230                 {
-00231                         i->list = true;
-00232                         return;
-00233                 }
-00234         }
-00235         return;
-00236 }
+Referenced by Server::AddExtendedListMode().
00153 {
+00154         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00155         {
+00156                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+00157                 {
+00158                         i->list = true;
+00159                         return;
+00160                 }
+00161         }
+00162         return;
+00163 }
 

 

     
@@ -807,13 +560,13 @@ Referenced by Server::AddEx
   
 
 
Variable Documentation

-

+

 
@@ -830,13 +583,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
char AdminEmail[MAXBUF]          int boundPortCount          
         

       

     

 

-

+

 
@@ -853,13 +606,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
char AdminName[MAXBUF]          chan_hash chanlist          
         

       

     

 

-

+

 
@@ -876,13 +629,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
char AdminNick[MAXBUF]          user_hash clientlist          
         

       

     

 

-

+

 
@@ -899,13 +652,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
int boundPortCount          command_table cmdlist          
         

       

     

 

-

+

 
@@ -922,13 +675,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
chan_hash chanlist          ServerConfig* Config          
         

       

     

 

-

+

 
@@ -942,16 +695,20 @@ Referenced by Server::AddEx
     
+
+

+Definition at line 76 of file modules.cpp.
+

+Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().    
   

   

     
       
-          
+          

         
user_hash clientlist          ExtModeList EMode          
         

       

     		
 
 

-    

 

-

+

 
@@ -968,13 +725,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
command_table cmdlist          std::vector<ircd_module*> factory          
         

       

     

 

-

+

 
@@ -991,13 +748,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
std::stringstream config_f          userrec* fd_ref_table[65536]          
         

       

     

 

-

+

 
@@ -1014,13 +771,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
int debugging          address_cache IP          
         

       

     

 

-

+

 
@@ -1034,16 +791,18 @@ Referenced by Server::AddEx
     
+
+

+Definition at line 933 of file modules.cpp.    
   

   

     
       
-          
+          

         
int DieDelay          int MODCOUNT = -1          
         

       

     		
 
 

-    

 

-

+

 
@@ -1057,16 +816,18 @@ Referenced by Server::AddEx
     
+
+

+Referenced by Server::AddSocket(), and Server::DelSocket().    
   

   

     
       
-          
+          

         
char diepass[MAXBUF]          std::vector<InspSocket*> module_sockets          
         

       

     		
 
 

-    

 

-

+

 
@@ -1083,13 +844,13 @@ Referenced by Server::AddEx
     
   

   

     
       
-          
+          

         
char DieValue[MAXBUF]          std::vector<Module*> modules          
         

       

     

 

-

+

 
@@ -1103,20 +864,16 @@ Referenced by Server::AddEx
     
+    
   

   

     
       
-          
+          

         
ExtModeList EMode          int portCount          
         

       

     		
 
 

-
-

-Definition at line 149 of file modules.cpp.
-

-Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().    

 

-

+

 
@@ -1133,521 +890,7 @@ Referenced by DoAddExtended
     
   

   

     
       
-          
+          

         
std::vector<ircd_module*> factory          int ports[MAXSOCKS]          
         

       

     

 

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
userrec* fd_ref_table[65536]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
std::vector<std::string> include_stack          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-
-

-Referenced by ConfigReader::ConfigReader().    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
address_cache IP          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char list[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
FILE* log_file          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
int LogLevel          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
int MaxWhoResults          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-
-

-Definition at line 81 of file channels.cpp.    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
int MODCOUNT = -1          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-
-

-Definition at line 1005 of file modules.cpp.    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
std::vector<std::string> module_names          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
std::vector<InspSocket*> module_sockets          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-
-

-Referenced by Server::AddSocket(), and Server::DelSocket().    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
std::vector<Module*> modules          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
file_cache MOTD          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char motd[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
time_t nb_start          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
int NetBufferSize          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char Network[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
int portCount          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
int ports[MAXSOCKS]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char PrefixQuit[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char restartpass[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
file_cache RULES          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char rules[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

+

 
-  
-

   

     
@@ -1666,52 +909,6 @@ Referenced by Server::AddSo
     
     
 
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char ServerDesc[MAXBUF]          

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-    

-

-
-  
-    
-  
-

-      
-        
-          
-        
-      
char ServerName[MAXBUF]          

-    

-
-  
-    
-    
@@ -1768,7 +965,7 @@ Referenced by Server::AddSo
     
@@ -1831,7 +1028,7 @@ Referenced by Server::AddSo
     
   

-       
-    
-
 

     

   

       
-          
+          

         
whowas_hash whowas          whowas_hash whowas          
         

       

     

 

-
Generated on Mon Dec 12 18:31:00 2005 for InspIRCd by 
+
Generated on Wed Dec 14 14:49:24 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.3.1-10-gc9f91