From bc0d192a35489b8f5c42aa381ab2b120957ef770 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 7 May 2005 15:35:21 +0000 Subject: Added final documentation for inspircd Beta 4 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1322 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8cpp.html | 339 ++++++++++++++++++++------------------ 1 file changed, 181 insertions(+), 158 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 ead727c76..064629708 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -57,40 +57,40 @@

Typedefs

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

Functions

-bool ModeDefined (char modechar, int type) +bool ModeDefined (char modechar, int type) -bool ModeIsListMode (char modechar, int type) +bool ModeIsListMode (char modechar, int type) -bool ModeDefinedOper (char modechar, int type) +bool ModeDefinedOper (char modechar, int type) -int ModeDefinedOn (char modechar, int type) +int ModeDefinedOn (char modechar, int type) -int ModeDefinedOff (char modechar, int type) +int ModeDefinedOff (char modechar, int type) -bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off) +bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off) -void ModeMakeList (char modechar) +void ModeMakeList (char modechar) -std::vector< Module * > modules (255) +std::vector< Module * > modules (255) -std::vector< ircd_module * > factory (255) +std::vector< ircd_module * > factory (255)

Variables

int MODCOUNT = -1 @@ -167,21 +167,23 @@ FILE * log_file -user_hash clientlist +userrec * fd_ref_table [65536] -chan_hash chanlist +user_hash clientlist -user_hash whowas +chan_hash chanlist -command_table cmdlist +user_hash whowas -file_cache MOTD +command_table cmdlist -file_cache RULES +file_cache MOTD -address_cache IP +file_cache RULES -ExtModeList EMode +address_cache IP + +ExtModeList EMode

Define Documentation

@@ -210,13 +212,13 @@ Definition at line 59 o

Typedef Documentation

-

+

@@ -231,16 +233,16 @@ Definition at line 59 o

-Definition at line 177 of file modules.cpp. +Definition at line 178 of file modules.cpp.

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

+

@@ -255,16 +257,16 @@ Definition at line 177

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

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

+

@@ -279,16 +281,16 @@ Definition at line 176

-Definition at line 178 of file modules.cpp. +Definition at line 179 of file modules.cpp.

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

+

@@ -303,16 +305,16 @@ Definition at line 178

-Definition at line 204 of file modules.cpp. +Definition at line 205 of file modules.cpp.

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

+

@@ -327,18 +329,18 @@ Definition at line 204

-Definition at line 205 of file modules.cpp. +Definition at line 206 of file modules.cpp.

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

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

+

@@ -353,11 +355,11 @@ Referenced by ModeDefined()

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

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

Function Documentation

-

+

@@ -412,23 +414,23 @@ Definition at line 175

-Definition at line 277 of file modules.cpp. +Definition at line 275 of file modules.cpp.

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

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

-

00278 {
-00279         if (ModeDefined(modechar,type)) {
-00280                 return false;
-00281         }
-00282         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
-00283         return true;
-00284 }
+
00276 {
+00277         if (ModeDefined(modechar,type)) {
+00278                 return false;
+00279         }
+00280         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
+00281         return true;
+00282 }
-

+

@@ -457,7 +459,7 @@ Referenced by Server::AddEx
-

+

@@ -494,15 +496,14 @@ Referenced by Server::AddEx

-Definition at line 211 of file modules.cpp. +Definition at line 212 of file modules.cpp.

-References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

-Referenced by DoAddExtendedMode(). +Referenced by DoAddExtendedMode().

-

00212 {
-00213         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00214         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+
00213 {
+00214         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 00215         {
 00216                 if ((i->modechar == modechar) && (i->type == type))
 00217                 {
@@ -514,7 +515,7 @@ Referenced by DoAddExtended
-

+

@@ -551,24 +552,24 @@ Referenced by DoAddExtended

-Definition at line 264 of file modules.cpp. +Definition at line 262 of file modules.cpp.

-References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

-

00265 {
-00266         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00267         {
-00268                 if ((i->modechar == modechar) && (i->type == type))
-00269                 {
-00270                         return i->params_when_off;
-00271                 }
-00272         }
-00273         return 0;
-00274 }
+
00263 {
+00264         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00265         {
+00266                 if ((i->modechar == modechar) && (i->type == type))
+00267                 {
+00268                         return i->params_when_off;
+00269                 }
+00270         }
+00271         return 0;
+00272 }
-

+

@@ -605,24 +606,24 @@ References EMode, and <

-Definition at line 251 of file modules.cpp. +Definition at line 249 of file modules.cpp.

-References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

-

00252 {
-00253         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00254         {
-00255                 if ((i->modechar == modechar) && (i->type == type))
-00256                 {
-00257                         return i->params_when_on;
-00258                 }
-00259         }
-00260         return 0;
-00261 }
+
00250 {
+00251         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00252         {
+00253                 if ((i->modechar == modechar) && (i->type == type))
+00254                 {
+00255                         return i->params_when_on;
+00256                 }
+00257         }
+00258         return 0;
+00259 }
-

+

@@ -659,25 +660,24 @@ References EMode, and <

-Definition at line 237 of file modules.cpp. +Definition at line 236 of file modules.cpp.

-References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

-

00238 {
-00239         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00240         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00241         {
-00242                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-00243                 {
-00244                         return true;
-00245                 }
-00246         }
-00247         return false;
-00248 }
+
00237 {
+00238         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00239         {
+00240                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+00241                 {
+00242                         return true;
+00243                 }
+00244         }
+00245         return false;
+00246 }
-

+

@@ -716,23 +716,22 @@ References DEBUG, Definition at line 224 of file modules.cpp.

-References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. 

00225 {
-00226         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00227         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00228         {
-00229                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
-00230                 {
-00231                         return true;
-00232                 }
-00233         }
-00234         return false;
-00235 }
+00226         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00227         {
+00228                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00229                 {
+00230                         return true;
+00231                 }
+00232         }
+00233         return false;
+00234 }
-

+

@@ -760,27 +759,27 @@ References DEBUG,

-Definition at line 287 of file modules.cpp. +Definition at line 285 of file modules.cpp.

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

-Referenced by Server::AddExtendedListMode(). +Referenced by Server::AddExtendedListMode().

-

00288 {
-00289         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00290         {
-00291                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-00292                 {
-00293                         i->list = true;
-00294                         return;
-00295                 }
-00296         }
-00297         return;
-00298 }
+
00286 {
+00287         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00288         {
+00289                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+00290                 {
+00291                         i->list = true;
+00292                         return;
+00293                 }
+00294         }
+00295         return;
+00296 }
-

+

@@ -930,13 +929,13 @@ Definition at line 103 Definition at line 97 of file modules.cpp.
-

+

@@ -951,16 +950,16 @@ Definition at line 97 o

-Definition at line 182 of file modules.cpp. +Definition at line 183 of file modules.cpp.

-
chan_hash chanlist + chan_hash chanlist
-

+

@@ -975,18 +974,16 @@ Definition at line 182

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

-Referenced by Server::GetUsers(). +Definition at line 182 of file modules.cpp.

-
user_hash clientlist + user_hash clientlist
-

+

@@ -1001,7 +998,7 @@ Referenced by Server::GetUs

-Definition at line 184 of file modules.cpp. +Definition at line 185 of file modules.cpp.

-
command_table cmdlist + command_table cmdlist

@@ -1148,13 +1145,13 @@ Definition at line 77 o Definition at line 83 of file modules.cpp. -

+

@@ -1169,9 +1166,9 @@ Definition at line 83 o

-Definition at line 208 of file modules.cpp. +Definition at line 209 of file modules.cpp.

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

-
ExtModeList EMode + ExtModeList EMode

@@ -1222,13 +1219,13 @@ Definition at line 66 o Definition at line 94 of file modules.cpp. -

+

@@ -1243,7 +1240,33 @@ Definition at line 94 o

-Definition at line 187 of file modules.cpp. +Definition at line 110 of file modules.cpp. +

+Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). + +

-
address_cache IP + userrec* fd_ref_table[65536]
+

+ + + + +
+ + +
address_cache IP +
+
+ + + +
+   + + +

+ +

+Definition at line 188 of file modules.cpp.

@@ -1387,7 +1410,7 @@ Definition at line 106

-Definition at line 1032 of file modules.cpp. +Definition at line 1048 of file modules.cpp.

@@ -1438,13 +1461,13 @@ Definition at line 95 o Definition at line 65 of file modules.cpp. -

+

@@ -1459,7 +1482,7 @@ Definition at line 65 o

-Definition at line 185 of file modules.cpp. +Definition at line 186 of file modules.cpp.

-
file_cache MOTD + file_cache MOTD

@@ -1654,13 +1677,13 @@ Definition at line 82 o Definition at line 78 of file modules.cpp. -

+

@@ -1675,7 +1698,7 @@ Definition at line 78 o

-Definition at line 186 of file modules.cpp. +Definition at line 187 of file modules.cpp.

-
file_cache RULES + file_cache RULES

@@ -1822,13 +1845,13 @@ Definition at line 68 o Definition at line 99 of file modules.cpp. -

+

@@ -1843,7 +1866,7 @@ Definition at line 99 o

-Definition at line 183 of file modules.cpp. +Definition at line 184 of file modules.cpp.

-
user_hash whowas + user_hash whowas

@@ -1894,7 +1917,7 @@ Definition at line 87 o Definition at line 86 of file modules.cpp. -

Generated on Tue Apr 26 17:11:46 2005 for InspIRCd by +
Generated on Sat May 7 15:34:22 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91