From 755d67224f033aaa9b4ef3d2dd00f46bb8c19dc2 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 7 Apr 2005 20:15:05 +0000 Subject: New docs to match extra module Version class stuff, etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1008 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8cpp.html | 624 ++++++++++++++++++++------------------ 1 file changed, 325 insertions(+), 299 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 1d49c4368..1874e8024 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -57,129 +57,131 @@

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 std::vector< Module * > modules -std::vector< ircd_module * > factory +std::vector< ircd_module * > factory -int LogLevel +time_t TIME -char ServerName [MAXBUF] +int LogLevel -char Network [MAXBUF] +char ServerName [MAXBUF] -char ServerDesc [MAXBUF] +char Network [MAXBUF] -char AdminName [MAXBUF] +char ServerDesc [MAXBUF] -char AdminEmail [MAXBUF] +char AdminName [MAXBUF] -char AdminNick [MAXBUF] +char AdminEmail [MAXBUF] -char diepass [MAXBUF] +char AdminNick [MAXBUF] -char restartpass [MAXBUF] +char diepass [MAXBUF] -char motd [MAXBUF] +char restartpass [MAXBUF] -char rules [MAXBUF] +char motd [MAXBUF] -char list [MAXBUF] +char rules [MAXBUF] -char PrefixQuit [MAXBUF] +char list [MAXBUF] -char DieValue [MAXBUF] +char PrefixQuit [MAXBUF] -int debugging +char DieValue [MAXBUF] -int WHOWAS_STALE +int debugging -int WHOWAS_MAX +int WHOWAS_STALE -int DieDelay +int WHOWAS_MAX -time_t startup_time +int DieDelay -int NetBufferSize +time_t startup_time -int MaxWhoResults +int NetBufferSize -time_t nb_start +int MaxWhoResults -std::vector< int > fd_reap +time_t nb_start -std::vector< std::string > module_names +std::vector< int > fd_reap -int boundPortCount +std::vector< std::string > module_names -int portCount +int boundPortCount -int UDPportCount +int portCount -int ports [MAXSOCKS] +int UDPportCount -int defaultRoute +int ports [MAXSOCKS] -std::vector< long > auth_cookies +int defaultRoute -std::stringstream config_f +std::vector< long > auth_cookies -serverrec * me [32] +std::stringstream config_f -FILE * log_file +serverrec * me [32] -user_hash clientlist +FILE * log_file -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

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

Typedef Documentation

-

+

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

-Definition at line 173 of file modules.cpp. +Definition at line 175 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
-

+

@@ -253,16 +255,16 @@ Definition at line 173

-Definition at line 172 of file modules.cpp. +Definition at line 174 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
-

+

@@ -277,16 +279,16 @@ Definition at line 172

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

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

+

@@ -301,16 +303,16 @@ Definition at line 174

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

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

+

@@ -325,18 +327,18 @@ Definition at line 200

-Definition at line 201 of file modules.cpp. +Definition at line 203 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
-

+

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

-Definition at line 171 of file modules.cpp. +Definition at line 173 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

-

+

@@ -410,29 +412,29 @@ Definition at line 171

-Definition at line 273 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().

-

00274 {
-00275         if (ModeDefined(modechar,type)) {
-00276                 return false;
-00277         }
-00278         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
-00279         return true;
-00280 }
+
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 }
-

+

@@ -1196,13 +1198,13 @@ Referenced by DoAddExtended Definition at line 66 of file modules.cpp.
- + @@ -455,7 +457,7 @@ Referenced by Server::AddEx
std::vector<ircd_module*> factory std::vector<ircd_module*> factory (  255 
-

+

@@ -492,27 +494,27 @@ Referenced by Server::AddEx

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

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

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

-

00208 {
-00209         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00210         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00211         {
-00212                 if ((i->modechar == modechar) && (i->type == type))
-00213                 {
-00214                         return true;
-00215                 }
-00216         }
-00217         return false;
-00218 }
+
00210 {
+00211         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00212         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00213         {
+00214                 if ((i->modechar == modechar) && (i->type == type))
+00215                 {
+00216                         return true;
+00217                 }
+00218         }
+00219         return false;
+00220 }
-

+

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

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

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

-

00261 {
-00262         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00263         {
-00264                 if ((i->modechar == modechar) && (i->type == type))
-00265                 {
-00266                         return i->params_when_off;
-00267                 }
-00268         }
-00269         return 0;
-00270 }
+
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 }
-

+

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

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

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

-

00248 {
-00249         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00250         {
-00251                 if ((i->modechar == modechar) && (i->type == type))
-00252                 {
-00253                         return i->params_when_on;
-00254                 }
-00255         }
-00256         return 0;
-00257 }
+
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 }
-

+

@@ -657,25 +659,25 @@ References EMode, and <

-Definition at line 233 of file modules.cpp. +Definition at line 235 of file modules.cpp.

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

-

00234 {
-00235         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00236         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00237         {
-00238                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-00239                 {
-00240                         return true;
-00241                 }
-00242         }
-00243         return false;
-00244 }
+
00236 {
+00237         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+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 }
-

+

@@ -712,25 +714,25 @@ References DEBUG,

-Definition at line 220 of file modules.cpp. +Definition at line 222 of file modules.cpp.

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

-

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

+

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

-Definition at line 283 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().

-

00284 {
-00285         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00286         {
-00287                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-00288                 {
-00289                         i->list = true;
-00290                         return;
-00291                 }
-00292         }
-00293         return;
-00294 }
+
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 }
-

+

@@ -808,13 +810,13 @@ Referenced by Server::AddEx

Variable Documentation

-

+

@@ -829,16 +831,16 @@ Referenced by Server::AddEx

-Definition at line 73 of file modules.cpp. +Definition at line 75 of file modules.cpp.

-
char AdminEmail[MAXBUF] + char AdminEmail[MAXBUF]
-

+

@@ -853,16 +855,16 @@ Definition at line 73 o

-Definition at line 72 of file modules.cpp. +Definition at line 74 of file modules.cpp.

-
char AdminName[MAXBUF] + char AdminName[MAXBUF]
-

+

@@ -877,16 +879,16 @@ Definition at line 72 o

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

-
char AdminNick[MAXBUF] + char AdminNick[MAXBUF]
-

+

@@ -901,16 +903,16 @@ Definition at line 74 o

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

-
std::vector<long> auth_cookies + std::vector<long> auth_cookies
-

+

@@ -925,16 +927,16 @@ Definition at line 101

-Definition at line 95 of file modules.cpp. +Definition at line 97 of file modules.cpp.

-
int boundPortCount + int boundPortCount
-

+

@@ -949,16 +951,16 @@ Definition at line 95 o

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

-
chan_hash chanlist + chan_hash chanlist
-

+

@@ -973,18 +975,18 @@ Definition at line 178

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

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

-
user_hash clientlist + user_hash clientlist
-

+

@@ -999,10 +1001,10 @@ Referenced by Server::GetUs

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

-
command_table cmdlist + command_table cmdlist
-

+

+Definition at line 104 of file modules.cpp.
@@ -1023,16 +1025,16 @@ Definition at line 180

-Definition at line 102 of file modules.cpp.

-

+

@@ -1047,16 +1049,16 @@ Definition at line 102

-Definition at line 83 of file modules.cpp. +Definition at line 85 of file modules.cpp.

-
int debugging + int debugging
-

+

@@ -1071,16 +1073,16 @@ Definition at line 83 o

-Definition at line 99 of file modules.cpp. +Definition at line 101 of file modules.cpp.

-
int defaultRoute + int defaultRoute
-

+

@@ -1095,16 +1097,16 @@ Definition at line 99 o

-Definition at line 86 of file modules.cpp. +Definition at line 88 of file modules.cpp.

-
int DieDelay + int DieDelay
-

+

@@ -1119,16 +1121,16 @@ Definition at line 86 o

-Definition at line 75 of file modules.cpp. +Definition at line 77 of file modules.cpp.

-
char diepass[MAXBUF] + char diepass[MAXBUF]
-

+

@@ -1143,16 +1145,16 @@ Definition at line 75 o

-Definition at line 81 of file modules.cpp. +Definition at line 83 of file modules.cpp.

-
char DieValue[MAXBUF] + char DieValue[MAXBUF]
-

+

@@ -1167,9 +1169,9 @@ Definition at line 81 o

-Definition at line 204 of file modules.cpp. +Definition at line 206 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

@@ -1178,7 +1180,7 @@ Referenced by DoAddExtended

-
std::vector<ircd_module*> factory + std::vector<ircd_module*> factory
-

+

@@ -1217,16 +1219,16 @@ Definition at line 66 o

-Definition at line 92 of file modules.cpp. +Definition at line 94 of file modules.cpp.

-
std::vector<int> fd_reap + std::vector<int> fd_reap
-

+

@@ -1241,16 +1243,16 @@ Definition at line 92 o

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

-
address_cache IP + address_cache IP
-

+

@@ -1265,16 +1267,16 @@ Definition at line 183

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

-
char list[MAXBUF] + char list[MAXBUF]
-

+

@@ -1289,16 +1291,16 @@ Definition at line 79 o

-Definition at line 106 of file modules.cpp. +Definition at line 108 of file modules.cpp.

-
FILE* log_file + FILE* log_file
-

+

@@ -1313,16 +1315,16 @@ Definition at line 106

-Definition at line 68 of file modules.cpp. +Definition at line 70 of file modules.cpp.

-
int LogLevel + int LogLevel
-

+

@@ -1337,16 +1339,16 @@ Definition at line 68 o

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

-
int MaxWhoResults + int MaxWhoResults
-

+

@@ -1361,7 +1363,7 @@ Definition at line 89 o

-Definition at line 104 of file modules.cpp. +Definition at line 106 of file modules.cpp.

-
serverrec* me[32] + serverrec* me[32]

@@ -1385,16 +1387,16 @@ Definition at line 104

-Definition at line 774 of file modules.cpp. +Definition at line 776 of file modules.cpp. -

+

@@ -1409,7 +1411,7 @@ Definition at line 774

-Definition at line 93 of file modules.cpp. +Definition at line 95 of file modules.cpp.

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

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

+

@@ -1457,16 +1459,16 @@ Definition at line 65 o

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

-
file_cache MOTD + file_cache MOTD
-

+

@@ -1481,16 +1483,40 @@ Definition at line 181

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

-
char motd[MAXBUF] + char motd[MAXBUF]
-

+

+ +
-
time_t nb_start + time_t nb_start +
+
+ + + + + +
+   + + +

+ +

+Definition at line 92 of file modules.cpp.

+

+ + + @@ -1508,13 +1534,13 @@ Definition at line 77 o Definition at line 90 of file modules.cpp.
+ + +
int NetBufferSize
-

+

@@ -1529,16 +1555,16 @@ Definition at line 90 o

-Definition at line 88 of file modules.cpp. +Definition at line 72 of file modules.cpp.

-
int NetBufferSize + char Network[MAXBUF]
-

+

@@ -1553,16 +1579,16 @@ Definition at line 88 o

-Definition at line 70 of file modules.cpp. +Definition at line 98 of file modules.cpp.

-
char Network[MAXBUF] + int portCount
-

+

@@ -1577,16 +1603,16 @@ Definition at line 70 o

-Definition at line 96 of file modules.cpp. +Definition at line 100 of file modules.cpp.

-
int portCount + int ports[MAXSOCKS]
-

+

@@ -1601,16 +1627,16 @@ Definition at line 96 o

-Definition at line 98 of file modules.cpp. +Definition at line 82 of file modules.cpp.

-
int ports[MAXSOCKS] + char PrefixQuit[MAXBUF]
-

+

@@ -1625,16 +1651,16 @@ Definition at line 98 o

-Definition at line 80 of file modules.cpp. +Definition at line 78 of file modules.cpp.

-
char PrefixQuit[MAXBUF] + char restartpass[MAXBUF]
-

+

@@ -1649,16 +1675,16 @@ Definition at line 80 o

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

-
char restartpass[MAXBUF] + file_cache RULES
-

+

@@ -1673,16 +1699,16 @@ Definition at line 76 o

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

-
file_cache RULES + char rules[MAXBUF]
-

+

@@ -1697,16 +1723,16 @@ Definition at line 182

-Definition at line 78 of file modules.cpp. +Definition at line 73 of file modules.cpp.

-
char rules[MAXBUF] + char ServerDesc[MAXBUF]
-

+

@@ -1724,13 +1750,13 @@ Definition at line 78 o Definition at line 71 of file modules.cpp.
-
char ServerDesc[MAXBUF] + char ServerName[MAXBUF]
-

+

@@ -1745,16 +1771,16 @@ Definition at line 71 o

-Definition at line 69 of file modules.cpp. +Definition at line 89 of file modules.cpp.

-
char ServerName[MAXBUF] + time_t startup_time
-

+

@@ -1769,16 +1795,16 @@ Definition at line 69 o

-Definition at line 87 of file modules.cpp. +Definition at line 68 of file modules.cpp.

-
time_t startup_time + time_t TIME
-

+

@@ -1793,16 +1819,16 @@ Definition at line 87 o

-Definition at line 97 of file modules.cpp. +Definition at line 99 of file modules.cpp.

-
int UDPportCount + int UDPportCount
-

+

@@ -1817,16 +1843,16 @@ Definition at line 97 o

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

-
user_hash whowas + user_hash whowas
-

+

@@ -1841,16 +1867,16 @@ Definition at line 179

-Definition at line 85 of file modules.cpp. +Definition at line 87 of file modules.cpp.

-
int WHOWAS_MAX + int WHOWAS_MAX
-

+

@@ -1865,10 +1891,10 @@ Definition at line 85 o

-Definition at line 84 of file modules.cpp. +Definition at line 86 of file modules.cpp.

-
int WHOWAS_STALE + int WHOWAS_STALE
-

Generated on Mon Apr 4 18:12:49 2005 for InspIRCd by +
Generated on Thu Apr 7 20:14:22 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91