]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/man/man3/modules.cpp.3
Added docs for new smaller memory footprint classes
[user/henk/code/inspircd.git] / docs / man / man3 / modules.cpp.3
index 9dbc2157e6ffe2b657d45a7ebac1708d2bc03e5e..b8a1f6769f0cf4d7d193f161250dfd7ec0b976bc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "modules.cpp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*-
+.TH "modules.cpp" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -68,6 +68,8 @@ modules.cpp \-
 .br
 \fC#include 'commands.h'\fP
 .br
+\fC#include 'inspstring.h'\fP
+.br
 
 .SS "Namespaces"
 
@@ -109,6 +111,9 @@ modules.cpp \-
 .RI "typedef nspace::hash_map< in_addr, string *, nspace::hash< in_addr >, \fBInAddr_HashComp\fP > \fBaddress_cache\fP"
 .br
 .ti -1c
+.RI "typedef nspace::hash_map< std::string, \fBWhoWasUser\fP *, nspace::hash< string >, \fBStrHashComp\fP > \fBwhowas_hash\fP"
+.br
+.ti -1c
 .RI "typedef std::deque< \fBcommand_t\fP > \fBcommand_table\fP"
 .br
 .ti -1c
@@ -156,10 +161,13 @@ modules.cpp \-
 .RI "int \fBMODCOUNT\fP = -1"
 .br
 .ti -1c
-.RI "vector< \fBModule\fP * > \fBmodules\fP"
+.RI "std::vector< \fBModule\fP * > \fBmodules\fP"
+.br
+.ti -1c
+.RI "std::vector< \fBircd_module\fP * > \fBfactory\fP"
 .br
 .ti -1c
-.RI "vector< \fBircd_module\fP * > \fBfactory\fP"
+.RI "time_t \fBTIME\fP"
 .br
 .ti -1c
 .RI "int \fBLogLevel\fP"
@@ -234,16 +242,13 @@ modules.cpp \-
 .RI "std::vector< std::string > \fBmodule_names\fP"
 .br
 .ti -1c
-.RI "char \fBbannerBuffer\fP [MAXBUF]"
-.br
-.ti -1c
 .RI "int \fBboundPortCount\fP"
 .br
 .ti -1c
 .RI "int \fBportCount\fP"
 .br
 .ti -1c
-.RI "int \fBUDPportCount\fP"
+.RI "int \fBSERVERportCount\fP"
 .br
 .ti -1c
 .RI "int \fBports\fP [MAXSOCKS]"
@@ -264,13 +269,16 @@ modules.cpp \-
 .RI "FILE * \fBlog_file\fP"
 .br
 .ti -1c
+.RI "\fBuserrec\fP * \fBfd_ref_table\fP [65536]"
+.br
+.ti -1c
 .RI "\fBuser_hash\fP \fBclientlist\fP"
 .br
 .ti -1c
 .RI "\fBchan_hash\fP \fBchanlist\fP"
 .br
 .ti -1c
-.RI "\fBuser_hash\fP \fBwhowas\fP"
+.RI "\fBwhowas_hash\fP \fBwhowas\fP"
 .br
 .ti -1c
 .RI "\fBcommand_table\fP \fBcmdlist\fP"
@@ -292,312 +300,312 @@ modules.cpp \-
 .PP 
 .SS "#define nspace   std"
 .PP
-Definition at line 42 of file modules.cpp.
+Definition at line 64 of file modules.cpp.
 .SH "Typedef Documentation"
 .PP 
-.SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBInAddr_HashComp\fP> address_cache"
+.SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBInAddr_HashComp\fP> \fBaddress_cache\fP"
 .PP
-Definition at line 151 of file modules.cpp.
-.SS "typedef nspace::hash_map<std::string, \fBchanrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> chan_hash"
+Definition at line 187 of file modules.cpp.
+.SS "typedef nspace::hash_map<std::string, \fBchanrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBchan_hash\fP"
 .PP
-Definition at line 150 of file modules.cpp.
-.SS "typedef std::deque<\fBcommand_t\fP> command_table"
+Definition at line 186 of file modules.cpp.
+.SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP"
 .PP
-Definition at line 152 of file modules.cpp.
-.SS "typedef std::vector<\fBExtMode\fP> ExtModeList"
+Definition at line 189 of file modules.cpp.
+.SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP"
 .PP
-Definition at line 178 of file modules.cpp.
-.SS "typedef ExtModeList::iterator ExtModeListIter"
+Definition at line 215 of file modules.cpp.
+.SS "typedef ExtModeList::iterator \fBExtModeListIter\fP"
 .PP
-Definition at line 179 of file modules.cpp.
+Definition at line 216 of file modules.cpp.
 .PP
 Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().
-.SS "typedef nspace::hash_map<std::string, \fBuserrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> user_hash"
+.SS "typedef nspace::hash_map<std::string, \fBuserrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBuser_hash\fP"
+.PP
+Definition at line 185 of file modules.cpp.
+.SS "typedef nspace::hash_map<std::string, \fBWhoWasUser\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBwhowas_hash\fP"
 .PP
-Definition at line 149 of file modules.cpp.
+Definition at line 188 of file modules.cpp.
 .SH "Function Documentation"
 .PP 
 .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)"
 .PP
-Definition at line 254 of file modules.cpp.
+Definition at line 285 of file modules.cpp.
 .PP
 References EMode, and ModeDefined().
 .PP
 Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode().
 .PP
 .nf
-255 {
-256         if (ModeDefined(modechar,type)) {
-257                 return false;
-258         }
-259         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
-260         return true;
-261 }
+286 {
+287         if (ModeDefined(modechar,type)) {
+288                 return false;
+289         }
+290         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
+291         return true;
+292 }
 .fi
 .SS "std::vector<\fBircd_module\fP*> factory (255)"
 .PP
 .SS "bool ModeDefined (char modechar, int type)"
 .PP
-Definition at line 185 of file modules.cpp.
+Definition at line 222 of file modules.cpp.
 .PP
 References EMode, and ExtModeListIter.
 .PP
 Referenced by DoAddExtendedMode().
 .PP
 .nf
-186 {
-187         log(DEBUG,'Size of extmodes vector is %d',EMode.size());
-188         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-189         {
-190                 log(DEBUG,'i->modechar==%c, modechar=%c, i->type=%d, type=%d',i->modechar,modechar,i->type,type);
-191                 if ((i->modechar == modechar) && (i->type == type))
-192                 {
-193                         return true;
-194                 }
-195         }
-196         return false;
-197 }
+223 {
+224         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+225         {
+226                 if ((i->modechar == modechar) && (i->type == type))
+227                 {
+228                         return true;
+229                 }
+230         }
+231         return false;
+232 }
 .fi
 .SS "int ModeDefinedOff (char modechar, int type)"
 .PP
-Definition at line 241 of file modules.cpp.
+Definition at line 272 of file modules.cpp.
 .PP
 References EMode, and ExtModeListIter.
 .PP
 .nf
-242 {
-243         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-244         {
-245                 if ((i->modechar == modechar) && (i->type == type))
-246                 {
-247                         return i->params_when_off;
-248                 }
-249         }
-250         return 0;
-251 }
+273 {
+274         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+275         {
+276                 if ((i->modechar == modechar) && (i->type == type))
+277                 {
+278                         return i->params_when_off;
+279                 }
+280         }
+281         return 0;
+282 }
 .fi
 .SS "int ModeDefinedOn (char modechar, int type)"
 .PP
-Definition at line 228 of file modules.cpp.
+Definition at line 259 of file modules.cpp.
 .PP
 References EMode, and ExtModeListIter.
 .PP
 .nf
-229 {
-230         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-231         {
-232                 if ((i->modechar == modechar) && (i->type == type))
-233                 {
-234                         return i->params_when_on;
-235                 }
-236         }
-237         return 0;
-238 }
+260 {
+261         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+262         {
+263                 if ((i->modechar == modechar) && (i->type == type))
+264                 {
+265                         return i->params_when_on;
+266                 }
+267         }
+268         return 0;
+269 }
 .fi
 .SS "bool ModeDefinedOper (char modechar, int type)"
 .PP
-Definition at line 213 of file modules.cpp.
+Definition at line 246 of file modules.cpp.
 .PP
 References EMode, and ExtModeListIter.
 .PP
 .nf
-214 {
-215         log(DEBUG,'Size of extmodes vector is %d',EMode.size());
-216         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-217         {
-218                 log(DEBUG,'i->modechar==%c, modechar=%c, i->type=%d, type=%d',i->modechar,modechar,i->type,type);
-219                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-220                 {
-221                         return true;
-222                 }
-223         }
-224         return false;
-225 }
+247 {
+248         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+249         {
+250                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+251                 {
+252                         return true;
+253                 }
+254         }
+255         return false;
+256 }
 .fi
 .SS "bool ModeIsListMode (char modechar, int type)"
 .PP
-Definition at line 199 of file modules.cpp.
+Definition at line 234 of file modules.cpp.
 .PP
 References EMode, and ExtModeListIter.
 .PP
 .nf
-200 {
-201         log(DEBUG,'Size of extmodes vector is %d',EMode.size());
-202         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-203         {
-204                 log(DEBUG,'i->modechar==%c, modechar=%c, i->type=%d, type=%d',i->modechar,modechar,i->type,type);
-205                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
-206                 {
-207                         return true;
-208                 }
-209         }
-210         return false;
-211 }
+235 {
+236         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+237         {
+238                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+239                 {
+240                         return true;
+241                 }
+242         }
+243         return false;
+244 }
 .fi
 .SS "void ModeMakeList (char modechar)"
 .PP
-Definition at line 264 of file modules.cpp.
+Definition at line 295 of file modules.cpp.
 .PP
 References EMode, ExtModeListIter, and MT_CHANNEL.
 .PP
 Referenced by Server::AddExtendedListMode().
 .PP
 .nf
-265 {
-266         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-267         {
-268                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-269                 {
-270                         i->list = true;
-271                         return;
-272                 }
-273         }
-274         return;
-275 }
+296 {
+297         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+298         {
+299                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+300                 {
+301                         i->list = true;
+302                         return;
+303                 }
+304         }
+305         return;
+306 }
 .fi
 .SS "std::vector<\fBModule\fP*> modules (255)"
 .PP
 .SH "Variable Documentation"
 .PP 
-.SS "char AdminEmail[MAXBUF]"
-.PP
-Definition at line 56 of file modules.cpp.
-.SS "char AdminName[MAXBUF]"
+.SS "char \fBAdminEmail\fP[MAXBUF]"
 .PP
-Definition at line 55 of file modules.cpp.
-.SS "char AdminNick[MAXBUF]"
+Definition at line 84 of file modules.cpp.
+.SS "char \fBAdminName\fP[MAXBUF]"
 .PP
-Definition at line 57 of file modules.cpp.
-.SS "std::vector<long> auth_cookies"
+Definition at line 83 of file modules.cpp.
+.SS "char \fBAdminNick\fP[MAXBUF]"
 .PP
 Definition at line 85 of file modules.cpp.
-.SS "char bannerBuffer[MAXBUF]"
+.SS "std::vector<long> \fBauth_cookies\fP"
 .PP
-Definition at line 78 of file modules.cpp.
-.SS "int boundPortCount"
+Definition at line 112 of file modules.cpp.
+.SS "int \fBboundPortCount\fP"
 .PP
-Definition at line 79 of file modules.cpp.
-.SS "\fBchan_hash\fP chanlist"
+Definition at line 106 of file modules.cpp.
+.SS "\fBchan_hash\fP \fBchanlist\fP"
 .PP
-Definition at line 156 of file modules.cpp.
-.SS "\fBuser_hash\fP clientlist"
+Definition at line 193 of file modules.cpp.
+.SS "\fBuser_hash\fP \fBclientlist\fP"
 .PP
-Definition at line 155 of file modules.cpp.
+Definition at line 192 of file modules.cpp.
+.SS "\fBcommand_table\fP \fBcmdlist\fP"
 .PP
-Referenced by Server::GetUsers().
-.SS "\fBcommand_table\fP cmdlist"
+Definition at line 195 of file modules.cpp.
+.SS "std::stringstream \fBconfig_f\fP"
 .PP
-Definition at line 158 of file modules.cpp.
-.SS "std::stringstream config_f"
+Definition at line 113 of file modules.cpp.
+.SS "int \fBdebugging\fP"
 .PP
-Definition at line 86 of file modules.cpp.
-.SS "int debugging"
+Definition at line 94 of file modules.cpp.
+.SS "int \fBdefaultRoute\fP"
 .PP
-Definition at line 66 of file modules.cpp.
-.SS "int defaultRoute"
+Definition at line 110 of file modules.cpp.
+.SS "int \fBDieDelay\fP"
 .PP
-Definition at line 83 of file modules.cpp.
-.SS "int DieDelay"
+Definition at line 97 of file modules.cpp.
+.SS "char \fBdiepass\fP[MAXBUF]"
 .PP
-Definition at line 69 of file modules.cpp.
-.SS "char diepass[MAXBUF]"
-.PP
-Definition at line 58 of file modules.cpp.
-.SS "char DieValue[MAXBUF]"
+Definition at line 86 of file modules.cpp.
+.SS "char \fBDieValue\fP[MAXBUF]"
 .PP
-Definition at line 64 of file modules.cpp.
-.SS "\fBExtModeList\fP EMode"
+Definition at line 92 of file modules.cpp.
+.SS "\fBExtModeList\fP \fBEMode\fP"
 .PP
-Definition at line 182 of file modules.cpp.
+Definition at line 219 of file modules.cpp.
 .PP
 Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().
-.SS "vector<\fBircd_module\fP*> factory"
-.PP
-Definition at line 49 of file modules.cpp.
-.SS "std::vector<int> fd_reap"
+.SS "std::vector<\fBircd_module\fP*> factory"
 .PP
 Definition at line 75 of file modules.cpp.
-.SS "\fBaddress_cache\fP IP"
+.SS "std::vector<int> \fBfd_reap\fP"
+.PP
+Definition at line 103 of file modules.cpp.
+.SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]"
 .PP
-Definition at line 161 of file modules.cpp.
-.SS "char list[MAXBUF]"
+Definition at line 119 of file modules.cpp.
 .PP
-Definition at line 62 of file modules.cpp.
-.SS "FILE* log_file"
+Referenced by Server::FindDescriptor(), and Server::PseudoToUser().
+.SS "\fBaddress_cache\fP \fBIP\fP"
+.PP
+Definition at line 198 of file modules.cpp.
+.SS "char \fBlist\fP[MAXBUF]"
 .PP
 Definition at line 90 of file modules.cpp.
-.SS "int LogLevel"
+.SS "FILE* \fBlog_file\fP"
 .PP
-Definition at line 51 of file modules.cpp.
-.SS "int MaxWhoResults"
+Definition at line 117 of file modules.cpp.
+.SS "int \fBLogLevel\fP"
 .PP
-Definition at line 72 of file modules.cpp.
-.SS "\fBserverrec\fP* me[32]"
+Definition at line 79 of file modules.cpp.
+.SS "int \fBMaxWhoResults\fP"
 .PP
-Definition at line 88 of file modules.cpp.
-.SS "int MODCOUNT = -1"
+Definition at line 100 of file modules.cpp.
+.SS "\fBserverrec\fP* \fBme\fP[32]"
 .PP
-Definition at line 714 of file modules.cpp.
-.SS "std::vector<std::string> module_names"
+Definition at line 115 of file modules.cpp.
+.SS "int \fBMODCOUNT\fP = -1"
 .PP
-Definition at line 76 of file modules.cpp.
-.SS "vector<\fBModule\fP*> modules"
+Definition at line 1067 of file modules.cpp.
+.SS "std::vector<std::string> \fBmodule_names\fP"
 .PP
-Definition at line 48 of file modules.cpp.
-.SS "\fBfile_cache\fP MOTD"
+Definition at line 104 of file modules.cpp.
+.SS "std::vector<\fBModule\fP*> modules"
 .PP
-Definition at line 159 of file modules.cpp.
-.SS "char motd[MAXBUF]"
+Definition at line 74 of file modules.cpp.
+.SS "\fBfile_cache\fP \fBMOTD\fP"
 .PP
-Definition at line 60 of file modules.cpp.
-.SS "time_t nb_start"
+Definition at line 196 of file modules.cpp.
+.SS "char \fBmotd\fP[MAXBUF]"
 .PP
-Definition at line 73 of file modules.cpp.
-.SS "int NetBufferSize"
+Definition at line 88 of file modules.cpp.
+.SS "time_t \fBnb_start\fP"
 .PP
-Definition at line 71 of file modules.cpp.
-.SS "char Network[MAXBUF]"
+Definition at line 101 of file modules.cpp.
+.SS "int \fBNetBufferSize\fP"
 .PP
-Definition at line 53 of file modules.cpp.
-.SS "int portCount"
+Definition at line 99 of file modules.cpp.
+.SS "char \fBNetwork\fP[MAXBUF]"
 .PP
-Definition at line 80 of file modules.cpp.
-.SS "int ports[MAXSOCKS]"
+Definition at line 81 of file modules.cpp.
+.SS "int \fBportCount\fP"
 .PP
-Definition at line 82 of file modules.cpp.
-.SS "char PrefixQuit[MAXBUF]"
+Definition at line 107 of file modules.cpp.
+.SS "int \fBports\fP[MAXSOCKS]"
+.PP
+Definition at line 109 of file modules.cpp.
+.SS "char \fBPrefixQuit\fP[MAXBUF]"
 .PP
-Definition at line 63 of file modules.cpp.
-.SS "char restartpass[MAXBUF]"
+Definition at line 91 of file modules.cpp.
+.SS "char \fBrestartpass\fP[MAXBUF]"
 .PP
-Definition at line 59 of file modules.cpp.
-.SS "\fBfile_cache\fP RULES"
+Definition at line 87 of file modules.cpp.
+.SS "\fBfile_cache\fP \fBRULES\fP"
 .PP
-Definition at line 160 of file modules.cpp.
-.SS "char rules[MAXBUF]"
+Definition at line 197 of file modules.cpp.
+.SS "char \fBrules\fP[MAXBUF]"
 .PP
-Definition at line 61 of file modules.cpp.
-.SS "char ServerDesc[MAXBUF]"
+Definition at line 89 of file modules.cpp.
+.SS "char \fBServerDesc\fP[MAXBUF]"
 .PP
-Definition at line 54 of file modules.cpp.
-.SS "char ServerName[MAXBUF]"
+Definition at line 82 of file modules.cpp.
+.SS "char \fBServerName\fP[MAXBUF]"
+.PP
+Definition at line 80 of file modules.cpp.
+.SS "int \fBSERVERportCount\fP"
 .PP
-Definition at line 52 of file modules.cpp.
-.SS "time_t startup_time"
+Definition at line 108 of file modules.cpp.
+.SS "time_t \fBstartup_time\fP"
 .PP
-Definition at line 70 of file modules.cpp.
-.SS "int UDPportCount"
+Definition at line 98 of file modules.cpp.
+.SS "time_t \fBTIME\fP"
 .PP
-Definition at line 81 of file modules.cpp.
-.SS "\fBuser_hash\fP whowas"
+Definition at line 77 of file modules.cpp.
+.SS "\fBwhowas_hash\fP \fBwhowas\fP"
 .PP
-Definition at line 157 of file modules.cpp.
-.SS "int WHOWAS_MAX"
+Definition at line 194 of file modules.cpp.
+.SS "int \fBWHOWAS_MAX\fP"
 .PP
-Definition at line 68 of file modules.cpp.
-.SS "int WHOWAS_STALE"
+Definition at line 96 of file modules.cpp.
+.SS "int \fBWHOWAS_STALE\fP"
 .PP
-Definition at line 67 of file modules.cpp.
+Definition at line 95 of file modules.cpp.
 .SH "Author"
 .PP 
 Generated automatically by Doxygen for InspIRCd from the source code.