From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/man/man3/Admin.3 | 24 +- docs/man/man3/BanItem.3 | 6 +- docs/man/man3/ConfigReader.3 | 304 +++-- docs/man/man3/ConnectClass.3 | 60 +- docs/man/man3/ExemptItem.3 | 6 +- docs/man/man3/ExtMode.3 | 30 +- docs/man/man3/Extensible.3 | 26 +- docs/man/man3/FileReader.3 | 106 +- docs/man/man3/GLine.3 | 12 +- docs/man/man3/HostItem.3 | 30 +- docs/man/man3/InAddr_HashComp.3 | 22 +- docs/man/man3/InviteItem.3 | 6 +- docs/man/man3/Invited.3 | 10 +- docs/man/man3/KLine.3 | 12 +- docs/man/man3/ModeParameter.3 | 20 +- docs/man/man3/Module.3 | 167 +-- docs/man/man3/ModuleFactory.3 | 22 +- docs/man/man3/QLine.3 | 18 +- docs/man/man3/Server.3 | 510 +++---- docs/man/man3/StrHashComp.3 | 16 +- docs/man/man3/Version.3 | 28 +- docs/man/man3/XLine.3 | 36 +- docs/man/man3/ZLine.3 | 18 +- docs/man/man3/base.h.3 | 10 +- docs/man/man3/channels.cpp.3 | 154 ++- docs/man/man3/channels.h.3 | 44 +- docs/man/man3/chanrec.3 | 299 +++-- docs/man/man3/classbase.3 | 28 +- docs/man/man3/command_t.3 | 42 +- docs/man/man3/commands.h.3 | 18 +- docs/man/man3/connection.3 | 168 +-- docs/man/man3/connection.h.3 | 24 +- docs/man/man3/ctables.h.3 | 4 +- docs/man/man3/ircd_connector.3 | 116 +- docs/man/man3/message.h.3 | 2 +- docs/man/man3/mode.h.3 | 2 +- docs/man/man3/modules.cpp.3 | 371 +++--- docs/man/man3/modules.h.3 | 92 +- docs/man/man3/nspace.3 | 6 +- docs/man/man3/nspace_nspace_hash_ in_addr _.3 | 14 +- docs/man/man3/nspace_nspace_hash_ string _.3 | 18 +- docs/man/man3/packet.3 | 8 +- docs/man/man3/serverrec.3 | 143 +- docs/man/man3/servers.cpp.3 | 2 +- docs/man/man3/servers.h.3 | 8 +- docs/man/man3/std.3 | 2 +- docs/man/man3/ucrec.3 | 30 +- docs/man/man3/userrec.3 | 380 +++--- docs/man/man3/users.cpp.3 | 6 +- docs/man/man3/users.h.3 | 32 +- docs/man/man3/xline.h.3 | 12 +- docs/module-doc/annotated.html | 75 +- docs/module-doc/base_8h-source.html | 101 +- docs/module-doc/base_8h.html | 48 +- docs/module-doc/channels_8cpp-source.html | 393 +++--- docs/module-doc/channels_8cpp.html | 490 +++---- docs/module-doc/channels_8h-source.html | 268 ++-- docs/module-doc/channels_8h.html | 159 ++- docs/module-doc/classAdmin-members.html | 29 +- docs/module-doc/classAdmin.html | 87 +- docs/module-doc/classBanItem-members.html | 31 +- docs/module-doc/classBanItem.html | 33 +- docs/module-doc/classConfigReader-members.html | 49 +- docs/module-doc/classConfigReader.html | 581 ++++---- docs/module-doc/classConnectClass-members.html | 33 +- docs/module-doc/classConnectClass.html | 151 ++- docs/module-doc/classExemptItem-members.html | 31 +- docs/module-doc/classExemptItem.html | 33 +- docs/module-doc/classExtMode-members.html | 35 +- docs/module-doc/classExtMode.html | 124 +- docs/module-doc/classExtensible-members.html | 29 +- docs/module-doc/classExtensible.html | 101 +- docs/module-doc/classFileReader-members.html | 37 +- docs/module-doc/classFileReader.html | 241 ++-- docs/module-doc/classGLine-members.html | 33 +- docs/module-doc/classGLine.html | 50 +- docs/module-doc/classHostItem-members.html | 31 +- docs/module-doc/classHostItem.html | 107 +- docs/module-doc/classInviteItem-members.html | 31 +- docs/module-doc/classInviteItem.html | 33 +- docs/module-doc/classInvited-members.html | 23 +- docs/module-doc/classInvited.html | 46 +- docs/module-doc/classKLine-members.html | 33 +- docs/module-doc/classKLine.html | 50 +- docs/module-doc/classModeParameter-members.html | 27 +- docs/module-doc/classModeParameter.html | 76 +- docs/module-doc/classModule-members.html | 66 +- docs/module-doc/classModule.html | 555 ++++---- docs/module-doc/classModuleFactory-members.html | 27 +- docs/module-doc/classModuleFactory.html | 78 +- docs/module-doc/classQLine-members.html | 35 +- docs/module-doc/classQLine.html | 67 +- docs/module-doc/classServer-members.html | 93 +- docs/module-doc/classServer.html | 1035 +++++++------- docs/module-doc/classVersion-members.html | 31 +- docs/module-doc/classVersion.html | 102 +- docs/module-doc/classXLine-members.html | 31 +- docs/module-doc/classXLine.html | 122 +- docs/module-doc/classZLine-members.html | 35 +- docs/module-doc/classZLine.html | 67 +- docs/module-doc/classchanrec-members.html | 69 +- docs/module-doc/classchanrec.html | 599 +++++---- docs/module-doc/classclassbase-members.html | 21 +- docs/module-doc/classclassbase.html | 100 +- docs/module-doc/classcommand__t-members.html | 39 +- docs/module-doc/classcommand__t.html | 134 +- docs/module-doc/classconnection-members.html | 85 +- docs/module-doc/classconnection.html | 551 ++++---- docs/module-doc/classes.html | 36 +- docs/module-doc/classircd__connector-members.html | 73 +- docs/module-doc/classircd__connector.html | 395 +++--- docs/module-doc/classpacket-members.html | 21 +- docs/module-doc/classpacket.html | 31 +- docs/module-doc/classserverrec-members.html | 112 +- docs/module-doc/classserverrec.html | 365 ++--- docs/module-doc/classucrec-members.html | 29 +- docs/module-doc/classucrec.html | 102 +- docs/module-doc/classuserrec-members.html | 127 +- docs/module-doc/classuserrec.html | 673 +++++----- docs/module-doc/commands_8h-source.html | 213 +-- docs/module-doc/commands_8h.html | 1077 ++++++++------- docs/module-doc/connection_8h-source.html | 289 ++-- docs/module-doc/connection_8h.html | 101 +- docs/module-doc/ctables_8h-source.html | 58 +- docs/module-doc/ctables_8h.html | 34 +- docs/module-doc/files.html | 15 +- docs/module-doc/functions.html | 245 ++-- docs/module-doc/functions_func.html | 214 +++ docs/module-doc/functions_vars.html | 181 +++ docs/module-doc/globals.html | 90 +- docs/module-doc/globals_defs.html | 95 ++ docs/module-doc/globals_func.html | 211 +++ docs/module-doc/globals_type.html | 34 + docs/module-doc/globals_vars.html | 109 ++ docs/module-doc/hierarchy.html | 19 +- docs/module-doc/index.html | 1 + docs/module-doc/inspircd.css | 50 - docs/module-doc/main.html | 15 +- docs/module-doc/message_8h-source.html | 101 +- docs/module-doc/message_8h.html | 264 ++-- docs/module-doc/mode_8h-source.html | 94 +- docs/module-doc/mode_8h.html | 251 ++-- docs/module-doc/modules_8cpp-source.html | 1408 ++++++++++---------- docs/module-doc/modules_8cpp.html | 981 +++++++------- docs/module-doc/modules_8h-source.html | 542 ++++---- docs/module-doc/modules_8h.html | 410 +++--- docs/module-doc/namespacenspace.html | 21 +- docs/module-doc/namespaces.html | 15 +- docs/module-doc/namespacestd.html | 15 +- docs/module-doc/servers_8cpp-source.html | 110 +- docs/module-doc/servers_8cpp.html | 22 +- docs/module-doc/servers_8h-source.html | 112 +- docs/module-doc/servers_8h.html | 52 +- .../module-doc/structInAddr__HashComp-members.html | 17 +- docs/module-doc/structInAddr__HashComp.html | 46 +- docs/module-doc/structStrHashComp-members.html | 17 +- docs/module-doc/structStrHashComp.html | 40 +- ..._1nspace_1_1hash_3_01in__addr_01_4-members.html | 17 +- ...nspace_1_1nspace_1_1hash_3_01in__addr_01_4.html | 38 +- ..._1_1nspace_1_1hash_3_01string_01_4-members.html | 17 +- ...ctnspace_1_1nspace_1_1hash_3_01string_01_4.html | 42 +- docs/module-doc/tree.html | 191 ++- docs/module-doc/users_8cpp-source.html | 323 ++--- docs/module-doc/users_8cpp.html | 35 +- docs/module-doc/users_8h-source.html | 224 ++-- docs/module-doc/users_8h.html | 133 +- docs/module-doc/xline_8h-source.html | 213 +-- docs/module-doc/xline_8h.html | 346 ++--- 168 files changed, 11824 insertions(+), 10453 deletions(-) create mode 100644 docs/module-doc/functions_func.html create mode 100644 docs/module-doc/functions_vars.html create mode 100644 docs/module-doc/globals_defs.html create mode 100644 docs/module-doc/globals_func.html create mode 100644 docs/module-doc/globals_type.html create mode 100644 docs/module-doc/globals_vars.html (limited to 'docs') diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 050082e5a..c467589a8 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,8 +1,8 @@ -.TH "Admin" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -Admin \- Holds /ADMIN data This class contains the admin details of the local server. +Admin \- Holds /ADMIN data This class contains the admin details of the local server. .PP .SH SYNOPSIS @@ -34,31 +34,31 @@ Inherits \fBclassbase\fP. .in -1c .SH "Detailed Description" .PP -Holds /ADMIN data This class contains the admin details of the local server. +Holds /ADMIN data This class contains the admin details of the local server. It is constructed by class \fBServer\fP, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running. .PP -Definition at line 104 of file modules.h. +Definition at line 114 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Admin::Admin (std::string name, std::string email, std::string nick)" .PP -Definition at line 283 of file modules.cpp. +Definition at line 295 of file modules.cpp. .PP .nf -283 : Name(name), Email(email), Nick(nick) { }; +295 : Name(name), Email(email), Nick(nick) { }; .fi .SH "Member Data Documentation" .PP -.SS "const std::string Admin::Email" +.SS "const std::string \fBAdmin::Email\fP" .PP -Definition at line 107 of file modules.h. -.SS "const std::string Admin::Name" +Definition at line 117 of file modules.h. +.SS "const std::string \fBAdmin::Name\fP" .PP -Definition at line 107 of file modules.h. -.SS "const std::string Admin::Nick" +Definition at line 117 of file modules.h. +.SS "const std::string \fBAdmin::Nick\fP" .PP -Definition at line 107 of file modules.h. +Definition at line 117 of file modules.h. .SH "Author" .PP diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index de063285c..0cff6dab3 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,8 +1,8 @@ -.TH "BanItem" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -BanItem \- A subclass of \fBHostItem\fP designed to hold channel bans (+b). +BanItem \- A subclass of \fBHostItem\fP designed to hold channel bans (+b). .PP .SH SYNOPSIS @@ -14,7 +14,7 @@ Inherits \fBHostItem\fP. .PP .SH "Detailed Description" .PP -A subclass of \fBHostItem\fP designed to hold channel bans (+b).Definition at line 34 of file channels.h. +A subclass of \fBHostItem\fP designed to hold channel bans (+b). Definition at line 45 of file channels.h. .SH "Author" .PP diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 29fcef35f..fc31d292e 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,8 +1,8 @@ -.TH "ConfigReader" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ConfigReader \- Allows 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. +ConfigReader \- Allows 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. .PP .SH SYNOPSIS @@ -18,43 +18,47 @@ Inherits \fBclassbase\fP. .ti -1c .RI "\fBConfigReader\fP ()" .br -.RI "\fIDefault constructor.\fP" +.RI "\fIDefault constructor. \fP" .ti -1c .RI "\fBConfigReader\fP (std::string filename)" .br -.RI "\fIOverloaded constructor.\fP" +.RI "\fIOverloaded constructor. \fP" .ti -1c .RI "\fB~ConfigReader\fP ()" .br -.RI "\fIDefault destructor.\fP" +.RI "\fIDefault destructor. \fP" .ti -1c .RI "std::string \fBReadValue\fP (std::string tag, std::string name, int index)" .br -.RI "\fIRetrieves a value from the config file.\fP" +.RI "\fIRetrieves a value from the config file. \fP" .ti -1c .RI "bool \fBReadFlag\fP (std::string tag, std::string name, int index)" .br -.RI "\fIRetrieves a boolean value from the config file.\fP" +.RI "\fIRetrieves a boolean value from the config file. \fP" .ti -1c .RI "long \fBReadInteger\fP (std::string tag, std::string name, int index, bool needs_unsigned)" .br -.RI "\fIRetrieves an integer value from the config file.\fP" +.RI "\fIRetrieves an integer value from the config file. \fP" .ti -1c .RI "long \fBGetError\fP ()" .br -.RI "\fIReturns the last error to occur.\fP" +.RI "\fIReturns the last error to occur. \fP" .ti -1c .RI "int \fBEnumerate\fP (std::string tag)" .br -.RI "\fICounts the number of times a given tag appears in the config file.\fP" +.RI "\fICounts the number of times a given tag appears in the config file. \fP" .ti -1c .RI "bool \fBVerify\fP ()" .br -.RI "\fIReturns true if a config file is valid.\fP" +.RI "\fIReturns true if a config file is valid. \fP" +.ti -1c +.RI "void \fBDumpErrors\fP (bool bail, \fBuserrec\fP *user)" +.br +.RI "\fIDumps the list of errors in a config file to an output location. \fP" .ti -1c .RI "int \fBEnumerateValues\fP (std::string tag, int index)" .br -.RI "\fIReturns the number of items within a tag.\fP" +.RI "\fIReturns the number of items within a tag. \fP" .in -1c .SS "Protected Attributes" @@ -62,203 +66,257 @@ Inherits \fBclassbase\fP. .ti -1c .RI "std::stringstream * \fBcache\fP" .br -.RI "\fIThe contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).\fP" +.RI "\fIThe contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). \fP" +.ti -1c +.RI "std::stringstream * \fBerrorlog\fP" +.br .ti -1c .RI "bool \fBreaderror\fP" .br -.RI "\fIUsed to store errors.\fP" +.RI "\fIUsed to store errors. \fP" .ti -1c .RI "long \fBerror\fP" .br .in -1c .SH "Detailed Description" .PP -Allows 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. +Allows 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. It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read. .PP -Definition at line 618 of file modules.h. +Definition at line 641 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConfigReader::ConfigReader ()" .PP -Default constructor.This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 553 of file modules.cpp. +Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 566 of file modules.cpp. .PP -References cache, CONF_FILE_NOT_FOUND, error, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -554 { -555 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -556 this->readerror = LoadConf(CONFIG_FILE,this->cache); -557 if (!this->readerror) -558 this->error = CONF_FILE_NOT_FOUND; -559 } +567 { +568 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +569 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +570 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +571 if (!this->readerror) +572 this->error = CONF_FILE_NOT_FOUND; +573 } .fi .SS "ConfigReader::ConfigReader (std::string filename)" .PP -Overloaded constructor.This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 569 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 585 of file modules.cpp. .PP -References cache, CONF_FILE_NOT_FOUND, error, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -570 { -571 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -572 this->readerror = LoadConf(filename.c_str(),this->cache); -573 if (!this->readerror) -574 this->error = CONF_FILE_NOT_FOUND; -575 }; +586 { +587 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +588 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +589 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +590 if (!this->readerror) +591 this->error = CONF_FILE_NOT_FOUND; +592 }; .fi -.SS "ConfigReader::~ConfigReader ()" +.SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor.This method destroys the ConfigReader class.Definition at line 562 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 576 of file modules.cpp. .PP -References cache. +References cache, and errorlog. .PP .nf -563 { -564 if (this->cache) -565 delete this->cache; -566 } +577 { +578 if (this->cache) +579 delete this->cache; +580 if (this->errorlog) +581 delete this->errorlog; +582 } .fi .SH "Member Function Documentation" .PP -.SS "int ConfigReader::Enumerate (std::string tag)" +.SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)" .PP -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 \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 647 of file modules.cpp. +Dumps the list of errors in a config file to an output location. If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.Definition at line 663 of file modules.cpp. +.PP +References errorlog, connection::fd, and userrec::nick. .PP .nf -648 { -649 return EnumConf(cache,tag.c_str()); -650 } +664 { +665 if (bail) +666 { +667 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +668 exit(0); +669 } +670 else +671 { +672 char dataline[1024]; +673 if (user) +674 { +675 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +676 while (!errorlog->eof()) +677 { +678 errorlog->getline(dataline,1024); +679 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +680 } +681 } +682 else +683 { +684 WriteOpers('There were errors in the configuration file:',user->nick); +685 while (!errorlog->eof()) +686 { +687 errorlog->getline(dataline,1024); +688 WriteOpers(dataline); +689 } +690 } +691 return; +692 } +693 } .fi -.SS "int ConfigReader::EnumerateValues (std::string tag, int index)" +.SS "int ConfigReader::Enumerate (std::string tag)" +.PP +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 \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 696 of file modules.cpp. .PP -Returns the number of items within a tag.For example if the tag was then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 652 of file modules.cpp. +References cache. .PP .nf -653 { -654 return EnumValues(cache, tag.c_str(), index); -655 } +697 { +698 return EnumConf(cache,tag.c_str()); +699 } .fi -.SS "long ConfigReader::GetError ()" +.SS "int ConfigReader::EnumerateValues (std::string tag, int index)" .PP -Returns the last error to occur.Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 639 of file modules.cpp. +Returns the number of items within a tag. For example if the tag was then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 701 of file modules.cpp. .PP -References error. +References cache. .PP .nf -640 { -641 long olderr = this->error; -642 this->error = 0; -643 return olderr; -644 } +702 { +703 return EnumValues(cache, tag.c_str(), index); +704 } .fi -.SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)" +.SS "long ConfigReader::GetError ()" .PP -Retrieves a boolean value from the config file.This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 593 of file modules.cpp. +Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 656 of file modules.cpp. .PP -References CONF_VALUE_NOT_FOUND, and error. +References error. .PP .nf -594 { -595 char val[MAXBUF]; -596 char t[MAXBUF]; -597 char n[MAXBUF]; -598 strncpy(t,tag.c_str(),MAXBUF); -599 strncpy(n,name.c_str(),MAXBUF); -600 int res = ReadConf(cache,t,n,index,val); -601 if (!res) -602 { -603 this->error = CONF_VALUE_NOT_FOUND; -604 return false; -605 } -606 std::string s = val; -607 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -608 } +657 { +658 long olderr = this->error; +659 this->error = 0; +660 return olderr; +661 } .fi -.SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)" +.SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)" .PP -Retrieves an integer value from the config file.This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 610 of file modules.cpp. +Retrieves a boolean value from the config file. This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 610 of file modules.cpp. .PP -References CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. +References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf 611 { 612 char val[MAXBUF]; 613 char t[MAXBUF]; 614 char n[MAXBUF]; -615 strncpy(t,tag.c_str(),MAXBUF); -616 strncpy(n,name.c_str(),MAXBUF); +615 strlcpy(t,tag.c_str(),MAXBUF); +616 strlcpy(n,name.c_str(),MAXBUF); 617 int res = ReadConf(cache,t,n,index,val); 618 if (!res) 619 { 620 this->error = CONF_VALUE_NOT_FOUND; -621 return 0; +621 return false; 622 } -623 for (int i = 0; i < strlen(val); i++) -624 { -625 if (!isdigit(val[i])) -626 { -627 this->error = CONF_NOT_A_NUMBER; -628 return 0; -629 } -630 } -631 if ((needs_unsigned) && (atoi(val)<0)) -632 { -633 this->error = CONF_NOT_UNSIGNED; -634 return 0; -635 } -636 return atoi(val); -637 } +623 std::string s = val; +624 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +625 } +.fi +.SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)" +.PP +Retrieves an integer value from the config file. This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 627 of file modules.cpp. +.PP +References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. +.PP +.nf +628 { +629 char val[MAXBUF]; +630 char t[MAXBUF]; +631 char n[MAXBUF]; +632 strlcpy(t,tag.c_str(),MAXBUF); +633 strlcpy(n,name.c_str(),MAXBUF); +634 int res = ReadConf(cache,t,n,index,val); +635 if (!res) +636 { +637 this->error = CONF_VALUE_NOT_FOUND; +638 return 0; +639 } +640 for (int i = 0; i < strlen(val); i++) +641 { +642 if (!isdigit(val[i])) +643 { +644 this->error = CONF_NOT_A_NUMBER; +645 return 0; +646 } +647 } +648 if ((needs_unsigned) && (atoi(val)<0)) +649 { +650 this->error = CONF_NOT_UNSIGNED; +651 return 0; +652 } +653 return atoi(val); +654 } .fi .SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)" .PP -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 577 of file modules.cpp. +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 594 of file modules.cpp. .PP -References CONF_VALUE_NOT_FOUND, and error. +References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -578 { -579 char val[MAXBUF]; -580 char t[MAXBUF]; -581 char n[MAXBUF]; -582 strncpy(t,tag.c_str(),MAXBUF); -583 strncpy(n,name.c_str(),MAXBUF); -584 int res = ReadConf(cache,t,n,index,val); -585 if (!res) -586 { -587 this->error = CONF_VALUE_NOT_FOUND; -588 return ''; -589 } -590 return std::string(val); -591 } +595 { +596 char val[MAXBUF]; +597 char t[MAXBUF]; +598 char n[MAXBUF]; +599 strlcpy(t,tag.c_str(),MAXBUF); +600 strlcpy(n,name.c_str(),MAXBUF); +601 int res = ReadConf(cache,t,n,index,val); +602 if (!res) +603 { +604 this->error = CONF_VALUE_NOT_FOUND; +605 return ''; +606 } +607 return std::string(val); +608 } .fi .SS "bool ConfigReader::Verify ()" .PP -Returns true if a config file is valid.This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 657 of file modules.cpp. +Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 706 of file modules.cpp. .PP References readerror. .PP .nf -658 { -659 return this->readerror; -660 } +707 { +708 return this->readerror; +709 } .fi .SH "Member Data Documentation" .PP -.SS "std::stringstream* ConfigReader::cache\fC [protected]\fP" +.SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP" .PP -The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 626 of file modules.h. +The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 649 of file modules.h. .PP -Referenced by ConfigReader(), and ~ConfigReader(). -.SS "long ConfigReader::error\fC [protected]\fP" +Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). +.SS "long \fBConfigReader::error\fP\fC [protected]\fP" .PP -Definition at line 630 of file modules.h. +Definition at line 654 of file modules.h. .PP Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). -.SS "bool ConfigReader::readerror\fC [protected]\fP" +.SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP" +.PP +Definition at line 650 of file modules.h. +.PP +Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). +.SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP" .PP -Used to store errors.Definition at line 629 of file modules.h. +Used to store errors. Definition at line 653 of file modules.h. .PP Referenced by ConfigReader(), and Verify(). diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index beb774677..b19e07801 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,8 +1,8 @@ -.TH "ConnectClass" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ConnectClass \- Holds information relevent to and tags in the config file. +ConnectClass \- Holds information relevent to and tags in the config file. .PP .SH SYNOPSIS @@ -25,58 +25,68 @@ Inherits \fBclassbase\fP. .ti -1c .RI "int \fBtype\fP" .br -.RI "\fIType of line, either CC_ALLOW or CC_DENY.\fP" +.RI "\fIType of line, either CC_ALLOW or CC_DENY. \fP" .ti -1c .RI "int \fBregistration_timeout\fP" .br -.RI "\fIMax time to register the connection in seconds.\fP" +.RI "\fIMax time to register the connection in seconds. \fP" .ti -1c .RI "int \fBflood\fP" .br -.RI "\fINumber of lines in buffer before excess flood is triggered.\fP" +.RI "\fINumber of lines in buffer before excess flood is triggered. \fP" .ti -1c .RI "char \fBhost\fP [MAXBUF]" .br -.RI "\fIHost mask for this line.\fP" +.RI "\fIHost mask for this line. \fP" .ti -1c .RI "char \fBpass\fP [MAXBUF]" .br -.RI "\fI(Optional) Password for this line\fP" +.RI "\fI(Optional) Password for this line \fP" .in -1c .SH "Detailed Description" .PP -Holds information relevent to and tags in the config file.Definition at line 34 of file users.h. +Holds information relevent to and tags in the config file. Definition at line 45 of file users.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConnectClass::ConnectClass ()\fC [inline]\fP" .PP -Definition at line 53 of file users.h. +Definition at line 64 of file users.h. +.PP +References flood, host, pass, and registration_timeout. .PP .nf -54 { -55 registration_timeout = 0; -56 flood = 0; -57 strcpy(host,''); -58 strcpy(pass,''); -59 } +65 { +66 registration_timeout = 0; +67 flood = 0; +68 strlcpy(host,'',MAXBUF); +69 strlcpy(pass,'',MAXBUF); +70 } .fi .SH "Member Data Documentation" .PP -.SS "int ConnectClass::flood" +.SS "int \fBConnectClass::flood\fP" +.PP +Number of lines in buffer before excess flood is triggered. Definition at line 56 of file users.h. +.PP +Referenced by ConnectClass(). +.SS "char \fBConnectClass::host\fP[MAXBUF]" +.PP +Host mask for this line. Definition at line 59 of file users.h. +.PP +Referenced by ConnectClass(). +.SS "char \fBConnectClass::pass\fP[MAXBUF]" .PP -Number of lines in buffer before excess flood is triggered.Definition at line 45 of file users.h. -.SS "char ConnectClass::host[MAXBUF]" +(Optional) Password for this line Definition at line 62 of file users.h. .PP -Host mask for this line.Definition at line 48 of file users.h. -.SS "char ConnectClass::pass[MAXBUF]" +Referenced by ConnectClass(). +.SS "int \fBConnectClass::registration_timeout\fP" .PP -(Optional) Password for this lineDefinition at line 51 of file users.h. -.SS "int ConnectClass::registration_timeout" +Max time to register the connection in seconds. Definition at line 53 of file users.h. .PP -Max time to register the connection in seconds.Definition at line 42 of file users.h. -.SS "int ConnectClass::type" +Referenced by ConnectClass(). +.SS "int \fBConnectClass::type\fP" .PP -Type of line, either CC_ALLOW or CC_DENY.Definition at line 39 of file users.h. +Type of line, either CC_ALLOW or CC_DENY. Definition at line 50 of file users.h. .SH "Author" .PP diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index 94b9a29eb..39ecb407b 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,8 +1,8 @@ -.TH "ExemptItem" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ExemptItem \- A subclass of \fBHostItem\fP designed to hold channel exempts (+e). +ExemptItem \- A subclass of \fBHostItem\fP designed to hold channel exempts (+e). .PP .SH SYNOPSIS @@ -14,7 +14,7 @@ Inherits \fBHostItem\fP. .PP .SH "Detailed Description" .PP -A subclass of \fBHostItem\fP designed to hold channel exempts (+e).Definition at line 42 of file channels.h. +A subclass of \fBHostItem\fP designed to hold channel exempts (+e). Definition at line 53 of file channels.h. .SH "Author" .PP diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index d2da027f5..1be57e1ec 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -41,31 +41,31 @@ Inherits \fBclassbase\fP. .PP .SS "ExtMode::ExtMode (char mc, int ty, bool oper, int p_on, int p_off)\fC [inline]\fP" .PP -Definition at line 175 of file modules.cpp. +Definition at line 190 of file modules.cpp. .PP .nf -175 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +190 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; .fi .SH "Member Data Documentation" .PP -.SS "bool ExtMode::list" +.SS "bool \fBExtMode::list\fP" .PP -Definition at line 174 of file modules.cpp. -.SS "char ExtMode::modechar" +Definition at line 189 of file modules.cpp. +.SS "char \fBExtMode::modechar\fP" .PP -Definition at line 169 of file modules.cpp. -.SS "bool ExtMode::needsoper" +Definition at line 184 of file modules.cpp. +.SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 173 of file modules.cpp. -.SS "int ExtMode::params_when_off" +Definition at line 188 of file modules.cpp. +.SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 172 of file modules.cpp. -.SS "int ExtMode::params_when_on" +Definition at line 187 of file modules.cpp. +.SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 171 of file modules.cpp. -.SS "int ExtMode::type" +Definition at line 186 of file modules.cpp. +.SS "int \fBExtMode::type\fP" .PP -Definition at line 170 of file modules.cpp. +Definition at line 185 of file modules.cpp. .SH "Author" .PP diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index dc2356ca4..f234a10f9 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,8 +1,8 @@ -.TH "Extensible" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -Extensible \- class Extensible is the parent class of many classes such as userrec and chanrec. +Extensible \- class Extensible is the parent class of many classes such as userrec and chanrec. .PP .SH SYNOPSIS @@ -20,15 +20,15 @@ Inherited by \fBchanrec\fP, \fBcommand_t\fP, \fBconnection\fP, and \fBircd_conne .ti -1c .RI "bool \fBExtend\fP (std::string key, char *p)" .br -.RI "\fIExtend an Extensible class.\fP" +.RI "\fIExtend an Extensible class. \fP" .ti -1c .RI "bool \fBShrink\fP (std::string key)" .br -.RI "\fIShrink an Extensible class.\fP" +.RI "\fIShrink an Extensible class. \fP" .ti -1c .RI "char * \fBGetExt\fP (std::string key)" .br -.RI "\fIGet an extension item.\fP" +.RI "\fIGet an extension item. \fP" .in -1c .SS "Private Attributes" @@ -36,31 +36,31 @@ Inherited by \fBchanrec\fP, \fBcommand_t\fP, \fBconnection\fP, and \fBircd_conne .ti -1c .RI "std::map< std::string, char * > \fBExtension_Items\fP" .br -.RI "\fIPrivate data store.\fP" +.RI "\fIPrivate data store. \fP" .in -1c .SH "Detailed Description" .PP -class Extensible is the parent class of many classes such as userrec and chanrec. +class Extensible is the parent class of many classes such as userrec and chanrec. class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage). .PP -Definition at line 38 of file base.h. +Definition at line 50 of file base.h. .SH "Member Function Documentation" .PP .SS "bool Extensible::Extend (std::string key, char * p)" .PP -Extend an Extensible class.You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, \fBExtensible::Extend\fP will return false in this case. On successful extension, Extend returns true. +Extend an Extensible class. You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, \fBExtensible::Extend\fP will return false in this case. On successful extension, Extend returns true. .SS "char* Extensible::GetExt (std::string key)" .PP -Get an extension item.You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned. +Get an extension item. You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned. .SS "bool Extensible::Shrink (std::string key)" .PP -Shrink an Extensible class.You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success. +Shrink an Extensible class. You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success. .SH "Member Data Documentation" .PP -.SS "std::map Extensible::Extension_Items\fC [private]\fP" +.SS "std::map \fBExtensible::Extension_Items\fP\fC [private]\fP" .PP -Private data store.Definition at line 42 of file base.h. +Private data store. Definition at line 54 of file base.h. .SH "Author" .PP diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index ec0652118..60ee3d2dd 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,8 +1,8 @@ -.TH "FileReader" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -FileReader \- Caches a text file into memory and can be used to retrieve lines from it. +FileReader \- Caches a text file into memory and can be used to retrieve lines from it. .PP .SH SYNOPSIS @@ -18,31 +18,31 @@ Inherits \fBclassbase\fP. .ti -1c .RI "\fBFileReader\fP ()" .br -.RI "\fIDefault constructor.\fP" +.RI "\fIDefault constructor. \fP" .ti -1c .RI "\fBFileReader\fP (std::string filename)" .br -.RI "\fISecondary constructor.\fP" +.RI "\fISecondary constructor. \fP" .ti -1c .RI "\fB~FileReader\fP ()" .br -.RI "\fIDefault destructor.\fP" +.RI "\fIDefault destructor. \fP" .ti -1c .RI "void \fBLoadFile\fP (std::string filename)" .br -.RI "\fIUsed to load a file.\fP" +.RI "\fIUsed to load a file. \fP" .ti -1c .RI "bool \fBExists\fP ()" .br -.RI "\fIReturns true if the file exists This function will return false if the file could not be opened.\fP" +.RI "\fIReturns true if the file exists This function will return false if the file could not be opened. \fP" .ti -1c .RI "std::string \fBGetLine\fP (int x)" .br -.RI "\fIRetrieve one line from the file.\fP" +.RI "\fIRetrieve one line from the file. \fP" .ti -1c .RI "int \fBFileSize\fP ()" .br -.RI "\fIReturns the size of the file in lines.\fP" +.RI "\fIReturns the size of the file in lines. \fP" .in -1c .SS "Private Attributes" @@ -53,104 +53,104 @@ Inherits \fBclassbase\fP. .in -1c .SH "Detailed Description" .PP -Caches a text file into memory and can be used to retrieve lines from it. +Caches a text file into memory and can be used to retrieve lines from it. This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. .PP -Definition at line 699 of file modules.h. +Definition at line 730 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" .PP -Default constructor.This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 670 of file modules.cpp. +Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 719 of file modules.cpp. .PP .nf -671 { -672 } +720 { +721 } .fi .SS "FileReader::FileReader (std::string filename)" .PP -Secondary constructor.This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 663 of file modules.cpp. +Secondary constructor. This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 712 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -664 { -665 file_cache c; -666 readfile(c,filename.c_str()); -667 this->fc = c; -668 } +713 { +714 file_cache c; +715 readfile(c,filename.c_str()); +716 this->fc = c; +717 } .fi -.SS "FileReader::~FileReader ()" +.SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor.This deletes the memory allocated to the file.Definition at line 682 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 731 of file modules.cpp. .PP .nf -683 { -684 } +732 { +733 } .fi .SH "Member Function Documentation" .PP .SS "bool FileReader::Exists ()" .PP -Returns true if the file exists This function will return false if the file could not be opened.Definition at line 686 of file modules.cpp. +Returns true if the file exists This function will return false if the file could not be opened. Definition at line 735 of file modules.cpp. .PP References fc. .PP .nf -687 { -688 if (fc.size() == 0) -689 { -690 return(false); -691 } -692 else -693 { -694 return(true); -695 } -696 } +736 { +737 if (fc.size() == 0) +738 { +739 return(false); +740 } +741 else +742 { +743 return(true); +744 } +745 } .fi .SS "int FileReader::FileSize ()" .PP -Returns the size of the file in lines.This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.Definition at line 705 of file modules.cpp. +Returns the size of the file in lines. This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.Definition at line 754 of file modules.cpp. .PP References fc. .PP .nf -706 { -707 return fc.size(); -708 } +755 { +756 return fc.size(); +757 } .fi .SS "std::string FileReader::GetLine (int x)" .PP -Retrieve one line from the file.This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.Definition at line 698 of file modules.cpp. +Retrieve one line from the file. This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.Definition at line 747 of file modules.cpp. .PP References fc. .PP .nf -699 { -700 if ((x<0) || (x>fc.size())) -701 return ''; -702 return fc[x]; -703 } +748 { +749 if ((x<0) || (x>fc.size())) +750 return ''; +751 return fc[x]; +752 } .fi .SS "void FileReader::LoadFile (std::string filename)" .PP -Used to load a file.This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 674 of file modules.cpp. +Used to load a file. This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 723 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -675 { -676 file_cache c; -677 readfile(c,filename.c_str()); -678 this->fc = c; -679 } +724 { +725 file_cache c; +726 readfile(c,filename.c_str()); +727 this->fc = c; +728 } .fi .SH "Member Data Documentation" .PP -.SS "\fBfile_cache\fP FileReader::fc\fC [private]\fP" +.SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 701 of file modules.h. +Definition at line 732 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index 1808a91af..16bdc1fbf 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,8 +1,8 @@ -.TH "GLine" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -GLine \- GLine class. +GLine \- GLine class. .PP .SH SYNOPSIS @@ -18,16 +18,16 @@ Inherits \fBXLine\fP. .ti -1c .RI "char \fBhostmask\fP [MAXBUF]" .br -.RI "\fIHostmask (ident) to match against May contain wildcards.\fP" +.RI "\fIHostmask (ident) to match against May contain wildcards. \fP" .in -1c .SH "Detailed Description" .PP -GLine class.Definition at line 57 of file xline.h. +GLine class. Definition at line 73 of file xline.h. .SH "Member Data Documentation" .PP -.SS "char GLine::hostmask[MAXBUF]" +.SS "char \fBGLine::hostmask\fP[MAXBUF]" .PP -Hostmask (ident) to match against May contain wildcards.Definition at line 63 of file xline.h. +Hostmask (ident) to match against May contain wildcards. Definition at line 79 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index d8f7eb9ea..9f9171770 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,8 +1,8 @@ -.TH "HostItem" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -HostItem \- Holds an entry for a ban list, exemption list, or invite list. +HostItem \- Holds an entry for a ban list, exemption list, or invite list. .PP .SH SYNOPSIS @@ -39,38 +39,38 @@ Inherited by \fBBanItem\fP, \fBExemptItem\fP, and \fBInviteItem\fP. .in -1c .SH "Detailed Description" .PP -Holds an entry for a ban list, exemption list, or invite list. +Holds an entry for a ban list, exemption list, or invite list. This class contains a single element in a channel list, such as a banlist. .PP -Definition at line 18 of file channels.h. +Definition at line 29 of file channels.h. .SH "Constructor & Destructor Documentation" .PP .SS "HostItem::HostItem ()\fC [inline]\fP" .PP -Definition at line 25 of file channels.h. +Definition at line 36 of file channels.h. .PP .nf -25 { /* stub */ } +36 { /* stub */ } .fi -.SS "virtual HostItem::~HostItem ()\fC [inline, virtual]\fP" +.SS "virtual HostItem::~\fBHostItem\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 26 of file channels.h. +Definition at line 37 of file channels.h. .PP .nf -26 { /* stub */ } +37 { /* stub */ } .fi .SH "Member Data Documentation" .PP -.SS "char HostItem::data[MAXBUF]" +.SS "char \fBHostItem::data\fP[MAXBUF]" .PP -Definition at line 23 of file channels.h. -.SS "char HostItem::set_by[NICKMAX]" +Definition at line 34 of file channels.h. +.SS "char \fBHostItem::set_by\fP[NICKMAX]" .PP -Definition at line 22 of file channels.h. -.SS "time_t HostItem::set_time" +Definition at line 33 of file channels.h. +.SS "time_t \fBHostItem::set_time\fP" .PP -Definition at line 21 of file channels.h. +Definition at line 32 of file channels.h. .SH "Author" .PP diff --git a/docs/man/man3/InAddr_HashComp.3 b/docs/man/man3/InAddr_HashComp.3 index 6075e0457..01929e516 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,18 +17,18 @@ InAddr_HashComp \- .PP .SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const\fC [inline]\fP" .PP -Definition at line 135 of file modules.cpp. +Definition at line 150 of file modules.cpp. .PP .nf -136 { -137 size_t q; -138 size_t p; -139 -140 memcpy(&q,&s1,sizeof(size_t)); -141 memcpy(&p,&s2,sizeof(size_t)); -142 -143 return (q == p); -144 } +151 { +152 size_t q; +153 size_t p; +154 +155 memcpy(&q,&s1,sizeof(size_t)); +156 memcpy(&p,&s2,sizeof(size_t)); +157 +158 return (q == p); +159 } .fi diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 9687c48d5..8e1a1453a 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,8 +1,8 @@ -.TH "InviteItem" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -InviteItem \- A subclass of \fBHostItem\fP designed to hold channel invites (+I). +InviteItem \- A subclass of \fBHostItem\fP designed to hold channel invites (+I). .PP .SH SYNOPSIS @@ -14,7 +14,7 @@ Inherits \fBHostItem\fP. .PP .SH "Detailed Description" .PP -A subclass of \fBHostItem\fP designed to hold channel invites (+I).Definition at line 50 of file channels.h. +A subclass of \fBHostItem\fP designed to hold channel invites (+I). Definition at line 61 of file channels.h. .SH "Author" .PP diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index 3281a6887..a6e52eb0d 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,8 +1,8 @@ -.TH "Invited" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -Invited \- Holds a channel name to which a user has been invited. +Invited \- Holds a channel name to which a user has been invited. .PP .SH SYNOPSIS @@ -21,12 +21,12 @@ Inherits \fBclassbase\fP. .in -1c .SH "Detailed Description" .PP -Holds a channel name to which a user has been invited.Definition at line 25 of file users.h. +Holds a channel name to which a user has been invited. Definition at line 36 of file users.h. .SH "Member Data Documentation" .PP -.SS "char Invited::channel[CHANMAX]" +.SS "char \fBInvited::channel\fP[CHANMAX]" .PP -Definition at line 28 of file users.h. +Definition at line 39 of file users.h. .PP Referenced by userrec::InviteTo(). diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index ec00ca87d..7ce3c2dc7 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,8 +1,8 @@ -.TH "KLine" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -KLine \- KLine class. +KLine \- KLine class. .PP .SH SYNOPSIS @@ -18,16 +18,16 @@ Inherits \fBXLine\fP. .ti -1c .RI "char \fBhostmask\fP [MAXBUF]" .br -.RI "\fIHostmask (ident) to match against May contain wildcards.\fP" +.RI "\fIHostmask (ident) to match against May contain wildcards. \fP" .in -1c .SH "Detailed Description" .PP -KLine class.Definition at line 46 of file xline.h. +KLine class. Definition at line 62 of file xline.h. .SH "Member Data Documentation" .PP -.SS "char KLine::hostmask[MAXBUF]" +.SS "char \fBKLine::hostmask\fP[MAXBUF]" .PP -Hostmask (ident) to match against May contain wildcards.Definition at line 52 of file xline.h. +Hostmask (ident) to match against May contain wildcards. Definition at line 68 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 7d83d8d88..a3ae736f6 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,8 +1,8 @@ -.TH "ModeParameter" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ModeParameter \- Holds a custom parameter to a module-defined channel mode e.g. +ModeParameter \- Holds a custom parameter to a module-defined channel mode e.g. .PP .SH SYNOPSIS @@ -27,26 +27,26 @@ Inherits \fBclassbase\fP. .in -1c .SH "Detailed Description" .PP -Holds a custom parameter to a module-defined channel mode e.g. +Holds a custom parameter to a module-defined channel mode e.g. for +L this would hold the channel name. .PP -Definition at line 59 of file channels.h. +Definition at line 70 of file channels.h. .SH "Member Data Documentation" .PP -.SS "char ModeParameter::channel[CHANMAX]" +.SS "char \fBModeParameter::channel\fP[CHANMAX]" .PP -Definition at line 64 of file channels.h. +Definition at line 75 of file channels.h. .PP Referenced by chanrec::SetCustomModeParam(). -.SS "char ModeParameter::mode" +.SS "char \fBModeParameter::mode\fP" .PP -Definition at line 62 of file channels.h. +Definition at line 73 of file channels.h. .PP Referenced by chanrec::SetCustomModeParam(). -.SS "char ModeParameter::parameter[MAXBUF]" +.SS "char \fBModeParameter::parameter\fP[MAXBUF]" .PP -Definition at line 63 of file channels.h. +Definition at line 74 of file channels.h. .PP Referenced by chanrec::SetCustomModeParam(). diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index f48f1d650..1974eb93a 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,8 +1,8 @@ -.TH "Module" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -Module \- Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +Module \- Base class for all InspIRCd modules This class is the base class for InspIRCd modules. .PP .SH SYNOPSIS @@ -18,127 +18,131 @@ Inherits \fBclassbase\fP. .ti -1c .RI "\fBModule\fP ()" .br -.RI "\fIDefault constructor creates a module class.\fP" +.RI "\fIDefault constructor creates a module class. \fP" .ti -1c .RI "virtual \fB~Module\fP ()" .br -.RI "\fIDefault destructor destroys a module class.\fP" +.RI "\fIDefault destructor destroys a module class. \fP" .ti -1c .RI "virtual \fBVersion\fP \fBGetVersion\fP ()" .br -.RI "\fIReturns the version number of a Module.\fP" +.RI "\fIReturns the version number of a Module. \fP" .ti -1c .RI "virtual void \fBOnUserConnect\fP (\fBuserrec\fP *user)" .br -.RI "\fICalled when a user connects.\fP" +.RI "\fICalled when a user connects. \fP" .ti -1c .RI "virtual void \fBOnUserQuit\fP (\fBuserrec\fP *user)" .br -.RI "\fICalled when a user quits.\fP" +.RI "\fICalled when a user quits. \fP" .ti -1c .RI "virtual void \fBOnUserJoin\fP (\fBuserrec\fP *user, \fBchanrec\fP *channel)" .br -.RI "\fICalled when a user joins a channel.\fP" +.RI "\fICalled when a user joins a channel. \fP" .ti -1c .RI "virtual void \fBOnUserPart\fP (\fBuserrec\fP *user, \fBchanrec\fP *channel)" .br -.RI "\fICalled when a user parts a channel.\fP" +.RI "\fICalled when a user parts a channel. \fP" .ti -1c .RI "virtual void \fBOnPacketTransmit\fP (char *p)" .br -.RI "\fICalled before a packet is transmitted across the irc network between two irc servers.\fP" +.RI "\fICalled before a packet is transmitted across the irc network between two irc servers. \fP" .ti -1c .RI "virtual void \fBOnPacketReceive\fP (char *p)" .br -.RI "\fICalled after a packet is received from another irc server.\fP" +.RI "\fICalled after a packet is received from another irc server. \fP" .ti -1c .RI "virtual void \fBOnRehash\fP ()" .br -.RI "\fICalled on rehash.\fP" +.RI "\fICalled on rehash. \fP" .ti -1c .RI "virtual void \fBOnServerRaw\fP (std::string &raw, bool inbound, \fBuserrec\fP *user)" .br -.RI "\fICalled when a raw command is transmitted or received.\fP" +.RI "\fICalled when a raw command is transmitted or received. \fP" .ti -1c .RI "virtual int \fBOnExtendedMode\fP (\fBuserrec\fP *user, void *target, char modechar, int type, bool mode_on, \fBstring_list\fP ¶ms)" .br -.RI "\fICalled whenever an extended mode is to be processed.\fP" +.RI "\fICalled whenever an extended mode is to be processed. \fP" .ti -1c .RI "virtual int \fBOnUserPreJoin\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan, const char *cname)" .br -.RI "\fICalled whenever a user is about to join a channel, before any processing is done.\fP" +.RI "\fICalled whenever a user is about to join a channel, before any processing is done. \fP" .ti -1c .RI "virtual void \fBOnOper\fP (\fBuserrec\fP *user)" .br -.RI "\fICalled whenever a user opers locally.\fP" +.RI "\fICalled whenever a user opers locally. \fP" .ti -1c .RI "virtual void \fBOnInfo\fP (\fBuserrec\fP *user)" .br -.RI "\fICalled whenever a user types /INFO.\fP" +.RI "\fICalled whenever a user types /INFO. \fP" .ti -1c .RI "virtual void \fBOnWhois\fP (\fBuserrec\fP *source, \fBuserrec\fP *dest)" .br -.RI "\fICalled whenever a /WHOIS is performed on a local user.\fP" +.RI "\fICalled whenever a /WHOIS is performed on a local user. \fP" .ti -1c -.RI "virtual int \fBOnUserPreMessage\fP (\fBuserrec\fP *user, void *dest, int target_type, std::string text)" +.RI "virtual int \fBOnUserPreInvite\fP (\fBuserrec\fP *source, \fBuserrec\fP *dest, \fBchanrec\fP *channel)" .br -.RI "\fICalled whenever a user is about to PRIVMSG A user or a channel, before any processing is done.\fP" +.RI "\fICalled whenever a user is about to invite another user into a channel, before any processing is done. \fP" .ti -1c -.RI "virtual int \fBOnUserPreNotice\fP (\fBuserrec\fP *user, void *dest, int target_type, std::string text)" +.RI "virtual int \fBOnUserPreMessage\fP (\fBuserrec\fP *user, void *dest, int target_type, std::string &text)" .br -.RI "\fICalled whenever a user is about to NOTICE A user or a channel, before any processing is done.\fP" +.RI "\fICalled whenever a user is about to PRIVMSG A user or a channel, before any processing is done. \fP" +.ti -1c +.RI "virtual int \fBOnUserPreNotice\fP (\fBuserrec\fP *user, void *dest, int target_type, std::string &text)" +.br +.RI "\fICalled whenever a user is about to NOTICE A user or a channel, before any processing is done. \fP" .ti -1c .RI "virtual int \fBOnUserPreNick\fP (\fBuserrec\fP *user, std::string newnick)" .br -.RI "\fICalled before any nickchange, local or remote.\fP" +.RI "\fICalled before any nickchange, local or remote. \fP" .ti -1c .RI "virtual int \fBOnAccessCheck\fP (\fBuserrec\fP *source, \fBuserrec\fP *dest, \fBchanrec\fP *channel, int access_type)" .br -.RI "\fICalled before an action which requires a channel privilage check.\fP" +.RI "\fICalled before an action which requires a channel privilage check. \fP" .ti -1c .RI "virtual \fBstring_list\fP \fBOnUserSync\fP (\fBuserrec\fP *user)" .br -.RI "\fICalled during a netburst to sync user data.\fP" +.RI "\fICalled during a netburst to sync user data. \fP" .ti -1c .RI "virtual \fBstring_list\fP \fBOnChannelSync\fP (\fBchanrec\fP *chan)" .br -.RI "\fICalled during a netburst to sync channel data.\fP" +.RI "\fICalled during a netburst to sync channel data. \fP" .in -1c .SH "Detailed Description" .PP -Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +Base class for all InspIRCd modules This class is the base class for InspIRCd modules. All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the \fBModuleFactory\fP class (see relevent section) for the plugin to be initialised. .PP -Definition at line 116 of file modules.h. +Definition at line 126 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Module::Module ()" .PP -Default constructor creates a module class.Definition at line 285 of file modules.cpp. +Default constructor creates a module class. Definition at line 297 of file modules.cpp. .PP .nf -285 { } +297 { } .fi -.SS "Module::~Module ()\fC [virtual]\fP" +.SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class.Definition at line 286 of file modules.cpp. +Default destructor destroys a module class. Definition at line 298 of file modules.cpp. .PP .nf -286 { } +298 { } .fi .SH "Member Function Documentation" .PP .SS "\fBVersion\fP Module::GetVersion ()\fC [virtual]\fP" .PP -Returns the version number of a Module.The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 297 of file modules.cpp. +Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 309 of file modules.cpp. .PP .nf -297 { return Version(1,0,0,0); } +309 { return Version(1,0,0,0); } .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP -Called before an action which requires a channel privilage check.This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are: +Called before an action which requires a channel privilage check. This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are: .br .br @@ -162,148 +166,155 @@ Called before an action which requires a channel privilage check.This function i .br .br - Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 304 of file modules.cpp. + Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 317 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -304 { return ACR_DEFAULT; }; +317 { return ACR_DEFAULT; }; .fi .SS "\fBstring_list\fP Module::OnChannelSync (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called during a netburst to sync channel data.This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 306 of file modules.cpp. +Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 319 of file modules.cpp. .PP References string_list. .PP .nf -306 { string_list empty; return empty; } +319 { string_list empty; return empty; } .fi .SS "int Module::OnExtendedMode (\fBuserrec\fP * user, void * target, char modechar, int type, bool mode_on, \fBstring_list\fP & params)\fC [virtual]\fP" .PP -Called whenever an extended mode is to be processed.The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 296 of file modules.cpp. +Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 308 of file modules.cpp. .PP .nf -296 { return false; } +308 { return false; } .fi .SS "void Module::OnInfo (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user types /INFO.The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format: +Called whenever a user types /INFO. The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format: .PP - :information hereDefinition at line 299 of file modules.cpp. + :information hereDefinition at line 311 of file modules.cpp. .PP .nf -299 { }; +311 { }; .fi .SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user opers locally.The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 298 of file modules.cpp. +Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 310 of file modules.cpp. .PP .nf -298 { }; +310 { }; .fi .SS "void Module::OnPacketReceive (char * p)\fC [virtual]\fP" .PP -Called after a packet is received from another irc server.The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 292 of file modules.cpp. +Called after a packet is received from another irc server. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 304 of file modules.cpp. .PP .nf -292 { } +304 { } .fi .SS "void Module::OnPacketTransmit (char * p)\fC [virtual]\fP" .PP -Called before a packet is transmitted across the irc network between two irc servers.The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 291 of file modules.cpp. +Called before a packet is transmitted across the irc network between two irc servers. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 303 of file modules.cpp. .PP .nf -291 { } +303 { } .fi .SS "void Module::OnRehash ()\fC [virtual]\fP" .PP -Called on rehash.This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 293 of file modules.cpp. +Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 305 of file modules.cpp. .PP .nf -293 { } +305 { } .fi .SS "void Module::OnServerRaw (std::string & raw, bool inbound, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a raw command is transmitted or received.This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 294 of file modules.cpp. +Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 306 of file modules.cpp. .PP .nf -294 { } +306 { } .fi .SS "void Module::OnUserConnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user connects.The details of the connecting user are available to you in the parameter userrec *userDefinition at line 287 of file modules.cpp. +Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 299 of file modules.cpp. .PP .nf -287 { } +299 { } .fi .SS "void Module::OnUserJoin (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user joins a channel.The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 289 of file modules.cpp. +Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 301 of file modules.cpp. .PP .nf -289 { } +301 { } .fi .SS "void Module::OnUserPart (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user parts a channel.The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 290 of file modules.cpp. +Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 302 of file modules.cpp. +.PP +.nf +302 { } +.fi +.SS "int Module::OnUserPreInvite (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel)\fC [virtual]\fP" +.PP +Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 313 of file modules.cpp. .PP .nf -290 { } +313 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP -Called whenever a user is about to join a channel, before any processing is done.Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc. +Called whenever a user is about to join a channel, before any processing is done. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc. .PP IMPORTANT NOTE! .PP -If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 295 of file modules.cpp. +If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 307 of file modules.cpp. .PP .nf -295 { return 0; } +307 { return 0; } .fi -.SS "int Module::OnUserPreMessage (\fBuserrec\fP * user, void * dest, int target_type, std::string text)\fC [virtual]\fP" +.SS "int Module::OnUserPreMessage (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 301 of file modules.cpp. +Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 314 of file modules.cpp. .PP .nf -301 { return 0; }; +314 { return 0; }; .fi .SS "int Module::OnUserPreNick (\fBuserrec\fP * user, std::string newnick)\fC [virtual]\fP" .PP -Called before any nickchange, local or remote.This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 303 of file modules.cpp. +Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 316 of file modules.cpp. .PP .nf -303 { return 0; }; +316 { return 0; }; .fi -.SS "int Module::OnUserPreNotice (\fBuserrec\fP * user, void * dest, int target_type, std::string text)\fC [virtual]\fP" +.SS "int Module::OnUserPreNotice (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to NOTICE A user or a channel, before any processing is done.Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 302 of file modules.cpp. +Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 315 of file modules.cpp. .PP .nf -302 { return 0; }; +315 { return 0; }; .fi .SS "void Module::OnUserQuit (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user quits.The details of the exiting user are available to you in the parameter userrec *userDefinition at line 288 of file modules.cpp. +Called when a user quits. The details of the exiting user are available to you in the parameter userrec *userDefinition at line 300 of file modules.cpp. .PP .nf -288 { } +300 { } .fi .SS "\fBstring_list\fP Module::OnUserSync (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called during a netburst to sync user data.This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 305 of file modules.cpp. +Called during a netburst to sync user data. This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 318 of file modules.cpp. .PP References string_list. .PP .nf -305 { string_list empty; return empty; } +318 { string_list empty; return empty; } .fi .SS "void Module::OnWhois (\fBuserrec\fP * source, \fBuserrec\fP * dest)\fC [virtual]\fP" .PP -Called whenever a /WHOIS is performed on a local user.The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 300 of file modules.cpp. +Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 312 of file modules.cpp. .PP .nf -300 { }; +312 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 353f4cd7a..fcecbc9ee 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,8 +1,8 @@ -.TH "ModuleFactory" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ModuleFactory \- Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. +ModuleFactory \- Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. .PP .SH SYNOPSIS @@ -24,36 +24,36 @@ Inherits \fBclassbase\fP. .ti -1c .RI "virtual \fBModule\fP * \fBCreateModule\fP ()=0" .br -.RI "\fICreates a new module.\fP" +.RI "\fICreates a new module. \fP" .in -1c .SH "Detailed Description" .PP -Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. +Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules. .PP -Definition at line 754 of file modules.h. +Definition at line 785 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 757 of file modules.h. +Definition at line 788 of file modules.h. .PP .nf -757 { } +788 { } .fi -.SS "virtual ModuleFactory::~ModuleFactory ()\fC [inline, virtual]\fP" +.SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 758 of file modules.h. +Definition at line 789 of file modules.h. .PP .nf -758 { } +789 { } .fi .SH "Member Function Documentation" .PP .SS "virtual \fBModule\fP* ModuleFactory::CreateModule ()\fC [pure virtual]\fP" .PP -Creates a new module.Your inherited class of ModuleFactory must return a pointer to your \fBModule\fP class using this method. +Creates a new module. Your inherited class of ModuleFactory must return a pointer to your \fBModule\fP class using this method. .SH "Author" .PP diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index fefd462c3..bef14dac0 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,8 +1,8 @@ -.TH "QLine" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -QLine \- QLine class. +QLine \- QLine class. .PP .SH SYNOPSIS @@ -18,23 +18,23 @@ Inherits \fBXLine\fP. .ti -1c .RI "char \fBnick\fP [MAXBUF]" .br -.RI "\fINickname to match against.\fP" +.RI "\fINickname to match against. \fP" .ti -1c .RI "bool \fBis_global\fP" .br -.RI "\fISet if this is a global Z:line (e.g.\fP" +.RI "\fISet if this is a global Z:line (e.g. \fP" .in -1c .SH "Detailed Description" .PP -QLine class.Definition at line 83 of file xline.h. +QLine class. Definition at line 99 of file xline.h. .SH "Member Data Documentation" .PP -.SS "bool QLine::is_global" +.SS "bool \fBQLine::is_global\fP" .PP -Set if this is a global Z:line (e.g.it came from another server)Definition at line 93 of file xline.h. -.SS "char QLine::nick[MAXBUF]" +Set if this is a global Z:line (e.g. it came from another server)Definition at line 109 of file xline.h. +.SS "char \fBQLine::nick\fP[MAXBUF]" .PP -Nickname to match against.May contain wildcards.Definition at line 89 of file xline.h. +Nickname to match against. May contain wildcards.Definition at line 105 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 60026555c..93ea60a25 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,8 +1,8 @@ -.TH "Server" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -Server \- Allows 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. +Server \- Allows 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. .PP .SH SYNOPSIS @@ -18,193 +18,193 @@ Inherits \fBclassbase\fP. .ti -1c .RI "\fBServer\fP ()" .br -.RI "\fIDefault constructor.\fP" +.RI "\fIDefault constructor. \fP" .ti -1c .RI "virtual \fB~Server\fP ()" .br -.RI "\fIDefault destructor.\fP" +.RI "\fIDefault destructor. \fP" .ti -1c .RI "virtual void \fBSendOpers\fP (std::string s)" .br -.RI "\fISends text to all opers.\fP" +.RI "\fISends text to all opers. \fP" .ti -1c .RI "virtual void \fBLog\fP (int level, std::string s)" .br -.RI "\fIWrites a log string.\fP" +.RI "\fIWrites a log string. \fP" .ti -1c .RI "virtual void \fBSend\fP (int Socket, std::string s)" .br -.RI "\fISends a line of text down a TCP/IP socket.\fP" +.RI "\fISends a line of text down a TCP/IP socket. \fP" .ti -1c .RI "virtual void \fBSendServ\fP (int Socket, std::string s)" .br -.RI "\fISends text from the server to a socket.\fP" +.RI "\fISends text from the server to a socket. \fP" .ti -1c .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)" .br -.RI "\fISends text from a user to a socket.\fP" +.RI "\fISends text from a user to a socket. \fP" .ti -1c .RI "virtual void \fBSendTo\fP (\fBuserrec\fP *Source, \fBuserrec\fP *Dest, std::string s)" .br -.RI "\fISends text from a user to another user.\fP" +.RI "\fISends text from a user to another user. \fP" .ti -1c .RI "virtual void \fBSendChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Channel, std::string s, bool IncludeSender)" .br -.RI "\fISends text from a user to a channel (mulicast).\fP" +.RI "\fISends text from a user to a channel (mulicast). \fP" .ti -1c .RI "virtual bool \fBCommonChannels\fP (\fBuserrec\fP *u1, \fBuserrec\fP *u2)" .br -.RI "\fIReturns true if two users share a common channel.\fP" +.RI "\fIReturns true if two users share a common channel. \fP" .ti -1c .RI "virtual void \fBSendCommon\fP (\fBuserrec\fP *User, std::string text, bool IncludeSender)" .br -.RI "\fISends text from a user to one or more channels (mulicast).\fP" +.RI "\fISends text from a user to one or more channels (mulicast). \fP" .ti -1c .RI "virtual void \fBSendWallops\fP (\fBuserrec\fP *User, std::string text)" .br -.RI "\fISends a WALLOPS message.\fP" +.RI "\fISends a WALLOPS message. \fP" .ti -1c .RI "virtual bool \fBIsNick\fP (std::string nick)" .br -.RI "\fIReturns true if a nick is valid.\fP" +.RI "\fIReturns true if a nick is valid. \fP" .ti -1c .RI "virtual int \fBCountUsers\fP (\fBchanrec\fP *c)" .br -.RI "\fIReturns a count of the number of users on a channel.\fP" +.RI "\fIReturns a count of the number of users on a channel. \fP" .ti -1c .RI "virtual \fBuserrec\fP * \fBFindNick\fP (std::string nick)" .br -.RI "\fIAttempts to look up a nick and return a pointer to it.\fP" +.RI "\fIAttempts to look up a nick and return a pointer to it. \fP" .ti -1c .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)" .br -.RI "\fIAttempts to look up a channel and return a pointer to it.\fP" +.RI "\fIAttempts to look up a channel and return a pointer to it. \fP" .ti -1c .RI "virtual std::string \fBChanMode\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)" .br -.RI "\fIAttempts to look up a user's privilages on a channel.\fP" +.RI "\fIAttempts to look up a user's privilages on a channel. \fP" .ti -1c .RI "virtual bool \fBIsOnChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)" .br -.RI "\fIChecks if a user is on a channel.\fP" +.RI "\fIChecks if a user is on a channel. \fP" .ti -1c .RI "virtual std::string \fBGetServerName\fP ()" .br -.RI "\fIReturns the server name of the server where the module is loaded.\fP" +.RI "\fIReturns the server name of the server where the module is loaded. \fP" .ti -1c .RI "virtual std::string \fBGetNetworkName\fP ()" .br -.RI "\fIReturns the network name, global to all linked servers.\fP" +.RI "\fIReturns the network name, global to all linked servers. \fP" .ti -1c .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()" .br -.RI "\fIReturns the information of the server as returned by the /ADMIN command.\fP" +.RI "\fIReturns the information of the server as returned by the /ADMIN command. \fP" .ti -1c .RI "virtual bool \fBAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)" .br -.RI "\fIAdds an extended mode letter which is parsed by a module.\fP" +.RI "\fIAdds an extended mode letter which is parsed by a module. \fP" .ti -1c .RI "virtual bool \fBAddExtendedListMode\fP (char modechar)" .br -.RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion.\fP" +.RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion. \fP" .ti -1c .RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams)" .br -.RI "\fIAdds a command to the command table.\fP" +.RI "\fIAdds a command to the command table. \fP" .ti -1c .RI "virtual void \fBSendMode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br -.RI "\fISends a servermode.\fP" +.RI "\fISends a servermode. \fP" .ti -1c .RI "virtual void \fBSendToModeMask\fP (std::string modes, int flags, std::string text)" .br -.RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter.\fP" +.RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter. \fP" .ti -1c .RI "virtual \fBchanrec\fP * \fBJoinUserToChannel\fP (\fBuserrec\fP *user, std::string cname, std::string key)" .br -.RI "\fIForces a user to join a channel.\fP" +.RI "\fIForces a user to join a channel. \fP" .ti -1c .RI "virtual \fBchanrec\fP * \fBPartUserFromChannel\fP (\fBuserrec\fP *user, std::string cname, std::string reason)" .br -.RI "\fIForces a user to part a channel.\fP" +.RI "\fIForces a user to part a channel. \fP" .ti -1c .RI "virtual void \fBChangeUserNick\fP (\fBuserrec\fP *user, std::string nickname)" .br -.RI "\fIForces a user nickchange.\fP" +.RI "\fIForces a user nickchange. \fP" .ti -1c .RI "virtual void \fBQuitUser\fP (\fBuserrec\fP *user, std::string reason)" .br -.RI "\fIForces a user to quit with the specified reason.\fP" +.RI "\fIForces a user to quit with the specified reason. \fP" .ti -1c .RI "virtual bool \fBMatchText\fP (std::string sliteral, std::string spattern)" .br -.RI "\fIMatches text against a glob pattern.\fP" +.RI "\fIMatches text against a glob pattern. \fP" .ti -1c .RI "virtual void \fBCallCommandHandler\fP (std::string commandname, char **parameters, int pcnt, \fBuserrec\fP *user)" .br -.RI "\fICalls the handler for a command, either implemented by the core or by another module.\fP" +.RI "\fICalls the handler for a command, either implemented by the core or by another module. \fP" .ti -1c .RI "virtual void \fBChangeHost\fP (\fBuserrec\fP *user, std::string host)" .br -.RI "\fIChange displayed hostname of a user.\fP" +.RI "\fIChange displayed hostname of a user. \fP" .ti -1c .RI "virtual void \fBChangeGECOS\fP (\fBuserrec\fP *user, std::string gecos)" .br -.RI "\fIChange GECOS (fullname) of a user.\fP" +.RI "\fIChange GECOS (fullname) of a user. \fP" .ti -1c .RI "virtual bool \fBIsUlined\fP (std::string server)" .br -.RI "\fIReturns true if the servername you give is ulined.\fP" +.RI "\fIReturns true if the servername you give is ulined. \fP" .ti -1c .RI "virtual \fBchanuserlist\fP \fBGetUsers\fP (\fBchanrec\fP *chan)" .br -.RI "\fIFetches the userlist of a channel.\fP" +.RI "\fIFetches the userlist of a channel. \fP" .in -1c .SH "Detailed Description" .PP -Allows 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. +Allows 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. All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. .PP -Definition at line 314 of file modules.h. +Definition at line 337 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor.Creates a Server object.Definition at line 313 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 326 of file modules.cpp. .PP .nf -314 { -315 } +327 { +328 } .fi -.SS "Server::~Server ()\fC [virtual]\fP" +.SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor.Destroys a Server object.Definition at line 317 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 330 of file modules.cpp. .PP .nf -318 { -319 } +331 { +332 } .fi .SH "Member Function Documentation" .PP .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams)\fC [virtual]\fP" .PP -Adds a command to the command table.This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc: +Adds a command to the command table. This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc: .PP typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP .PP -When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.Definition at line 394 of file modules.cpp. +When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.Definition at line 407 of file modules.cpp. .PP References createcommand(). .PP .nf -395 { -396 createcommand(cmd,f,flags,minparams); -397 } +408 { +409 createcommand(cmd,f,flags,minparams); +410 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP -Adds an extended mode letter which is parsed by a module and handled in a list fashion.This call is used to implement modes like +q and +a. The characteristics of these modes are as follows: +Adds an extended mode letter which is parsed by a module and handled in a list fashion. This call is used to implement modes like +q and +a. The characteristics of these modes are as follows: .PP (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL .PP @@ -214,329 +214,329 @@ Adds an extended mode letter which is parsed by a module and handled in a list f .PP (4) The mode and its parameter are NOT stored in the channels modes structure .PP -It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 539 of file modules.cpp. +It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 552 of file modules.cpp. .PP -References DoAddExtendedMode(), and ModeMakeList(). +References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -540 { -541 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -542 if (res) -543 ModeMakeList(modechar); -544 return res; -545 } +553 { +554 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +555 if (res) +556 ModeMakeList(modechar); +557 return res; +558 } .fi .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP" .PP -Adds an extended mode letter which is parsed by a module.This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 519 of file modules.cpp. -.PP -References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. -.PP -.nf -520 { -521 if (type == MT_SERVER) -522 { -523 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -524 return false; -525 } -526 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -527 { -528 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -529 return false; -530 } -531 if ((params_when_on>1) || (params_when_off>1)) -532 { -533 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -534 return false; -535 } -536 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -537 } +Adds an extended mode letter which is parsed by a module. This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 532 of file modules.cpp. +.PP +References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. +.PP +.nf +533 { +534 if (type == MT_SERVER) +535 { +536 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +537 return false; +538 } +539 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +540 { +541 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +542 return false; +543 } +544 if ((params_when_on>1) || (params_when_off>1)) +545 { +546 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +547 return false; +548 } +549 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +550 } .fi .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Calls the handler for a command, either implemented by the core or by another module.You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or +Calls the handler for a command, either implemented by the core or by another module. You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or .br -) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 384 of file modules.cpp. +) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 397 of file modules.cpp. .PP .nf -385 { -386 call_handler(commandname.c_str(),parameters,pcnt,user); -387 } +398 { +399 call_handler(commandname.c_str(),parameters,pcnt,user); +400 } .fi .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP" .PP -Change GECOS (fullname) of a user.You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 472 of file modules.cpp. +Change GECOS (fullname) of a user. You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 485 of file modules.cpp. .PP References ChangeName(). .PP .nf -473 { -474 ChangeName(user,gecos.c_str()); -475 } +486 { +487 ChangeName(user,gecos.c_str()); +488 } .fi .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP" .PP -Change displayed hostname of a user.You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 467 of file modules.cpp. +Change displayed hostname of a user. You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 480 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -468 { -469 ChangeDisplayedHost(user,host.c_str()); -470 } +481 { +482 ChangeDisplayedHost(user,host.c_str()); +483 } .fi .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP" .PP -Forces a user nickchange.This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 368 of file modules.cpp. +Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 381 of file modules.cpp. .PP .nf -369 { -370 force_nickchange(user,nickname.c_str()); -371 } +382 { +383 force_nickchange(user,nickname.c_str()); +384 } .fi .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Attempts to look up a user's privilages on a channel.This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 492 of file modules.cpp. +Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 505 of file modules.cpp. .PP References cmode(). .PP .nf -493 { -494 return cmode(User,Chan); -495 } +506 { +507 return cmode(User,Chan); +508 } .fi .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP" .PP -Returns true if two users share a common channel.This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 445 of file modules.cpp. +Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 458 of file modules.cpp. .PP References common_channels(). .PP .nf -446 { -447 return (common_channels(u1,u2) != 0); -448 } +459 { +460 return (common_channels(u1,u2) != 0); +461 } .fi .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP" .PP -Returns a count of the number of users on a channel.This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 547 of file modules.cpp. +Returns a count of the number of users on a channel. This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 560 of file modules.cpp. .PP .nf -548 { -549 return usercount(c); -550 } +561 { +562 return usercount(c); +563 } .fi .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP" .PP -Attempts to look up a channel and return a pointer to it.This function will return NULL if the channel does not exist.Definition at line 487 of file modules.cpp. +Attempts to look up a channel and return a pointer to it. This function will return NULL if the channel does not exist.Definition at line 500 of file modules.cpp. .PP .nf -488 { -489 return FindChan(channel.c_str()); -490 } +501 { +502 return FindChan(channel.c_str()); +503 } .fi .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP" .PP -Attempts to look up a nick and return a pointer to it.This function will return NULL if the nick does not exist.Definition at line 482 of file modules.cpp. +Attempts to look up a nick and return a pointer to it. This function will return NULL if the nick does not exist.Definition at line 495 of file modules.cpp. .PP .nf -483 { -484 return Find(nick); -485 } +496 { +497 return Find(nick); +498 } .fi .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP" .PP -Returns the information of the server as returned by the /ADMIN command.See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 512 of file modules.cpp. +Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 525 of file modules.cpp. .PP .nf -513 { -514 return Admin(getadminname(),getadminemail(),getadminnick()); -515 } +526 { +527 return Admin(getadminname(),getadminemail(),getadminnick()); +528 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers.Definition at line 507 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 520 of file modules.cpp. .PP .nf -508 { -509 return getnetworkname(); -510 } +521 { +522 return getnetworkname(); +523 } .fi .SS "std::string Server::GetServerName ()\fC [virtual]\fP" .PP -Returns the server name of the server where the module is loaded.Definition at line 502 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 515 of file modules.cpp. .PP .nf -503 { -504 return getservername(); -505 } +516 { +517 return getservername(); +518 } .fi .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Fetches the userlist of a channel.This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 349 of file modules.cpp. +Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 362 of file modules.cpp. .PP References chanuserlist, clientlist, has_channel(), and isnick(). .PP .nf -350 { -351 chanuserlist userl; -352 userl.clear(); -353 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -354 { -355 if (i->second) -356 { -357 if (has_channel(i->second,chan)) -358 { -359 if (isnick(i->second->nick)) -360 { -361 userl.push_back(i->second); -362 } -363 } -364 } -365 } -366 return userl; -367 } +363 { +364 chanuserlist userl; +365 userl.clear(); +366 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) +367 { +368 if (i->second) +369 { +370 if (has_channel(i->second,chan)) +371 { +372 if (isnick(i->second->nick)) +373 { +374 userl.push_back(i->second); +375 } +376 } +377 } +378 } +379 return userl; +380 } .fi .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP" .PP -Returns true if a nick is valid.Nicks for unregistered connections will return false.Definition at line 477 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 490 of file modules.cpp. .PP References isnick(). .PP .nf -478 { -479 return (isnick(nick.c_str()) != 0); -480 } +491 { +492 return (isnick(nick.c_str()) != 0); +493 } .fi .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Checks if a user is on a channel.This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 497 of file modules.cpp. +Checks if a user is on a channel. This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 510 of file modules.cpp. .PP References has_channel(). .PP .nf -498 { -499 return has_channel(User,Chan); -500 } +511 { +512 return has_channel(User,Chan); +513 } .fi .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP" .PP -Returns true if the servername you give is ulined.ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 379 of file modules.cpp. +Returns true if the servername you give is ulined. ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 392 of file modules.cpp. .PP References is_uline(). .PP .nf -380 { -381 return is_uline(server.c_str()); -382 } +393 { +394 return is_uline(server.c_str()); +395 } .fi .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP" .PP -Forces a user to join a channel.This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 339 of file modules.cpp. +Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 352 of file modules.cpp. .PP .nf -340 { -341 return add_channel(user,cname.c_str(),key.c_str(),true); -342 } +353 { +354 return add_channel(user,cname.c_str(),key.c_str(),true); +355 } .fi .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP" .PP -Writes a log string.This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 389 of file modules.cpp. +Writes a log string. This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 402 of file modules.cpp. .PP .nf -390 { -391 log(level,'%s',s.c_str()); -392 } +403 { +404 log(level,'%s',s.c_str()); +405 } .fi .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP" .PP -Matches text against a glob pattern.Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 326 of file modules.cpp. +Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 339 of file modules.cpp. .PP .nf -327 { -328 char literal[MAXBUF],pattern[MAXBUF]; -329 strncpy(literal,sliteral.c_str(),MAXBUF); -330 strncpy(pattern,spattern.c_str(),MAXBUF); -331 return match(literal,pattern); -332 } +340 { +341 char literal[MAXBUF],pattern[MAXBUF]; +342 strlcpy(literal,sliteral.c_str(),MAXBUF); +343 strlcpy(pattern,spattern.c_str(),MAXBUF); +344 return match(literal,pattern); +345 } .fi .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP" .PP -Forces a user to part a channel.This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 344 of file modules.cpp. +Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 357 of file modules.cpp. .PP .nf -345 { -346 return del_channel(user,cname.c_str(),reason.c_str(),false); -347 } +358 { +359 return del_channel(user,cname.c_str(),reason.c_str(),false); +360 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP -Forces a user to quit with the specified reason.To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file. +Forces a user to quit with the specified reason. To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file. .PP WARNING! .PP -Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 373 of file modules.cpp. +Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 386 of file modules.cpp. .PP References userrec::nick, and send_network_quit(). .PP .nf -374 { -375 send_network_quit(user->nick,reason.c_str()); -376 kill_link(user,reason.c_str()); -377 } +387 { +388 send_network_quit(user->nick,reason.c_str()); +389 kill_link(user,reason.c_str()); +390 } .fi .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP" .PP -Sends a line of text down a TCP/IP socket.This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 404 of file modules.cpp. +Sends a line of text down a TCP/IP socket. This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 417 of file modules.cpp. .PP .nf -405 { -406 Write(Socket,'%s',s.c_str()); -407 } +418 { +419 Write(Socket,'%s',s.c_str()); +420 } .fi .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP" .PP -Sends text from a user to a channel (mulicast).This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 433 of file modules.cpp. +Sends text from a user to a channel (mulicast). This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 446 of file modules.cpp. .PP .nf -434 { -435 if (IncludeSender) -436 { -437 WriteChannel(Channel,User,'%s',s.c_str()); -438 } -439 else -440 { -441 ChanExceptSender(Channel,User,'%s',s.c_str()); -442 } -443 } +447 { +448 if (IncludeSender) +449 { +450 WriteChannel(Channel,User,'%s',s.c_str()); +451 } +452 else +453 { +454 ChanExceptSender(Channel,User,'%s',s.c_str()); +455 } +456 } .fi .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP" .PP -Sends text from a user to one or more channels (mulicast).This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 450 of file modules.cpp. +Sends text from a user to one or more channels (mulicast). This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 463 of file modules.cpp. .PP .nf -451 { -452 if (IncludeSender) -453 { -454 WriteCommon(User,'%s',text.c_str()); -455 } -456 else -457 { -458 WriteCommonExcept(User,'%s',text.c_str()); -459 } -460 } +464 { +465 if (IncludeSender) +466 { +467 WriteCommon(User,'%s',text.c_str()); +468 } +469 else +470 { +471 WriteCommonExcept(User,'%s',text.c_str()); +472 } +473 } .fi .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP" .PP -Sends text from a user to a socket.This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 414 of file modules.cpp. +Sends text from a user to a socket. This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 427 of file modules.cpp. .PP .nf -415 { -416 WriteFrom(Socket,User,'%s',s.c_str()); -417 } +428 { +429 WriteFrom(Socket,User,'%s',s.c_str()); +430 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Sends a servermode.you must format the parameters array with the target, modes and parameters for those modes. +Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes. .PP For example: .PP @@ -550,36 +550,36 @@ modes[2] = user->nick; .PP Srv->SendMode(modes,3,user); .PP -The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 399 of file modules.cpp. +The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 412 of file modules.cpp. .PP References server_mode(). .PP .nf -400 { -401 server_mode(parameters,pcnt,user); -402 } +413 { +414 server_mode(parameters,pcnt,user); +415 } .fi .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP" .PP -Sends text to all opers.This method sends a server notice to all opers with the usermode +s.Definition at line 321 of file modules.cpp. +Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 334 of file modules.cpp. .PP .nf -322 { -323 WriteOpers('%s',s.c_str()); -324 } +335 { +336 WriteOpers('%s',s.c_str()); +337 } .fi .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP" .PP -Sends text from the server to a socket.This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 409 of file modules.cpp. +Sends text from the server to a socket. This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 422 of file modules.cpp. .PP .nf -410 { -411 WriteServ(Socket,'%s',s.c_str()); -412 } +423 { +424 WriteServ(Socket,'%s',s.c_str()); +425 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP -Sends text from a user to another user.This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of: +Sends text from a user to another user. This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of: .PP :user!ident TEXT .PP @@ -587,45 +587,45 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 419 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 432 of file modules.cpp. .PP References connection::fd. .PP .nf -420 { -421 if (!Source) -422 { -423 // if source is NULL, then the message originates from the local server -424 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -425 } -426 else -427 { -428 // otherwise it comes from the user specified -429 WriteTo(Source,Dest,'%s',s.c_str()); -430 } -431 } +433 { +434 if (!Source) +435 { +436 // if source is NULL, then the message originates from the local server +437 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +438 } +439 else +440 { +441 // otherwise it comes from the user specified +442 WriteTo(Source,Dest,'%s',s.c_str()); +443 } +444 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP -Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use: +Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use: .PP Serv->SendToModeMask('xi', WM_OR, 'm00'); .PP -Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 334 of file modules.cpp. +Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 347 of file modules.cpp. .PP .nf -335 { -336 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -337 } +348 { +349 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +350 } .fi .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP" .PP -Sends a WALLOPS message.This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 462 of file modules.cpp. +Sends a WALLOPS message. This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 475 of file modules.cpp. .PP .nf -463 { -464 WriteWallOps(User,false,'%s',text.c_str()); -465 } +476 { +477 WriteWallOps(User,false,'%s',text.c_str()); +478 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 953b79a2c..138cf2edb 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,15 +17,15 @@ StrHashComp \- .PP .SS "bool StrHashComp::operator() (const string & s1, const string & s2) const\fC [inline]\fP" .PP -Definition at line 122 of file modules.cpp. +Definition at line 137 of file modules.cpp. .PP .nf -123 { -124 char a[MAXBUF],b[MAXBUF]; -125 strcpy(a,s1.c_str()); -126 strcpy(b,s2.c_str()); -127 return (strcasecmp(a,b) == 0); -128 } +138 { +139 char a[MAXBUF],b[MAXBUF]; +140 strlcpy(a,s1.c_str(),MAXBUF); +141 strlcpy(b,s2.c_str(),MAXBUF); +142 return (strcasecmp(a,b) == 0); +143 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index d62906a16..2f44abcd1 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,8 +1,8 @@ -.TH "Version" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -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. +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. .PP .SH SYNOPSIS @@ -37,34 +37,34 @@ Inherits \fBclassbase\fP. .in -1c .SH "Detailed Description" .PP -Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. +Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. A class of type Version is returned by the GetVersion method of the \fBModule\fP class. .PP -Definition at line 92 of file modules.h. +Definition at line 102 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Version::Version (int major, int minor, int revision, int build)" .PP -Definition at line 279 of file modules.cpp. +Definition at line 291 of file modules.cpp. .PP .nf -279 : Major(major), Minor(minor), Revision(revision), Build(build) { }; +291 : Major(major), Minor(minor), Revision(revision), Build(build) { }; .fi .SH "Member Data Documentation" .PP -.SS "const int Version::Build" +.SS "const int \fBVersion::Build\fP" .PP -Definition at line 95 of file modules.h. -.SS "const int Version::Major" +Definition at line 105 of file modules.h. +.SS "const int \fBVersion::Major\fP" .PP -Definition at line 95 of file modules.h. -.SS "const int Version::Minor" +Definition at line 105 of file modules.h. +.SS "const int \fBVersion::Minor\fP" .PP -Definition at line 95 of file modules.h. -.SS "const int Version::Revision" +Definition at line 105 of file modules.h. +.SS "const int \fBVersion::Revision\fP" .PP -Definition at line 95 of file modules.h. +Definition at line 105 of file modules.h. .SH "Author" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 8c2c1ca02..3dcffb0b1 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,8 +1,8 @@ -.TH "XLine" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -XLine \- XLine is the base class for ban lines such as G lines and K lines. +XLine \- XLine is the base class for ban lines such as G lines and K lines. .PP .SH SYNOPSIS @@ -20,44 +20,44 @@ Inherited by \fBGLine\fP, \fBKLine\fP, \fBQLine\fP, and \fBZLine\fP. .ti -1c .RI "time_t \fBset_time\fP" .br -.RI "\fIThe time the line was added.\fP" +.RI "\fIThe time the line was added. \fP" .ti -1c .RI "long \fBduration\fP" .br -.RI "\fIThe duration of the ban, or 0 if permenant.\fP" +.RI "\fIThe duration of the ban, or 0 if permenant. \fP" .ti -1c .RI "char \fBsource\fP [MAXBUF]" .br -.RI "\fISource of the ban.\fP" +.RI "\fISource of the ban. \fP" .ti -1c .RI "char \fBreason\fP [MAXBUF]" .br -.RI "\fIReason for the ban.\fP" +.RI "\fIReason for the ban. \fP" .ti -1c .RI "long \fBn_matches\fP" .br -.RI "\fINumber of times the core matches the ban, for statistics.\fP" +.RI "\fINumber of times the core matches the ban, for statistics. \fP" .in -1c .SH "Detailed Description" .PP -XLine is the base class for ban lines such as G lines and K lines.Definition at line 18 of file xline.h. +XLine is the base class for ban lines such as G lines and K lines. Definition at line 34 of file xline.h. .SH "Member Data Documentation" .PP -.SS "long XLine::duration" +.SS "long \fBXLine::duration\fP" .PP -The duration of the ban, or 0 if permenant.Definition at line 28 of file xline.h. -.SS "long XLine::n_matches" +The duration of the ban, or 0 if permenant. Definition at line 44 of file xline.h. +.SS "long \fBXLine::n_matches\fP" .PP -Number of times the core matches the ban, for statistics.Definition at line 40 of file xline.h. -.SS "char XLine::reason[MAXBUF]" +Number of times the core matches the ban, for statistics. Definition at line 56 of file xline.h. +.SS "char \fBXLine::reason\fP[MAXBUF]" .PP -Reason for the ban.Definition at line 36 of file xline.h. -.SS "time_t XLine::set_time" +Reason for the ban. Definition at line 52 of file xline.h. +.SS "time_t \fBXLine::set_time\fP" .PP -The time the line was added.Definition at line 24 of file xline.h. -.SS "char XLine::source[MAXBUF]" +The time the line was added. Definition at line 40 of file xline.h. +.SS "char \fBXLine::source\fP[MAXBUF]" .PP -Source of the ban.This can be a servername or an oper nicknameDefinition at line 32 of file xline.h. +Source of the ban. This can be a servername or an oper nicknameDefinition at line 48 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index ddb27e9b1..99a67a12f 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,8 +1,8 @@ -.TH "ZLine" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ZLine \- ZLine class. +ZLine \- ZLine class. .PP .SH SYNOPSIS @@ -18,23 +18,23 @@ Inherits \fBXLine\fP. .ti -1c .RI "char \fBipaddr\fP [MAXBUF]" .br -.RI "\fIIP Address (xx.yy.zz.aa) to match against May contain wildcards.\fP" +.RI "\fIIP Address (xx.yy.zz.aa) to match against May contain wildcards. \fP" .ti -1c .RI "bool \fBis_global\fP" .br -.RI "\fISet if this is a global Z:line (e.g.\fP" +.RI "\fISet if this is a global Z:line (e.g. \fP" .in -1c .SH "Detailed Description" .PP -ZLine class.Definition at line 68 of file xline.h. +ZLine class. Definition at line 84 of file xline.h. .SH "Member Data Documentation" .PP -.SS "char ZLine::ipaddr[MAXBUF]" +.SS "char \fBZLine::ipaddr\fP[MAXBUF]" .PP -IP Address (xx.yy.zz.aa) to match against May contain wildcards.Definition at line 74 of file xline.h. -.SS "bool ZLine::is_global" +IP Address (xx.yy.zz.aa) to match against May contain wildcards. Definition at line 90 of file xline.h. +.SS "bool \fBZLine::is_global\fP" .PP -Set if this is a global Z:line (e.g.it came from another server)Definition at line 78 of file xline.h. +Set if this is a global Z:line (e.g. it came from another server)Definition at line 94 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/base.h.3 b/docs/man/man3/base.h.3 index 64b58a308..3ab34e375 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -21,11 +21,11 @@ base.h \- .ti -1c .RI "class \fBclassbase\fP" .br -.RI "\fIThe base class for all inspircd classes.\fP" +.RI "\fIThe base class for all inspircd classes. \fP" .ti -1c .RI "class \fBExtensible\fP" .br -.RI "\fIclass Extensible is the parent class of many classes such as userrec and chanrec.\fP" +.RI "\fIclass Extensible is the parent class of many classes such as userrec and chanrec. \fP" .in -1c .SS "Typedefs" @@ -36,9 +36,9 @@ base.h \- .in -1c .SH "Typedef Documentation" .PP -.SS "typedef void* VoidPointer" +.SS "typedef void* \fBVoidPointer\fP" .PP -Definition at line 13 of file base.h. +Definition at line 25 of file base.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/channels.cpp.3 b/docs/man/man3/channels.cpp.3 index f1fe73602..929482350 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -166,9 +166,6 @@ channels.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 @@ -203,125 +200,124 @@ channels.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 41 of file channels.cpp. +Definition at line 57 of file channels.cpp. .SH "Variable Documentation" .PP -.SS "char AdminEmail[MAXBUF]" +.SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 55 of file channels.cpp. -.SS "char AdminName[MAXBUF]" +Definition at line 71 of file channels.cpp. +.SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 54 of file channels.cpp. -.SS "char AdminNick[MAXBUF]" +Definition at line 70 of file channels.cpp. +.SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 56 of file channels.cpp. -.SS "std::vector auth_cookies" +Definition at line 72 of file channels.cpp. +.SS "std::vector \fBauth_cookies\fP" .PP -Definition at line 84 of file channels.cpp. -.SS "char bannerBuffer[MAXBUF]" +Definition at line 99 of file channels.cpp. +.SS "int \fBboundPortCount\fP" .PP -Definition at line 77 of file channels.cpp. -.SS "int boundPortCount" +Definition at line 93 of file channels.cpp. +.SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 78 of file channels.cpp. -.SS "std::stringstream config_f" +Definition at line 100 of file channels.cpp. .PP -Definition at line 85 of file channels.cpp. -.SS "std::vector<\fBModeParameter\fP> custom_mode_params" +Referenced by userrec::HasPermission(). +.SS "std::vector<\fBModeParameter\fP> \fBcustom_mode_params\fP" .PP -Definition at line 94 of file channels.cpp. +Definition at line 109 of file channels.cpp. .PP Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam(). -.SS "int debugging" +.SS "int \fBdebugging\fP" .PP -Definition at line 65 of file channels.cpp. -.SS "int defaultRoute" +Definition at line 81 of file channels.cpp. +.SS "int \fBdefaultRoute\fP" .PP -Definition at line 82 of file channels.cpp. -.SS "int DieDelay" +Definition at line 97 of file channels.cpp. +.SS "int \fBDieDelay\fP" .PP -Definition at line 68 of file channels.cpp. -.SS "char diepass[MAXBUF]" +Definition at line 84 of file channels.cpp. +.SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 57 of file channels.cpp. -.SS "char DieValue[MAXBUF]" +Definition at line 73 of file channels.cpp. +.SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 63 of file channels.cpp. +Definition at line 79 of file channels.cpp. .SS "vector<\fBircd_module\fP*> factory" .PP -Definition at line 48 of file channels.cpp. -.SS "std::vector fd_reap" +Definition at line 64 of file channels.cpp. +.SS "std::vector \fBfd_reap\fP" .PP -Definition at line 74 of file channels.cpp. -.SS "char list[MAXBUF]" +Definition at line 90 of file channels.cpp. +.SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 61 of file channels.cpp. -.SS "FILE* log_file" -.PP -Definition at line 89 of file channels.cpp. -.SS "int LogLevel" +Definition at line 77 of file channels.cpp. +.SS "FILE* \fBlog_file\fP" .PP -Definition at line 50 of file channels.cpp. -.SS "int MaxWhoResults" +Definition at line 104 of file channels.cpp. +.SS "int \fBLogLevel\fP" .PP -Definition at line 71 of file channels.cpp. -.SS "\fBserverrec\fP* me[32]" +Definition at line 66 of file channels.cpp. +.SS "int \fBMaxWhoResults\fP" .PP Definition at line 87 of file channels.cpp. -.SS "int MODCOUNT = -1" +.SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 714 of file modules.cpp. -.SS "std::vector module_names" +Definition at line 102 of file channels.cpp. +.SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 75 of file channels.cpp. +Definition at line 763 of file modules.cpp. +.SS "std::vector \fBmodule_names\fP" +.PP +Definition at line 91 of file channels.cpp. .SS "vector<\fBModule\fP*> modules" .PP -Definition at line 47 of file channels.cpp. -.SS "char motd[MAXBUF]" +Definition at line 63 of file channels.cpp. +.SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 59 of file channels.cpp. -.SS "time_t nb_start" +Definition at line 75 of file channels.cpp. +.SS "time_t \fBnb_start\fP" .PP -Definition at line 72 of file channels.cpp. -.SS "int NetBufferSize" +Definition at line 88 of file channels.cpp. +.SS "int \fBNetBufferSize\fP" .PP -Definition at line 70 of file channels.cpp. -.SS "char Network[MAXBUF]" +Definition at line 86 of file channels.cpp. +.SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 52 of file channels.cpp. -.SS "int portCount" +Definition at line 68 of file channels.cpp. +.SS "int \fBportCount\fP" .PP -Definition at line 79 of file channels.cpp. -.SS "int ports[MAXSOCKS]" +Definition at line 94 of file channels.cpp. +.SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 81 of file channels.cpp. -.SS "char PrefixQuit[MAXBUF]" +Definition at line 96 of file channels.cpp. +.SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 62 of file channels.cpp. -.SS "char restartpass[MAXBUF]" +Definition at line 78 of file channels.cpp. +.SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 58 of file channels.cpp. -.SS "char rules[MAXBUF]" +Definition at line 74 of file channels.cpp. +.SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 60 of file channels.cpp. -.SS "char ServerDesc[MAXBUF]" +Definition at line 76 of file channels.cpp. +.SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 53 of file channels.cpp. -.SS "char ServerName[MAXBUF]" +Definition at line 69 of file channels.cpp. +.SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 51 of file channels.cpp. -.SS "time_t startup_time" +Definition at line 67 of file channels.cpp. +.SS "time_t \fBstartup_time\fP" .PP -Definition at line 69 of file channels.cpp. -.SS "int UDPportCount" +Definition at line 85 of file channels.cpp. +.SS "int \fBUDPportCount\fP" .PP -Definition at line 80 of file channels.cpp. -.SS "int WHOWAS_MAX" +Definition at line 95 of file channels.cpp. +.SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 67 of file channels.cpp. -.SS "int WHOWAS_STALE" +Definition at line 83 of file channels.cpp. +.SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 66 of file channels.cpp. +Definition at line 82 of file channels.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index bae8d2f2a..fa8009f18 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -23,31 +23,31 @@ channels.h \- .ti -1c .RI "class \fBBanItem\fP" .br -.RI "\fIA subclass of \fBHostItem\fP designed to hold channel bans (+b).\fP" +.RI "\fIA subclass of \fBHostItem\fP designed to hold channel bans (+b). \fP" .ti -1c .RI "class \fBchanrec\fP" .br -.RI "\fIHolds all relevent information for a channel.\fP" +.RI "\fIHolds all relevent information for a channel. \fP" .ti -1c .RI "class \fBExemptItem\fP" .br -.RI "\fIA subclass of \fBHostItem\fP designed to hold channel exempts (+e).\fP" +.RI "\fIA subclass of \fBHostItem\fP designed to hold channel exempts (+e). \fP" .ti -1c .RI "class \fBHostItem\fP" .br -.RI "\fIHolds an entry for a ban list, exemption list, or invite list.\fP" +.RI "\fIHolds an entry for a ban list, exemption list, or invite list. \fP" .ti -1c .RI "class \fBInviteItem\fP" .br -.RI "\fIA subclass of \fBHostItem\fP designed to hold channel invites (+I).\fP" +.RI "\fIA subclass of \fBHostItem\fP designed to hold channel invites (+I). \fP" .ti -1c .RI "class \fBModeParameter\fP" .br -.RI "\fIHolds a custom parameter to a module-defined channel mode e.g.\fP" +.RI "\fIHolds a custom parameter to a module-defined channel mode e.g. \fP" .ti -1c .RI "class \fBucrec\fP" .br -.RI "\fIHolds 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.\fP" +.RI "\fIHolds 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. \fP" .in -1c .SS "Defines" @@ -74,44 +74,44 @@ channels.h \- .ti -1c .RI "typedef std::vector< \fBBanItem\fP > \fBBanList\fP" .br -.RI "\fIHolds a complete ban list.\fP" +.RI "\fIHolds a complete ban list. \fP" .ti -1c .RI "typedef std::vector< \fBExemptItem\fP > \fBExemptList\fP" .br -.RI "\fIHolds a complete exempt list.\fP" +.RI "\fIHolds a complete exempt list. \fP" .ti -1c .RI "typedef std::vector< \fBInviteItem\fP > \fBInviteList\fP" .br -.RI "\fIHolds a complete invite list.\fP" +.RI "\fIHolds a complete invite list. \fP" .in -1c .SH "Define Documentation" .PP .SS "#define UCMODE_FOUNDER 16" .PP -Definition at line 184 of file channels.h. +Definition at line 195 of file channels.h. .SS "#define UCMODE_HOP 4" .PP -Definition at line 182 of file channels.h. +Definition at line 193 of file channels.h. .SS "#define UCMODE_OP 1" .PP -Definition at line 180 of file channels.h. +Definition at line 191 of file channels.h. .SS "#define UCMODE_PROTECT 8" .PP -Definition at line 183 of file channels.h. +Definition at line 194 of file channels.h. .SS "#define UCMODE_VOICE 2" .PP -Definition at line 181 of file channels.h. +Definition at line 192 of file channels.h. .SH "Typedef Documentation" .PP -.SS "typedef std::vector<\fBBanItem\fP> BanList" +.SS "typedef std::vector<\fBBanItem\fP> \fBBanList\fP" .PP -Holds a complete ban list.Definition at line 69 of file channels.h. -.SS "typedef std::vector<\fBExemptItem\fP> ExemptList" +Holds a complete ban list. Definition at line 80 of file channels.h. +.SS "typedef std::vector<\fBExemptItem\fP> \fBExemptList\fP" .PP -Holds a complete exempt list.Definition at line 73 of file channels.h. -.SS "typedef std::vector<\fBInviteItem\fP> InviteList" +Holds a complete exempt list. Definition at line 84 of file channels.h. +.SS "typedef std::vector<\fBInviteItem\fP> \fBInviteList\fP" .PP -Holds a complete invite list.Definition at line 77 of file channels.h. +Holds a complete invite list. Definition at line 88 of file channels.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 203c96ce0..afac25b94 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,8 +1,8 @@ -.TH "chanrec" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -chanrec \- Holds all relevent information for a channel. +chanrec \- Holds all relevent information for a channel. .PP .SH SYNOPSIS @@ -18,23 +18,23 @@ Inherits \fBExtensible\fP. .ti -1c .RI "void \fBSetCustomMode\fP (char mode, bool mode_on)" .br -.RI "\fISets or unsets a custom mode in the channels info.\fP" +.RI "\fISets or unsets a custom mode in the channels info. \fP" .ti -1c .RI "void \fBSetCustomModeParam\fP (char mode, char *parameter, bool mode_on)" .br -.RI "\fISets or unsets the parameters for a custom mode in a channels info.\fP" +.RI "\fISets or unsets the parameters for a custom mode in a channels info. \fP" .ti -1c .RI "bool \fBIsCustomModeSet\fP (char mode)" .br -.RI "\fIReturns true if a custom mode is set on a channel.\fP" +.RI "\fIReturns true if a custom mode is set on a channel. \fP" .ti -1c .RI "std::string \fBGetModeParameter\fP (char mode)" .br -.RI "\fIReturns the parameter for a custom mode on a channel.\fP" +.RI "\fIReturns the parameter for a custom mode on a channel. \fP" .ti -1c .RI "\fBchanrec\fP ()" .br -.RI "\fICreates a channel record and initialises it with default values.\fP" +.RI "\fICreates a channel record and initialises it with default values. \fP" .ti -1c .RI "virtual \fB~chanrec\fP ()" .br @@ -45,267 +45,274 @@ Inherits \fBExtensible\fP. .ti -1c .RI "char \fBname\fP [CHANMAX]" .br -.RI "\fIThe channels name.\fP" +.RI "\fIThe channels name. \fP" .ti -1c .RI "char \fBcustom_modes\fP [MAXMODES]" .br -.RI "\fICustom modes for the channel.\fP" +.RI "\fICustom modes for the channel. \fP" .ti -1c .RI "char \fBtopic\fP [MAXBUF]" .br -.RI "\fIChannel topic.\fP" +.RI "\fIChannel topic. \fP" .ti -1c .RI "time_t \fBcreated\fP" .br -.RI "\fICreation time.\fP" +.RI "\fICreation time. \fP" .ti -1c .RI "time_t \fBtopicset\fP" .br -.RI "\fITime topic was set.\fP" +.RI "\fITime topic was set. \fP" .ti -1c .RI "char \fBsetby\fP [NICKMAX]" .br -.RI "\fIThe last user to set the topic.\fP" +.RI "\fIThe last user to set the topic. \fP" .ti -1c .RI "long \fBlimit\fP" .br -.RI "\fIContains the channel user limit.\fP" +.RI "\fIContains the channel user limit. \fP" .ti -1c .RI "char \fBkey\fP [32]" .br -.RI "\fIContains the channel key.\fP" +.RI "\fIContains the channel key. \fP" .ti -1c .RI "short int \fBtopiclock\fP" .br -.RI "\fINonzero if the mode +t is set.\fP" +.RI "\fINonzero if the mode +t is set. \fP" .ti -1c .RI "short int \fBnoexternal\fP" .br -.RI "\fINonzero if the mode +n is set.\fP" +.RI "\fINonzero if the mode +n is set. \fP" .ti -1c .RI "short int \fBinviteonly\fP" .br -.RI "\fINonzero if the mode +i is set.\fP" +.RI "\fINonzero if the mode +i is set. \fP" .ti -1c .RI "short int \fBmoderated\fP" .br -.RI "\fINonzero if the mode +m is set.\fP" +.RI "\fINonzero if the mode +m is set. \fP" .ti -1c .RI "short int \fBsecret\fP" .br -.RI "\fINonzero if the mode +s is set.\fP" +.RI "\fINonzero if the mode +s is set. \fP" .ti -1c .RI "short int \fBc_private\fP" .br -.RI "\fINonzero if the mode +p is set.\fP" +.RI "\fINonzero if the mode +p is set. \fP" .ti -1c .RI "\fBBanList\fP \fBbans\fP" .br -.RI "\fIThe list of all bans set on the channel.\fP" +.RI "\fIThe list of all bans set on the channel. \fP" .in -1c .SH "Detailed Description" .PP -Holds all relevent information for a channel. +Holds all relevent information for a channel. This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type. .PP -Definition at line 83 of file channels.h. +Definition at line 94 of file channels.h. .SH "Constructor & Destructor Documentation" .PP .SS "chanrec::chanrec ()" .PP -Creates a channel record and initialises it with default values.Definition at line 96 of file channels.cpp. +Creates a channel record and initialises it with default values. Definition at line 111 of file channels.cpp. .PP -References c_private, created, inviteonly, limit, moderated, noexternal, secret, topiclock, and topicset. +References c_private, created, custom_modes, inviteonly, key, limit, moderated, name, noexternal, secret, setby, topic, topiclock, and topicset. .PP .nf -97 { -98 strcpy(name,''); -99 strcpy(custom_modes,''); -100 strcpy(topic,''); -101 strcpy(setby,''); -102 strcpy(key,''); -103 created = topicset = limit = 0; -104 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; -105 } +112 { +113 strcpy(name,''); +114 strcpy(custom_modes,''); +115 strcpy(topic,''); +116 strcpy(setby,''); +117 strcpy(key,''); +118 created = topicset = limit = 0; +119 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; +120 } .fi -.SS "virtual chanrec::~chanrec ()\fC [inline, virtual]\fP" +.SS "virtual chanrec::~\fBchanrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 174 of file channels.h. +Definition at line 185 of file channels.h. .PP .nf -174 { /* stub */ } +185 { /* stub */ } .fi .SH "Member Function Documentation" .PP .SS "std::string chanrec::GetModeParameter (char mode)" .PP -Returns the parameter for a custom mode on a channel.For example if '+L #foo' is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.Definition at line 172 of file channels.cpp. +Returns the parameter for a custom mode on a channel. For example if '+L #foo' is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.Definition at line 184 of file channels.cpp. .PP References custom_mode_params. .PP .nf -173 { -174 if (custom_mode_params.size()) -175 { -176 for (vector::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) -177 { -178 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) -179 { -180 return std::string(i->parameter); -181 } -182 } -183 } -184 return std::string(''); -185 } +185 { +186 if (custom_mode_params.size()) +187 { +188 for (vector::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +189 { +190 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +191 { +192 return std::string(i->parameter); +193 } +194 } +195 } +196 return std::string(''); +197 } .fi .SS "bool chanrec::IsCustomModeSet (char mode)" .PP -Returns true if a custom mode is set on a channel.Definition at line 166 of file channels.cpp. +Returns true if a custom mode is set on a channel. Definition at line 178 of file channels.cpp. +.PP +References DEBUG. .PP .nf -167 { -168 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); -169 return (strchr(this->custom_modes,mode) != 0); -170 } +179 { +180 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); +181 return (strchr(this->custom_modes,mode) != 0); +182 } .fi .SS "void chanrec::SetCustomMode (char mode, bool mode_on)" .PP -Sets or unsets a custom mode in the channels info.Definition at line 107 of file channels.cpp. +Sets or unsets a custom mode in the channels info. Definition at line 122 of file channels.cpp. .PP -References custom_modes, and SetCustomModeParam(). +References custom_modes, DEBUG, and SetCustomModeParam(). .PP .nf -108 { -109 if (mode_on) { -110 char m[3]; -111 m[0] = mode; -112 m[1] = '\0'; -113 if (!strchr(this->custom_modes,mode)) -114 { -115 strncat(custom_modes,m,MAXMODES); -116 } -117 log(DEBUG,'Custom mode %c set',mode); -118 } -119 else { -120 char temp[MAXBUF]; -121 int count = 0; -122 for (int q = 0; q < strlen(custom_modes); q++) { -123 if (custom_modes[q] != mode) { -124 temp[count++] = mode; -125 } -126 } -127 temp[count] = '\0'; -128 strncpy(custom_modes,temp,MAXMODES); -129 log(DEBUG,'Custom mode %c removed',mode); -130 this->SetCustomModeParam(mode,'',false); -131 } -132 } +123 { +124 if (mode_on) { +125 char m[3]; +126 m[0] = mode; +127 m[1] = '\0'; +128 if (!strchr(this->custom_modes,mode)) +129 { +130 strlcat(custom_modes,m,MAXMODES); +131 } +132 log(DEBUG,'Custom mode %c set',mode); +133 } +134 else { +135 +136 std::string a = this->custom_modes; +137 int pos = a.find(mode); +138 a.erase(pos,1); +139 strncpy(this->custom_modes,a.c_str(),MAXMODES); +140 +141 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); +142 this->SetCustomModeParam(mode,'',false); +143 } +144 } .fi .SS "void chanrec::SetCustomModeParam (char mode, char * parameter, bool mode_on)" .PP -Sets or unsets the parameters for a custom mode in a channels info.Definition at line 135 of file channels.cpp. +Sets or unsets the parameters for a custom mode in a channels info. Definition at line 147 of file channels.cpp. .PP -References ModeParameter::channel, custom_mode_params, ModeParameter::mode, and ModeParameter::parameter. +References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter. .PP Referenced by SetCustomMode(). .PP .nf -136 { -137 -138 log(DEBUG,'SetCustomModeParam called'); -139 ModeParameter M; -140 M.mode = mode; -141 strcpy(M.channel,this->name); -142 strcpy(M.parameter,parameter); -143 if (mode_on) -144 { -145 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); -146 custom_mode_params.push_back(M); -147 } -148 else -149 { -150 if (custom_mode_params.size()) -151 { -152 for (vector::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) -153 { -154 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) -155 { -156 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); -157 custom_mode_params.erase(i); -158 return; -159 } -160 } -161 } -162 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); -163 } -164 } +148 { +149 +150 log(DEBUG,'SetCustomModeParam called'); +151 ModeParameter M; +152 M.mode = mode; +153 strlcpy(M.channel,this->name,CHANMAX); +154 strlcpy(M.parameter,parameter,MAXBUF); +155 if (mode_on) +156 { +157 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); +158 custom_mode_params.push_back(M); +159 } +160 else +161 { +162 if (custom_mode_params.size()) +163 { +164 for (vector::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +165 { +166 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +167 { +168 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); +169 custom_mode_params.erase(i); +170 return; +171 } +172 } +173 } +174 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); +175 } +176 } .fi .SH "Member Data Documentation" .PP -.SS "\fBBanList\fP chanrec::bans" +.SS "\fBBanList\fP \fBchanrec::bans\fP" .PP -The list of all bans set on the channel.Definition at line 148 of file channels.h. -.SS "short int chanrec::c_private" +The list of all bans set on the channel. Definition at line 159 of file channels.h. +.SS "short int \fBchanrec::c_private\fP" .PP -Nonzero if the mode +p is set.This value cannot be set at the same time as \fBchanrec::secret\fPDefinition at line 144 of file channels.h. +Nonzero if the mode +p is set. This value cannot be set at the same time as \fBchanrec::secret\fPDefinition at line 155 of file channels.h. .PP Referenced by chanrec(). -.SS "time_t chanrec::created" +.SS "time_t \fBchanrec::created\fP" .PP -Creation time.Definition at line 100 of file channels.h. +Creation time. Definition at line 111 of file channels.h. .PP Referenced by chanrec(). -.SS "char chanrec::custom_modes[MAXMODES]" +.SS "char \fBchanrec::custom_modes\fP[MAXMODES]" .PP -Custom modes for the channel.Plugins may use this field in any way they see fit.Definition at line 92 of file channels.h. +Custom modes for the channel. Plugins may use this field in any way they see fit.Definition at line 103 of file channels.h. .PP -Referenced by SetCustomMode(). -.SS "short int chanrec::inviteonly" +Referenced by chanrec(), and SetCustomMode(). +.SS "short int \fBchanrec::inviteonly\fP" +.PP +Nonzero if the mode +i is set. Definition at line 141 of file channels.h. +.PP +Referenced by chanrec(). +.SS "char \fBchanrec::key\fP[32]" .PP -Nonzero if the mode +i is set.Definition at line 130 of file channels.h. +Contains the channel key. If this value is an empty string, there is no channel key in place.Definition at line 129 of file channels.h. .PP Referenced by chanrec(). -.SS "char chanrec::key[32]" +.SS "long \fBchanrec::limit\fP" .PP -Contains the channel key.If this value is an empty string, there is no channel key in place.Definition at line 118 of file channels.h. -.SS "long chanrec::limit" +Contains the channel user limit. If this value is zero, there is no limit in place.Definition at line 124 of file channels.h. .PP -Contains the channel user limit.If this value is zero, there is no limit in place.Definition at line 113 of file channels.h. +Referenced by chanrec(). +.SS "short int \fBchanrec::moderated\fP" +.PP +Nonzero if the mode +m is set. Definition at line 145 of file channels.h. .PP Referenced by chanrec(). -.SS "short int chanrec::moderated" +.SS "char \fBchanrec::name\fP[CHANMAX]" .PP -Nonzero if the mode +m is set.Definition at line 134 of file channels.h. +The channels name. Definition at line 99 of file channels.h. .PP Referenced by chanrec(). -.SS "char chanrec::name[CHANMAX]" +.SS "short int \fBchanrec::noexternal\fP" .PP -The channels name.Definition at line 88 of file channels.h. -.SS "short int chanrec::noexternal" +Nonzero if the mode +n is set. Definition at line 137 of file channels.h. .PP -Nonzero if the mode +n is set.Definition at line 126 of file channels.h. +Referenced by chanrec(). +.SS "short int \fBchanrec::secret\fP" +.PP +Nonzero if the mode +s is set. This value cannot be set at the same time as \fBchanrec::c_private\fPDefinition at line 150 of file channels.h. .PP Referenced by chanrec(). -.SS "short int chanrec::secret" +.SS "char \fBchanrec::setby\fP[NICKMAX]" .PP -Nonzero if the mode +s is set.This value cannot be set at the same time as \fBchanrec::c_private\fPDefinition at line 139 of file channels.h. +The last user to set the topic. If this member is an empty string, no topic was ever set.Definition at line 119 of file channels.h. .PP Referenced by chanrec(). -.SS "char chanrec::setby[NICKMAX]" +.SS "char \fBchanrec::topic\fP[MAXBUF]" .PP -The last user to set the topic.If this member is an empty string, no topic was ever set.Definition at line 108 of file channels.h. -.SS "char chanrec::topic[MAXBUF]" +Channel topic. If this is an empty string, no channel topic is set.Definition at line 108 of file channels.h. .PP -Channel topic.If this is an empty string, no channel topic is set.Definition at line 97 of file channels.h. -.SS "short int chanrec::topiclock" +Referenced by chanrec(). +.SS "short int \fBchanrec::topiclock\fP" .PP -Nonzero if the mode +t is set.Definition at line 122 of file channels.h. +Nonzero if the mode +t is set. Definition at line 133 of file channels.h. .PP Referenced by chanrec(). -.SS "time_t chanrec::topicset" +.SS "time_t \fBchanrec::topicset\fP" .PP -Time topic was set.If no topic was ever set, this will be equal to \fBchanrec::created\fPDefinition at line 104 of file channels.h. +Time topic was set. If no topic was ever set, this will be equal to \fBchanrec::created\fPDefinition at line 115 of file channels.h. .PP Referenced by chanrec(). diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index f0b468217..7cf12b51d 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,8 +1,8 @@ -.TH "classbase" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -classbase \- The base class for all inspircd classes. +classbase \- The base class for all inspircd classes. .PP .SH SYNOPSIS @@ -18,7 +18,7 @@ Inherited by \fBAdmin\fP, \fBConfigReader\fP, \fBConnectClass\fP, \fBExtensible\ .ti -1c .RI "\fBclassbase\fP ()" .br -.RI "\fIConstructor, Sets the object's time.\fP" +.RI "\fIConstructor, Sets the object's time. \fP" .ti -1c .RI "\fB~classbase\fP ()" .br @@ -29,32 +29,36 @@ Inherited by \fBAdmin\fP, \fBConfigReader\fP, \fBConnectClass\fP, \fBExtensible\ .ti -1c .RI "time_t \fBage\fP" .br -.RI "\fITime that the object was instantiated (used for TS calculation etc).\fP" +.RI "\fITime that the object was instantiated (used for TS calculation etc). \fP" .in -1c .SH "Detailed Description" .PP -The base class for all inspircd classes.Definition at line 17 of file base.h. +The base class for all inspircd classes. Definition at line 29 of file base.h. .SH "Constructor & Destructor Documentation" .PP .SS "classbase::classbase ()\fC [inline]\fP" .PP -Constructor, Sets the object's time.Definition at line 27 of file base.h. +Constructor, Sets the object's time. Definition at line 39 of file base.h. +.PP +References age. .PP .nf -27 { age = time(NULL); } +39 { age = time(NULL); } .fi -.SS "classbase::~classbase ()\fC [inline]\fP" +.SS "classbase::~\fBclassbase\fP ()\fC [inline]\fP" .PP -Definition at line 28 of file base.h. +Definition at line 40 of file base.h. .PP .nf -28 { } +40 { } .fi .SH "Member Data Documentation" .PP -.SS "time_t classbase::age" +.SS "time_t \fBclassbase::age\fP" +.PP +Time that the object was instantiated (used for TS calculation etc). Definition at line 34 of file base.h. .PP -Time that the object was instantiated (used for TS calculation etc).Definition at line 22 of file base.h. +Referenced by classbase(). .SH "Author" .PP diff --git a/docs/man/man3/command_t.3 b/docs/man/man3/command_t.3 index 8f3229494..fd4aad7f1 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,8 +1,8 @@ -.TH "command_t" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -command_t \- A structure that defines a command. +command_t \- A structure that defines a command. .PP .SH SYNOPSIS @@ -18,51 +18,51 @@ Inherits \fBExtensible\fP. .ti -1c .RI "char \fBcommand\fP [MAXBUF]" .br -.RI "\fICommand name.\fP" +.RI "\fICommand name. \fP" .ti -1c .RI "handlerfunc * \fBhandler_function\fP" .br -.RI "\fIHandler function as in typedef.\fP" +.RI "\fIHandler function as in typedef. \fP" .ti -1c .RI "char \fBflags_needed\fP" .br -.RI "\fIUser flags needed to execute the command or 0.\fP" +.RI "\fIUser flags needed to execute the command or 0. \fP" .ti -1c .RI "int \fBmin_params\fP" .br -.RI "\fIMinimum number of parameters command takes.\fP" +.RI "\fIMinimum number of parameters command takes. \fP" .ti -1c .RI "long \fBuse_count\fP" .br -.RI "\fIused by /stats m\fP" +.RI "\fIused by /stats m \fP" .ti -1c .RI "long \fBtotal_bytes\fP" .br -.RI "\fIused by /stats m\fP" +.RI "\fIused by /stats m \fP" .in -1c .SH "Detailed Description" .PP -A structure that defines a command.Definition at line 25 of file ctables.h. +A structure that defines a command. Definition at line 26 of file ctables.h. .SH "Member Data Documentation" .PP -.SS "char command_t::command[MAXBUF]" +.SS "char \fBcommand_t::command\fP[MAXBUF]" .PP -Command name.Definition at line 30 of file ctables.h. -.SS "char command_t::flags_needed" +Command name. Definition at line 31 of file ctables.h. +.SS "char \fBcommand_t::flags_needed\fP" .PP -User flags needed to execute the command or 0.Definition at line 36 of file ctables.h. -.SS "handlerfunc* command_t::handler_function" +User flags needed to execute the command or 0. Definition at line 37 of file ctables.h. +.SS "handlerfunc* \fBcommand_t::handler_function\fP" .PP -Handler function as in typedef.Definition at line 33 of file ctables.h. -.SS "int command_t::min_params" +Handler function as in typedef. Definition at line 34 of file ctables.h. +.SS "int \fBcommand_t::min_params\fP" .PP -Minimum number of parameters command takes.Definition at line 39 of file ctables.h. -.SS "long command_t::total_bytes" +Minimum number of parameters command takes. Definition at line 40 of file ctables.h. +.SS "long \fBcommand_t::total_bytes\fP" .PP -used by /stats mDefinition at line 45 of file ctables.h. -.SS "long command_t::use_count" +used by /stats m Definition at line 46 of file ctables.h. +.SS "long \fBcommand_t::use_count\fP" .PP -used by /stats mDefinition at line 42 of file ctables.h. +used by /stats m Definition at line 43 of file ctables.h. .SH "Author" .PP diff --git a/docs/man/man3/commands.h.3 b/docs/man/man3/commands.h.3 index 7a226017d..d3a0c3c89 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -29,7 +29,7 @@ commands.h \- .ti -1c .RI "void \fBhandle_join\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br -.RI "\fIThese are the handlers for user commands.\fP" +.RI "\fIThese are the handlers for user commands. \fP" .ti -1c .RI "void \fBhandle_part\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br @@ -171,14 +171,14 @@ commands.h \- .ti -1c .RI "void \fBhandle_link_packet\fP (char *udp_msg, char *tcp_host, \fBserverrec\fP *serv)" .br -.RI "\fISpecial functions for processing server to server traffic.\fP" +.RI "\fISpecial functions for processing server to server traffic. \fP" .ti -1c .RI "void \fBprocess_restricted_commands\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *ipaddr, int port)" .br .ti -1c .RI "void \fBhandle_amp\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" .br -.RI "\fIThese are the handlers for server commands (tokens).\fP" +.RI "\fIThese are the handlers for server commands (tokens). \fP" .ti -1c .RI "void \fBhandle_dollar\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" .br @@ -245,7 +245,7 @@ commands.h \- .ti -1c .RI "bool \fBis_uline\fP (const char *server)" .br -.RI "\fIFunctions for u:lined servers.\fP" +.RI "\fIFunctions for u:lined servers. \fP" .in -1c .SH "Function Documentation" .PP @@ -255,7 +255,7 @@ commands.h \- .PP .SS "void handle_amp (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP -These are the handlers for server commands (tokens). +These are the handlers for server commands (tokens). .SS "void handle_AT (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP .SS "void handle_away (char ** parameters, int pcnt, \fBuserrec\fP * user)" @@ -284,7 +284,7 @@ These are the handlers for server commands (tokens). .PP .SS "void handle_join (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -These are the handlers for user commands. +These are the handlers for user commands. .SS "void handle_K (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP .SS "void handle_k (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" @@ -299,7 +299,7 @@ These are the handlers for user commands. .PP .SS "void handle_link_packet (char * udp_msg, char * tcp_host, \fBserverrec\fP * serv)" .PP -Special functions for processing server to server traffic. +Special functions for processing server to server traffic. .SS "void handle_links (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP .SS "void handle_list (char ** parameters, int pcnt, \fBuserrec\fP * user)" @@ -394,7 +394,7 @@ Special functions for processing server to server traffic. .PP .SS "bool is_uline (const char * server)" .PP -Functions for u:lined servers.Referenced by Server::IsUlined(). +Functions for u:lined servers. Referenced by Server::IsUlined(). .SS "void process_restricted_commands (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * ipaddr, int port)" .PP .SH "Author" diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index c6b343005..57d15f3d3 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,8 +1,8 @@ -.TH "connection" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -connection \- Please note: classes serverrec and userrec both inherit from class connection. +connection \- Please note: classes serverrec and userrec both inherit from class connection. .PP .SH SYNOPSIS @@ -20,43 +20,43 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .ti -1c .RI "\fBconnection\fP ()" .br -.RI "\fIDefault constructor.\fP" +.RI "\fIDefault constructor. \fP" .ti -1c .RI "bool \fBCreateListener\fP (char *\fBhost\fP, int p)" .br -.RI "\fICreate a listening socket on 'host' using port number 'p'.\fP" +.RI "\fICreate a listening socket on 'host' using port number 'p'. \fP" .ti -1c .RI "bool \fBBeginLink\fP (char *targethost, int \fBport\fP, char *password, char *servername, int myport)" .br -.RI "\fIBegin an outbound link to another ircd at targethost.\fP" +.RI "\fIBegin an outbound link to another ircd at targethost. \fP" .ti -1c .RI "bool \fBMeshCookie\fP (char *targethost, int \fBport\fP, long cookie, char *servername)" .br -.RI "\fIBegin an outbound mesh link to another ircd on a network you are already an authenticated member of.\fP" +.RI "\fIBegin an outbound mesh link to another ircd on a network you are already an authenticated member of. \fP" .ti -1c .RI "void \fBTerminateLink\fP (char *targethost)" .br -.RI "\fITerminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method.\fP" +.RI "\fITerminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. \fP" .ti -1c .RI "bool \fBSendPacket\fP (char *message, const char *\fBhost\fP)" .br -.RI "\fISend a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false.\fP" +.RI "\fISend a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false. \fP" .ti -1c .RI "bool \fBRecvPacket\fP (std::deque< std::string > &messages, char *\fBhost\fP)" .br -.RI "\fIReturns the next available packet and returns true if data is available.\fP" +.RI "\fIReturns the next available packet and returns true if data is available. \fP" .ti -1c .RI "\fBircd_connector\fP * \fBFindHost\fP (std::string \fBhost\fP)" .br -.RI "\fIFind the \fBircd_connector\fP oject related to a certain servername given in 'host'.\fP" +.RI "\fIFind the \fBircd_connector\fP oject related to a certain servername given in 'host'. \fP" .ti -1c .RI "bool \fBAddIncoming\fP (int \fBfd\fP, char *targethost, int sourceport)" .br -.RI "\fIAdd an incoming connection to the connection pool.\fP" +.RI "\fIAdd an incoming connection to the connection pool. \fP" .ti -1c .RI "long \fBGenKey\fP ()" .br -.RI "\fIThis function is deprecated and may be removed in a later alpha/beta.\fP" +.RI "\fIThis function is deprecated and may be removed in a later alpha/beta. \fP" .in -1c .SS "Public Attributes" @@ -64,200 +64,206 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .ti -1c .RI "int \fBfd\fP" .br -.RI "\fIFile descriptor of the connection.\fP" +.RI "\fIFile descriptor of the connection. \fP" .ti -1c .RI "char \fBhost\fP [256]" .br -.RI "\fIHostname of connection.\fP" +.RI "\fIHostname of connection. \fP" .ti -1c .RI "char \fBip\fP [32]" .br -.RI "\fIIP of connection.\fP" +.RI "\fIIP of connection. \fP" .ti -1c .RI "char \fBinbuf\fP [MAXBUF]" .br -.RI "\fIInbuf of connection.\fP" +.RI "\fIInbuf of connection. \fP" .ti -1c .RI "long \fBbytes_in\fP" .br -.RI "\fIStats counter for bytes inbound.\fP" +.RI "\fIStats counter for bytes inbound. \fP" .ti -1c .RI "long \fBbytes_out\fP" .br -.RI "\fIStats counter for bytes outbound.\fP" +.RI "\fIStats counter for bytes outbound. \fP" .ti -1c .RI "long \fBcmds_in\fP" .br -.RI "\fIStats counter for commands inbound.\fP" +.RI "\fIStats counter for commands inbound. \fP" .ti -1c .RI "long \fBcmds_out\fP" .br -.RI "\fIStats counter for commands outbound.\fP" +.RI "\fIStats counter for commands outbound. \fP" .ti -1c .RI "bool \fBhaspassed\fP" .br -.RI "\fITrue if server/user has authenticated, false if otherwise.\fP" +.RI "\fITrue if server/user has authenticated, false if otherwise. \fP" .ti -1c .RI "int \fBport\fP" .br -.RI "\fIPort number For a userrec, this is the port they connected to the network on.\fP" +.RI "\fIPort number For a userrec, this is the port they connected to the network on. \fP" .ti -1c .RI "int \fBregistered\fP" .br -.RI "\fIUsed by userrec to indicate the registration status of the connection.\fP" +.RI "\fIUsed by userrec to indicate the registration status of the connection. \fP" .ti -1c .RI "short int \fBstate\fP" .br -.RI "\fIReserved for future use.\fP" +.RI "\fIReserved for future use. \fP" .ti -1c .RI "time_t \fBlastping\fP" .br -.RI "\fITime the connection was last pinged.\fP" +.RI "\fITime the connection was last pinged. \fP" .ti -1c .RI "time_t \fBsignon\fP" .br -.RI "\fITime the connection was created, set in the constructor.\fP" +.RI "\fITime the connection was created, set in the constructor. \fP" .ti -1c .RI "time_t \fBidle_lastmsg\fP" .br -.RI "\fITime that the connection last sent data, used to calculate idle time.\fP" +.RI "\fITime that the connection last sent data, used to calculate idle time. \fP" .ti -1c .RI "time_t \fBnping\fP" .br -.RI "\fIUsed by PING checks with clients.\fP" +.RI "\fIUsed by PING checks with clients. \fP" .ti -1c .RI "char \fBinternal_addr\fP [MAXBUF]" .br -.RI "\fIUnused, will be removed in a future alpha/beta.\fP" +.RI "\fIUnused, will be removed in a future alpha/beta. \fP" .ti -1c .RI "int \fBinternal_port\fP" .br -.RI "\fIUnused, will be removed in a future alpha/beta.\fP" +.RI "\fIUnused, will be removed in a future alpha/beta. \fP" .ti -1c .RI "std::vector< \fBircd_connector\fP > \fBconnectors\fP" .br -.RI "\fIWith a serverrec, this is a list of all established server connections.\fP" +.RI "\fIWith a serverrec, this is a list of all established server connections. \fP" .in -1c .SH "Detailed Description" .PP -Please note: classes serverrec and userrec both inherit from class connection.Definition at line 161 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. Definition at line 173 of file connection.h. .SH "Constructor & Destructor Documentation" .PP .SS "connection::connection ()" .PP -Default constructor. +Default constructor. .SH "Member Function Documentation" .PP .SS "bool connection::AddIncoming (int fd, char * targethost, int sourceport)" .PP -Add an incoming connection to the connection pool.(reserved for core use) +Add an incoming connection to the connection pool. (reserved for core use) .SS "bool connection::BeginLink (char * targethost, int port, char * password, char * servername, int myport)" .PP -Begin an outbound link to another ircd at targethost. +Begin an outbound link to another ircd at targethost. .SS "bool connection::CreateListener (char * host, int p)" .PP -Create a listening socket on 'host' using port number 'p'. +Create a listening socket on 'host' using port number 'p'. .SS "\fBircd_connector\fP* connection::FindHost (std::string host)" .PP -Find the \fBircd_connector\fP oject related to a certain servername given in 'host'. +Find the \fBircd_connector\fP oject related to a certain servername given in 'host'. .SS "long connection::GenKey ()" .PP -This function is deprecated and may be removed in a later alpha/beta. +This function is deprecated and may be removed in a later alpha/beta. .SS "bool connection::MeshCookie (char * targethost, int port, long cookie, char * servername)" .PP -Begin an outbound mesh link to another ircd on a network you are already an authenticated member of. +Begin an outbound mesh link to another ircd on a network you are already an authenticated member of. .SS "bool connection::RecvPacket (std::deque< std::string > & messages, char * host)" .PP -Returns the next available packet and returns true if data is available.Writes the servername the data came from to 'host'. If no data is available this function returns false. This function will automatically close broken links and reroute pathways, generating split messages on the network. +Returns the next available packet and returns true if data is available. Writes the servername the data came from to 'host'. If no data is available this function returns false. This function will automatically close broken links and reroute pathways, generating split messages on the network. .SS "bool connection::SendPacket (char * message, const char * host)" .PP -Send a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false. +Send a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false. .SS "void connection::TerminateLink (char * targethost)" .PP -Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. +Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. .SH "Member Data Documentation" .PP -.SS "long connection::bytes_in" +.SS "long \fBconnection::bytes_in\fP" .PP -Stats counter for bytes inbound.Definition at line 182 of file connection.h. +Stats counter for bytes inbound. Definition at line 194 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "long connection::bytes_out" +.SS "long \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound.Definition at line 186 of file connection.h. +Stats counter for bytes outbound. Definition at line 198 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "long connection::cmds_in" +.SS "long \fBconnection::cmds_in\fP" .PP -Stats counter for commands inbound.Definition at line 190 of file connection.h. +Stats counter for commands inbound. Definition at line 202 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "long connection::cmds_out" +.SS "long \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound.Definition at line 194 of file connection.h. +Stats counter for commands outbound. Definition at line 206 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "std::vector<\fBircd_connector\fP> connection::connectors" +.SS "std::vector<\fBircd_connector\fP> \fBconnection::connectors\fP" .PP -With a serverrec, this is a list of all established server connections.With a userrec this is unused.Definition at line 241 of file connection.h. -.SS "int connection::fd" +With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 253 of file connection.h. +.SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection.Definition at line 166 of file connection.h. +File descriptor of the connection. Definition at line 178 of file connection.h. .PP -Referenced by Server::SendTo(), serverrec::serverrec(), and userrec::userrec(). -.SS "bool connection::haspassed" +Referenced by ConfigReader::DumpErrors(), Server::SendTo(), serverrec::serverrec(), and userrec::userrec(). +.SS "bool \fBconnection::haspassed\fP" .PP -True if server/user has authenticated, false if otherwise.Definition at line 198 of file connection.h. +True if server/user has authenticated, false if otherwise. Definition at line 210 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "char connection::host[256]" +.SS "char \fBconnection::host\fP[256]" .PP -Hostname of connection.Not used if this is a serverrecDefinition at line 170 of file connection.h. -.SS "time_t connection::idle_lastmsg" +Hostname of connection. Not used if this is a serverrecDefinition at line 182 of file connection.h. .PP -Time that the connection last sent data, used to calculate idle time.Definition at line 224 of file connection.h. +Referenced by userrec::GetFullRealHost(), and userrec::userrec(). +.SS "time_t \fBconnection::idle_lastmsg\fP" +.PP +Time that the connection last sent data, used to calculate idle time. Definition at line 236 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "char connection::inbuf[MAXBUF]" +.SS "char \fBconnection::inbuf\fP[MAXBUF]" +.PP +Inbuf of connection. Only used for userrecDefinition at line 190 of file connection.h. .PP -Inbuf of connection.Only used for userrecDefinition at line 178 of file connection.h. -.SS "char connection::internal_addr[MAXBUF]" +Referenced by userrec::userrec(). +.SS "char \fBconnection::internal_addr\fP[MAXBUF]" .PP -Unused, will be removed in a future alpha/beta.Definition at line 232 of file connection.h. -.SS "int connection::internal_port" +Unused, will be removed in a future alpha/beta. Definition at line 244 of file connection.h. +.SS "int \fBconnection::internal_port\fP" .PP -Unused, will be removed in a future alpha/beta.Definition at line 236 of file connection.h. -.SS "char connection::ip[32]" +Unused, will be removed in a future alpha/beta. Definition at line 248 of file connection.h. +.SS "char \fBconnection::ip\fP[32]" .PP -IP of connection.Reserved for future use.Definition at line 174 of file connection.h. -.SS "time_t connection::lastping" +IP of connection. Reserved for future use.Definition at line 186 of file connection.h. +.PP +Referenced by userrec::userrec(). +.SS "time_t \fBconnection::lastping\fP" .PP -Time the connection was last pinged.Definition at line 216 of file connection.h. +Time the connection was last pinged. Definition at line 228 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). -.SS "time_t connection::nping" +.SS "time_t \fBconnection::nping\fP" .PP -Used by PING checks with clients.Definition at line 228 of file connection.h. +Used by PING checks with clients. Definition at line 240 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "int connection::port" +.SS "int \fBconnection::port\fP" .PP -Port number For a userrec, this is the port they connected to the network on.For a serverrec this is the current listening port of the serverrec object.Definition at line 204 of file connection.h. +Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 216 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "int connection::registered" +.SS "int \fBconnection::registered\fP" .PP -Used by userrec to indicate the registration status of the connection.Definition at line 208 of file connection.h. +Used by userrec to indicate the registration status of the connection. Definition at line 220 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "time_t connection::signon" +.SS "time_t \fBconnection::signon\fP" .PP -Time the connection was created, set in the constructor.Definition at line 220 of file connection.h. +Time the connection was created, set in the constructor. Definition at line 232 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). -.SS "short int connection::state" +.SS "short int \fBconnection::state\fP" .PP -Reserved for future use.Definition at line 212 of file connection.h. +Reserved for future use. Definition at line 224 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index 2b9d98d53..557593211 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -14,10 +14,10 @@ connection.h \- .br \fC#include \fP .br -\fC#include \fP -.br \fC#include \fP .br +\fC#include \fP +.br \fC#include \fP .br \fC#include \fP @@ -39,15 +39,15 @@ connection.h \- .ti -1c .RI "class \fBconnection\fP" .br -.RI "\fIPlease note: classes serverrec and userrec both inherit from class connection.\fP" +.RI "\fIPlease note: classes serverrec and userrec both inherit from class connection. \fP" .ti -1c .RI "class \fBircd_connector\fP" .br -.RI "\fIEach connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds.\fP" +.RI "\fIEach connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. \fP" .ti -1c .RI "class \fBpacket\fP" .br -.RI "\fIClass packet is deprecated.\fP" +.RI "\fIClass packet is deprecated. \fP" .in -1c .SS "Defines" @@ -75,22 +75,22 @@ connection.h \- .PP .SS "#define STATE_CONNECTED 1" .PP -Definition at line 23 of file connection.h. +Definition at line 35 of file connection.h. .SS "#define STATE_DISCONNECTED 0" .PP -Definition at line 22 of file connection.h. +Definition at line 34 of file connection.h. .SS "#define STATE_NOAUTH_INBOUND 3" .PP -Definition at line 25 of file connection.h. +Definition at line 37 of file connection.h. .SS "#define STATE_NOAUTH_OUTBOUND 4" .PP -Definition at line 26 of file connection.h. +Definition at line 38 of file connection.h. .SS "#define STATE_SERVICES 5" .PP -Definition at line 27 of file connection.h. +Definition at line 39 of file connection.h. .SS "#define STATE_SYNC 2" .PP -Definition at line 24 of file connection.h. +Definition at line 36 of file connection.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index 16ffd0c6b..3d5e395a6 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -19,7 +19,7 @@ ctables.h \- .ti -1c .RI "class \fBcommand_t\fP" .br -.RI "\fIA structure that defines a command.\fP" +.RI "\fIA structure that defines a command. \fP" .in -1c .SH "Author" .PP diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index 6dc5377cd..e18142434 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,8 +1,8 @@ -.TH "ircd_connector" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ircd_connector \- Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. +ircd_connector \- Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. .PP .SH SYNOPSIS @@ -18,59 +18,59 @@ Inherits \fBExtensible\fP. .ti -1c .RI "bool \fBMakeOutboundConnection\fP (char *\fBhost\fP, int \fBport\fP)" .br -.RI "\fICreate an outbound connection to a listening socket.\fP" +.RI "\fICreate an outbound connection to a listening socket. \fP" .ti -1c .RI "std::string \fBGetServerName\fP ()" .br -.RI "\fIReturn the servername on this established connection.\fP" +.RI "\fIReturn the servername on this established connection. \fP" .ti -1c .RI "void \fBSetServerName\fP (std::string serv)" .br -.RI "\fISet the server name of this connection.\fP" +.RI "\fISet the server name of this connection. \fP" .ti -1c .RI "int \fBGetDescriptor\fP ()" .br -.RI "\fIGet the file descriptor associated with this connection.\fP" +.RI "\fIGet the file descriptor associated with this connection. \fP" .ti -1c .RI "void \fBSetDescriptor\fP (int \fBfd\fP)" .br -.RI "\fISet the file descriptor for this connection.\fP" +.RI "\fISet the file descriptor for this connection. \fP" .ti -1c .RI "int \fBGetState\fP ()" .br -.RI "\fIGet the state flags for this connection.\fP" +.RI "\fIGet the state flags for this connection. \fP" .ti -1c .RI "void \fBSetState\fP (int \fBstate\fP)" .br -.RI "\fISet the state flags for this connection.\fP" +.RI "\fISet the state flags for this connection. \fP" .ti -1c .RI "char * \fBGetServerIP\fP ()" .br -.RI "\fIGet the ip address (not servername) associated with this connection.\fP" +.RI "\fIGet the ip address (not servername) associated with this connection. \fP" .ti -1c .RI "std::string \fBGetDescription\fP ()" .br -.RI "\fIGet the server description of this connection.\fP" +.RI "\fIGet the server description of this connection. \fP" .ti -1c .RI "void \fBSetDescription\fP (std::string desc)" .br -.RI "\fISet the server description of this connection.\fP" +.RI "\fISet the server description of this connection. \fP" .ti -1c .RI "int \fBGetServerPort\fP ()" .br -.RI "\fIGet the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP.\fP" +.RI "\fIGet the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP. \fP" .ti -1c .RI "void \fBSetServerPort\fP (int p)" .br -.RI "\fISet the port used by this connection.\fP" +.RI "\fISet the port used by this connection. \fP" .ti -1c .RI "bool \fBSetHostAndPort\fP (char *\fBhost\fP, int \fBport\fP)" .br -.RI "\fISet both the host and the port in one operation for this connection.\fP" +.RI "\fISet both the host and the port in one operation for this connection. \fP" .ti -1c .RI "void \fBCloseConnection\fP ()" .br -.RI "\fIClose the connection by calling close() on its file descriptor This function call updates no other data.\fP" +.RI "\fIClose the connection by calling close() on its file descriptor This function call updates no other data. \fP" .in -1c .SS "Public Attributes" @@ -78,15 +78,15 @@ Inherits \fBExtensible\fP. .ti -1c .RI "char \fBhost\fP [MAXBUF]" .br -.RI "\fIWhen MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.\fP" +.RI "\fIWhen MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. \fP" .ti -1c .RI "int \fBport\fP" .br -.RI "\fIWhen MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.\fP" +.RI "\fIWhen MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. \fP" .ti -1c .RI "std::vector< std::string > \fBroutes\fP" .br -.RI "\fI\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B.\fP" +.RI "\fI\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. \fP" .in -1c .SS "Private Member Functions" @@ -94,7 +94,7 @@ Inherits \fBExtensible\fP. .ti -1c .RI "bool \fBSetHostAddress\fP (char *\fBhost\fP, int \fBport\fP)" .br -.RI "\fIPRIVATE function to set the host address and port to connect to.\fP" +.RI "\fIPRIVATE function to set the host address and port to connect to. \fP" .in -1c .SS "Private Attributes" @@ -102,104 +102,104 @@ Inherits \fBExtensible\fP. .ti -1c .RI "sockaddr_in \fBaddr\fP" .br -.RI "\fISockaddr of the outbound ip and port.\fP" +.RI "\fISockaddr of the outbound ip and port. \fP" .ti -1c .RI "int \fBfd\fP" .br -.RI "\fIFile descriptor of the connection.\fP" +.RI "\fIFile descriptor of the connection. \fP" .ti -1c .RI "std::string \fBservername\fP" .br -.RI "\fI\fBServer\fP name.\fP" +.RI "\fI\fBServer\fP name. \fP" .ti -1c .RI "std::string \fBdescription\fP" .br -.RI "\fI\fBServer\fP 'GECOS'.\fP" +.RI "\fI\fBServer\fP 'GECOS'. \fP" .ti -1c .RI "int \fBstate\fP" .br -.RI "\fIState.\fP" +.RI "\fIState. \fP" .in -1c .SH "Detailed Description" .PP -Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. +Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. A listening socket that accepts server type connections is represented by one class serverrec. Class serverrec will instantiate several objects of type ircd_connector to represent each established connection, inbound or outbound. So, to determine all linked servers you must walk through all the serverrecs that the core defines, and in each one iterate through until you find connection(s) relating to the server you want information on. The core and module API provide functions for this. .PP -Definition at line 41 of file connection.h. +Definition at line 53 of file connection.h. .SH "Member Function Documentation" .PP .SS "void ircd_connector::CloseConnection ()" .PP -Close the connection by calling close() on its file descriptor This function call updates no other data. +Close the connection by calling close() on its file descriptor This function call updates no other data. .SS "std::string ircd_connector::GetDescription ()" .PP -Get the server description of this connection. +Get the server description of this connection. .SS "int ircd_connector::GetDescriptor ()" .PP -Get the file descriptor associated with this connection. +Get the file descriptor associated with this connection. .SS "char* ircd_connector::GetServerIP ()" .PP -Get the ip address (not servername) associated with this connection. +Get the ip address (not servername) associated with this connection. .SS "std::string ircd_connector::GetServerName ()" .PP -Return the servername on this established connection. +Return the servername on this established connection. .SS "int ircd_connector::GetServerPort ()" .PP -Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP. +Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP. .SS "int ircd_connector::GetState ()" .PP -Get the state flags for this connection. +Get the state flags for this connection. .SS "bool ircd_connector::MakeOutboundConnection (char * host, int port)" .PP -Create an outbound connection to a listening socket. +Create an outbound connection to a listening socket. .SS "void ircd_connector::SetDescription (std::string desc)" .PP -Set the server description of this connection. +Set the server description of this connection. .SS "void ircd_connector::SetDescriptor (int fd)" .PP -Set the file descriptor for this connection. +Set the file descriptor for this connection. .SS "bool ircd_connector::SetHostAddress (char * host, int port)\fC [private]\fP" .PP -PRIVATE function to set the host address and port to connect to. +PRIVATE function to set the host address and port to connect to. .SS "bool ircd_connector::SetHostAndPort (char * host, int port)" .PP -Set both the host and the port in one operation for this connection. +Set both the host and the port in one operation for this connection. .SS "void ircd_connector::SetServerName (std::string serv)" .PP -Set the server name of this connection. +Set the server name of this connection. .SS "void ircd_connector::SetServerPort (int p)" .PP -Set the port used by this connection. +Set the port used by this connection. .SS "void ircd_connector::SetState (int state)" .PP -Set the state flags for this connection. +Set the state flags for this connection. .SH "Member Data Documentation" .PP -.SS "sockaddr_in ircd_connector::addr\fC [private]\fP" +.SS "sockaddr_in \fBircd_connector::addr\fP\fC [private]\fP" .PP -Sockaddr of the outbound ip and port.Definition at line 46 of file connection.h. -.SS "std::string ircd_connector::description\fC [private]\fP" +Sockaddr of the outbound ip and port. Definition at line 58 of file connection.h. +.SS "std::string \fBircd_connector::description\fP\fC [private]\fP" .PP -\fBServer\fP 'GECOS'.Definition at line 58 of file connection.h. -.SS "int ircd_connector::fd\fC [private]\fP" +\fBServer\fP 'GECOS'. Definition at line 70 of file connection.h. +.SS "int \fBircd_connector::fd\fP\fC [private]\fP" .PP -File descriptor of the connection.Definition at line 50 of file connection.h. -.SS "char ircd_connector::host[MAXBUF]" +File descriptor of the connection. Definition at line 62 of file connection.h. +.SS "char \fBircd_connector::host\fP[MAXBUF]" .PP -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.Definition at line 75 of file connection.h. -.SS "int ircd_connector::port" +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 87 of file connection.h. +.SS "int \fBircd_connector::port\fP" .PP -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.Definition at line 81 of file connection.h. -.SS "std::vector ircd_connector::routes" +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 93 of file connection.h. +.SS "std::vector \fBircd_connector::routes\fP" .PP -\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B.Definition at line 87 of file connection.h. -.SS "std::string ircd_connector::servername\fC [private]\fP" +\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. Definition at line 99 of file connection.h. +.SS "std::string \fBircd_connector::servername\fP\fC [private]\fP" .PP -\fBServer\fP name.Definition at line 54 of file connection.h. -.SS "int ircd_connector::state\fC [private]\fP" +\fBServer\fP name. Definition at line 66 of file connection.h. +.SS "int \fBircd_connector::state\fP\fC [private]\fP" .PP -State.STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTEDDefinition at line 63 of file connection.h. +State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTEDDefinition at line 75 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 66313e5c7..cdd851103 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index ffc4a4a84..71ef611fd 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/modules.cpp.3 b/docs/man/man3/modules.cpp.3 index 9dbc2157e..8d1da1384 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -234,9 +234,6 @@ 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 @@ -292,312 +289,306 @@ modules.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 42 of file modules.cpp. +Definition at line 58 of file modules.cpp. .SH "Typedef Documentation" .PP -.SS "typedef nspace::hash_map, \fBInAddr_HashComp\fP> address_cache" +.SS "typedef nspace::hash_map, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 151 of file modules.cpp. -.SS "typedef nspace::hash_map, \fBStrHashComp\fP> chan_hash" +Definition at line 166 of file modules.cpp. +.SS "typedef nspace::hash_map, \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 165 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 167 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 193 of file modules.cpp. +.SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 179 of file modules.cpp. +Definition at line 194 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). -.SS "typedef nspace::hash_map, \fBStrHashComp\fP> user_hash" +.SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 149 of file modules.cpp. +Definition at line 164 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 266 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 } +267 { +268 if (ModeDefined(modechar,type)) { +269 return false; +270 } +271 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +272 return true; +273 } .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 200 of file modules.cpp. .PP -References EMode, and ExtModeListIter. +References DEBUG, 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 } +201 { +202 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +203 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +204 { +205 if ((i->modechar == modechar) && (i->type == type)) +206 { +207 return true; +208 } +209 } +210 return false; +211 } .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 241 of file modules.cpp. +Definition at line 253 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 } +254 { +255 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +256 { +257 if ((i->modechar == modechar) && (i->type == type)) +258 { +259 return i->params_when_off; +260 } +261 } +262 return 0; +263 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 228 of file modules.cpp. +Definition at line 240 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 } +241 { +242 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +243 { +244 if ((i->modechar == modechar) && (i->type == type)) +245 { +246 return i->params_when_on; +247 } +248 } +249 return 0; +250 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 213 of file modules.cpp. +Definition at line 226 of file modules.cpp. .PP -References EMode, and ExtModeListIter. +References DEBUG, 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 } +227 { +228 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +229 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +230 { +231 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +232 { +233 return true; +234 } +235 } +236 return false; +237 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP -Definition at line 199 of file modules.cpp. +Definition at line 213 of file modules.cpp. .PP -References EMode, and ExtModeListIter. +References DEBUG, 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 } +214 { +215 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +216 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +217 { +218 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +219 { +220 return true; +221 } +222 } +223 return false; +224 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 264 of file modules.cpp. +Definition at line 276 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 } +277 { +278 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +279 { +280 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +281 { +282 i->list = true; +283 return; +284 } +285 } +286 return; +287 } .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 72 of file modules.cpp. +.SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 57 of file modules.cpp. -.SS "std::vector auth_cookies" +Definition at line 71 of file modules.cpp. +.SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 85 of file modules.cpp. -.SS "char bannerBuffer[MAXBUF]" +Definition at line 73 of file modules.cpp. +.SS "std::vector \fBauth_cookies\fP" .PP -Definition at line 78 of file modules.cpp. -.SS "int boundPortCount" +Definition at line 100 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 94 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 171 of file modules.cpp. +.SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 155 of file modules.cpp. +Definition at line 170 of file modules.cpp. .PP Referenced by Server::GetUsers(). -.SS "\fBcommand_table\fP cmdlist" +.SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 158 of file modules.cpp. -.SS "std::stringstream config_f" +Definition at line 173 of file modules.cpp. +.SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 86 of file modules.cpp. -.SS "int debugging" +Definition at line 101 of file modules.cpp. +.SS "int \fBdebugging\fP" .PP -Definition at line 66 of file modules.cpp. -.SS "int defaultRoute" +Definition at line 82 of file modules.cpp. +.SS "int \fBdefaultRoute\fP" .PP -Definition at line 83 of file modules.cpp. -.SS "int DieDelay" +Definition at line 98 of file modules.cpp. +.SS "int \fBDieDelay\fP" .PP -Definition at line 69 of file modules.cpp. -.SS "char diepass[MAXBUF]" +Definition at line 85 of file modules.cpp. +.SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 58 of file modules.cpp. -.SS "char DieValue[MAXBUF]" +Definition at line 74 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 80 of file modules.cpp. +.SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 182 of file modules.cpp. +Definition at line 197 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 fd_reap" -.PP -Definition at line 75 of file modules.cpp. -.SS "\fBaddress_cache\fP IP" +Definition at line 65 of file modules.cpp. +.SS "std::vector \fBfd_reap\fP" .PP -Definition at line 161 of file modules.cpp. -.SS "char list[MAXBUF]" +Definition at line 91 of file modules.cpp. +.SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 62 of file modules.cpp. -.SS "FILE* log_file" +Definition at line 176 of file modules.cpp. +.SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 90 of file modules.cpp. -.SS "int LogLevel" +Definition at line 78 of file modules.cpp. +.SS "FILE* \fBlog_file\fP" .PP -Definition at line 51 of file modules.cpp. -.SS "int MaxWhoResults" +Definition at line 105 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 67 of file modules.cpp. +.SS "int \fBMaxWhoResults\fP" .PP Definition at line 88 of file modules.cpp. -.SS "int MODCOUNT = -1" +.SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 714 of file modules.cpp. -.SS "std::vector module_names" +Definition at line 103 of file modules.cpp. +.SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 76 of file modules.cpp. +Definition at line 763 of file modules.cpp. +.SS "std::vector \fBmodule_names\fP" +.PP +Definition at line 92 of file modules.cpp. .SS "vector<\fBModule\fP*> modules" .PP -Definition at line 48 of file modules.cpp. -.SS "\fBfile_cache\fP MOTD" +Definition at line 64 of file modules.cpp. +.SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 159 of file modules.cpp. -.SS "char motd[MAXBUF]" +Definition at line 174 of file modules.cpp. +.SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 60 of file modules.cpp. -.SS "time_t nb_start" +Definition at line 76 of file modules.cpp. +.SS "time_t \fBnb_start\fP" .PP -Definition at line 73 of file modules.cpp. -.SS "int NetBufferSize" +Definition at line 89 of file modules.cpp. +.SS "int \fBNetBufferSize\fP" .PP -Definition at line 71 of file modules.cpp. -.SS "char Network[MAXBUF]" +Definition at line 87 of file modules.cpp. +.SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 53 of file modules.cpp. -.SS "int portCount" +Definition at line 69 of file modules.cpp. +.SS "int \fBportCount\fP" .PP -Definition at line 80 of file modules.cpp. -.SS "int ports[MAXSOCKS]" +Definition at line 95 of file modules.cpp. +.SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 82 of file modules.cpp. -.SS "char PrefixQuit[MAXBUF]" +Definition at line 97 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 79 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 75 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 175 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 77 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 70 of file modules.cpp. +.SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 52 of file modules.cpp. -.SS "time_t startup_time" +Definition at line 68 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 86 of file modules.cpp. +.SS "int \fBUDPportCount\fP" .PP -Definition at line 81 of file modules.cpp. -.SS "\fBuser_hash\fP whowas" +Definition at line 96 of file modules.cpp. +.SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 157 of file modules.cpp. -.SS "int WHOWAS_MAX" +Definition at line 172 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 84 of file modules.cpp. +.SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 67 of file modules.cpp. +Definition at line 83 of file modules.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index f98d6b440..591d46a91 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -25,31 +25,31 @@ modules.h \- .ti -1c .RI "class \fBAdmin\fP" .br -.RI "\fIHolds /ADMIN data This class contains the admin details of the local server.\fP" +.RI "\fIHolds /ADMIN data This class contains the admin details of the local server. \fP" .ti -1c .RI "class \fBConfigReader\fP" .br -.RI "\fIAllows 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.\fP" +.RI "\fIAllows 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. \fP" .ti -1c .RI "class \fBFileReader\fP" .br -.RI "\fICaches a text file into memory and can be used to retrieve lines from it.\fP" +.RI "\fICaches a text file into memory and can be used to retrieve lines from it. \fP" .ti -1c .RI "class \fBModule\fP" .br -.RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules.\fP" +.RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules. \fP" .ti -1c .RI "class \fBModuleFactory\fP" .br -.RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.\fP" +.RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. \fP" .ti -1c .RI "class \fBServer\fP" .br -.RI "\fIAllows 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.\fP" +.RI "\fIAllows 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. \fP" .ti -1c .RI "class \fBVersion\fP" .br -.RI "\fIHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module.\fP" +.RI "\fIHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. \fP" .in -1c .SS "Defines" @@ -139,14 +139,14 @@ modules.h \- .ti -1c .RI "typedef std::deque< std::string > \fBfile_cache\fP" .br -.RI "\fILow level definition of a \fBFileReader\fP classes file cache area.\fP" +.RI "\fILow level definition of a \fBFileReader\fP classes file cache area. \fP" .ti -1c .RI "typedef \fBfile_cache\fP \fBstring_list\fP" .br .ti -1c .RI "typedef std::deque< \fBuserrec\fP * > \fBchanuserlist\fP" .br -.RI "\fIHolds a list of users in a channel.\fP" +.RI "\fIHolds a list of users in a channel. \fP" .ti -1c .RI "typedef DLLFactory< \fBModuleFactory\fP > \fBircd_module\fP" .br @@ -165,71 +165,73 @@ modules.h \- .PP .SS "#define AC_DEHALFOP 6" .PP -Definition at line 37 of file modules.h. +Definition at line 47 of file modules.h. .SS "#define AC_DEOP 1" .PP -Definition at line 32 of file modules.h. +Definition at line 42 of file modules.h. .SS "#define AC_DEVOICE 4" .PP -Definition at line 35 of file modules.h. +Definition at line 45 of file modules.h. .SS "#define AC_GENERAL_MODE 8" .PP -Definition at line 39 of file modules.h. +Definition at line 49 of file modules.h. .SS "#define AC_HALFOP 5" .PP -Definition at line 36 of file modules.h. +Definition at line 46 of file modules.h. .SS "#define AC_INVITE 7" .PP -Definition at line 38 of file modules.h. +Definition at line 48 of file modules.h. .SS "#define AC_KICK 0" .PP -Definition at line 31 of file modules.h. +Definition at line 41 of file modules.h. .SS "#define AC_OP 2" .PP -Definition at line 33 of file modules.h. +Definition at line 43 of file modules.h. .SS "#define AC_VOICE 3" .PP -Definition at line 34 of file modules.h. +Definition at line 44 of file modules.h. .SS "#define ACR_ALLOW 2" .PP -Definition at line 29 of file modules.h. +Definition at line 39 of file modules.h. .SS "#define ACR_DEFAULT 0" .PP -Definition at line 27 of file modules.h. +Definition at line 37 of file modules.h. .PP Referenced by Module::OnAccessCheck(). .SS "#define ACR_DENY 1" .PP -Definition at line 28 of file modules.h. +Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 610 of file modules.h. +Definition at line 633 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 607 of file modules.h. +Definition at line 630 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 608 of file modules.h. +Definition at line 631 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 609 of file modules.h. +Definition at line 632 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" .PP -Definition at line 13 of file modules.h. +Definition at line 23 of file modules.h. +.PP +Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). .SS "#define DEFAULT 30" .PP -Definition at line 15 of file modules.h. +Definition at line 25 of file modules.h. .SS "#define FOREACH_MOD for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->" .PP -Definition at line 62 of file modules.h. +Definition at line 72 of file modules.h. .SS "#define FOREACH_RESULT(x)" .PP \fBValue:\fP.nf @@ -244,49 +246,49 @@ Definition at line 62 of file modules.h. } .fi .PP -Definition at line 70 of file modules.h. +Definition at line 80 of file modules.h. .SS "#define MT_CHANNEL 1" .PP -Definition at line 21 of file modules.h. +Definition at line 31 of file modules.h. .PP -Referenced by ModeMakeList(). +Referenced by Server::AddExtendedListMode(), and ModeMakeList(). .SS "#define MT_CLIENT 2" .PP -Definition at line 22 of file modules.h. +Definition at line 32 of file modules.h. .PP Referenced by Server::AddExtendedMode(). .SS "#define MT_SERVER 3" .PP -Definition at line 23 of file modules.h. +Definition at line 33 of file modules.h. .PP Referenced by Server::AddExtendedMode(). .SS "#define NONE 50" .PP -Definition at line 17 of file modules.h. +Definition at line 27 of file modules.h. .SS "#define SPARSE 40" .PP -Definition at line 16 of file modules.h. +Definition at line 26 of file modules.h. .SS "#define VERBOSE 20" .PP -Definition at line 14 of file modules.h. +Definition at line 24 of file modules.h. .SH "Typedef Documentation" .PP -.SS "typedef std::deque<\fBuserrec\fP*> chanuserlist" +.SS "typedef std::deque<\fBuserrec\fP*> \fBchanuserlist\fP" .PP -Holds a list of users in a channel.Definition at line 55 of file modules.h. +Holds a list of users in a channel. Definition at line 65 of file modules.h. .PP Referenced by Server::GetUsers(). -.SS "typedef std::deque file_cache" +.SS "typedef std::deque \fBfile_cache\fP" .PP -Low level definition of a \fBFileReader\fP classes file cache area.Definition at line 50 of file modules.h. +Low level definition of a \fBFileReader\fP classes file cache area. Definition at line 60 of file modules.h. .PP Referenced by FileReader::FileReader(), and FileReader::LoadFile(). -.SS "typedef DLLFactory<\fBModuleFactory\fP> ircd_module" +.SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP" .PP -Definition at line 767 of file modules.h. -.SS "typedef \fBfile_cache\fP string_list" +Definition at line 798 of file modules.h. +.SS "typedef \fBfile_cache\fP \fBstring_list\fP" .PP -Definition at line 51 of file modules.h. +Definition at line 61 of file modules.h. .PP Referenced by Module::OnChannelSync(), and Module::OnUserSync(). .SH "Function Documentation" diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 558159c61..cb53b328e 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -10,10 +10,10 @@ nspace \- .in +1c .ti -1c -.RI "struct \fBhash< in_addr >\fP" +.RI "struct \fBnspace.hash< in_addr >\fP" .br .ti -1c -.RI "struct \fBhash< string >\fP" +.RI "struct \fBnspace.hash< string >\fP" .br .in -1c .SH "Author" diff --git a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 index 98b8b817d..fcbba4004 100644 --- a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 +++ b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< in_addr >" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,14 +20,14 @@ nspace::nspace::hash< in_addr > \- .PP .SS "size_t nspace::hash< in_addr >::operator() (const struct in_addr & a) const\fC [inline]\fP" .PP -Definition at line 97 of file modules.cpp. +Definition at line 112 of file modules.cpp. .PP .nf -98 { -99 size_t q; -100 memcpy(&q,&a,sizeof(size_t)); -101 return q; -102 } +113 { +114 size_t q; +115 memcpy(&q,&a,sizeof(size_t)); +116 return q; +117 } .fi diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index f2f747113..6607065b5 100644 --- a/docs/man/man3/nspace_nspace_hash_ string _.3 +++ b/docs/man/man3/nspace_nspace_hash_ string _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< string >" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,16 +20,16 @@ nspace::nspace::hash< string > \- .PP .SS "size_t nspace::hash< string >::operator() (const string & s) const\fC [inline]\fP" .PP -Definition at line 107 of file modules.cpp. +Definition at line 122 of file modules.cpp. .PP .nf -108 { -109 char a[MAXBUF]; -110 static struct hash strhash; -111 strcpy(a,s.c_str()); -112 strlower(a); -113 return strhash(a); -114 } +123 { +124 char a[MAXBUF]; +125 static struct hash strhash; +126 strlcpy(a,s.c_str(),MAXBUF); +127 strlower(a); +128 return strhash(a); +129 } .fi diff --git a/docs/man/man3/packet.3 b/docs/man/man3/packet.3 index 8d8b2ff9f..72f475b24 100644 --- a/docs/man/man3/packet.3 +++ b/docs/man/man3/packet.3 @@ -1,8 +1,8 @@ -.TH "packet" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "packet" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -packet \- Class packet is deprecated. +packet \- Class packet is deprecated. .PP .SH SYNOPSIS @@ -14,11 +14,11 @@ Inherits \fBclassbase\fP. .PP .SH "Detailed Description" .PP -Class packet is deprecated. +Class packet is deprecated. This declaration is preserved here to maintain documentation only. .PP -Definition at line 155 of file connection.h. +Definition at line 167 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 72b563865..bb8a99543 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,8 +1,8 @@ -.TH "serverrec" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -serverrec \- A class that defines the local server or a remote server. +serverrec \- A class that defines the local server or a remote server. .PP .SH SYNOPSIS @@ -18,15 +18,15 @@ Inherits \fBconnection\fP. .ti -1c .RI "\fBserverrec\fP ()" .br -.RI "\fIConstructor.\fP" +.RI "\fIConstructor. \fP" .ti -1c .RI "\fBserverrec\fP (char *n, long ver, bool jupe)" .br -.RI "\fIConstructor which initialises some of the main variables.\fP" +.RI "\fIConstructor which initialises some of the main variables. \fP" .ti -1c .RI "\fB~serverrec\fP ()" .br -.RI "\fIDestructor.\fP" +.RI "\fIDestructor. \fP" .in -1c .SS "Public Attributes" @@ -34,140 +34,153 @@ Inherits \fBconnection\fP. .ti -1c .RI "char \fBname\fP [MAXBUF]" .br -.RI "\fIserver name\fP" +.RI "\fIserver name \fP" .ti -1c .RI "long \fBpingtime\fP" .br -.RI "\fIlast ping response (ms)\fP" +.RI "\fIlast ping response (ms) \fP" .ti -1c .RI "long \fBusercount_i\fP" .br -.RI "\fIinvisible users on server\fP" +.RI "\fIinvisible users on server \fP" .ti -1c .RI "long \fBusercount\fP" .br -.RI "\fInon-invisible users on server\fP" +.RI "\fInon-invisible users on server \fP" .ti -1c .RI "long \fBopercount\fP" .br -.RI "\fIopers on server\fP" +.RI "\fIopers on server \fP" .ti -1c .RI "int \fBhops_away\fP" .br -.RI "\fInumber of hops away (for quick access)\fP" +.RI "\fInumber of hops away (for quick access) \fP" .ti -1c .RI "long \fBversion\fP" .br -.RI "\fIircd version\fP" +.RI "\fIircd version \fP" .ti -1c .RI "bool \fBjupiter\fP" .br -.RI "\fIis a JUPE server (faked to enforce a server ban)\fP" +.RI "\fIis a JUPE server (faked to enforce a server ban) \fP" .ti -1c .RI "char \fBdescription\fP [MAXBUF]" .br -.RI "\fIDescription of the server.\fP" +.RI "\fIDescription of the server. \fP" +.ti -1c +.RI "char \fBnickserv\fP [NICKMAX]" +.br +.RI "\fIHolds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/). \fP" .ti -1c .RI "bool \fBsync_soon\fP" .br .in -1c .SH "Detailed Description" .PP -A class that defines the local server or a remote server.Definition at line 19 of file servers.h. +A class that defines the local server or a remote server. Definition at line 30 of file servers.h. .SH "Constructor & Destructor Documentation" .PP .SS "serverrec::serverrec ()" .PP -Constructor.Definition at line 12 of file servers.cpp. +Constructor. Definition at line 23 of file servers.cpp. .PP -References connection::fd, hops_away, jupiter, connection::lastping, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version. +References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version. .PP .nf -13 { -14 strcpy(name,''); -15 pingtime = 0; -16 lastping = time(NULL); -17 usercount_i = usercount = opercount = version = 0; -18 hops_away = 1; -19 signon = time(NULL); -20 jupiter = false; -21 fd = 0; -22 sync_soon = false; -23 } +24 { +25 strlcpy(name,'',256); +26 pingtime = 0; +27 lastping = time(NULL); +28 usercount_i = usercount = opercount = version = 0; +29 hops_away = 1; +30 signon = time(NULL); +31 jupiter = false; +32 fd = 0; +33 sync_soon = false; +34 strlcpy(nickserv,'',NICKMAX); +35 } .fi .SS "serverrec::serverrec (char * n, long ver, bool jupe)" .PP -Constructor which initialises some of the main variables.Definition at line 30 of file servers.cpp. +Constructor which initialises some of the main variables. Definition at line 42 of file servers.cpp. .PP -References connection::fd, hops_away, jupiter, connection::lastping, opercount, connection::signon, sync_soon, usercount, usercount_i, and version. +References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, usercount, usercount_i, and version. .PP .nf -31 { -32 strcpy(name,n); -33 lastping = time(NULL); -34 usercount_i = usercount = opercount = 0; -35 version = ver; -36 hops_away = 1; -37 signon = time(NULL); -38 jupiter = jupe; -39 fd = 0; -40 sync_soon = false; -41 } +43 { +44 strlcpy(name,n,256); +45 lastping = time(NULL); +46 usercount_i = usercount = opercount = 0; +47 version = ver; +48 hops_away = 1; +49 signon = time(NULL); +50 jupiter = jupe; +51 fd = 0; +52 sync_soon = false; +53 strlcpy(nickserv,'',NICKMAX); +54 } .fi -.SS "serverrec::~serverrec ()" +.SS "serverrec::~\fBserverrec\fP ()" .PP -Destructor.Definition at line 26 of file servers.cpp. +Destructor. Definition at line 38 of file servers.cpp. .PP .nf -27 { -28 } +39 { +40 } .fi .SH "Member Data Documentation" .PP -.SS "char serverrec::description[MAXBUF]" +.SS "char \fBserverrec::description\fP[MAXBUF]" .PP -Description of the server.Definition at line 50 of file servers.h. -.SS "int serverrec::hops_away" +Description of the server. Definition at line 61 of file servers.h. +.SS "int \fBserverrec::hops_away\fP" .PP -number of hops away (for quick access)Definition at line 40 of file servers.h. +number of hops away (for quick access) Definition at line 51 of file servers.h. .PP Referenced by serverrec(). -.SS "bool serverrec::jupiter" +.SS "bool \fBserverrec::jupiter\fP" .PP -is a JUPE server (faked to enforce a server ban)Definition at line 46 of file servers.h. +is a JUPE server (faked to enforce a server ban) Definition at line 57 of file servers.h. .PP Referenced by serverrec(). -.SS "char serverrec::name[MAXBUF]" +.SS "char \fBserverrec::name\fP[MAXBUF]" .PP -server nameDefinition at line 25 of file servers.h. -.SS "long serverrec::opercount" +server name Definition at line 36 of file servers.h. +.PP +Referenced by serverrec(). +.SS "char \fBserverrec::nickserv\fP[NICKMAX]" +.PP +Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/). Definition at line 65 of file servers.h. +.PP +Referenced by serverrec(). +.SS "long \fBserverrec::opercount\fP" .PP -opers on serverDefinition at line 37 of file servers.h. +opers on server Definition at line 48 of file servers.h. .PP Referenced by serverrec(). -.SS "long serverrec::pingtime" +.SS "long \fBserverrec::pingtime\fP" .PP -last ping response (ms)Definition at line 28 of file servers.h. +last ping response (ms) Definition at line 39 of file servers.h. .PP Referenced by serverrec(). -.SS "bool serverrec::sync_soon" +.SS "bool \fBserverrec::sync_soon\fP" .PP -Definition at line 52 of file servers.h. +Definition at line 67 of file servers.h. .PP Referenced by serverrec(). -.SS "long serverrec::usercount" +.SS "long \fBserverrec::usercount\fP" .PP -non-invisible users on serverDefinition at line 34 of file servers.h. +non-invisible users on server Definition at line 45 of file servers.h. .PP Referenced by serverrec(). -.SS "long serverrec::usercount_i" +.SS "long \fBserverrec::usercount_i\fP" .PP -invisible users on serverDefinition at line 31 of file servers.h. +invisible users on server Definition at line 42 of file servers.h. .PP Referenced by serverrec(). -.SS "long serverrec::version" +.SS "long \fBserverrec::version\fP" .PP -ircd versionDefinition at line 43 of file servers.h. +ircd version Definition at line 54 of file servers.h. .PP Referenced by serverrec(). diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index bcf1673a7..647c95365 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index db6deb563..794e07b6a 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -21,7 +21,7 @@ servers.h \- .ti -1c .RI "class \fBserverrec\fP" .br -.RI "\fIA class that defines the local server or a remote server.\fP" +.RI "\fIA class that defines the local server or a remote server. \fP" .in -1c .SS "Defines" @@ -37,10 +37,10 @@ servers.h \- .PP .SS "#define LINK_ACTIVE 1" .PP -Definition at line 14 of file servers.h. +Definition at line 25 of file servers.h. .SS "#define LINK_INACTIVE 0" .PP -Definition at line 15 of file servers.h. +Definition at line 26 of file servers.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index fd2eb0f06..267325c89 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 8aae73488..9036f983b 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,8 +1,8 @@ -.TH "ucrec" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -ucrec \- Holds 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. +ucrec \- Holds 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. .PP .SH SYNOPSIS @@ -28,45 +28,45 @@ Inherits \fBclassbase\fP. .ti -1c .RI "long \fBuc_modes\fP" .br -.RI "\fIContains a bitmask of the UCMODE_OP ...\fP" +.RI "\fIContains a bitmask of the UCMODE_OP ... \fP" .ti -1c .RI "\fBchanrec\fP * \fBchannel\fP" .br -.RI "\fIPoints to the channel record where the given modes apply.\fP" +.RI "\fIPoints to the channel record where the given modes apply. \fP" .in -1c .SH "Detailed Description" .PP -Holds 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. +Holds 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. The uc_modes member holds a bitmask of which privilages the user has on the channel, such as op, voice, etc. .PP -Definition at line 191 of file channels.h. +Definition at line 202 of file channels.h. .SH "Constructor & Destructor Documentation" .PP .SS "ucrec::ucrec ()\fC [inline]\fP" .PP -Definition at line 204 of file channels.h. +Definition at line 215 of file channels.h. .PP .nf -204 { /* stub */ } +215 { /* stub */ } .fi -.SS "virtual ucrec::~ucrec ()\fC [inline, virtual]\fP" +.SS "virtual ucrec::~\fBucrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 205 of file channels.h. +Definition at line 216 of file channels.h. .PP .nf -205 { /* stub */ } +216 { /* stub */ } .fi .SH "Member Data Documentation" .PP -.SS "\fBchanrec\fP* ucrec::channel" +.SS "\fBchanrec\fP* \fBucrec::channel\fP" .PP -Points to the channel record where the given modes apply.If the record is not in use, this value will be NULL.Definition at line 202 of file channels.h. +Points to the channel record where the given modes apply. If the record is not in use, this value will be NULL.Definition at line 213 of file channels.h. .PP Referenced by userrec::userrec(). -.SS "long ucrec::uc_modes" +.SS "long \fBucrec::uc_modes\fP" .PP -Contains a bitmask of the UCMODE_OP ...UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.Definition at line 197 of file channels.h. +Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.Definition at line 208 of file channels.h. .PP Referenced by userrec::userrec(). diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index cefee519e..dba632b51 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,8 +1,8 @@ -.TH "userrec" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -userrec \- Holds all information about a user This class stores all information about a user connected to the irc server. +userrec \- Holds all information about a user This class stores all information about a user connected to the irc server. .PP .SH SYNOPSIS @@ -24,27 +24,27 @@ Inherits \fBconnection\fP. .ti -1c .RI "virtual char * \fBGetFullHost\fP ()" .br -.RI "\fIReturns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.\fP" +.RI "\fIReturns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. \fP" .ti -1c .RI "virtual char * \fBGetFullRealHost\fP ()" .br -.RI "\fIReturns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.\fP" +.RI "\fIReturns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. \fP" .ti -1c .RI "virtual bool \fBIsInvited\fP (char *channel)" .br -.RI "\fIReturns true if a user is invited to a channel.\fP" +.RI "\fIReturns true if a user is invited to a channel. \fP" .ti -1c .RI "virtual void \fBInviteTo\fP (char *channel)" .br -.RI "\fIAdds a channel to a users invite list (invites them to a channel).\fP" +.RI "\fIAdds a channel to a users invite list (invites them to a channel). \fP" .ti -1c .RI "virtual void \fBRemoveInvite\fP (char *channel)" .br -.RI "\fIRemoves a channel from a users invite list.\fP" +.RI "\fIRemoves a channel from a users invite list. \fP" .ti -1c .RI "bool \fBHasPermission\fP (char *command)" .br -.RI "\fIReturns true or false for if a user can execute a privilaged oper command.\fP" +.RI "\fIReturns true or false for if a user can execute a privilaged oper command. \fP" .in -1c .SS "Public Attributes" @@ -52,50 +52,50 @@ Inherits \fBconnection\fP. .ti -1c .RI "char \fBnick\fP [NICKMAX]" .br -.RI "\fIThe users nickname.\fP" +.RI "\fIThe users nickname. \fP" .ti -1c .RI "char \fBident\fP [64]" .br -.RI "\fIThe users ident reply.\fP" +.RI "\fIThe users ident reply. \fP" .ti -1c .RI "char \fBdhost\fP [256]" .br -.RI "\fIThe host displayed to non-opers (used for cloaking etc).\fP" +.RI "\fIThe host displayed to non-opers (used for cloaking etc). \fP" .ti -1c .RI "char \fBfullname\fP [128]" .br -.RI "\fIThe users full name.\fP" +.RI "\fIThe users full name. \fP" .ti -1c .RI "char \fBmodes\fP [MAXBUF]" .br -.RI "\fIThe user's mode string.\fP" +.RI "\fIThe user's mode string. \fP" .ti -1c .RI "\fBucrec\fP \fBchans\fP [MAXCHANS]" .br .ti -1c .RI "char \fBserver\fP [256]" .br -.RI "\fIThe server the user is connected to.\fP" +.RI "\fIThe server the user is connected to. \fP" .ti -1c .RI "char \fBawaymsg\fP [512]" .br -.RI "\fIThe user's away message.\fP" +.RI "\fIThe user's away message. \fP" .ti -1c .RI "char \fBresult\fP [256]" .br -.RI "\fIStores the result of the last GetFullHost or GetRealHost call.\fP" +.RI "\fIStores the result of the last GetFullHost or GetRealHost call. \fP" .ti -1c .RI "int \fBflood\fP" .br -.RI "\fINumber of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.\fP" +.RI "\fINumber of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. \fP" .ti -1c .RI "unsigned long \fBtimeout\fP" .br -.RI "\fINumber of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.\fP" +.RI "\fINumber of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. \fP" .ti -1c .RI "char \fBoper\fP [NICKMAX]" .br -.RI "\fIThe oper type they logged in as, if they are an oper.\fP" +.RI "\fIThe oper type they logged in as, if they are an oper. \fP" .in -1c .SS "Private Attributes" @@ -103,250 +103,264 @@ Inherits \fBconnection\fP. .ti -1c .RI "\fBInvitedList\fP \fBinvites\fP" .br -.RI "\fIA list of channels the user has a pending invite to.\fP" +.RI "\fIA list of channels the user has a pending invite to. \fP" .in -1c .SH "Detailed Description" .PP -Holds all information about a user This class stores all information about a user connected to the irc server. +Holds all information about a user This class stores all information about a user connected to the irc server. Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname. .PP -Definition at line 78 of file users.h. +Definition at line 89 of file users.h. .SH "Constructor & Destructor Documentation" .PP .SS "userrec::userrec ()" .PP -Definition at line 13 of file users.cpp. +Definition at line 25 of file users.cpp. .PP -References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, flood, connection::haspassed, connection::idle_lastmsg, invites, connection::lastping, connection::nping, connection::port, connection::registered, connection::signon, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. .PP .nf -14 { -15 // the PROPER way to do it, AVOID bzero at *ALL* costs -16 strcpy(nick,''); -17 strcpy(ip,'127.0.0.1'); -18 timeout = 0; -19 strcpy(ident,''); -20 strcpy(host,''); -21 strcpy(dhost,''); -22 strcpy(fullname,''); -23 strcpy(modes,''); -24 strcpy(inbuf,''); -25 strcpy(server,''); -26 strcpy(awaymsg,''); -27 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -28 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -29 haspassed = false; -30 strcpy(result,''); -31 for (int i = 0; i < MAXCHANS; i++) -32 { -33 this->chans[i].channel = NULL; -34 this->chans[i].uc_modes = 0; -35 } -36 invites.clear(); -37 } +26 { +27 // the PROPER way to do it, AVOID bzero at *ALL* costs +28 strcpy(nick,''); +29 strcpy(ip,'127.0.0.1'); +30 timeout = 0; +31 strcpy(ident,''); +32 strcpy(host,''); +33 strcpy(dhost,''); +34 strcpy(fullname,''); +35 strcpy(modes,''); +36 strcpy(inbuf,''); +37 strcpy(server,''); +38 strcpy(awaymsg,''); +39 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +40 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +41 haspassed = false; +42 strcpy(result,''); +43 for (int i = 0; i < MAXCHANS; i++) +44 { +45 this->chans[i].channel = NULL; +46 this->chans[i].uc_modes = 0; +47 } +48 invites.clear(); +49 } .fi -.SS "virtual userrec::~userrec ()\fC [inline, virtual]\fP" +.SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 149 of file users.h. +Definition at line 160 of file users.h. .PP .nf -149 { } +160 { } .fi .SH "Member Function Documentation" .PP .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.Definition at line 41 of file users.cpp. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 53 of file users.cpp. .PP -References result. +References dhost, ident, nick, and result. .PP .nf -42 { -43 sprintf(result,'%s!%s@%s',nick,ident,dhost); -44 return result; -45 } +54 { +55 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +56 return result; +57 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 48 of file users.cpp. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 60 of file users.cpp. .PP -References result. +References connection::host, ident, nick, and result. .PP .nf -49 { -50 sprintf(result,'%s!%s@%s',nick,ident,host); -51 return result; -52 } +61 { +62 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +63 return result; +64 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command.This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 97 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 109 of file users.cpp. +.PP +References config_f, and DEBUG. .PP .nf -98 { -99 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -100 char* myclass; -101 char* mycmd; -102 char* savept; -103 char* savept2; -104 -105 // are they even an oper at all? -106 if (strchr(this->modes,'o')) -107 { -108 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -109 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -110 { -111 ConfValue('type','name',j,TypeName,&config_f); -112 if (!strcmp(TypeName,this->oper)) -113 { -114 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -115 ConfValue('type','classes',j,Classes,&config_f); -116 char* myclass = strtok_r(Classes,' ',&savept); -117 while (myclass) -118 { -119 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -120 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -121 { -122 ConfValue('class','name',k,ClassName,&config_f); -123 if (!strcmp(ClassName,myclass)) -124 { -125 ConfValue('class','commands',k,CommandList,&config_f); -126 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -127 -128 -129 mycmd = strtok_r(CommandList,' ',&savept2); -130 while (mycmd) -131 { -132 if (!strcasecmp(mycmd,command)) -133 { -134 log(DEBUG,'*** Command %s found, returning true',command); -135 return true; -136 } -137 mycmd = strtok_r(NULL,' ',&savept2); -138 } -139 } -140 } -141 myclass = strtok_r(NULL,' ',&savept); -142 } -143 } -144 } -145 } -146 return false; -147 } +110 { +111 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +112 char* myclass; +113 char* mycmd; +114 char* savept; +115 char* savept2; +116 +117 // are they even an oper at all? +118 if (strchr(this->modes,'o')) +119 { +120 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +121 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +122 { +123 ConfValue('type','name',j,TypeName,&config_f); +124 if (!strcmp(TypeName,this->oper)) +125 { +126 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +127 ConfValue('type','classes',j,Classes,&config_f); +128 char* myclass = strtok_r(Classes,' ',&savept); +129 while (myclass) +130 { +131 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +132 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +133 { +134 ConfValue('class','name',k,ClassName,&config_f); +135 if (!strcmp(ClassName,myclass)) +136 { +137 ConfValue('class','commands',k,CommandList,&config_f); +138 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +139 +140 +141 mycmd = strtok_r(CommandList,' ',&savept2); +142 while (mycmd) +143 { +144 if (!strcasecmp(mycmd,command)) +145 { +146 log(DEBUG,'*** Command %s found, returning true',command); +147 return true; +148 } +149 mycmd = strtok_r(NULL,' ',&savept2); +150 } +151 } +152 } +153 myclass = strtok_r(NULL,' ',&savept); +154 } +155 } +156 } +157 } +158 return false; +159 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel).Definition at line 68 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 80 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -69 { -70 Invited i; -71 strcpy(i.channel,channel); -72 invites.push_back(i); -73 } +81 { +82 Invited i; +83 strlcpy(i.channel,channel,CHANMAX); +84 invites.push_back(i); +85 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel.Definition at line 54 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 66 of file users.cpp. .PP References invites. .PP .nf -55 { -56 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -57 { -58 if (i->channel) { -59 if (!strcasecmp(i->channel,channel)) -60 { -61 return true; -62 } -63 } -64 } -65 return false; -66 } +67 { +68 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +69 { +70 if (i->channel) { +71 if (!strcasecmp(i->channel,channel)) +72 { +73 return true; +74 } +75 } +76 } +77 return false; +78 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -Removes a channel from a users invite list.This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 75 of file users.cpp. +Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 87 of file users.cpp. .PP -References invites. +References DEBUG, and invites. .PP .nf -76 { -77 log(DEBUG,'Removing invites'); -78 if (channel) -79 { -80 if (invites.size()) -81 { -82 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -83 { -84 if (i->channel) -85 { -86 if (!strcasecmp(i->channel,channel)) -87 { -88 invites.erase(i); -89 return; -90 } -91 } -92 } -93 } -94 } -95 } +88 { +89 log(DEBUG,'Removing invites'); +90 if (channel) +91 { +92 if (invites.size()) +93 { +94 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +95 { +96 if (i->channel) +97 { +98 if (!strcasecmp(i->channel,channel)) +99 { +100 invites.erase(i); +101 return; +102 } +103 } +104 } +105 } +106 } +107 } .fi .SH "Member Data Documentation" .PP -.SS "char userrec::awaymsg[512]" +.SS "char \fBuserrec::awaymsg\fP[512]" +.PP +The user's away message. If this string is empty, the user is not marked as away.Definition at line 132 of file users.h. .PP -The user's away message.If this string is empty, the user is not marked as away.Definition at line 121 of file users.h. -.SS "\fBucrec\fP userrec::chans[MAXCHANS]" +Referenced by userrec(). +.SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]" .PP -Definition at line 112 of file users.h. +Definition at line 123 of file users.h. .PP Referenced by userrec(). -.SS "char userrec::dhost[256]" +.SS "char \fBuserrec::dhost\fP[256]" +.PP +The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 111 of file users.h. +.PP +Referenced by GetFullHost(), and userrec(). +.SS "int \fBuserrec::flood\fP" .PP -The host displayed to non-opers (used for cloaking etc).This usually matches the value of \fBuserrec::host\fP.Definition at line 100 of file users.h. -.SS "int userrec::flood" +Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 143 of file users.h. .PP -Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.Definition at line 132 of file users.h. +Referenced by userrec(). +.SS "char \fBuserrec::fullname\fP[128]" +.PP +The users full name. Definition at line 115 of file users.h. .PP Referenced by userrec(). -.SS "char userrec::fullname[128]" +.SS "char \fBuserrec::ident\fP[64]" .PP -The users full name.Definition at line 104 of file users.h. -.SS "char userrec::ident[64]" +The users ident reply. Definition at line 106 of file users.h. .PP -The users ident reply.Definition at line 95 of file users.h. -.SS "\fBInvitedList\fP userrec::invites\fC [private]\fP" +Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +.SS "\fBInvitedList\fP \fBuserrec::invites\fP\fC [private]\fP" .PP -A list of channels the user has a pending invite to.Definition at line 84 of file users.h. +A list of channels the user has a pending invite to. Definition at line 95 of file users.h. .PP Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). -.SS "char userrec::modes[MAXBUF]" +.SS "char \fBuserrec::modes\fP[MAXBUF]" +.PP +The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 121 of file users.h. .PP -The user's mode string.This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 110 of file users.h. -.SS "char userrec::nick[NICKMAX]" +Referenced by userrec(). +.SS "char \fBuserrec::nick\fP[NICKMAX]" +.PP +The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 102 of file users.h. .PP -The users nickname.An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 91 of file users.h. +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::QuitUser(), and userrec(). +.SS "char \fBuserrec::oper\fP[NICKMAX]" .PP -Referenced by Server::QuitUser(). -.SS "char userrec::oper[NICKMAX]" +The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 156 of file users.h. +.SS "char \fBuserrec::result\fP[256]" .PP -The oper type they logged in as, if they are an oper.This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 145 of file users.h. -.SS "char userrec::result[256]" +Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 137 of file users.h. .PP -Stores the result of the last GetFullHost or GetRealHost call.You may use this to increase the speed of use of this class.Definition at line 126 of file users.h. +Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +.SS "char \fBuserrec::server\fP[256]" .PP -Referenced by GetFullHost(), and GetFullRealHost(). -.SS "char userrec::server[256]" +The server the user is connected to. Definition at line 127 of file users.h. .PP -The server the user is connected to.Definition at line 116 of file users.h. -.SS "unsigned long userrec::timeout" +Referenced by userrec(). +.SS "unsigned long \fBuserrec::timeout\fP" .PP -Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.Definition at line 138 of file users.h. +Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 149 of file users.h. .PP Referenced by userrec(). diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index 5c43f680a..f10abbad6 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -26,9 +26,9 @@ users.cpp \- .in -1c .SH "Variable Documentation" .PP -.SS "std::stringstream config_f" +.SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 11 of file users.cpp. +Definition at line 23 of file users.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index 3abb5c541..20e941809 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -21,15 +21,15 @@ users.h \- .ti -1c .RI "class \fBConnectClass\fP" .br -.RI "\fIHolds information relevent to and tags in the config file.\fP" +.RI "\fIHolds information relevent to and tags in the config file. \fP" .ti -1c .RI "class \fBInvited\fP" .br -.RI "\fIHolds a channel name to which a user has been invited.\fP" +.RI "\fIHolds a channel name to which a user has been invited. \fP" .ti -1c .RI "class \fBuserrec\fP" .br -.RI "\fIHolds all information about a user This class stores all information about a user connected to the irc server.\fP" +.RI "\fIHolds all information about a user This class stores all information about a user connected to the irc server. \fP" .in -1c .SS "Defines" @@ -59,40 +59,40 @@ users.h \- .ti -1c .RI "typedef std::vector< \fBInvited\fP > \fBInvitedList\fP" .br -.RI "\fIHolds a complete list of all channels to which a user has been invited and has not yet joined.\fP" +.RI "\fIHolds a complete list of all channels to which a user has been invited and has not yet joined. \fP" .ti -1c .RI "typedef std::vector< \fBConnectClass\fP > \fBClassVector\fP" .br -.RI "\fIHolds a complete list of all allow and deny tags from the configuration file (connection classes).\fP" +.RI "\fIHolds a complete list of all allow and deny tags from the configuration file (connection classes). \fP" .in -1c .SH "Define Documentation" .PP .SS "#define CC_ALLOW 0" .PP -Definition at line 20 of file users.h. +Definition at line 31 of file users.h. .SS "#define CC_DENY 1" .PP -Definition at line 21 of file users.h. +Definition at line 32 of file users.h. .SS "#define STATUS_HOP 2" .PP -Definition at line 16 of file users.h. +Definition at line 27 of file users.h. .SS "#define STATUS_NORMAL 0" .PP -Definition at line 18 of file users.h. +Definition at line 29 of file users.h. .SS "#define STATUS_OP 4" .PP -Definition at line 15 of file users.h. +Definition at line 26 of file users.h. .SS "#define STATUS_VOICE 1" .PP -Definition at line 17 of file users.h. +Definition at line 28 of file users.h. .SH "Typedef Documentation" .PP -.SS "typedef std::vector<\fBConnectClass\fP> ClassVector" +.SS "typedef std::vector<\fBConnectClass\fP> \fBClassVector\fP" .PP -Holds a complete list of all allow and deny tags from the configuration file (connection classes).Definition at line 70 of file users.h. -.SS "typedef std::vector<\fBInvited\fP> InvitedList" +Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 81 of file users.h. +.SS "typedef std::vector<\fBInvited\fP> \fBInvitedList\fP" .PP -Holds a complete list of all channels to which a user has been invited and has not yet joined.Definition at line 64 of file users.h. +Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 75 of file users.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 2db737493..a0b5fea50 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -29,23 +29,23 @@ xline.h \- .ti -1c .RI "class \fBGLine\fP" .br -.RI "\fIGLine class.\fP" +.RI "\fIGLine class. \fP" .ti -1c .RI "class \fBKLine\fP" .br -.RI "\fIKLine class.\fP" +.RI "\fIKLine class. \fP" .ti -1c .RI "class \fBQLine\fP" .br -.RI "\fIQLine class.\fP" +.RI "\fIQLine class. \fP" .ti -1c .RI "class \fBXLine\fP" .br -.RI "\fIXLine is the base class for ban lines such as G lines and K lines.\fP" +.RI "\fIXLine is the base class for ban lines such as G lines and K lines. \fP" .ti -1c .RI "class \fBZLine\fP" .br -.RI "\fIZLine class.\fP" +.RI "\fIZLine class. \fP" .in -1c .SS "Functions" diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index 150079420..248e8ce91 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -1,50 +1,49 @@ -Annotated Index +InspIRCd: Annotated Index - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

InspIRCd Compound List

Here are the classes, structs, unions and interfaces with brief descriptions: - - - - - - - - - - + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

InspIRCd Compound List

Here are the classes, structs, unions and interfaces with brief descriptions:
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
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
connectionPlease note: classes serverrec and userrec both inherit from class connection
ExemptItemA subclass of HostItem designed to hold channel exempts (+e)
ExtensibleClass Extensible is the parent class of many classes such as userrec and chanrec
+ + + + + + + + + + - - + + + + + + + + + + + - - - - - - - - - - - - - + + + + - - - - - + + + + +
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
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
connectionPlease note: classes serverrec and userrec both inherit from class connection
ExemptItemA subclass of HostItem designed to hold channel exempts (+e)
ExtensibleClass Extensible is the parent class of many classes such as userrec and chanrec
ExtMode
FileReaderCaches a text file into memory and can be used to retrieve lines from it
GLineGLine class
FileReaderCaches a text file into memory and can be used to retrieve lines from it
GLineGLine class
HostItemHolds an entry for a ban list, exemption list, or invite list
InAddr_HashComp
InvitedHolds a channel name to which a user has been invited
InviteItemA subclass of HostItem designed to hold channel invites (+I)
ircd_connectorEach connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds
KLineKLine class
ModeParameterHolds a custom parameter to a module-defined channel mode e.g
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
nspace::hash< in_addr >
nspace::hash< string >
HostItemHolds an entry for a ban list, exemption list, or invite list
InAddr_HashComp
InvitedHolds a channel name to which a user has been invited
InviteItemA subclass of HostItem designed to hold channel invites (+I)
ircd_connectorEach connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds
KLineKLine class
ModeParameterHolds a custom parameter to a module-defined channel mode e.g
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
packetClass packet is deprecated
QLineQLine class
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
serverrecA class that defines the local server or a remote server
packetClass packet is deprecated
QLineQLine class
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
serverrecA class that defines the local server or a remote server
StrHashComp
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
XLineXLine is the base class for ban lines such as G lines and K lines
ZLineZLine class
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
XLineXLine is the base class for ban lines such as G lines and K lines
ZLineZLine class
-
Generated on Sun May 2 00:09:29 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/base_8h-source.html b/docs/module-doc/base_8h-source.html index 3de7c4079..8adefdfe8 100644 --- a/docs/module-doc/base_8h-source.html +++ b/docs/module-doc/base_8h-source.html @@ -1,52 +1,63 @@ -base.h Source File +InspIRCd: base.h Source File - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

base.h

Go to the documentation of this file.
00001 /*
-00002 Defines the base classes used by InspIRCd
-00003 */
-00004 
-00005 #ifndef __BASE_H__ 
-00006 #define __BASE_H__ 
-00007 
-00008 #include "inspircd_config.h" 
-00009 #include <time.h>
-00010 #include <map>
-00011 #include <string>
-00012 
-00013 typedef void* VoidPointer;
-00014  
-00017 class classbase
-00018 {
-00019  public:
-00022         time_t age;
-00023 
-00027         classbase() { age = time(NULL); }
-00028         ~classbase() { }
-00029 };
-00030 
-00038 class Extensible : public classbase
-00039 {
-00042         std::map<std::string,char*> Extension_Items;
-00043         
-00044 public:
-00045 
-00052         bool Extend(std::string key, char* p);
-00053 
-00059         bool Shrink(std::string key);
-00060         
-00065         char* GetExt(std::string key);
-00066 };
-00067 
-00068 #endif
-00069 
-
Generated on Sun May 2 00:09:18 2004 for InspIRCd by + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

base.h

Go to the documentation of this file.
00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #ifndef __BASE_H__ 
+00018 #define __BASE_H__ 
+00019 
+00020 #include "inspircd_config.h" 
+00021 #include <time.h>
+00022 #include <map>
+00023 #include <string>
+00024 
+00025 typedef void* VoidPointer;
+00026  
+00029 class classbase
+00030 {
+00031  public:
+00034         time_t age;
+00035 
+00039         classbase() { age = time(NULL); }
+00040         ~classbase() { }
+00041 };
+00042 
+00050 class Extensible : public classbase
+00051 {
+00054         std::map<std::string,char*> Extension_Items;
+00055         
+00056 public:
+00057 
+00064         bool Extend(std::string key, char* p);
+00065 
+00071         bool Shrink(std::string key);
+00072         
+00077         char* GetExt(std::string key);
+00078 };
+00079 
+00080 #endif
+00081 
+
Generated on Fri Mar 25 03:49:26 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/base_8h.html b/docs/module-doc/base_8h.html index 4f51260bc..46e433aab 100644 --- a/docs/module-doc/base_8h.html +++ b/docs/module-doc/base_8h.html @@ -1,47 +1,37 @@ -base.h File Reference +InspIRCd: base.h File Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

base.h File Reference

#include "inspircd_config.h"
+ +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

base.h File Reference

#include "inspircd_config.h"
#include <time.h>
#include <map>
#include <string>
-

-Include dependency graph for base.h:

Include dependency graph
- -

-This graph shows which files directly or indirectly include this file:

Included by dependency graph
- - - - - - -

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

Compounds

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

class  Extensible
 class Extensible is the parent class of many classes such as userrec and chanrec. More...

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

class  Extensible
 class Extensible is the parent class of many classes such as userrec and chanrec. More...


Typedefs

typedef void * VoidPointer
typedef void * VoidPointer

Typedef Documentation

- +
- @@ -56,12 +46,12 @@ This graph shows which files directly or indirectly include this file:

-Definition at line 13 of file base.h. +Definition at line 25 of file base.h.

+ -
typedef void* VoidPointer + typedef void* VoidPointer
-

Generated on Sun May 2 00:09:19 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:29 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/channels_8cpp-source.html b/docs/module-doc/channels_8cpp-source.html index 51d99f553..2e474e22d 100644 --- a/docs/module-doc/channels_8cpp-source.html +++ b/docs/module-doc/channels_8cpp-source.html @@ -1,199 +1,210 @@ -channels.cpp Source File +InspIRCd: channels.cpp Source File - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

channels.cpp

Go to the documentation of this file.
00001 #include "inspircd.h"
-00002 #include "inspircd_io.h"
-00003 #include "inspircd_util.h"
-00004 #include "inspircd_config.h"
-00005 #include <unistd.h>
-00006 #include <fcntl.h>
-00007 #include <sys/errno.h>
-00008 #include <sys/ioctl.h>
-00009 #include <sys/utsname.h>
-00010 #include <cstdio>
-00011 #include <time.h>
-00012 #include <string>
-00013 #ifdef GCC3
-00014 #include <ext/hash_map>
-00015 #else
-00016 #include <hash_map>
-00017 #endif
-00018 #include <map>
-00019 #include <sstream>
-00020 #include <vector>
-00021 #include <errno.h>
-00022 #include <deque>
-00023 #include <errno.h>
-00024 #include <unistd.h>
-00025 #include <sched.h>
-00026 #include "connection.h"
-00027 #include "users.h"
-00028 #include "servers.h"
-00029 #include "ctables.h"
-00030 #include "globals.h"
-00031 #include "modules.h"
-00032 #include "dynamic.h"
-00033 #include "wildcard.h"
-00034 #include "message.h"
-00035 #include "mode.h"
-00036 #include "xline.h"
-00037 
-00038 #ifdef GCC3
-00039 #define nspace __gnu_cxx
-00040 #else
-00041 #define nspace std
-00042 #endif
-00043 
-00044 using namespace std;
-00045 
-00046 extern int MODCOUNT;
-00047 extern vector<Module*> modules;
-00048 extern vector<ircd_module*> factory;
-00049 
-00050 extern int LogLevel;
-00051 extern char ServerName[MAXBUF];
-00052 extern char Network[MAXBUF];
-00053 extern char ServerDesc[MAXBUF];
-00054 extern char AdminName[MAXBUF];
-00055 extern char AdminEmail[MAXBUF];
-00056 extern char AdminNick[MAXBUF];
-00057 extern char diepass[MAXBUF];
-00058 extern char restartpass[MAXBUF];
-00059 extern char motd[MAXBUF];
-00060 extern char rules[MAXBUF];
-00061 extern char list[MAXBUF];
-00062 extern char PrefixQuit[MAXBUF];
-00063 extern char DieValue[MAXBUF];
-00064 
-00065 extern int debugging;
-00066 extern int WHOWAS_STALE;
-00067 extern int WHOWAS_MAX;
-00068 extern int DieDelay;
-00069 extern time_t startup_time;
-00070 extern int NetBufferSize;
-00071 int MaxWhoResults;
-00072 extern time_t nb_start;
-00073 
-00074 extern std::vector<int> fd_reap;
-00075 extern std::vector<std::string> module_names;
-00076 
-00077 extern char bannerBuffer[MAXBUF];
-00078 extern int boundPortCount;
-00079 extern int portCount;
-00080 extern int UDPportCount;
-00081 extern int ports[MAXSOCKS];
-00082 extern int defaultRoute;
-00083 
-00084 extern std::vector<long> auth_cookies;
-00085 extern std::stringstream config_f;
-00086 
-00087 extern serverrec* me[32];
-00088 
-00089 extern FILE *log_file;
-00090 
-00091 
-00092 using namespace std;
-00093 
-00094 std::vector<ModeParameter> custom_mode_params;
-00095 
-00096 chanrec::chanrec()
-00097 {
-00098         strcpy(name,"");
-00099         strcpy(custom_modes,"");
-00100         strcpy(topic,"");
-00101         strcpy(setby,"");
-00102         strcpy(key,"");
-00103         created = topicset = limit = 0;
-00104         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
-00105 }
+
+
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

+
channels.cpp
Go to the documentation of this file.
00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #include "inspircd.h"
+00018 #include "inspircd_io.h"
+00019 #include "inspircd_util.h"
+00020 #include "inspircd_config.h"
+00021 #include <unistd.h>
+00022 #include <fcntl.h>
+00023 #include <sys/errno.h>
+00024 #include <sys/ioctl.h>
+00025 #include <sys/utsname.h>
+00026 #include <cstdio>
+00027 #include <time.h>
+00028 #include <string>
+00029 #ifdef GCC3
+00030 #include <ext/hash_map>
+00031 #else
+00032 #include <hash_map>
+00033 #endif
+00034 #include <map>
+00035 #include <sstream>
+00036 #include <vector>
+00037 #include <errno.h>
+00038 #include <deque>
+00039 #include <errno.h>
+00040 #include <unistd.h>
+00041 #include <sched.h>
+00042 #include "connection.h"
+00043 #include "users.h"
+00044 #include "servers.h"
+00045 #include "ctables.h"
+00046 #include "globals.h"
+00047 #include "modules.h"
+00048 #include "dynamic.h"
+00049 #include "wildcard.h"
+00050 #include "message.h"
+00051 #include "mode.h"
+00052 #include "xline.h"
+00053 
+00054 #ifdef GCC3
+00055 #define nspace __gnu_cxx
+00056 #else
+00057 #define nspace std
+00058 #endif
+00059 
+00060 using namespace std;
+00061 
+00062 extern int MODCOUNT;
+00063 extern vector<Module*> modules;
+00064 extern vector<ircd_module*> factory;
+00065 
+00066 extern int LogLevel;
+00067 extern char ServerName[MAXBUF];
+00068 extern char Network[MAXBUF];
+00069 extern char ServerDesc[MAXBUF];
+00070 extern char AdminName[MAXBUF];
+00071 extern char AdminEmail[MAXBUF];
+00072 extern char AdminNick[MAXBUF];
+00073 extern char diepass[MAXBUF];
+00074 extern char restartpass[MAXBUF];
+00075 extern char motd[MAXBUF];
+00076 extern char rules[MAXBUF];
+00077 extern char list[MAXBUF];
+00078 extern char PrefixQuit[MAXBUF];
+00079 extern char DieValue[MAXBUF];
+00080 
+00081 extern int debugging;
+00082 extern int WHOWAS_STALE;
+00083 extern int WHOWAS_MAX;
+00084 extern int DieDelay;
+00085 extern time_t startup_time;
+00086 extern int NetBufferSize;
+00087 int MaxWhoResults;
+00088 extern time_t nb_start;
+00089 
+00090 extern std::vector<int> fd_reap;
+00091 extern std::vector<std::string> module_names;
+00092 
+00093 extern int boundPortCount;
+00094 extern int portCount;
+00095 extern int UDPportCount;
+00096 extern int ports[MAXSOCKS];
+00097 extern int defaultRoute;
+00098 
+00099 extern std::vector<long> auth_cookies;
+00100 extern std::stringstream config_f;
+00101 
+00102 extern serverrec* me[32];
+00103 
+00104 extern FILE *log_file;
+00105 
 00106 
-00107 void chanrec::SetCustomMode(char mode,bool mode_on)
-00108 {
-00109         if (mode_on) {
-00110                 char m[3];
-00111                 m[0] = mode;
-00112                 m[1] = '\0';
-00113                 if (!strchr(this->custom_modes,mode))
-00114                 {
-00115                         strncat(custom_modes,m,MAXMODES);
-00116                 }
-00117                 log(DEBUG,"Custom mode %c set",mode);
-00118         }
-00119         else {
-00120                 char temp[MAXBUF];
-00121                 int count = 0;
-00122                 for (int q = 0; q < strlen(custom_modes); q++) {
-00123                         if (custom_modes[q] != mode) {
-00124                                 temp[count++] = mode;
-00125                         }
-00126                 }
-00127                 temp[count] = '\0';
-00128                 strncpy(custom_modes,temp,MAXMODES);
-00129                 log(DEBUG,"Custom mode %c removed",mode);
-00130                 this->SetCustomModeParam(mode,"",false);
-00131         }
-00132 }
-00133 
-00134 
-00135 void chanrec::SetCustomModeParam(char mode,char* parameter,bool mode_on)
-00136 {
-00137 
-00138         log(DEBUG,"SetCustomModeParam called");
-00139         ModeParameter M;
-00140         M.mode = mode;
-00141         strcpy(M.channel,this->name);
-00142         strcpy(M.parameter,parameter);
-00143         if (mode_on)
-00144         {
-00145                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
-00146                 custom_mode_params.push_back(M);
-00147         }
-00148         else
-00149         {
-00150                 if (custom_mode_params.size())
-00151                 {
-00152                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00153                         {
-00154                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00155                                 {
-00156                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
-00157                                         custom_mode_params.erase(i);
-00158                                         return;
-00159                                 }
-00160                         }
-00161                 }
-00162                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
-00163         }
-00164 }
-00165 
-00166 bool chanrec::IsCustomModeSet(char mode)
-00167 {
-00168         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
-00169         return (strchr(this->custom_modes,mode) != 0);
-00170 }
-00171 
-00172 std::string chanrec::GetModeParameter(char mode)
-00173 {
-00174         if (custom_mode_params.size())
-00175         {
-00176                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00177                 {
-00178                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00179                         {
-00180                                 return std::string(i->parameter);
-00181                         }
-00182                 }
-00183         }
-00184         return std::string("");
-00185 }
-
Generated on Sun May 2 00:09:18 2004 for InspIRCd by
+00107 using namespace std;
+00108 
+00109 std::vector<ModeParameter> custom_mode_params;
+00110 
+00111 chanrec::chanrec()
+00112 {
+00113         strcpy(name,"");
+00114         strcpy(custom_modes,"");
+00115         strcpy(topic,"");
+00116         strcpy(setby,"");
+00117         strcpy(key,"");
+00118         created = topicset = limit = 0;
+00119         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
+00120 }
+00121 
+00122 void chanrec::SetCustomMode(char mode,bool mode_on)
+00123 {
+00124         if (mode_on) {
+00125                 char m[3];
+00126                 m[0] = mode;
+00127                 m[1] = '\0';
+00128                 if (!strchr(this->custom_modes,mode))
+00129                 {
+00130                         strlcat(custom_modes,m,MAXMODES);
+00131                 }
+00132                 log(DEBUG,"Custom mode %c set",mode);
+00133         }
+00134         else {
+00135 
+00136                 std::string a = this->custom_modes;
+00137                 int pos = a.find(mode);
+00138                 a.erase(pos,1);
+00139                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
+00140 
+00141                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
+00142                 this->SetCustomModeParam(mode,"",false);
+00143         }
+00144 }
+00145 
+00146 
+00147 void chanrec::SetCustomModeParam(char mode,char* parameter,bool mode_on)
+00148 {
+00149 
+00150         log(DEBUG,"SetCustomModeParam called");
+00151         ModeParameter M;
+00152         M.mode = mode;
+00153         strlcpy(M.channel,this->name,CHANMAX);
+00154         strlcpy(M.parameter,parameter,MAXBUF);
+00155         if (mode_on)
+00156         {
+00157                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
+00158                 custom_mode_params.push_back(M);
+00159         }
+00160         else
+00161         {
+00162                 if (custom_mode_params.size())
+00163                 {
+00164                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00165                         {
+00166                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00167                                 {
+00168                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
+00169                                         custom_mode_params.erase(i);
+00170                                         return;
+00171                                 }
+00172                         }
+00173                 }
+00174                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
+00175         }
+00176 }
+00177 
+00178 bool chanrec::IsCustomModeSet(char mode)
+00179 {
+00180         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
+00181         return (strchr(this->custom_modes,mode) != 0);
+00182 }
+00183 
+00184 std::string chanrec::GetModeParameter(char mode)
+00185 {
+00186         if (custom_mode_params.size())
+00187         {
+00188                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00189                 {
+00190                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00191                         {
+00192                                 return std::string(i->parameter);
+00193                         }
+00194                 }
+00195         }
+00196         return std::string("");
+00197 }
+
Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3 diff --git a/docs/module-doc/channels_8cpp.html b/docs/module-doc/channels_8cpp.html index 3f8440b4a..84283bee2 100644 --- a/docs/module-doc/channels_8cpp.html +++ b/docs/module-doc/channels_8cpp.html @@ -1,12 +1,11 @@ -channels.cpp File Reference +InspIRCd: channels.cpp File Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

channels.cpp File Reference

#include "inspircd.h"
+ +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

channels.cpp File Reference

#include "inspircd.h"
#include "inspircd_io.h"
#include "inspircd_util.h"
#include "inspircd_config.h"
@@ -37,71 +36,96 @@ #include "mode.h"
#include "xline.h"
-

-Include dependency graph for channels.cpp:

Include dependency graph
- - - - - - - - - - -

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

Namespaces

namespace  std
namespace  std

Defines

#define nspace   std
#define nspace   std

Variables

int MODCOUNT = -1
vector< Module * > modules
vector< ircd_module * > factory
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< int > fd_reap
std::vector< std::string > module_names
char bannerBuffer [MAXBUF]
int boundPortCount
int portCount
int UDPportCount
int ports [MAXSOCKS]
int defaultRoute
std::vector< long > auth_cookies
std::stringstream config_f
serverrec * me [32]
FILE * log_file
std::vector< ModeParameter > custom_mode_params
int MODCOUNT = -1
vector< Module * > modules
vector< ircd_module * > factory
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< int > fd_reap
std::vector< std::string > module_names
int boundPortCount
int portCount
int UDPportCount
int ports [MAXSOCKS]
int defaultRoute
std::vector< long > auth_cookies
std::stringstream config_f
serverrec * me [32]
FILE * log_file
std::vector< ModeParameter > custom_mode_params

Define Documentation

- +
-
+ +Definition at line 57 of file channels.cpp.
#define nspace   std @@ -119,17 +143,17 @@ Include dependency graph for channels.cpp:

41 of file channels.cpp.

Variable Documentation

- +
- @@ -144,16 +168,16 @@ Definition at line 41

-Definition at line 55 of file channels.cpp. +Definition at line 71 of file channels.cpp.

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

- +
- @@ -168,16 +192,16 @@ Definition at line 55

-Definition at line 54 of file channels.cpp. +Definition at line 70 of file channels.cpp.

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

- +
- @@ -192,16 +216,16 @@ Definition at line 54

-Definition at line 56 of file channels.cpp. +Definition at line 72 of file channels.cpp.

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

- +

+

- @@ -216,16 +240,16 @@ Definition at line 56

-Definition at line 84 of file channels.cpp. +Definition at line 99 of file channels.cpp.

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

- +

+

- @@ -240,16 +264,16 @@ Definition at line 84

-Definition at line 77 of file channels.cpp. +Definition at line 93 of file channels.cpp.

+ -
char bannerBuffer[MAXBUF] + int boundPortCount
-

- +

+

- @@ -264,40 +288,18 @@ Definition at line 77

-Definition at line 78 of file channels.cpp. - -

+ -
int boundPortCount + std::stringstream config_f
-

- - - - -
- - -
std::stringstream config_f -
-
- - - - +Referenced by userrec::HasPermission().
-   - - +Definition at line 100 of file channels.cpp.

- -

-Definition at line 85 of file channels.cpp.

-

- +

+

- @@ -312,18 +314,18 @@ Definition at line 85

-Definition at line 94 of file channels.cpp. +Definition at line 109 of file channels.cpp.

-Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam(). +Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam().

+ -
std::vector<ModeParameter> custom_mode_params + std::vector<ModeParameter> custom_mode_params

- +
- @@ -338,16 +340,16 @@ Referenced by chanrec::Get

-Definition at line 65 of file channels.cpp. +Definition at line 81 of file channels.cpp.

+ -
int debugging + int debugging
-

- +

+

- @@ -362,16 +364,16 @@ Definition at line 65

-Definition at line 82 of file channels.cpp. +Definition at line 97 of file channels.cpp.

+ -
int defaultRoute + int defaultRoute

- +
- @@ -386,16 +388,16 @@ Definition at line 82

-Definition at line 68 of file channels.cpp. +Definition at line 84 of file channels.cpp.

+ -
int DieDelay + int DieDelay

- +
- @@ -410,16 +412,16 @@ Definition at line 68

-Definition at line 57 of file channels.cpp. +Definition at line 73 of file channels.cpp.

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

- +
- @@ -434,13 +436,13 @@ Definition at line 57

-Definition at line 63 of file channels.cpp. +Definition at line 79 of file channels.cpp.

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

- +
-
+ +Definition at line 64 of file channels.cpp.
vector<ircd_module*> factory @@ -458,16 +460,16 @@ Definition at line 63

-Definition at line 48 of file channels.cpp.

- +
- @@ -482,16 +484,16 @@ Definition at line 48

-Definition at line 74 of file channels.cpp. +Definition at line 90 of file channels.cpp.

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

- +
- @@ -506,16 +508,16 @@ Definition at line 74

-Definition at line 61 of file channels.cpp. +Definition at line 77 of file channels.cpp.

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

- +

+

- @@ -530,16 +532,16 @@ Definition at line 61

-Definition at line 89 of file channels.cpp. +Definition at line 104 of file channels.cpp.

+ -
FILE* log_file + FILE* log_file

- +
- @@ -554,16 +556,16 @@ Definition at line 89

-Definition at line 50 of file channels.cpp. +Definition at line 66 of file channels.cpp.

+ -
int LogLevel + int LogLevel

- +
- @@ -578,16 +580,16 @@ Definition at line 50

-Definition at line 71 of file channels.cpp. +Definition at line 87 of file channels.cpp.

+ -
int MaxWhoResults + int MaxWhoResults
-

- +

+

- @@ -602,16 +604,16 @@ Definition at line 71

-Definition at line 87 of file channels.cpp. +Definition at line 102 of file channels.cpp.

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

- +
- @@ -626,16 +628,16 @@ Definition at line 87

-Definition at line 714 of file modules.cpp. +Definition at line 763 of file modules.cpp.

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

- +
- @@ -650,13 +652,13 @@ Definition at line 714

-Definition at line 75 of file channels.cpp. +Definition at line 91 of file channels.cpp.

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

- +
-
+ +Definition at line 63 of file channels.cpp.
vector<Module*> modules @@ -674,16 +676,16 @@ Definition at line 75

-Definition at line 47 of file channels.cpp.

- +
- @@ -698,16 +700,16 @@ Definition at line 47

-Definition at line 59 of file channels.cpp. +Definition at line 75 of file channels.cpp.

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

- +
- @@ -722,16 +724,16 @@ Definition at line 59

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

+ -
time_t nb_start + time_t nb_start

- +
- @@ -746,16 +748,16 @@ Definition at line 72

-Definition at line 70 of file channels.cpp. +Definition at line 86 of file channels.cpp.

+ -
int NetBufferSize + int NetBufferSize

- +
- @@ -770,16 +772,16 @@ Definition at line 70

-Definition at line 52 of file channels.cpp. +Definition at line 68 of file channels.cpp.

+ -
char Network[MAXBUF] + char Network[MAXBUF]
-

- +

+

- @@ -794,16 +796,16 @@ Definition at line 52

-Definition at line 79 of file channels.cpp. +Definition at line 94 of file channels.cpp.

+ -
int portCount + int portCount
-

- +

+

- @@ -818,16 +820,16 @@ Definition at line 79

-Definition at line 81 of file channels.cpp. +Definition at line 96 of file channels.cpp.

+ -
int ports[MAXSOCKS] + int ports[MAXSOCKS]

- +
- @@ -842,16 +844,16 @@ Definition at line 81

-Definition at line 62 of file channels.cpp. +Definition at line 78 of file channels.cpp.

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

- +
- @@ -866,16 +868,16 @@ Definition at line 62

-Definition at line 58 of file channels.cpp. +Definition at line 74 of file channels.cpp.

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

- +
- @@ -890,16 +892,16 @@ Definition at line 58

-Definition at line 60 of file channels.cpp. +Definition at line 76 of file channels.cpp.

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

- +
- @@ -914,16 +916,16 @@ Definition at line 60

-Definition at line 53 of file channels.cpp. +Definition at line 69 of file channels.cpp.

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

- +
- @@ -938,16 +940,16 @@ Definition at line 53

-Definition at line 51 of file channels.cpp. +Definition at line 67 of file channels.cpp.

+ -
char ServerName[MAXBUF] + char ServerName[MAXBUF]

- +
- @@ -962,16 +964,16 @@ Definition at line 51

-Definition at line 69 of file channels.cpp. +Definition at line 85 of file channels.cpp.

+ -
time_t startup_time + time_t startup_time
-

- +

+

- @@ -986,16 +988,16 @@ Definition at line 69

-Definition at line 80 of file channels.cpp. +Definition at line 95 of file channels.cpp.

+ -
int UDPportCount + int UDPportCount

- +
- @@ -1010,16 +1012,16 @@ Definition at line 80

-Definition at line 67 of file channels.cpp. +Definition at line 83 of file channels.cpp.

+ -
int WHOWAS_MAX + int WHOWAS_MAX

- +
- @@ -1034,12 +1036,12 @@ Definition at line 67

-Definition at line 66 of file channels.cpp. +Definition at line 82 of file channels.cpp.

+ -
int WHOWAS_STALE + int WHOWAS_STALE
-

Generated on Sun May 2 00:09:20 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:29 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html index fc7d4a5ec..d768a44a0 100644 --- a/docs/module-doc/channels_8h-source.html +++ b/docs/module-doc/channels_8h-source.html @@ -1,137 +1,147 @@ -channels.h Source File +InspIRCd: channels.h Source File - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

channels.h

Go to the documentation of this file.
00001 /*
-00002 
-00003    
-00004 */
-00005 
-00006 #include "inspircd_config.h"
-00007 #include "base.h"
-00008 #include <time.h>
-00009 #include <vector>
-00010 #include <string>
-00011 
-00012 #ifndef __CHANNELS_H__
-00013 #define __CHANNELS_H__
-00014 
-00018 class HostItem : public classbase
-00019 {
-00020  public:
-00021         time_t set_time;
-00022         char set_by[NICKMAX];
-00023         char data[MAXBUF];
-00024 
-00025         HostItem() { /* stub */ }
-00026         virtual ~HostItem() { /* stub */ }
-00027 };
-00028 
-00029 // banlist is inherited from HostList mainly for readability
-00030 // reasons only
-00031 
-00034 class BanItem : public HostItem
-00035 {
-00036 };
-00037 
-00038 // same with this...
+
+
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

+
channels.h
Go to the documentation of this file.
00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #include "inspircd_config.h"
+00018 #include "base.h"
+00019 #include <time.h>
+00020 #include <vector>
+00021 #include <string>
+00022 
+00023 #ifndef __CHANNELS_H__
+00024 #define __CHANNELS_H__
+00025 
+00029 class HostItem : public classbase
+00030 {
+00031  public:
+00032         time_t set_time;
+00033         char set_by[NICKMAX];
+00034         char data[MAXBUF];
+00035 
+00036         HostItem() { /* stub */ }
+00037         virtual ~HostItem() { /* stub */ }
+00038 };
 00039 
-00042 class ExemptItem : public HostItem
-00043 {
-00044 };
-00045 
-00046 // and this...
-00047 
-00050 class InviteItem : public HostItem
-00051 {
-00052 };
-00053 
-00054 
-00059 class ModeParameter : public classbase
-00060 {
-00061  public:
-00062         char mode;
-00063         char parameter[MAXBUF];
-00064         char channel[CHANMAX];
-00065 };
-00066 
-00069 typedef std::vector<BanItem>    BanList;
-00070 
-00073 typedef std::vector<ExemptItem> ExemptList;
-00074 
-00077 typedef std::vector<InviteItem> InviteList;
-00078 
-00083 class chanrec : public Extensible
-00084 {
-00085  public:
-00088         char name[CHANMAX]; /* channel name */
-00092         char custom_modes[MAXMODES];     /* modes handled by modules */
-00093         
-00097         char topic[MAXBUF];
-00100         time_t created;
-00104         time_t topicset;
-00108         char setby[NICKMAX];
-00109 
-00113         long limit;
-00114         
-00118         char key[32];
-00119         
-00122         short int topiclock;
-00123         
-00126         short int noexternal;
-00127         
-00130         short int inviteonly;
-00131         
-00134         short int moderated;
-00135         
-00139         short int secret;
-00140         
-00144         short int c_private;
-00145         
-00148         BanList bans;
-00149         
-00152         void SetCustomMode(char mode,bool mode_on);
-00153 
-00156         void SetCustomModeParam(char mode,char* parameter,bool mode_on);
-00157  
-00160         bool IsCustomModeSet(char mode);
-00161 
-00168         std::string GetModeParameter(char mode);
-00169 
-00172         chanrec();
-00173 
-00174         virtual ~chanrec() { /* stub */ }
-00175 };
-00176 
-00177 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
-00178  * needs to come AFTER struct chanrec */
-00179 
-00180 #define UCMODE_OP      1
-00181 #define UCMODE_VOICE   2
-00182 #define UCMODE_HOP     4
-00183 #define UCMODE_PROTECT 8
-00184 #define UCMODE_FOUNDER 16
-00185  
-00191 class ucrec : public classbase
-00192 {
-00193  public:
-00197         long uc_modes;
-00198         
-00202         chanrec *channel;
-00203 
-00204         ucrec() { /* stub */ }
-00205         virtual ~ucrec() { /* stub */ }
-00206 };
-00207 
-00208 #endif
-00209 
-
Generated on Sun May 2 00:09:18 2004 for InspIRCd by
+00040 // banlist is inherited from HostList mainly for readability
+00041 // reasons only
+00042 
+00045 class BanItem : public HostItem
+00046 {
+00047 };
+00048 
+00049 // same with this...
+00050 
+00053 class ExemptItem : public HostItem
+00054 {
+00055 };
+00056 
+00057 // and this...
+00058 
+00061 class InviteItem : public HostItem
+00062 {
+00063 };
+00064 
+00065 
+00070 class ModeParameter : public classbase
+00071 {
+00072  public:
+00073         char mode;
+00074         char parameter[MAXBUF];
+00075         char channel[CHANMAX];
+00076 };
+00077 
+00080 typedef std::vector<BanItem>    BanList;
+00081 
+00084 typedef std::vector<ExemptItem> ExemptList;
+00085 
+00088 typedef std::vector<InviteItem> InviteList;
+00089 
+00094 class chanrec : public Extensible
+00095 {
+00096  public:
+00099         char name[CHANMAX]; /* channel name */
+00103         char custom_modes[MAXMODES];     /* modes handled by modules */
+00104         
+00108         char topic[MAXBUF];
+00111         time_t created;
+00115         time_t topicset;
+00119         char setby[NICKMAX];
+00120 
+00124         long limit;
+00125         
+00129         char key[32];
+00130         
+00133         short int topiclock;
+00134         
+00137         short int noexternal;
+00138         
+00141         short int inviteonly;
+00142         
+00145         short int moderated;
+00146         
+00150         short int secret;
+00151         
+00155         short int c_private;
+00156         
+00159         BanList bans;
+00160         
+00163         void SetCustomMode(char mode,bool mode_on);
+00164 
+00167         void SetCustomModeParam(char mode,char* parameter,bool mode_on);
+00168  
+00171         bool IsCustomModeSet(char mode);
+00172 
+00179         std::string GetModeParameter(char mode);
+00180 
+00183         chanrec();
+00184 
+00185         virtual ~chanrec() { /* stub */ }
+00186 };
+00187 
+00188 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
+00189  * needs to come AFTER struct chanrec */
+00190 
+00191 #define UCMODE_OP      1
+00192 #define UCMODE_VOICE   2
+00193 #define UCMODE_HOP     4
+00194 #define UCMODE_PROTECT 8
+00195 #define UCMODE_FOUNDER 16
+00196  
+00202 class ucrec : public classbase
+00203 {
+00204  public:
+00208         long uc_modes;
+00209         
+00213         chanrec *channel;
+00214 
+00215         ucrec() { /* stub */ }
+00216         virtual ~ucrec() { /* stub */ }
+00217 };
+00218 
+00219 #endif
+00220 
+
Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3 diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html index d4d8fdea6..8bc451f8b 100644 --- a/docs/module-doc/channels_8h.html +++ b/docs/module-doc/channels_8h.html @@ -1,73 +1,68 @@ -channels.h File Reference +InspIRCd: channels.h File Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

channels.h File Reference

#include "inspircd_config.h"
+ +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

channels.h File Reference

#include "inspircd_config.h"
#include "base.h"
#include <time.h>
#include <vector>
#include <string>
-

-Include dependency graph for channels.h:

Include dependency graph
- - - - -

-This graph shows which files directly or indirectly include this file:

Included by dependency graph
- - - - - - - - - - -

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

Compounds

class  BanItem
 A subclass of HostItem designed to hold channel bans (+b). More...

class  chanrec
 Holds all relevent information for a channel. More...

class  ExemptItem
 A subclass of HostItem designed to hold channel exempts (+e). More...

class  HostItem
 Holds an entry for a ban list, exemption list, or invite list. More...

class  InviteItem
 A subclass of HostItem designed to hold channel invites (+I). More...

class  ModeParameter
 Holds a custom parameter to a module-defined channel mode e.g. More...

class  ucrec
 Holds 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. More...

class  BanItem
 A subclass of HostItem designed to hold channel bans (+b). More...

class  chanrec
 Holds all relevent information for a channel. More...

class  ExemptItem
 A subclass of HostItem designed to hold channel exempts (+e). More...

class  HostItem
 Holds an entry for a ban list, exemption list, or invite list. More...

class  InviteItem
 A subclass of HostItem designed to hold channel invites (+I). More...

class  ModeParameter
 Holds a custom parameter to a module-defined channel mode e.g. More...

class  ucrec
 Holds 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. More...


Defines

#define UCMODE_OP   1
#define UCMODE_VOICE   2
#define UCMODE_HOP   4
#define UCMODE_PROTECT   8
#define UCMODE_FOUNDER   16
#define UCMODE_OP   1
#define UCMODE_VOICE   2
#define UCMODE_HOP   4
#define UCMODE_PROTECT   8
#define UCMODE_FOUNDER   16

Typedefs

typedef std::vector< BanItem > BanList
 Holds a complete ban list.

typedef std::vector< ExemptItem > ExemptList
 Holds a complete exempt list.

typedef std::vector< InviteItem > InviteList
 Holds a complete invite list.

typedef std::vector< BanItem > BanList
 Holds a complete ban list.

typedef std::vector< ExemptItem > ExemptList
 Holds a complete exempt list.

typedef std::vector< InviteItem > InviteList
 Holds a complete invite list.

Define Documentation

- +
-
+ +Definition at line 195 of file channels.h.
#define UCMODE_FOUNDER   16 @@ -85,13 +80,13 @@ This graph shows which files directly or indirectly include this file:

-Definition at line 184 of file channels.h.

- +
-
+ +Definition at line 193 of file channels.h.
#define UCMODE_HOP   4 @@ -109,13 +104,13 @@ Definition at line 184 o

-Definition at line 182 of file channels.h.

- +
-
+ +Definition at line 191 of file channels.h.
#define UCMODE_OP   1 @@ -133,13 +128,13 @@ Definition at line 182 o

-Definition at line 180 of file channels.h.

- +
-
+ +Definition at line 194 of file channels.h.
#define UCMODE_PROTECT   8 @@ -157,13 +152,13 @@ Definition at line 180 o

-Definition at line 183 of file channels.h.

- +
-
+ +Definition at line 192 of file channels.h.
#define UCMODE_VOICE   2 @@ -181,17 +176,17 @@ Definition at line 183 o

-Definition at line 181 of file channels.h.

Typedef Documentation

- +
- @@ -204,20 +199,20 @@ Definition at line 181 o +Definition at line 80 of file channels.h.
+ -
typedef std::vector<BanItem> BanList + typedef std::vector<BanItem> BanList

-Holds a complete ban list. +Holds a complete ban list.

-Definition at line 69 of file channels.h.

- +
- @@ -230,20 +225,20 @@ Definition at line 69 of +Definition at line 84 of file channels.h.
+ -
typedef std::vector<ExemptItem> ExemptList + typedef std::vector<ExemptItem> ExemptList

-Holds a complete exempt list. +Holds a complete exempt list.

-Definition at line 73 of file channels.h.

- +
- @@ -256,16 +251,16 @@ Definition at line 73 of +Definition at line 88 of file channels.h.
+ -
typedef std::vector<InviteItem> InviteList + typedef std::vector<InviteItem> InviteList

-Holds a complete invite list. +Holds a complete invite list.

-Definition at line 77 of file channels.h.

-

Generated on Sun May 2 00:09:21 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:29 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html index 36b2e3e8c..1149be0ac 100644 --- a/docs/module-doc/classAdmin-members.html +++ b/docs/module-doc/classAdmin-members.html @@ -1,22 +1,21 @@ -Member List +InspIRCd: Member List - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

Admin Member List

This is the complete list of members for Admin, including all inherited members. - - - - - - - -
Admin(std::string name, std::string email, std::string nick)Admin
ageclassbase
classbase()classbase [inline]
EmailAdmin
NameAdmin
NickAdmin
~classbase()classbase [inline]
Generated on Sun May 2 00:09:29 2004 for InspIRCd by + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

Admin Member List

This is the complete list of members for Admin, including all inherited members. + + + + + + + +
Admin(std::string name, std::string email, std::string nick)Admin
ageclassbase
classbase()classbase [inline]
EmailAdmin
NameAdmin
NickAdmin
~classbase()classbase [inline]
Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html index 4fd121ef7..7c32f4fed 100644 --- a/docs/module-doc/classAdmin.html +++ b/docs/module-doc/classAdmin.html @@ -1,63 +1,60 @@ -Admin class Reference +InspIRCd: Admin class Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

Admin Class Reference

Holds /ADMIN data This class contains the admin details of the local server. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

Admin Class Reference

Holds /ADMIN data This class contains the admin details of the local server. More...

#include <modules.h>

-Inheritance diagram for Admin:

Inheritance graph
- - - -
[legend]
Collaboration diagram for Admin:

Collaboration graph
- - - -
[legend]
List of all members. +Inherits classbase. +

+List of all members.

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

Public Member Functions

 Admin (std::string name, std::string email, std::string nick)
 Admin (std::string name, std::string email, std::string nick)

Public Attributes

const std::string Name
const std::string Email
const std::string Nick
const std::string Name
const std::string Email
const std::string Nick

Detailed Description

-Holds /ADMIN data This class contains the admin details of the local server. +Holds /ADMIN data This class contains the admin details of the local server.

It is constructed by class Server, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running.

-Definition at line 104 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 114 of file modules.h.

Constructor & Destructor Documentation

- +
-
+ - + - + - + @@ -79,20 +76,20 @@ Definition at line 104 of

-Definition at line 283 of file modules.cpp. +Definition at line 295 of file modules.cpp.

-

00283 : Name(name), Email(email), Nick(nick) { };
+
00295 : Name(name), Email(email), Nick(nick) { };
Admin::Admin (  std::string   name, name,
std::string   email, email,
std::string   nick nick

Member Data Documentation

-

- +

+

- @@ -107,16 +104,16 @@ Definition at line 283

-Definition at line 107 of file modules.h. +Definition at line 117 of file modules.h.

+ -
const std::string Admin::Email + const std::string Admin::Email
-

- +

+

- @@ -131,16 +128,16 @@ Definition at line 107 of

-Definition at line 107 of file modules.h. +Definition at line 117 of file modules.h.

+ -
const std::string Admin::Name + const std::string Admin::Name
-

- +

+

- @@ -155,14 +152,14 @@ Definition at line 107 of

-Definition at line 107 of file modules.h. +Definition at line 117 of file modules.h.

+ -
const std::string Admin::Nick + const std::string Admin::Nick

The documentation for this class was generated from the following files: -
Generated on Sun May 2 00:09:29 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html index 7baeb71f6..76ea1821b 100644 --- a/docs/module-doc/classBanItem-members.html +++ b/docs/module-doc/classBanItem-members.html @@ -1,23 +1,22 @@ -Member List +InspIRCd: Member List - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

BanItem Member List

This is the complete list of members for BanItem, including all inherited members. - - - - - - - - -
ageclassbase
classbase()classbase [inline]
dataHostItem
HostItem()HostItem [inline]
set_byHostItem
set_timeHostItem
~classbase()classbase [inline]
~HostItem()HostItem [inline, virtual]
Generated on Sun May 2 00:09:30 2004 for InspIRCd by + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

BanItem Member List

This is the complete list of members for BanItem, including all inherited members. + + + + + + + + +
ageclassbase
classbase()classbase [inline]
dataHostItem
HostItem()HostItem [inline]
set_byHostItem
set_timeHostItem
~classbase()classbase [inline]
~HostItem()HostItem [inline, virtual]
Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html index 676c2b373..87f54f264 100644 --- a/docs/module-doc/classBanItem.html +++ b/docs/module-doc/classBanItem.html @@ -1,39 +1,30 @@ -BanItem class Reference +InspIRCd: BanItem class Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

BanItem Class Reference

A subclass of HostItem designed to hold channel bans (+b). + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

BanItem Class Reference

A subclass of HostItem designed to hold channel bans (+b). More...

#include <channels.h>

-Inheritance diagram for BanItem:

Inheritance graph
- - - - -
[legend]
Collaboration diagram for BanItem:

Collaboration graph
- - - - -
[legend]
List of all members. +Inherits HostItem. +

+List of all members.

Detailed Description

-A subclass of HostItem designed to hold channel bans (+b). +A subclass of HostItem designed to hold channel bans (+b).

-Definition at line 34 of file channels.h.

The documentation for this class was generated from the following file:
    +Definition at line 45 of file channels.h.
    The documentation for this class was generated from the following file: -
    Generated on Sun May 2 00:09:30 2004 for InspIRCd by +
    Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
    +doxygen +1.3.3
    diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html index 0cb5f4742..5487f9e86 100644 --- a/docs/module-doc/classConfigReader-members.html +++ b/docs/module-doc/classConfigReader-members.html @@ -1,31 +1,32 @@ -Member List +InspIRCd: Member List - -
    -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    -

    ConfigReader Member List

    This is the complete list of members for ConfigReader, including all inherited members. - - - - - - - - - - - - - - - - -
    ageclassbase
    cacheConfigReader [protected]
    classbase()classbase [inline]
    ConfigReader()ConfigReader
    ConfigReader(std::string filename)ConfigReader
    Enumerate(std::string tag)ConfigReader
    EnumerateValues(std::string tag, int index)ConfigReader
    errorConfigReader [protected]
    GetError()ConfigReader
    readerrorConfigReader [protected]
    ReadFlag(std::string tag, std::string name, int index)ConfigReader
    ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned)ConfigReader
    ReadValue(std::string tag, std::string name, int index)ConfigReader
    Verify()ConfigReader
    ~classbase()classbase [inline]
    ~ConfigReader()ConfigReader
    Generated on Sun May 2 00:09:32 2004 for InspIRCd by + +
    Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
    +

    ConfigReader Member List

    This is the complete list of members for ConfigReader, including all inherited members. + + + + + + + + + + + + + + + + + + +
    ageclassbase
    cacheConfigReader [protected]
    classbase()classbase [inline]
    ConfigReader()ConfigReader
    ConfigReader(std::string filename)ConfigReader
    DumpErrors(bool bail, userrec *user)ConfigReader
    Enumerate(std::string tag)ConfigReader
    EnumerateValues(std::string tag, int index)ConfigReader
    errorConfigReader [protected]
    errorlogConfigReader [protected]
    GetError()ConfigReader
    readerrorConfigReader [protected]
    ReadFlag(std::string tag, std::string name, int index)ConfigReader
    ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned)ConfigReader
    ReadValue(std::string tag, std::string name, int index)ConfigReader
    Verify()ConfigReader
    ~classbase()classbase [inline]
    ~ConfigReader()ConfigReader
    Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
    +doxygen +1.3.3
    diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index f8c1f7bda..3519d1aa8 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -1,72 +1,83 @@ -ConfigReader class Reference +InspIRCd: ConfigReader class Reference - -
    -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    -

    ConfigReader Class Reference

    Allows 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. + +
    Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
    +

    ConfigReader Class Reference

    Allows 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. More...

    #include <modules.h>

    -Inheritance diagram for ConfigReader:

    Inheritance graph
    - - - -
    [legend]
    Collaboration diagram for ConfigReader:

    Collaboration graph
    - - - -
    [legend]
    List of all members. +Inherits classbase. +

    +List of all members.

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

    Public Member Functions

     ConfigReader ()
     Default constructor.

     ConfigReader (std::string filename)
     Overloaded constructor.

     ~ConfigReader ()
     Default destructor.

    std::string ReadValue (std::string tag, std::string name, int index)
     Retrieves a value from the config file.

    bool ReadFlag (std::string tag, std::string name, int index)
     Retrieves a boolean value from the config file.

    long ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)
     Retrieves an integer value from the config file.

    long GetError ()
     Returns the last error to occur.

    int Enumerate (std::string tag)
     Counts the number of times a given tag appears in the config file.

    bool Verify ()
     Returns true if a config file is valid.

    int EnumerateValues (std::string tag, int index)
     Returns the number of items within a tag.

     ConfigReader ()
     Default constructor.

     ConfigReader (std::string filename)
     Overloaded constructor.

     ~ConfigReader ()
     Default destructor.

    std::string ReadValue (std::string tag, std::string name, int index)
     Retrieves a value from the config file.

    bool ReadFlag (std::string tag, std::string name, int index)
     Retrieves a boolean value from the config file.

    long ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)
     Retrieves an integer value from the config file.

    long GetError ()
     Returns the last error to occur.

    int Enumerate (std::string tag)
     Counts the number of times a given tag appears in the config file.

    bool Verify ()
     Returns true if a config file is valid.

    void DumpErrors (bool bail, userrec *user)
     Dumps the list of errors in a config file to an output location.

    int EnumerateValues (std::string tag, int index)
     Returns the number of items within a tag.


    Protected Attributes

    std::stringstream * cache
     The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).

    bool readerror
     Used to store errors.

    long error
    std::stringstream * cache
     The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).

    std::stringstream * errorlog
    bool readerror
     Used to store errors.

    long error

    Detailed Description

    -Allows 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. +Allows 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.

    It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.

    -Definition at line 618 of file modules.h.

    Constructor & Destructor Documentation

    +Definition at line 641 of file modules.h.

    Constructor & Destructor Documentation

    - +
    -
    + - - + + @@ -82,34 +93,35 @@ Definition at line 618 of
    ConfigReader::ConfigReader (   )   ) 

    -Default constructor. +Default constructor.

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

    -Definition at line 553 of file modules.cpp. +Definition at line 566 of file modules.cpp.

    -References cache, CONF_FILE_NOT_FOUND, error, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

    -

    00554 {
-00555         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00556         this->readerror = LoadConf(CONFIG_FILE,this->cache);
-00557         if (!this->readerror)
-00558                 this->error = CONF_FILE_NOT_FOUND;
-00559 }
+
    00567 {
+00568         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00569         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00570         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00571         if (!this->readerror)
+00572                 this->error = CONF_FILE_NOT_FOUND;
+00573 }

    - +
    -
    + - - + + @@ -125,33 +137,34 @@ References cache,

    -Overloaded constructor. +Overloaded constructor.

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

    -Definition at line 569 of file modules.cpp. +Definition at line 585 of file modules.cpp.

    -References cache, CONF_FILE_NOT_FOUND, error, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

    -

    00570 {
-00571         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00572         this->readerror = LoadConf(filename.c_str(),this->cache);
-00573         if (!this->readerror)
-00574                 this->error = CONF_FILE_NOT_FOUND;
-00575 };
+
    00586 {
+00587         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00588         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00589         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00590         if (!this->readerror)
+00591                 this->error = CONF_FILE_NOT_FOUND;
+00592 };
    ConfigReader::ConfigReader (  std::string   filename )  filename  ) 

    - +
    -
    + - + - - + + @@ -167,33 +180,111 @@ References cache,

    -Default destructor. +Default destructor.

    This method destroys the ConfigReader class.

    -Definition at line 562 of file modules.cpp. +Definition at line 576 of file modules.cpp.

    -References cache. +References cache, and errorlog.

    -

    00563 {
-00564         if (this->cache)
-00565                 delete this->cache;
-00566 }
+
    00577 {
+00578         if (this->cache)
+00579                 delete this->cache;
+00580         if (this->errorlog)
+00581                 delete this->errorlog;
+00582 }
    ConfigReader::~ConfigReader ConfigReader::~ConfigReader (   )   ) 

    Member Function Documentation

    +

    + + + + +
    + + + + + + + + + + + + + + + + + + + +
    void ConfigReader::DumpErrors ( bool  bail,
    userrec *  user
    ) 
    +
    + + + + + +
    +   + + +

    +Dumps the list of errors in a config file to an output location. +

    +If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers. +

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

    +References errorlog, connection::fd, and userrec::nick. +

    +

    00664 {
+00665         if (bail)
+00666         {
+00667                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00668                 exit(0);
+00669         }
+00670         else
+00671         {
+00672                 char dataline[1024];
+00673                 if (user)
+00674                 {
+00675                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00676                         while (!errorlog->eof())
+00677                         {
+00678                                 errorlog->getline(dataline,1024);
+00679                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00680                         }
+00681                 }
+00682                 else
+00683                 {
+00684                         WriteOpers("There were errors in the configuration file:",user->nick);
+00685                         while (!errorlog->eof())
+00686                         {
+00687                                 errorlog->getline(dataline,1024);
+00688                                 WriteOpers(dataline);
+00689                         }
+00690                 }
+00691                 return;
+00692         }
+00693 }
+

    - +
    -
    + - - + + @@ -209,34 +300,36 @@ References cache.
    int ConfigReader::Enumerate (  std::string   tag )  tag  ) 

    -Counts the number of times a given tag appears in the config file. +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 647 of file modules.cpp. +Definition at line 696 of file modules.cpp.

    -

    00648 {
-00649         return EnumConf(cache,tag.c_str());
-00650 }
+References cache.
+
    
+
    00697 {
+00698         return EnumConf(cache,tag.c_str());
+00699 }
    -

    - +

    +

    -
    + - + - + @@ -256,28 +349,30 @@ Definition at line 647
    int ConfigReader::EnumerateValues (  std::string   tag, tag,
    int   index index

    -Returns the number of items within a tag. +Returns the number of items within a tag.

    For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.

    -Definition at line 652 of file modules.cpp. +Definition at line 701 of file modules.cpp. +

    +References cache.

    -

    00653 {
-00654         return EnumValues(cache, tag.c_str(), index);
-00655 }
+
    00702 {
+00703         return EnumValues(cache, tag.c_str(), index);
+00704 }

    - +
    -
    + - - + + @@ -293,44 +388,44 @@ Definition at line 652
    long ConfigReader::GetError (   )   ) 

    -Returns the last error to occur. +Returns the last error to occur.

    Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.

    -Definition at line 639 of file modules.cpp. +Definition at line 656 of file modules.cpp.

    -References error. +References error.

    -

    00640 {
-00641         long olderr = this->error;
-00642         this->error = 0;
-00643         return olderr;
-00644 }
+
    00657 {
+00658         long olderr = this->error;
+00659         this->error = 0;
+00660         return olderr;
+00661 }

    - +
    -
    + - + - + - + @@ -350,60 +445,60 @@ References error.
    bool ConfigReader::ReadFlag (  std::string   tag, tag,
    std::string   name, name,
    int   index index

    -Retrieves a boolean value from the config file. +Retrieves a boolean value from the config file.

    This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" and "true" in the config file count as true to ReadFlag, and any other value counts as false.

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

    -References CONF_VALUE_NOT_FOUND, and error. -

    -

    00594 {
-00595         char val[MAXBUF];
-00596         char t[MAXBUF];
-00597         char n[MAXBUF];
-00598         strncpy(t,tag.c_str(),MAXBUF);
-00599         strncpy(n,name.c_str(),MAXBUF);
-00600         int res = ReadConf(cache,t,n,index,val);
-00601         if (!res)
-00602         {
-00603                 this->error = CONF_VALUE_NOT_FOUND;
-00604                 return false;
-00605         }
-00606         std::string s = val;
-00607         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00608 }
+Definition at line 610 of file modules.cpp.
+
    
+References cache, CONF_VALUE_NOT_FOUND, and error.
+
    
+
    00611 {
+00612         char val[MAXBUF];
+00613         char t[MAXBUF];
+00614         char n[MAXBUF];
+00615         strlcpy(t,tag.c_str(),MAXBUF);
+00616         strlcpy(n,name.c_str(),MAXBUF);
+00617         int res = ReadConf(cache,t,n,index,val);
+00618         if (!res)
+00619         {
+00620                 this->error = CONF_VALUE_NOT_FOUND;
+00621                 return false;
+00622         }
+00623         std::string s = val;
+00624         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00625 }

    - +
    -
    + - + - + - + - + @@ -423,66 +518,66 @@ References CONF_VALUE_NOT_FOU
    long ConfigReader::ReadInteger (  std::string   tag, tag,
    std::string   name, name,
    int   index, index,
    bool   needs_unsigned needs_unsigned

    -Retrieves an integer value from the config file. +Retrieves an integer value from the config file.

    This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED

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

    -References CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. -

    -

    00611 {
-00612         char val[MAXBUF];
-00613         char t[MAXBUF];
-00614         char n[MAXBUF];
-00615         strncpy(t,tag.c_str(),MAXBUF);
-00616         strncpy(n,name.c_str(),MAXBUF);
-00617         int res = ReadConf(cache,t,n,index,val);
-00618         if (!res)
-00619         {
-00620                 this->error = CONF_VALUE_NOT_FOUND;
-00621                 return 0;
-00622         }
-00623         for (int i = 0; i < strlen(val); i++)
-00624         {
-00625                 if (!isdigit(val[i]))
-00626                 {
-00627                         this->error = CONF_NOT_A_NUMBER;
-00628                         return 0;
-00629                 }
-00630         }
-00631         if ((needs_unsigned) && (atoi(val)<0))
-00632         {
-00633                 this->error = CONF_NOT_UNSIGNED;
-00634                 return 0;
-00635         }
-00636         return atoi(val);
-00637 }
+Definition at line 627 of file modules.cpp.
+
    
+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
+
    
+
    00628 {
+00629         char val[MAXBUF];
+00630         char t[MAXBUF];
+00631         char n[MAXBUF];
+00632         strlcpy(t,tag.c_str(),MAXBUF);
+00633         strlcpy(n,name.c_str(),MAXBUF);
+00634         int res = ReadConf(cache,t,n,index,val);
+00635         if (!res)
+00636         {
+00637                 this->error = CONF_VALUE_NOT_FOUND;
+00638                 return 0;
+00639         }
+00640         for (int i = 0; i < strlen(val); i++)
+00641         {
+00642                 if (!isdigit(val[i]))
+00643                 {
+00644                         this->error = CONF_NOT_A_NUMBER;
+00645                         return 0;
+00646                 }
+00647         }
+00648         if ((needs_unsigned) && (atoi(val)<0))
+00649         {
+00650                 this->error = CONF_NOT_UNSIGNED;
+00651                 return 0;
+00652         }
+00653         return atoi(val);
+00654 }

    - +
    -
    + - + - + - + @@ -502,41 +597,41 @@ References CONF_NOT_A_NUMBER<
    std::string ConfigReader::ReadValue (  std::string   tag, tag,
    std::string   name, name,
    int   index index

    -Retrieves a value from the config file. +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 577 of file modules.cpp. -

    -References CONF_VALUE_NOT_FOUND, and error. -

    -

    00578 {
-00579         char val[MAXBUF];
-00580         char t[MAXBUF];
-00581         char n[MAXBUF];
-00582         strncpy(t,tag.c_str(),MAXBUF);
-00583         strncpy(n,name.c_str(),MAXBUF);
-00584         int res = ReadConf(cache,t,n,index,val);
-00585         if (!res)
-00586         {
-00587                 this->error = CONF_VALUE_NOT_FOUND;
-00588                 return "";
-00589         }
-00590         return std::string(val);
-00591 }
+Definition at line 594 of file modules.cpp.
+
    
+References cache, CONF_VALUE_NOT_FOUND, and error.
+
    
+
    00595 {
+00596         char val[MAXBUF];
+00597         char t[MAXBUF];
+00598         char n[MAXBUF];
+00599         strlcpy(t,tag.c_str(),MAXBUF);
+00600         strlcpy(n,name.c_str(),MAXBUF);
+00601         int res = ReadConf(cache,t,n,index,val);
+00602         if (!res)
+00603         {
+00604                 this->error = CONF_VALUE_NOT_FOUND;
+00605                 return "";
+00606         }
+00607         return std::string(val);
+00608 }

    - +
    -
    + - - + + @@ -552,28 +647,28 @@ References CONF_VALUE_NOT_FOU
    bool ConfigReader::Verify (   )   ) 

    -Returns true if a config file is valid. +Returns true if a config file is valid.

    This method is partially implemented and will only return false if the config file does not exist or could not be opened.

    -Definition at line 657 of file modules.cpp. +Definition at line 706 of file modules.cpp.

    -References readerror. +References readerror.

    -

    00658 {
-00659         return this->readerror;
-00660 }
+
    00707 {
+00708         return this->readerror;
+00709 }

    Member Data Documentation

    -

    - +

    +

    - @@ -586,22 +681,48 @@ References readerror. + +
    + -
    std::stringstream* ConfigReader::cache [protected] + std::stringstream* ConfigReader::cache [protected]

    -The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). +The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).

    It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.

    -Definition at line 626 of file modules.h. +Definition at line 649 of file modules.h. +

    +Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().

    +

    + + + + +
    + + +
    long ConfigReader::error [protected] +
    +
    + + + + +Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
    +   + + +

    + +

    +Definition at line 654 of file modules.h.

    -Referenced by ConfigReader(), and ~ConfigReader().

    -

    - +

    +

    - @@ -616,18 +737,18 @@ Referenced by ConfigReader(

    -Definition at line 630 of file modules.h. +Definition at line 650 of file modules.h.

    -Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). +Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().

    + -
    long ConfigReader::error [protected] + std::stringstream* ConfigReader::errorlog [protected]
    -

    - +

    +

    - @@ -640,20 +761,20 @@ Referenced by ConfigReader( +Referenced by ConfigReader(), and Verify().
    + -
    bool ConfigReader::readerror [protected] + bool ConfigReader::readerror [protected]

    -Used to store errors. +Used to store errors.

    -Definition at line 629 of file modules.h. +Definition at line 653 of file modules.h.

    -Referenced by ConfigReader(), and Verify().

    The documentation for this class was generated from the following files: -
    Generated on Sun May 2 00:09:32 2004 for InspIRCd by +
    Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
    +doxygen +1.3.3
    diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html index 19b112718..4cf3b8c8c 100644 --- a/docs/module-doc/classConnectClass-members.html +++ b/docs/module-doc/classConnectClass-members.html @@ -1,24 +1,23 @@ -Member List +InspIRCd: Member List - -
    -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    -

    ConnectClass Member List

    This is the complete list of members for ConnectClass, including all inherited members. - - - - - - - - - -
    ageclassbase
    classbase()classbase [inline]
    ConnectClass()ConnectClass [inline]
    floodConnectClass
    hostConnectClass
    passConnectClass
    registration_timeoutConnectClass
    typeConnectClass
    ~classbase()classbase [inline]
    Generated on Sun May 2 00:09:33 2004 for InspIRCd by + +
    Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
    +

    ConnectClass Member List

    This is the complete list of members for ConnectClass, including all inherited members. + + + + + + + + + +
    ageclassbase
    classbase()classbase [inline]
    ConnectClass()ConnectClass [inline]
    floodConnectClass
    hostConnectClass
    passConnectClass
    registration_timeoutConnectClass
    typeConnectClass
    ~classbase()classbase [inline]
    Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
    +doxygen +1.3.3
    diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html index 361951c86..dfddf30a3 100644 --- a/docs/module-doc/classConnectClass.html +++ b/docs/module-doc/classConnectClass.html @@ -1,56 +1,55 @@ -ConnectClass class Reference +InspIRCd: ConnectClass class Reference - -
    -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    -

    ConnectClass Class Reference

    Holds information relevent to <connect allow> and <connect deny> tags in the config file. + +
    Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
    +

    ConnectClass Class Reference

    Holds information relevent to <connect allow> and <connect deny> tags in the config file. More...

    #include <users.h>

    -Inheritance diagram for ConnectClass:

    Inheritance graph
    - - - -
    [legend]
    Collaboration diagram for ConnectClass:

    Collaboration graph
    - - - -
    [legend]
    List of all members. +Inherits classbase. +

    +List of all members.

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

    Public Member Functions

     ConnectClass ()
     ConnectClass ()

    Public Attributes

    int type
     Type of line, either CC_ALLOW or CC_DENY.

    int registration_timeout
     Max time to register the connection in seconds.

    int flood
     Number of lines in buffer before excess flood is triggered.

    char host [MAXBUF]
     Host mask for this line.

    char pass [MAXBUF]
     (Optional) Password for this line

    int type
     Type of line, either CC_ALLOW or CC_DENY.

    int registration_timeout
     Max time to register the connection in seconds.

    int flood
     Number of lines in buffer before excess flood is triggered.

    char host [MAXBUF]
     Host mask for this line.

    char pass [MAXBUF]
     (Optional) Password for this line

    Detailed Description

    -Holds information relevent to <connect allow> and <connect deny> tags in the config file. +Holds information relevent to <connect allow> and <connect deny> tags in the config file.

    -Definition at line 34 of file users.h.

    Constructor & Destructor Documentation

    +Definition at line 45 of file users.h.

    Constructor & Destructor Documentation

    - +
    -
    + - - + + @@ -68,25 +67,27 @@ Definition at line 34 of fi

    -Definition at line 53 of file users.h. +Definition at line 64 of file users.h. +

    +References flood, host, pass, and registration_timeout.

    -

    00054         {
-00055                 registration_timeout = 0;
-00056                 flood = 0;
-00057                 strcpy(host,"");
-00058                 strcpy(pass,"");
-00059         }
+
    00065         {
+00066                 registration_timeout = 0;
+00067                 flood = 0;
+00068                 strlcpy(host,"",MAXBUF);
+00069                 strlcpy(pass,"",MAXBUF);
+00070         }
    ConnectClass::ConnectClass (   )   )  [inline]

    Member Data Documentation

    -

    - +

    +

    - @@ -99,20 +100,22 @@ Definition at line 53 of fi +Definition at line 56 of file users.h. +

    +Referenced by ConnectClass().

    + -
    int ConnectClass::flood + int ConnectClass::flood

    -Number of lines in buffer before excess flood is triggered. +Number of lines in buffer before excess flood is triggered.

    -Definition at line 45 of file users.h.

    -

    - +

    +

    - @@ -125,20 +128,22 @@ Definition at line 45 of fi +Definition at line 59 of file users.h. +

    +Referenced by ConnectClass().

    + -
    char ConnectClass::host[MAXBUF] + char ConnectClass::host[MAXBUF]

    -Host mask for this line. +Host mask for this line.

    -Definition at line 48 of file users.h.

    -

    - +

    +

    - @@ -151,20 +156,22 @@ Definition at line 48 of fi +Definition at line 62 of file users.h. +

    +Referenced by ConnectClass().

    + -
    char ConnectClass::pass[MAXBUF] + char ConnectClass::pass[MAXBUF]

    -(Optional) Password for this line +(Optional) Password for this line

    -Definition at line 51 of file users.h.

    -

    - +

    +

    - @@ -177,20 +184,22 @@ Definition at line 51 of fi +Definition at line 53 of file users.h. +

    +Referenced by ConnectClass().

    + -
    int ConnectClass::registration_timeout + int ConnectClass::registration_timeout

    -Max time to register the connection in seconds. +Max time to register the connection in seconds.

    -Definition at line 42 of file users.h.

    -

    - +

    +

    - @@ -203,18 +212,18 @@ Definition at line 42 of fi +Definition at line 50 of file users.h.
    + -
    int ConnectClass::type + int ConnectClass::type

    -Type of line, either CC_ALLOW or CC_DENY. +Type of line, either CC_ALLOW or CC_DENY.

    -Definition at line 39 of file users.h.

    The documentation for this class was generated from the following file: -
    Generated on Sun May 2 00:09:33 2004 for InspIRCd by +
    Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
    +doxygen +1.3.3
    diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html index 94e61a4b6..46a3151d2 100644 --- a/docs/module-doc/classExemptItem-members.html +++ b/docs/module-doc/classExemptItem-members.html @@ -1,23 +1,22 @@ -Member List +InspIRCd: Member List - -
    -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    -

    ExemptItem Member List

    This is the complete list of members for ExemptItem, including all inherited members. - - - - - - - - -
    ageclassbase
    classbase()classbase [inline]
    dataHostItem
    HostItem()HostItem [inline]
    set_byHostItem
    set_timeHostItem
    ~classbase()classbase [inline]
    ~HostItem()HostItem [inline, virtual]
    Generated on Sun May 2 00:09:34 2004 for InspIRCd by + +
    Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
    +

    ExemptItem Member List

    This is the complete list of members for ExemptItem, including all inherited members. + + + + + + + + +
    ageclassbase
    classbase()classbase [inline]
    dataHostItem
    HostItem()HostItem [inline]
    set_byHostItem
    set_timeHostItem
    ~classbase()classbase [inline]
    ~HostItem()HostItem [inline, virtual]
    Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
    +doxygen +1.3.3
    diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html index 987763504..dfc401c96 100644 --- a/docs/module-doc/classExemptItem.html +++ b/docs/module-doc/classExemptItem.html @@ -1,39 +1,30 @@ -ExemptItem class Reference +InspIRCd: ExemptItem class Reference - -
    -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
    -

    ExemptItem Class Reference

    A subclass of HostItem designed to hold channel exempts (+e). + +
    Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
    +

    ExemptItem Class Reference

    A subclass of HostItem designed to hold channel exempts (+e). More...

    #include <channels.h>

    -Inheritance diagram for ExemptItem:

    Inheritance graph
    - - - - -
    [legend]
    Collaboration diagram for ExemptItem:

    Collaboration graph
    - - - - -
    [legend]
    List of all members. +Inherits HostItem. +

    +List of all members.

    Detailed Description

    -A subclass of HostItem designed to hold channel exempts (+e). +A subclass of HostItem designed to hold channel exempts (+e).

    -Definition at line 42 of file channels.h.

    The documentation for this class was generated from the following file:
      +Definition at line 53 of file channels.h.
      The documentation for this class was generated from the following file: -
      Generated on Sun May 2 00:09:34 2004 for InspIRCd by +
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classExtMode-members.html b/docs/module-doc/classExtMode-members.html index 4f3b8f47a..357214dfb 100644 --- a/docs/module-doc/classExtMode-members.html +++ b/docs/module-doc/classExtMode-members.html @@ -1,25 +1,24 @@ -Member List +InspIRCd: Member List - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      ExtMode Member List

      This is the complete list of members for ExtMode, including all inherited members. - - - - - - - - - - -
      ageclassbase
      classbase()classbase [inline]
      ExtMode(char mc, int ty, bool oper, int p_on, int p_off)ExtMode [inline]
      listExtMode
      modecharExtMode
      needsoperExtMode
      params_when_offExtMode
      params_when_onExtMode
      typeExtMode
      ~classbase()classbase [inline]
      Generated on Sun May 2 00:09:36 2004 for InspIRCd by + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      ExtMode Member List

      This is the complete list of members for ExtMode, including all inherited members. + + + + + + + + + + +
      ageclassbase
      classbase()classbase [inline]
      ExtMode(char mc, int ty, bool oper, int p_on, int p_off)ExtMode [inline]
      listExtMode
      modecharExtMode
      needsoperExtMode
      params_when_offExtMode
      params_when_onExtMode
      typeExtMode
      ~classbase()classbase [inline]
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classExtMode.html b/docs/module-doc/classExtMode.html index ee1a55aac..a1703bdad 100644 --- a/docs/module-doc/classExtMode.html +++ b/docs/module-doc/classExtMode.html @@ -1,66 +1,66 @@ -ExtMode class Reference +InspIRCd: ExtMode class Reference - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      ExtMode Class Reference

      Inheritance diagram for ExtMode:

      Inheritance graph
      - - - -
      [legend]
      Collaboration diagram for ExtMode:

      Collaboration graph
      - - - -
      [legend]
      List of all members. + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      ExtMode Class Reference

      Inherits classbase. +

      +List of all members.

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

      Public Member Functions

       ExtMode (char mc, int ty, bool oper, int p_on, int p_off)
       ExtMode (char mc, int ty, bool oper, int p_on, int p_off)

      Public Attributes

      char modechar
      int type
      int params_when_on
      int params_when_off
      bool needsoper
      bool list
      char modechar
      int type
      int params_when_on
      int params_when_off
      bool needsoper
      bool list

      Constructor & Destructor Documentation

      - +
      -
      + - + - + - + - + - + @@ -82,20 +82,20 @@

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

      -

      00175 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
+
      00190 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
      ExtMode::ExtMode (  char   mc, mc,
      int   ty, ty,
      bool   oper, oper,
      int   p_on, p_on,
      int   p_off p_off

      Member Data Documentation

      -

      - +

      +

      - @@ -110,16 +110,16 @@ Definition at line 175

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

      + -
      bool ExtMode::list + bool ExtMode::list
      -

      - +

      +

      - @@ -134,16 +134,16 @@ Definition at line 174

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

      + -
      char ExtMode::modechar + char ExtMode::modechar
      -

      - +

      +

      - @@ -158,16 +158,16 @@ Definition at line 169

      -Definition at line 173 of file modules.cpp. +Definition at line 188 of file modules.cpp.

      + -
      bool ExtMode::needsoper + bool ExtMode::needsoper
      -

      - +

      +

      - @@ -182,16 +182,16 @@ Definition at line 173

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

      + -
      int ExtMode::params_when_off + int ExtMode::params_when_off
      -

      - +

      +

      - @@ -206,16 +206,16 @@ Definition at line 172

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

      + -
      int ExtMode::params_when_on + int ExtMode::params_when_on
      -

      - +

      +

      - @@ -230,14 +230,14 @@ Definition at line 171

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

      + -
      int ExtMode::type + int ExtMode::type

      The documentation for this class was generated from the following file: -
      Generated on Sun May 2 00:09:36 2004 for InspIRCd by +
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classExtensible-members.html b/docs/module-doc/classExtensible-members.html index 2c4871fca..7c83ec3ac 100644 --- a/docs/module-doc/classExtensible-members.html +++ b/docs/module-doc/classExtensible-members.html @@ -1,22 +1,21 @@ -Member List +InspIRCd: Member List - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      Extensible Member List

      This is the complete list of members for Extensible, including all inherited members. - - - - - - - -
      ageclassbase
      classbase()classbase [inline]
      Extend(std::string key, char *p)Extensible
      Extension_ItemsExtensible [private]
      GetExt(std::string key)Extensible
      Shrink(std::string key)Extensible
      ~classbase()classbase [inline]
      Generated on Sun May 2 00:09:35 2004 for InspIRCd by + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      Extensible Member List

      This is the complete list of members for Extensible, including all inherited members. + + + + + + + +
      ageclassbase
      classbase()classbase [inline]
      Extend(std::string key, char *p)Extensible
      Extension_ItemsExtensible [private]
      GetExt(std::string key)Extensible
      Shrink(std::string key)Extensible
      ~classbase()classbase [inline]
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index bb81a4f98..f662fa5e3 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -1,67 +1,60 @@ -Extensible class Reference +InspIRCd: Extensible class Reference - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      Extensible Class Reference

      class Extensible is the parent class of many classes such as userrec and chanrec. + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      Extensible Class Reference

      class Extensible is the parent class of many classes such as userrec and chanrec. More...

      #include <base.h>

      -Inheritance diagram for Extensible:

      Inheritance graph
      - - - - - - - - - -
      [legend]
      Collaboration diagram for Extensible:

      Collaboration graph
      - - - -
      [legend]
      List of all members. +Inherits classbase. +

      +Inherited by chanrec, command_t, connection, and ircd_connector. +

      +List of all members.

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

      Public Member Functions

      bool Extend (std::string key, char *p)
       Extend an Extensible class.

      bool Shrink (std::string key)
       Shrink an Extensible class.

      char * GetExt (std::string key)
       Get an extension item.

      bool Extend (std::string key, char *p)
       Extend an Extensible class.

      bool Shrink (std::string key)
       Shrink an Extensible class.

      char * GetExt (std::string key)
       Get an extension item.


      Private Attributes

      std::map< std::string, char * > Extension_Items
       Private data store.

      std::map< std::string, char * > Extension_Items
       Private data store.

      Detailed Description

      -class Extensible is the parent class of many classes such as userrec and chanrec. +class Extensible is the parent class of many classes such as userrec and chanrec.

      class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage).

      -Definition at line 38 of file base.h.

      Member Function Documentation

      +Definition at line 50 of file base.h.

      Member Function Documentation

      - +
      -
      + - + - + @@ -81,22 +74,22 @@ Definition at line 38 of fil
      bool Extensible::Extend (  std::string   key, key,
      char *   p p

      -Extend an Extensible class. +Extend an Extensible class.

      You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, Extensible::Extend will return false in this case. On successful extension, Extend returns true.

      - +
      -
      + - - + + @@ -112,22 +105,22 @@ You must provide a key to store the data as, and a void* to the data (typedef Vo
      char* Extensible::GetExt (  std::string   key )  key  ) 

      -Get an extension item. +Get an extension item.

      You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.

      - +
      -
      + - - + + @@ -143,19 +136,19 @@ You must provide a key name, which is case sensitive. If you provide a non-exist
      bool Extensible::Shrink (  std::string   key )  key  ) 

      -Shrink an Extensible class. +Shrink an Extensible class.

      You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success.

      Member Data Documentation

      -

      - +

      +

      - @@ -168,18 +161,18 @@ You must provide a key name. The given key name will be removed from the classes +Definition at line 54 of file base.h.
      + -
      std::map<std::string,char*> Extensible::Extension_Items [private] + std::map<std::string,char*> Extensible::Extension_Items [private]

      -Private data store. +Private data store.

      -Definition at line 42 of file base.h.

      The documentation for this class was generated from the following file: -
      Generated on Sun May 2 00:09:35 2004 for InspIRCd by +
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classFileReader-members.html b/docs/module-doc/classFileReader-members.html index e2e10b1bf..cb8bb55cb 100644 --- a/docs/module-doc/classFileReader-members.html +++ b/docs/module-doc/classFileReader-members.html @@ -1,26 +1,25 @@ -Member List +InspIRCd: Member List - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      FileReader Member List

      This is the complete list of members for FileReader, including all inherited members. - - - - - - - - - - - -
      ageclassbase
      classbase()classbase [inline]
      Exists()FileReader
      fcFileReader [private]
      FileReader()FileReader
      FileReader(std::string filename)FileReader
      FileSize()FileReader
      GetLine(int x)FileReader
      LoadFile(std::string filename)FileReader
      ~classbase()classbase [inline]
      ~FileReader()FileReader
      Generated on Sun May 2 00:09:36 2004 for InspIRCd by + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      FileReader Member List

      This is the complete list of members for FileReader, including all inherited members. + + + + + + + + + + + +
      ageclassbase
      classbase()classbase [inline]
      Exists()FileReader
      fcFileReader [private]
      FileReader()FileReader
      FileReader(std::string filename)FileReader
      FileSize()FileReader
      GetLine(int x)FileReader
      LoadFile(std::string filename)FileReader
      ~classbase()classbase [inline]
      ~FileReader()FileReader
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 8cbb5d3ea..952b8dcb8 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -1,62 +1,63 @@ -FileReader class Reference +InspIRCd: FileReader class Reference - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      FileReader Class Reference

      Caches a text file into memory and can be used to retrieve lines from it. + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      FileReader Class Reference

      Caches a text file into memory and can be used to retrieve lines from it. More...

      #include <modules.h>

      -Inheritance diagram for FileReader:

      Inheritance graph
      - - - -
      [legend]
      Collaboration diagram for FileReader:

      Collaboration graph
      - - - -
      [legend]
      List of all members. +Inherits classbase. +

      +List of all members.

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

      Public Member Functions

       FileReader ()
       Default constructor.

       FileReader (std::string filename)
       Secondary constructor.

       ~FileReader ()
       Default destructor.

      void LoadFile (std::string filename)
       Used to load a file.

      bool Exists ()
       Returns true if the file exists This function will return false if the file could not be opened.

      std::string GetLine (int x)
       Retrieve one line from the file.

      int FileSize ()
       Returns the size of the file in lines.

       FileReader ()
       Default constructor.

       FileReader (std::string filename)
       Secondary constructor.

       ~FileReader ()
       Default destructor.

      void LoadFile (std::string filename)
       Used to load a file.

      bool Exists ()
       Returns true if the file exists This function will return false if the file could not be opened.

      std::string GetLine (int x)
       Retrieve one line from the file.

      int FileSize ()
       Returns the size of the file in lines.


      Private Attributes

      file_cache fc
      file_cache fc

      Detailed Description

      -Caches a text file into memory and can be used to retrieve lines from it. +Caches a text file into memory and can be used to retrieve lines from it.

      This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file.

      -Definition at line 699 of file modules.h.

      Constructor & Destructor Documentation

      +Definition at line 730 of file modules.h.

      Constructor & Destructor Documentation

      - +
      -
      + - - + + @@ -72,28 +73,28 @@ Definition at line 699 of
      FileReader::FileReader (   )   ) 

      -Default constructor. +Default constructor.

      This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.

      -Definition at line 670 of file modules.cpp. +Definition at line 719 of file modules.cpp.

      -

      00671 {
-00672 }
+
      00720 {
+00721 }

      - +
      -
      + - - + + @@ -109,32 +110,32 @@ Definition at line 670
      FileReader::FileReader (  std::string   filename )  filename  ) 

      -Secondary constructor. +Secondary constructor.

      This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

      -Definition at line 663 of file modules.cpp. +Definition at line 712 of file modules.cpp.

      -References fc, and file_cache. +References fc, and file_cache.

      -

      00664 {
-00665         file_cache c;
-00666         readfile(c,filename.c_str());
-00667         this->fc = c;
-00668 }
+
      00713 {
+00714         file_cache c;
+00715         readfile(c,filename.c_str());
+00716         this->fc = c;
+00717 }

      - +
      -
      + - + - - + + @@ -150,28 +151,28 @@ References fc, and

      -Default destructor. +Default destructor.

      This deletes the memory allocated to the file.

      -Definition at line 682 of file modules.cpp. +Definition at line 731 of file modules.cpp.

      -

      00683 {
-00684 }
+
      00732 {
+00733 }
      FileReader::~FileReader FileReader::~FileReader (   )   ) 

      Member Function Documentation

      - +
      -
      + - - + + @@ -187,37 +188,37 @@ Definition at line 682
      bool FileReader::Exists (   )   ) 

      -Returns true if the file exists This function will return false if the file could not be opened. +Returns true if the file exists This function will return false if the file could not be opened.

      -Definition at line 686 of file modules.cpp. +Definition at line 735 of file modules.cpp.

      -References fc. +References fc.

      -

      00687 {
-00688         if (fc.size() == 0)
-00689         {
-00690                 return(false);
-00691         }
-00692         else
-00693         {
-00694                 return(true);
-00695         }
-00696 }
+
      00736 {
+00737         if (fc.size() == 0)
+00738         {
+00739                 return(false);
+00740         }
+00741         else
+00742         {
+00743                 return(true);
+00744         }
+00745 }

      - +
      -
      + - - + + @@ -233,31 +234,31 @@ References fc.
      int FileReader::FileSize (   )   ) 

      -Returns the size of the file in lines. +Returns the size of the file in lines.

      This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.

      -Definition at line 705 of file modules.cpp. +Definition at line 754 of file modules.cpp.

      -References fc. +References fc.

      -

      00706 {
-00707         return fc.size();
-00708 }
+
      00755 {
+00756         return fc.size();
+00757 }

      - +
      -
      + - - + + @@ -273,33 +274,33 @@ References fc.
      std::string FileReader::GetLine (  int   x )  x  ) 

      -Retrieve one line from the file. +Retrieve one line from the file.

      This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.

      -Definition at line 698 of file modules.cpp. +Definition at line 747 of file modules.cpp.

      -References fc. +References fc.

      -

      00699 {
-00700         if ((x<0) || (x>fc.size()))
-00701                 return "";
-00702         return fc[x];
-00703 }
+
      00748 {
+00749         if ((x<0) || (x>fc.size()))
+00750                 return "";
+00751         return fc[x];
+00752 }

      - +
      -
      + - - + + @@ -315,30 +316,30 @@ References fc.
      void FileReader::LoadFile (  std::string   filename )  filename  ) 

      -Used to load a file. +Used to load a file.

      This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

      -Definition at line 674 of file modules.cpp. +Definition at line 723 of file modules.cpp.

      -References fc, and file_cache. +References fc, and file_cache.

      -

      00675 {
-00676         file_cache c;
-00677         readfile(c,filename.c_str());
-00678         this->fc = c;
-00679 }
+
      00724 {
+00725         file_cache c;
+00726         readfile(c,filename.c_str());
+00727         this->fc = c;
+00728 }

      Member Data Documentation

      -

      - +

      +

      - @@ -353,16 +354,16 @@ References fc, and

      -Definition at line 701 of file modules.h. +Definition at line 732 of file modules.h.

      -Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). +Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().

      + -
      file_cache FileReader::fc [private] + file_cache FileReader::fc [private]

      The documentation for this class was generated from the following files: -
      Generated on Sun May 2 00:09:36 2004 for InspIRCd by +
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classGLine-members.html b/docs/module-doc/classGLine-members.html index e0ce7b030..10f04a3b2 100644 --- a/docs/module-doc/classGLine-members.html +++ b/docs/module-doc/classGLine-members.html @@ -1,24 +1,23 @@ -Member List +InspIRCd: Member List - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      GLine Member List

      This is the complete list of members for GLine, including all inherited members. - - - - - - - - - -
      ageclassbase
      classbase()classbase [inline]
      durationXLine
      hostmaskGLine
      n_matchesXLine
      reasonXLine
      set_timeXLine
      sourceXLine
      ~classbase()classbase [inline]
      Generated on Sun May 2 00:09:37 2004 for InspIRCd by + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      GLine Member List

      This is the complete list of members for GLine, including all inherited members. + + + + + + + + + +
      ageclassbase
      classbase()classbase [inline]
      durationXLine
      hostmaskGLine
      n_matchesXLine
      reasonXLine
      set_timeXLine
      sourceXLine
      ~classbase()classbase [inline]
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classGLine.html b/docs/module-doc/classGLine.html index 068363eb6..4a6997d0d 100644 --- a/docs/module-doc/classGLine.html +++ b/docs/module-doc/classGLine.html @@ -1,45 +1,37 @@ -GLine class Reference +InspIRCd: GLine class Reference - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      GLine Class Reference

      GLine class. + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      GLine Class Reference

      GLine class. More...

      #include <xline.h>

      -Inheritance diagram for GLine:

      Inheritance graph
      - - - - -
      [legend]
      Collaboration diagram for GLine:

      Collaboration graph
      - - - - -
      [legend]
      List of all members. +Inherits XLine. +

      +List of all members.

      - - + + +

      Public Attributes

      char hostmask [MAXBUF]
       Hostmask (ident) to match against May contain wildcards.

      char hostmask [MAXBUF]
       Hostmask (ident) to match against May contain wildcards.

      Detailed Description

      -GLine class. +GLine class.

      -Definition at line 57 of file xline.h.

      Member Data Documentation

      -

      - +Definition at line 73 of file xline.h.

      Member Data Documentation

      +

      +

      - @@ -52,18 +44,18 @@ Definition at line 57 of fi +Definition at line 79 of file xline.h.
      + -
      char GLine::hostmask[MAXBUF] + char GLine::hostmask[MAXBUF]

      -Hostmask (ident) to match against May contain wildcards. +Hostmask (ident) to match against May contain wildcards.

      -Definition at line 63 of file xline.h.

      The documentation for this class was generated from the following file: -
      Generated on Sun May 2 00:09:37 2004 for InspIRCd by +
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classHostItem-members.html b/docs/module-doc/classHostItem-members.html index 4e4ac6d51..61a0e1b7e 100644 --- a/docs/module-doc/classHostItem-members.html +++ b/docs/module-doc/classHostItem-members.html @@ -1,23 +1,22 @@ -Member List +InspIRCd: Member List - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      HostItem Member List

      This is the complete list of members for HostItem, including all inherited members. - - - - - - - - -
      ageclassbase
      classbase()classbase [inline]
      dataHostItem
      HostItem()HostItem [inline]
      set_byHostItem
      set_timeHostItem
      ~classbase()classbase [inline]
      ~HostItem()HostItem [inline, virtual]
      Generated on Sun May 2 00:09:37 2004 for InspIRCd by + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      HostItem Member List

      This is the complete list of members for HostItem, including all inherited members. + + + + + + + + +
      ageclassbase
      classbase()classbase [inline]
      dataHostItem
      HostItem()HostItem [inline]
      set_byHostItem
      set_timeHostItem
      ~classbase()classbase [inline]
      ~HostItem()HostItem [inline, virtual]
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classHostItem.html b/docs/module-doc/classHostItem.html index 411589057..1c687d73b 100644 --- a/docs/module-doc/classHostItem.html +++ b/docs/module-doc/classHostItem.html @@ -1,55 +1,52 @@ -HostItem class Reference +InspIRCd: HostItem class Reference - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      HostItem Class Reference

      Holds an entry for a ban list, exemption list, or invite list. + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      HostItem Class Reference

      Holds an entry for a ban list, exemption list, or invite list. More...

      #include <channels.h>

      -Inheritance diagram for HostItem:

      Inheritance graph
      - - - - - - -
      [legend]
      Collaboration diagram for HostItem:

      Collaboration graph
      - - - -
      [legend]
      List of all members. +Inherits classbase. +

      +Inherited by BanItem, ExemptItem, and InviteItem. +

      +List of all members.

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

      Public Member Functions

       HostItem ()
      virtual ~HostItem ()
       HostItem ()
      virtual ~HostItem ()

      Public Attributes

      time_t set_time
      char set_by [NICKMAX]
      char data [MAXBUF]
      time_t set_time
      char set_by [NICKMAX]
      char data [MAXBUF]

      Detailed Description

      -Holds an entry for a ban list, exemption list, or invite list. +Holds an entry for a ban list, exemption list, or invite list.

      This class contains a single element in a channel list, such as a banlist.

      -Definition at line 18 of file channels.h.

      Constructor & Destructor Documentation

      +Definition at line 29 of file channels.h.

      Constructor & Destructor Documentation

      - +
      -
      + - - + + @@ -67,22 +64,22 @@ Definition at line 18 of

      -Definition at line 25 of file channels.h. +Definition at line 36 of file channels.h.

      -

      00025 { /* stub */ }
+
      00036 { /* stub */ }
      HostItem::HostItem (   )   )  [inline]

      - +
      -
      + - + - - + + @@ -100,20 +97,20 @@ Definition at line 25 of

      -Definition at line 26 of file channels.h. +Definition at line 37 of file channels.h.

      -

      00026 { /* stub */ }
+
      00037 { /* stub */ }
      virtual HostItem::~HostItem virtual HostItem::~HostItem (   )   )  [inline, virtual]

      Member Data Documentation

      -

      - +

      +

      - @@ -128,16 +125,16 @@ Definition at line 26 of

      -Definition at line 23 of file channels.h. +Definition at line 34 of file channels.h.

      + -
      char HostItem::data[MAXBUF] + char HostItem::data[MAXBUF]
      -

      - +

      +

      - @@ -152,16 +149,16 @@ Definition at line 23 of

      -Definition at line 22 of file channels.h. +Definition at line 33 of file channels.h.

      + -
      char HostItem::set_by[NICKMAX] + char HostItem::set_by[NICKMAX]
      -

      - +

      +

      - @@ -176,14 +173,14 @@ Definition at line 22 of

      -Definition at line 21 of file channels.h. +Definition at line 32 of file channels.h.

      + -
      time_t HostItem::set_time + time_t HostItem::set_time

      The documentation for this class was generated from the following file: -
      Generated on Sun May 2 00:09:37 2004 for InspIRCd by +
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classInviteItem-members.html b/docs/module-doc/classInviteItem-members.html index 8f37a3ab3..49a5d25c7 100644 --- a/docs/module-doc/classInviteItem-members.html +++ b/docs/module-doc/classInviteItem-members.html @@ -1,23 +1,22 @@ -Member List +InspIRCd: Member List - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      InviteItem Member List

      This is the complete list of members for InviteItem, including all inherited members. - - - - - - - - -
      ageclassbase
      classbase()classbase [inline]
      dataHostItem
      HostItem()HostItem [inline]
      set_byHostItem
      set_timeHostItem
      ~classbase()classbase [inline]
      ~HostItem()HostItem [inline, virtual]
      Generated on Sun May 2 00:09:38 2004 for InspIRCd by + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      InviteItem Member List

      This is the complete list of members for InviteItem, including all inherited members. + + + + + + + + +
      ageclassbase
      classbase()classbase [inline]
      dataHostItem
      HostItem()HostItem [inline]
      set_byHostItem
      set_timeHostItem
      ~classbase()classbase [inline]
      ~HostItem()HostItem [inline, virtual]
      Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
      +doxygen +1.3.3
      diff --git a/docs/module-doc/classInviteItem.html b/docs/module-doc/classInviteItem.html index 400167144..8cde5b7aa 100644 --- a/docs/module-doc/classInviteItem.html +++ b/docs/module-doc/classInviteItem.html @@ -1,39 +1,30 @@ -InviteItem class Reference +InspIRCd: InviteItem class Reference - -
      -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
      -

      InviteItem Class Reference

      A subclass of HostItem designed to hold channel invites (+I). + +
      Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
      +

      InviteItem Class Reference

      A subclass of HostItem designed to hold channel invites (+I). More...

      #include <channels.h>

      -Inheritance diagram for InviteItem:

      Inheritance graph
      - - - - -
      [legend]
      Collaboration diagram for InviteItem:

      Collaboration graph
      - - - - -
      [legend]
      List of all members. +Inherits HostItem. +

      +List of all members.

      Detailed Description

      -A subclass of HostItem designed to hold channel invites (+I). +A subclass of HostItem designed to hold channel invites (+I).

      -Definition at line 50 of file channels.h.

      The documentation for this class was generated from the following file:
        +Definition at line 61 of file channels.h.
        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:38 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classInvited-members.html b/docs/module-doc/classInvited-members.html index d355eb806..44fcd5d19 100644 --- a/docs/module-doc/classInvited-members.html +++ b/docs/module-doc/classInvited-members.html @@ -1,19 +1,18 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Invited Member List

        This is the complete list of members for Invited, including all inherited members. - - - - -
        ageclassbase
        channelInvited
        classbase()classbase [inline]
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:38 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Invited Member List

        This is the complete list of members for Invited, including all inherited members. + + + + +
        ageclassbase
        channelInvited
        classbase()classbase [inline]
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classInvited.html b/docs/module-doc/classInvited.html index c8144ed86..7847153fd 100644 --- a/docs/module-doc/classInvited.html +++ b/docs/module-doc/classInvited.html @@ -1,42 +1,36 @@ -Invited class Reference +InspIRCd: Invited class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Invited Class Reference

        Holds a channel name to which a user has been invited. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Invited Class Reference

        Holds a channel name to which a user has been invited. More...

        #include <users.h>

        -Inheritance diagram for Invited:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for Invited:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

        - + +

        Public Attributes

        char channel [CHANMAX]
        char channel [CHANMAX]

        Detailed Description

        -Holds a channel name to which a user has been invited. +Holds a channel name to which a user has been invited.

        -Definition at line 25 of file users.h.

        Member Data Documentation

        -

        - +Definition at line 36 of file users.h.

        Member Data Documentation

        +

        +

        - @@ -51,16 +45,16 @@ Definition at line 25 of fi

        -Definition at line 28 of file users.h. +Definition at line 39 of file users.h.

        -Referenced by userrec::InviteTo(). +Referenced by userrec::InviteTo().

        + -
        char Invited::channel[CHANMAX] + char Invited::channel[CHANMAX]

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:38 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classKLine-members.html b/docs/module-doc/classKLine-members.html index 4fe3facfa..9cc27d5ff 100644 --- a/docs/module-doc/classKLine-members.html +++ b/docs/module-doc/classKLine-members.html @@ -1,24 +1,23 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        KLine Member List

        This is the complete list of members for KLine, including all inherited members. - - - - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        hostmaskKLine
        n_matchesXLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:40 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        KLine Member List

        This is the complete list of members for KLine, including all inherited members. + + + + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        hostmaskKLine
        n_matchesXLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classKLine.html b/docs/module-doc/classKLine.html index dbbd60389..e598f95bb 100644 --- a/docs/module-doc/classKLine.html +++ b/docs/module-doc/classKLine.html @@ -1,45 +1,37 @@ -KLine class Reference +InspIRCd: KLine class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        KLine Class Reference

        KLine class. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        KLine Class Reference

        KLine class. More...

        #include <xline.h>

        -Inheritance diagram for KLine:

        Inheritance graph
        - - - - -
        [legend]
        Collaboration diagram for KLine:

        Collaboration graph
        - - - - -
        [legend]
        List of all members. +Inherits XLine. +

        +List of all members.

        - - + + +

        Public Attributes

        char hostmask [MAXBUF]
         Hostmask (ident) to match against May contain wildcards.

        char hostmask [MAXBUF]
         Hostmask (ident) to match against May contain wildcards.

        Detailed Description

        -KLine class. +KLine class.

        -Definition at line 46 of file xline.h.

        Member Data Documentation

        -

        - +Definition at line 62 of file xline.h.

        Member Data Documentation

        +

        +

        - @@ -52,18 +44,18 @@ Definition at line 46 of fi +Definition at line 68 of file xline.h.
        + -
        char KLine::hostmask[MAXBUF] + char KLine::hostmask[MAXBUF]

        -Hostmask (ident) to match against May contain wildcards. +Hostmask (ident) to match against May contain wildcards.

        -Definition at line 52 of file xline.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:40 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classModeParameter-members.html b/docs/module-doc/classModeParameter-members.html index 900a001d5..8ab7a86cb 100644 --- a/docs/module-doc/classModeParameter-members.html +++ b/docs/module-doc/classModeParameter-members.html @@ -1,21 +1,20 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ModeParameter Member List

        This is the complete list of members for ModeParameter, including all inherited members. - - - - - - -
        ageclassbase
        channelModeParameter
        classbase()classbase [inline]
        modeModeParameter
        parameterModeParameter
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:40 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ModeParameter Member List

        This is the complete list of members for ModeParameter, including all inherited members. + + + + + + +
        ageclassbase
        channelModeParameter
        classbase()classbase [inline]
        modeModeParameter
        parameterModeParameter
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classModeParameter.html b/docs/module-doc/classModeParameter.html index cdeb3d184..fbd3c3409 100644 --- a/docs/module-doc/classModeParameter.html +++ b/docs/module-doc/classModeParameter.html @@ -1,46 +1,42 @@ -ModeParameter class Reference +InspIRCd: ModeParameter class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ModeParameter Class Reference

        Holds a custom parameter to a module-defined channel mode e.g. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ModeParameter Class Reference

        Holds a custom parameter to a module-defined channel mode e.g. More...

        #include <channels.h>

        -Inheritance diagram for ModeParameter:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for ModeParameter:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

        - - - + + + + + +

        Public Attributes

        char mode
        char parameter [MAXBUF]
        char channel [CHANMAX]
        char mode
        char parameter [MAXBUF]
        char channel [CHANMAX]

        Detailed Description

        -Holds a custom parameter to a module-defined channel mode e.g. +Holds a custom parameter to a module-defined channel mode e.g.

        for +L this would hold the channel name.

        -Definition at line 59 of file channels.h.

        Member Data Documentation

        -

        - +Definition at line 70 of file channels.h.

        Member Data Documentation

        +

        +

        - @@ -55,18 +51,18 @@ Definition at line 59 of

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

        -Referenced by chanrec::SetCustomModeParam(). +Referenced by chanrec::SetCustomModeParam().

        + -
        char ModeParameter::channel[CHANMAX] + char ModeParameter::channel[CHANMAX]
        -

        - +

        +

        - @@ -81,18 +77,18 @@ Referenced by chanrec::Set

        -Definition at line 62 of file channels.h. +Definition at line 73 of file channels.h.

        -Referenced by chanrec::SetCustomModeParam(). +Referenced by chanrec::SetCustomModeParam().

        + -
        char ModeParameter::mode + char ModeParameter::mode
        -

        - +

        +

        - @@ -107,16 +103,16 @@ Referenced by chanrec::Set

        -Definition at line 63 of file channels.h. +Definition at line 74 of file channels.h.

        -Referenced by chanrec::SetCustomModeParam(). +Referenced by chanrec::SetCustomModeParam().

        + -
        char ModeParameter::parameter[MAXBUF] + char ModeParameter::parameter[MAXBUF]

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:40 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classModule-members.html b/docs/module-doc/classModule-members.html index ad9926e5b..b015aa959 100644 --- a/docs/module-doc/classModule-members.html +++ b/docs/module-doc/classModule-members.html @@ -1,40 +1,40 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Module Member List

        This is the complete list of members for Module, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        GetVersion()Module [virtual]
        Module()Module
        OnAccessCheck(userrec *source, userrec *dest, chanrec *channel, int access_type)Module [virtual]
        OnChannelSync(chanrec *chan)Module [virtual]
        OnExtendedMode(userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)Module [virtual]
        OnInfo(userrec *user)Module [virtual]
        OnOper(userrec *user)Module [virtual]
        OnPacketReceive(char *p)Module [virtual]
        OnPacketTransmit(char *p)Module [virtual]
        OnRehash()Module [virtual]
        OnServerRaw(std::string &raw, bool inbound, userrec *user)Module [virtual]
        OnUserConnect(userrec *user)Module [virtual]
        OnUserJoin(userrec *user, chanrec *channel)Module [virtual]
        OnUserPart(userrec *user, chanrec *channel)Module [virtual]
        OnUserPreJoin(userrec *user, chanrec *chan, const char *cname)Module [virtual]
        OnUserPreMessage(userrec *user, void *dest, int target_type, std::string text)Module [virtual]
        OnUserPreNick(userrec *user, std::string newnick)Module [virtual]
        OnUserPreNotice(userrec *user, void *dest, int target_type, std::string text)Module [virtual]
        OnUserQuit(userrec *user)Module [virtual]
        OnUserSync(userrec *user)Module [virtual]
        OnWhois(userrec *source, userrec *dest)Module [virtual]
        ~classbase()classbase [inline]
        ~Module()Module [virtual]
        Generated on Sun May 2 00:09:41 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Module Member List

        This is the complete list of members for Module, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        GetVersion()Module [virtual]
        Module()Module
        OnAccessCheck(userrec *source, userrec *dest, chanrec *channel, int access_type)Module [virtual]
        OnChannelSync(chanrec *chan)Module [virtual]
        OnExtendedMode(userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)Module [virtual]
        OnInfo(userrec *user)Module [virtual]
        OnOper(userrec *user)Module [virtual]
        OnPacketReceive(char *p)Module [virtual]
        OnPacketTransmit(char *p)Module [virtual]
        OnRehash()Module [virtual]
        OnServerRaw(std::string &raw, bool inbound, userrec *user)Module [virtual]
        OnUserConnect(userrec *user)Module [virtual]
        OnUserJoin(userrec *user, chanrec *channel)Module [virtual]
        OnUserPart(userrec *user, chanrec *channel)Module [virtual]
        OnUserPreInvite(userrec *source, userrec *dest, chanrec *channel)Module [virtual]
        OnUserPreJoin(userrec *user, chanrec *chan, const char *cname)Module [virtual]
        OnUserPreMessage(userrec *user, void *dest, int target_type, std::string &text)Module [virtual]
        OnUserPreNick(userrec *user, std::string newnick)Module [virtual]
        OnUserPreNotice(userrec *user, void *dest, int target_type, std::string &text)Module [virtual]
        OnUserQuit(userrec *user)Module [virtual]
        OnUserSync(userrec *user)Module [virtual]
        OnWhois(userrec *source, userrec *dest)Module [virtual]
        ~classbase()classbase [inline]
        ~Module()Module [virtual]
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index f17ba5067..c32b72a62 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -1,90 +1,108 @@ -Module class Reference +InspIRCd: Module class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Module Class Reference

        Base class for all InspIRCd modules This class is the base class for InspIRCd modules. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Module Class Reference

        Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...

        #include <modules.h>

        -Inheritance diagram for Module:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for Module:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

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

        Public Member Functions

         Module ()
         Default constructor creates a module class.

        virtual ~Module ()
         Default destructor destroys a module class.

        virtual Version GetVersion ()
         Returns the version number of a Module.

        virtual void OnUserConnect (userrec *user)
         Called when a user connects.

        virtual void OnUserQuit (userrec *user)
         Called when a user quits.

        virtual void OnUserJoin (userrec *user, chanrec *channel)
         Called when a user joins a channel.

        virtual void OnUserPart (userrec *user, chanrec *channel)
         Called when a user parts a channel.

        virtual void OnPacketTransmit (char *p)
         Called before a packet is transmitted across the irc network between two irc servers.

        virtual void OnPacketReceive (char *p)
         Called after a packet is received from another irc server.

        virtual void OnRehash ()
         Called on rehash.

        virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)
         Called when a raw command is transmitted or received.

        virtual int OnExtendedMode (userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)
         Called whenever an extended mode is to be processed.

        virtual int OnUserPreJoin (userrec *user, chanrec *chan, const char *cname)
         Called whenever a user is about to join a channel, before any processing is done.

        virtual void OnOper (userrec *user)
         Called whenever a user opers locally.

        virtual void OnInfo (userrec *user)
         Called whenever a user types /INFO.

        virtual void OnWhois (userrec *source, userrec *dest)
         Called whenever a /WHOIS is performed on a local user.

        virtual int OnUserPreMessage (userrec *user, void *dest, int target_type, std::string text)
         Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.

        virtual int OnUserPreNotice (userrec *user, void *dest, int target_type, std::string text)
         Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

        virtual int OnUserPreNick (userrec *user, std::string newnick)
         Called before any nickchange, local or remote.

        virtual int OnAccessCheck (userrec *source, userrec *dest, chanrec *channel, int access_type)
         Called before an action which requires a channel privilage check.

        virtual string_list OnUserSync (userrec *user)
         Called during a netburst to sync user data.

        virtual string_list OnChannelSync (chanrec *chan)
         Called during a netburst to sync channel data.

         Module ()
         Default constructor creates a module class.

        virtual ~Module ()
         Default destructor destroys a module class.

        virtual Version GetVersion ()
         Returns the version number of a Module.

        virtual void OnUserConnect (userrec *user)
         Called when a user connects.

        virtual void OnUserQuit (userrec *user)
         Called when a user quits.

        virtual void OnUserJoin (userrec *user, chanrec *channel)
         Called when a user joins a channel.

        virtual void OnUserPart (userrec *user, chanrec *channel)
         Called when a user parts a channel.

        virtual void OnPacketTransmit (char *p)
         Called before a packet is transmitted across the irc network between two irc servers.

        virtual void OnPacketReceive (char *p)
         Called after a packet is received from another irc server.

        virtual void OnRehash ()
         Called on rehash.

        virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)
         Called when a raw command is transmitted or received.

        virtual int OnExtendedMode (userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)
         Called whenever an extended mode is to be processed.

        virtual int OnUserPreJoin (userrec *user, chanrec *chan, const char *cname)
         Called whenever a user is about to join a channel, before any processing is done.

        virtual void OnOper (userrec *user)
         Called whenever a user opers locally.

        virtual void OnInfo (userrec *user)
         Called whenever a user types /INFO.

        virtual void OnWhois (userrec *source, userrec *dest)
         Called whenever a /WHOIS is performed on a local user.

        virtual int OnUserPreInvite (userrec *source, userrec *dest, chanrec *channel)
         Called whenever a user is about to invite another user into a channel, before any processing is done.

        virtual int OnUserPreMessage (userrec *user, void *dest, int target_type, std::string &text)
         Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.

        virtual int OnUserPreNotice (userrec *user, void *dest, int target_type, std::string &text)
         Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

        virtual int OnUserPreNick (userrec *user, std::string newnick)
         Called before any nickchange, local or remote.

        virtual int OnAccessCheck (userrec *source, userrec *dest, chanrec *channel, int access_type)
         Called before an action which requires a channel privilage check.

        virtual string_list OnUserSync (userrec *user)
         Called during a netburst to sync user data.

        virtual string_list OnChannelSync (chanrec *chan)
         Called during a netburst to sync channel data.

        Detailed Description

        -Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +Base class for all InspIRCd modules This class is the base class for InspIRCd modules.

        All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.

        -Definition at line 116 of file modules.h.

        Constructor & Destructor Documentation

        +Definition at line 126 of file modules.h.

        Constructor & Destructor Documentation

        - +
        -
        + - - + + @@ -100,26 +118,26 @@ Definition at line 116 of
        Module::Module (   )   ) 

        -Default constructor creates a module class. +Default constructor creates a module class.

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

        -

        00285 { }
+
        00297 { }

        - +
        -
        + - + - - + + @@ -135,27 +153,27 @@ Definition at line 285
        Module::~Module Module::~Module (   )   )  [virtual]

        -Default destructor destroys a module class. +Default destructor destroys a module class.

        -Definition at line 286 of file modules.cpp. +Definition at line 298 of file modules.cpp.

        -

        00286 { }
+
        00298 { }

        Member Function Documentation

        - +
        -
        + - - + + @@ -171,44 +189,44 @@ Definition at line 286
        Version Module::GetVersion (   )   )  [virtual]

        -Returns the version number of a Module. +Returns the version number of a Module.

        The method should return a Version object with its version information assigned via Version::Version

        -Definition at line 297 of file modules.cpp. +Definition at line 309 of file modules.cpp.

        -

        00297 { return Version(1,0,0,0); }
+
        00309 { return Version(1,0,0,0); }
        -

        - +

        +

        -
        + - + - + - + - + @@ -228,7 +246,7 @@ Definition at line 297
        int Module::OnAccessCheck (  userrec *   source, source,
        userrec *   dest, dest,
        chanrec *   channel, channel,
        int   access_type access_type

        -Called before an action which requires a channel privilage check. +Called before an action which requires a channel privilage check.

        This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are:

        @@ -244,25 +262,25 @@ This function is called before many functions which check a users status on a ch
        Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).

        -Definition at line 304 of file modules.cpp. +Definition at line 317 of file modules.cpp.

        -References ACR_DEFAULT. +References ACR_DEFAULT.

        -

        00304 { return ACR_DEFAULT; };
+
        00317 { return ACR_DEFAULT; };
        -

        - +

        +

        -
        + - - + + @@ -278,58 +296,58 @@ References ACR_DEFAULT.
        string_list Module::OnChannelSync (  chanrec *   chan )  chan  )  [virtual]

        -Called during a netburst to sync channel data. +Called during a netburst to sync channel data.

        This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.

        -Definition at line 306 of file modules.cpp. +Definition at line 319 of file modules.cpp.

        -References string_list. +References string_list.

        -

        00306 { string_list empty; return empty; }
+
        00319 { string_list empty; return empty; }

        - +
        -
        + - + - + - + - + - + - + @@ -349,27 +367,27 @@ References string_list.
        int Module::OnExtendedMode (  userrec *   user, user,
        void *   target, target,
        char   modechar, modechar,
        int   type, type,
        bool   mode_on, mode_on,
        string_list &   params params

        -Called whenever an extended mode is to be processed. +Called whenever an extended mode is to be processed.

        The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with Server::AddExtendedMode If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.

        -Definition at line 296 of file modules.cpp. +Definition at line 308 of file modules.cpp.

        -

        00296 { return false; }
+
        00308 { return false; }

        - +
        -
        + - - + + @@ -385,28 +403,28 @@ Definition at line 296
        void Module::OnInfo (  userrec *   user )  user  )  [virtual]

        -Called whenever a user types /INFO. +Called whenever a user types /INFO.

        The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:

        <nick> :information here

        -Definition at line 299 of file modules.cpp. +Definition at line 311 of file modules.cpp.

        -

        00299 { };
+
        00311 { };

        - +
        -
        + - - + + @@ -422,27 +440,27 @@ Definition at line 299
        void Module::OnOper (  userrec *   user )  user  )  [virtual]

        -Called whenever a user opers locally. +Called whenever a user opers locally.

        The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.

        -Definition at line 298 of file modules.cpp. +Definition at line 310 of file modules.cpp.

        -

        00298 { };
+
        00310 { };

        - +
        -
        + - - + + @@ -458,27 +476,27 @@ Definition at line 298
        void Module::OnPacketReceive (  char *   p )  p  )  [virtual]

        -Called after a packet is received from another irc server. +Called after a packet is received from another irc server.

        The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.

        -Definition at line 292 of file modules.cpp. +Definition at line 304 of file modules.cpp.

        -

        00292 { }
+
        00304 { }

        - +
        -
        + - - + + @@ -494,26 +512,26 @@ Definition at line 292
        void Module::OnPacketTransmit (  char *   p )  p  )  [virtual]

        -Called before a packet is transmitted across the irc network between two irc servers. +Called before a packet is transmitted across the irc network between two irc servers.

        The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.

        -Definition at line 291 of file modules.cpp. +Definition at line 303 of file modules.cpp.

        -

        00291 { }
+
        00303 { }

        - +
        -
        + - - + + @@ -529,38 +547,38 @@ Definition at line 291
        void Module::OnRehash (   )   )  [virtual]

        -Called on rehash. +Called on rehash.

        This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.

        -Definition at line 293 of file modules.cpp. +Definition at line 305 of file modules.cpp.

        -

        00293 { }
+
        00305 { }

        - +
        -
        + - + - + - + @@ -580,27 +598,27 @@ Definition at line 293
        void Module::OnServerRaw (  std::string &   raw, raw,
        bool   inbound, inbound,
        userrec *   user user

        -Called when a raw command is transmitted or received. +Called when a raw command is transmitted or received.

        This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.

        -Definition at line 294 of file modules.cpp. +Definition at line 306 of file modules.cpp.

        -

        00294 { }
+
        00306 { }

        - +
        -
        + - - + + @@ -616,32 +634,32 @@ Definition at line 294
        void Module::OnUserConnect (  userrec *   user )  user  )  [virtual]

        -Called when a user connects. +Called when a user connects.

        The details of the connecting user are available to you in the parameter userrec *user

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

        -

        00287 { }
+
        00299 { }

        - +
        -
        + - + - + @@ -661,32 +679,32 @@ Definition at line 287
        void Module::OnUserJoin (  userrec *   user, user,
        chanrec *   channel channel

        -Called when a user joins a channel. +Called when a user joins a channel.

        The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel

        -Definition at line 289 of file modules.cpp. +Definition at line 301 of file modules.cpp.

        -

        00289 { }
+
        00301 { }

        - +
        -
        + - + - + @@ -706,38 +724,89 @@ Definition at line 289 + +
        void Module::OnUserPart (  userrec *   user, user,
        chanrec *   channel channel

        -Called when a user parts a channel. +Called when a user parts a channel.

        The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel

        -Definition at line 290 of file modules.cpp. +Definition at line 302 of file modules.cpp.

        -

        00290 { }
+
        00302 { }
+
        +

        + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + +
        int Module::OnUserPreInvite ( userrec *  source,
        userrec *  dest,
        chanrec *  channel
        )  [virtual]
        +
        + + + +
        +   + + +

        +Called whenever a user is about to invite another user into a channel, before any processing is done. +

        +Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels. +

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

        +

        00313 { return 0; };

        - +
        -
        + - + - + - + @@ -757,46 +826,46 @@ Definition at line 290
        int Module::OnUserPreJoin (  userrec *   user, user,
        chanrec *   chan, chan,
        const char *   cname cname

        -Called whenever a user is about to join a channel, before any processing is done. +Called whenever a user is about to join a channel, before any processing is done.

        Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.

        IMPORTANT NOTE!

        If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.

        -Definition at line 295 of file modules.cpp. +Definition at line 307 of file modules.cpp.

        -

        00295 { return 0; }
+
        00307 { return 0; }
        -

        - +

        +

        -
        + - + - + - + - - + + @@ -816,32 +885,32 @@ Definition at line 295
        int Module::OnUserPreMessage (  userrec *   user, user,
        void *   dest, dest,
        int   target_type, target_type,
        std::string   textstd::string &  text

        -Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. +Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.

        Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.

        -Definition at line 301 of file modules.cpp. +Definition at line 314 of file modules.cpp.

        -

        00301 { return 0; };
+
        00314 { return 0; };
        -

        - +

        +

        -
        + - + - + @@ -861,44 +930,44 @@ Definition at line 301
        int Module::OnUserPreNick (  userrec *   user, user,
        std::string   newnick newnick

        -Called before any nickchange, local or remote. +Called before any nickchange, local or remote.

        -This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output. +This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.

        -Definition at line 303 of file modules.cpp. +Definition at line 316 of file modules.cpp.

        -

        00303 { return 0; };
+
        00316 { return 0; };
        -

        - +

        +

        -
        + - + - + - + - - + + @@ -918,27 +987,27 @@ Definition at line 303
        int Module::OnUserPreNotice (  userrec *   user, user,
        void *   dest, dest,
        int   target_type, target_type,
        std::string   textstd::string &  text

        -Called whenever a user is about to NOTICE A user or a channel, before any processing is done. +Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

        -Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. +Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.

        -Definition at line 302 of file modules.cpp. +Definition at line 315 of file modules.cpp.

        -

        00302 { return 0; };
+
        00315 { return 0; };

        - +
        -
        + - - + + @@ -954,27 +1023,27 @@ Definition at line 302
        void Module::OnUserQuit (  userrec *   user )  user  )  [virtual]

        -Called when a user quits. +Called when a user quits.

        The details of the exiting user are available to you in the parameter userrec *user

        -Definition at line 288 of file modules.cpp. +Definition at line 300 of file modules.cpp.

        -

        00288 { }
+
        00300 { }
        -

        - +

        +

        -
        + - - + + @@ -990,34 +1059,34 @@ Definition at line 288
        string_list Module::OnUserSync (  userrec *   user )  user  )  [virtual]

        -Called during a netburst to sync user data. +Called during a netburst to sync user data.

        This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.

        -Definition at line 305 of file modules.cpp. +Definition at line 318 of file modules.cpp.

        -References string_list. +References string_list.

        -

        00305 { string_list empty; return empty; }
+
        00318 { string_list empty; return empty; }

        - +
        -
        + - + - + @@ -1037,21 +1106,21 @@ References string_list.
        void Module::OnWhois (  userrec *   source, source,
        userrec *   dest dest

        -Called whenever a /WHOIS is performed on a local user. +Called whenever a /WHOIS is performed on a local user.

        The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.

        -Definition at line 300 of file modules.cpp. +Definition at line 312 of file modules.cpp.

        -

        00300 { };
+
        00312 { };
        The documentation for this class was generated from the following files: -
        Generated on Sun May 2 00:09:41 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classModuleFactory-members.html b/docs/module-doc/classModuleFactory-members.html index f04954d9f..9b33b9882 100644 --- a/docs/module-doc/classModuleFactory-members.html +++ b/docs/module-doc/classModuleFactory-members.html @@ -1,21 +1,20 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ModuleFactory Member List

        This is the complete list of members for ModuleFactory, including all inherited members. - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        CreateModule()=0ModuleFactory [pure virtual]
        ModuleFactory()ModuleFactory [inline]
        ~classbase()classbase [inline]
        ~ModuleFactory()ModuleFactory [inline, virtual]
        Generated on Sun May 2 00:09:41 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ModuleFactory Member List

        This is the complete list of members for ModuleFactory, including all inherited members. + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        CreateModule()=0ModuleFactory [pure virtual]
        ModuleFactory()ModuleFactory [inline]
        ~classbase()classbase [inline]
        ~ModuleFactory()ModuleFactory [inline, virtual]
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html index 90a9e4e6d..800132b55 100644 --- a/docs/module-doc/classModuleFactory.html +++ b/docs/module-doc/classModuleFactory.html @@ -1,50 +1,46 @@ -ModuleFactory class Reference +InspIRCd: ModuleFactory class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ModuleFactory Class Reference

        Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ModuleFactory Class Reference

        Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. More...

        #include <modules.h>

        -Inheritance diagram for ModuleFactory:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for ModuleFactory:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

        - - - - + + + + + + +

        Public Member Functions

         ModuleFactory ()
        virtual ~ModuleFactory ()
        virtual Module * CreateModule ()=0
         Creates a new module.

         ModuleFactory ()
        virtual ~ModuleFactory ()
        virtual Module * CreateModule ()=0
         Creates a new module.

        Detailed Description

        -Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. +Instantiates classes inherited from Module This class creates a class inherited from type Module, using new.

        This is to allow for modules to create many different variants of Module, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules.

        -Definition at line 754 of file modules.h.

        Constructor & Destructor Documentation

        +Definition at line 785 of file modules.h.

        Constructor & Destructor Documentation

        - +
        -
        + - - + + @@ -62,22 +58,22 @@ Definition at line 754 of

        -Definition at line 757 of file modules.h. +Definition at line 788 of file modules.h.

        -

        00757 { }
+
        00788 { }
        ModuleFactory::ModuleFactory (   )   )  [inline]

        - +
        -
        + - + - - + + @@ -95,23 +91,23 @@ Definition at line 757 of

        -Definition at line 758 of file modules.h. +Definition at line 789 of file modules.h.

        -

        00758 { }
+
        00789 { }
        virtual ModuleFactory::~ModuleFactory virtual ModuleFactory::~ModuleFactory (   )   )  [inline, virtual]

        Member Function Documentation

        - +
        -
        + - - + + @@ -127,16 +123,16 @@ Definition at line 758 of
        virtual Module* ModuleFactory::CreateModule (   )   )  [pure virtual]

        -Creates a new module. +Creates a new module.

        Your inherited class of ModuleFactory must return a pointer to your Module class using this method.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:41 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classQLine-members.html b/docs/module-doc/classQLine-members.html index fbfc7b10d..6af3255e2 100644 --- a/docs/module-doc/classQLine-members.html +++ b/docs/module-doc/classQLine-members.html @@ -1,25 +1,24 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        QLine Member List

        This is the complete list of members for QLine, including all inherited members. - - - - - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        is_globalQLine
        n_matchesXLine
        nickQLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:42 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        QLine Member List

        This is the complete list of members for QLine, including all inherited members. + + + + + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        is_globalQLine
        n_matchesXLine
        nickQLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classQLine.html b/docs/module-doc/classQLine.html index 6813ebb0d..94ef272f0 100644 --- a/docs/module-doc/classQLine.html +++ b/docs/module-doc/classQLine.html @@ -1,47 +1,40 @@ -QLine class Reference +InspIRCd: QLine class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        QLine Class Reference

        QLine class. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        QLine Class Reference

        QLine class. More...

        #include <xline.h>

        -Inheritance diagram for QLine:

        Inheritance graph
        - - - - -
        [legend]
        Collaboration diagram for QLine:

        Collaboration graph
        - - - - -
        [legend]
        List of all members. +Inherits XLine. +

        +List of all members.

        - - - - + + + + + +

        Public Attributes

        char nick [MAXBUF]
         Nickname to match against.

        bool is_global
         Set if this is a global Z:line (e.g.

        char nick [MAXBUF]
         Nickname to match against.

        bool is_global
         Set if this is a global Z:line (e.g.

        Detailed Description

        -QLine class. +QLine class.

        -Definition at line 83 of file xline.h.

        Member Data Documentation

        -

        - +Definition at line 99 of file xline.h.

        Member Data Documentation

        +

        +

        - @@ -54,20 +47,20 @@ Definition at line 83 of fi +Definition at line 109 of file xline.h.
        + -
        bool QLine::is_global + bool QLine::is_global

        -Set if this is a global Z:line (e.g. +Set if this is a global Z:line (e.g.

        it came from another server)

        -Definition at line 93 of file xline.h.

        -

        - +

        +

        - @@ -80,18 +73,18 @@ Definition at line 93 of fi +Definition at line 105 of file xline.h.
        + -
        char QLine::nick[MAXBUF] + char QLine::nick[MAXBUF]

        -Nickname to match against. +Nickname to match against.

        May contain wildcards.

        -Definition at line 89 of file xline.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:42 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classServer-members.html b/docs/module-doc/classServer-members.html index 216cb96c1..62a281904 100644 --- a/docs/module-doc/classServer-members.html +++ b/docs/module-doc/classServer-members.html @@ -1,54 +1,53 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Server Member List

        This is the complete list of members for Server, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        AddCommand(char *cmd, handlerfunc f, char flags, int minparams)Server [virtual]
        AddExtendedListMode(char modechar)Server [virtual]
        AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)Server [virtual]
        ageclassbase
        CallCommandHandler(std::string commandname, char **parameters, int pcnt, userrec *user)Server [virtual]
        ChangeGECOS(userrec *user, std::string gecos)Server [virtual]
        ChangeHost(userrec *user, std::string host)Server [virtual]
        ChangeUserNick(userrec *user, std::string nickname)Server [virtual]
        ChanMode(userrec *User, chanrec *Chan)Server [virtual]
        classbase()classbase [inline]
        CommonChannels(userrec *u1, userrec *u2)Server [virtual]
        CountUsers(chanrec *c)Server [virtual]
        FindChannel(std::string channel)Server [virtual]
        FindNick(std::string nick)Server [virtual]
        GetAdmin()Server [virtual]
        GetNetworkName()Server [virtual]
        GetServerName()Server [virtual]
        GetUsers(chanrec *chan)Server [virtual]
        IsNick(std::string nick)Server [virtual]
        IsOnChannel(userrec *User, chanrec *Chan)Server [virtual]
        IsUlined(std::string server)Server [virtual]
        JoinUserToChannel(userrec *user, std::string cname, std::string key)Server [virtual]
        Log(int level, std::string s)Server [virtual]
        MatchText(std::string sliteral, std::string spattern)Server [virtual]
        PartUserFromChannel(userrec *user, std::string cname, std::string reason)Server [virtual]
        QuitUser(userrec *user, std::string reason)Server [virtual]
        Send(int Socket, std::string s)Server [virtual]
        SendChannel(userrec *User, chanrec *Channel, std::string s, bool IncludeSender)Server [virtual]
        SendCommon(userrec *User, std::string text, bool IncludeSender)Server [virtual]
        SendFrom(int Socket, userrec *User, std::string s)Server [virtual]
        SendMode(char **parameters, int pcnt, userrec *user)Server [virtual]
        SendOpers(std::string s)Server [virtual]
        SendServ(int Socket, std::string s)Server [virtual]
        SendTo(userrec *Source, userrec *Dest, std::string s)Server [virtual]
        SendToModeMask(std::string modes, int flags, std::string text)Server [virtual]
        SendWallops(userrec *User, std::string text)Server [virtual]
        Server()Server
        ~classbase()classbase [inline]
        ~Server()Server [virtual]
        Generated on Sun May 2 00:09:43 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Server Member List

        This is the complete list of members for Server, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AddCommand(char *cmd, handlerfunc f, char flags, int minparams)Server [virtual]
        AddExtendedListMode(char modechar)Server [virtual]
        AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)Server [virtual]
        ageclassbase
        CallCommandHandler(std::string commandname, char **parameters, int pcnt, userrec *user)Server [virtual]
        ChangeGECOS(userrec *user, std::string gecos)Server [virtual]
        ChangeHost(userrec *user, std::string host)Server [virtual]
        ChangeUserNick(userrec *user, std::string nickname)Server [virtual]
        ChanMode(userrec *User, chanrec *Chan)Server [virtual]
        classbase()classbase [inline]
        CommonChannels(userrec *u1, userrec *u2)Server [virtual]
        CountUsers(chanrec *c)Server [virtual]
        FindChannel(std::string channel)Server [virtual]
        FindNick(std::string nick)Server [virtual]
        GetAdmin()Server [virtual]
        GetNetworkName()Server [virtual]
        GetServerName()Server [virtual]
        GetUsers(chanrec *chan)Server [virtual]
        IsNick(std::string nick)Server [virtual]
        IsOnChannel(userrec *User, chanrec *Chan)Server [virtual]
        IsUlined(std::string server)Server [virtual]
        JoinUserToChannel(userrec *user, std::string cname, std::string key)Server [virtual]
        Log(int level, std::string s)Server [virtual]
        MatchText(std::string sliteral, std::string spattern)Server [virtual]
        PartUserFromChannel(userrec *user, std::string cname, std::string reason)Server [virtual]
        QuitUser(userrec *user, std::string reason)Server [virtual]
        Send(int Socket, std::string s)Server [virtual]
        SendChannel(userrec *User, chanrec *Channel, std::string s, bool IncludeSender)Server [virtual]
        SendCommon(userrec *User, std::string text, bool IncludeSender)Server [virtual]
        SendFrom(int Socket, userrec *User, std::string s)Server [virtual]
        SendMode(char **parameters, int pcnt, userrec *user)Server [virtual]
        SendOpers(std::string s)Server [virtual]
        SendServ(int Socket, std::string s)Server [virtual]
        SendTo(userrec *Source, userrec *Dest, std::string s)Server [virtual]
        SendToModeMask(std::string modes, int flags, std::string text)Server [virtual]
        SendWallops(userrec *User, std::string text)Server [virtual]
        Server()Server
        ~classbase()classbase [inline]
        ~Server()Server [virtual]
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 1c9116ffe..3f90b0048 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -1,118 +1,147 @@ -Server class Reference +InspIRCd: Server class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Server Class Reference

        Allows 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. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Server Class Reference

        Allows 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. More...

        #include <modules.h>

        -Inheritance diagram for Server:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for Server:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

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

        Public Member Functions

         Server ()
         Default constructor.

        virtual ~Server ()
         Default destructor.

        virtual void SendOpers (std::string s)
         Sends text to all opers.

        virtual void Log (int level, std::string s)
         Writes a log string.

        virtual void Send (int Socket, std::string s)
         Sends a line of text down a TCP/IP socket.

        virtual void SendServ (int Socket, std::string s)
         Sends text from the server to a socket.

        virtual void SendFrom (int Socket, userrec *User, std::string s)
         Sends text from a user to a socket.

        virtual void SendTo (userrec *Source, userrec *Dest, std::string s)
         Sends text from a user to another user.

        virtual void SendChannel (userrec *User, chanrec *Channel, std::string s, bool IncludeSender)
         Sends text from a user to a channel (mulicast).

        virtual bool CommonChannels (userrec *u1, userrec *u2)
         Returns true if two users share a common channel.

        virtual void SendCommon (userrec *User, std::string text, bool IncludeSender)
         Sends text from a user to one or more channels (mulicast).

        virtual void SendWallops (userrec *User, std::string text)
         Sends a WALLOPS message.

        virtual bool IsNick (std::string nick)
         Returns true if a nick is valid.

        virtual int CountUsers (chanrec *c)
         Returns a count of the number of users on a channel.

        virtual userrec * FindNick (std::string nick)
         Attempts to look up a nick and return a pointer to it.

        virtual chanrec * FindChannel (std::string channel)
         Attempts to look up a channel and return a pointer to it.

        virtual std::string ChanMode (userrec *User, chanrec *Chan)
         Attempts to look up a user's privilages on a channel.

        virtual bool IsOnChannel (userrec *User, chanrec *Chan)
         Checks if a user is on a channel.

        virtual std::string GetServerName ()
         Returns the server name of the server where the module is loaded.

        virtual std::string GetNetworkName ()
         Returns the network name, global to all linked servers.

        virtual Admin GetAdmin ()
         Returns the information of the server as returned by the /ADMIN command.

        virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
         Adds an extended mode letter which is parsed by a module.

        virtual bool AddExtendedListMode (char modechar)
         Adds an extended mode letter which is parsed by a module and handled in a list fashion.

        virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams)
         Adds a command to the command table.

        virtual void SendMode (char **parameters, int pcnt, userrec *user)
         Sends a servermode.

        virtual void SendToModeMask (std::string modes, int flags, std::string text)
         Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

        virtual chanrec * JoinUserToChannel (userrec *user, std::string cname, std::string key)
         Forces a user to join a channel.

        virtual chanrec * PartUserFromChannel (userrec *user, std::string cname, std::string reason)
         Forces a user to part a channel.

        virtual void ChangeUserNick (userrec *user, std::string nickname)
         Forces a user nickchange.

        virtual void QuitUser (userrec *user, std::string reason)
         Forces a user to quit with the specified reason.

        virtual bool MatchText (std::string sliteral, std::string spattern)
         Matches text against a glob pattern.

        virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user)
         Calls the handler for a command, either implemented by the core or by another module.

        virtual void ChangeHost (userrec *user, std::string host)
         Change displayed hostname of a user.

        virtual void ChangeGECOS (userrec *user, std::string gecos)
         Change GECOS (fullname) of a user.

        virtual bool IsUlined (std::string server)
         Returns true if the servername you give is ulined.

        virtual chanuserlist GetUsers (chanrec *chan)
         Fetches the userlist of a channel.

         Server ()
         Default constructor.

        virtual ~Server ()
         Default destructor.

        virtual void SendOpers (std::string s)
         Sends text to all opers.

        virtual void Log (int level, std::string s)
         Writes a log string.

        virtual void Send (int Socket, std::string s)
         Sends a line of text down a TCP/IP socket.

        virtual void SendServ (int Socket, std::string s)
         Sends text from the server to a socket.

        virtual void SendFrom (int Socket, userrec *User, std::string s)
         Sends text from a user to a socket.

        virtual void SendTo (userrec *Source, userrec *Dest, std::string s)
         Sends text from a user to another user.

        virtual void SendChannel (userrec *User, chanrec *Channel, std::string s, bool IncludeSender)
         Sends text from a user to a channel (mulicast).

        virtual bool CommonChannels (userrec *u1, userrec *u2)
         Returns true if two users share a common channel.

        virtual void SendCommon (userrec *User, std::string text, bool IncludeSender)
         Sends text from a user to one or more channels (mulicast).

        virtual void SendWallops (userrec *User, std::string text)
         Sends a WALLOPS message.

        virtual bool IsNick (std::string nick)
         Returns true if a nick is valid.

        virtual int CountUsers (chanrec *c)
         Returns a count of the number of users on a channel.

        virtual userrec * FindNick (std::string nick)
         Attempts to look up a nick and return a pointer to it.

        virtual chanrec * FindChannel (std::string channel)
         Attempts to look up a channel and return a pointer to it.

        virtual std::string ChanMode (userrec *User, chanrec *Chan)
         Attempts to look up a user's privilages on a channel.

        virtual bool IsOnChannel (userrec *User, chanrec *Chan)
         Checks if a user is on a channel.

        virtual std::string GetServerName ()
         Returns the server name of the server where the module is loaded.

        virtual std::string GetNetworkName ()
         Returns the network name, global to all linked servers.

        virtual Admin GetAdmin ()
         Returns the information of the server as returned by the /ADMIN command.

        virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
         Adds an extended mode letter which is parsed by a module.

        virtual bool AddExtendedListMode (char modechar)
         Adds an extended mode letter which is parsed by a module and handled in a list fashion.

        virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams)
         Adds a command to the command table.

        virtual void SendMode (char **parameters, int pcnt, userrec *user)
         Sends a servermode.

        virtual void SendToModeMask (std::string modes, int flags, std::string text)
         Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

        virtual chanrec * JoinUserToChannel (userrec *user, std::string cname, std::string key)
         Forces a user to join a channel.

        virtual chanrec * PartUserFromChannel (userrec *user, std::string cname, std::string reason)
         Forces a user to part a channel.

        virtual void ChangeUserNick (userrec *user, std::string nickname)
         Forces a user nickchange.

        virtual void QuitUser (userrec *user, std::string reason)
         Forces a user to quit with the specified reason.

        virtual bool MatchText (std::string sliteral, std::string spattern)
         Matches text against a glob pattern.

        virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user)
         Calls the handler for a command, either implemented by the core or by another module.

        virtual void ChangeHost (userrec *user, std::string host)
         Change displayed hostname of a user.

        virtual void ChangeGECOS (userrec *user, std::string gecos)
         Change GECOS (fullname) of a user.

        virtual bool IsUlined (std::string server)
         Returns true if the servername you give is ulined.

        virtual chanuserlist GetUsers (chanrec *chan)
         Fetches the userlist of a channel.

        Detailed Description

        -Allows 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. +Allows 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.

        All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.

        -Definition at line 314 of file modules.h.

        Constructor & Destructor Documentation

        +Definition at line 337 of file modules.h.

        Constructor & Destructor Documentation

        - +
        -
        + - - + + @@ -128,27 +157,27 @@ Definition at line 314 of
        Server::Server (   )   ) 

        -Default constructor. +Default constructor.

        Creates a Server object.

        -Definition at line 313 of file modules.cpp. +Definition at line 326 of file modules.cpp.

        -

        00314 {
-00315 }
+
        00327 {
+00328 }

        - +
        -
        + - + - - + + @@ -164,46 +193,46 @@ Definition at line 313
        Server::~Server Server::~Server (   )   )  [virtual]

        -Default destructor. +Default destructor.

        Destroys a Server object.

        -Definition at line 317 of file modules.cpp. +Definition at line 330 of file modules.cpp.

        -

        00318 {
-00319 }
+
        00331 {
+00332 }

        Member Function Documentation

        - +
        -
        + - + - + - + - + @@ -223,33 +252,33 @@ Definition at line 317
        void Server::AddCommand (  char *   cmd, cmd,
        handlerfunc   f, f,
        char   flags, flags,
        int   minparams minparams

        -Adds a command to the command table. +Adds a command to the command table.

        This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:

        typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

        When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.

        -Definition at line 394 of file modules.cpp. +Definition at line 407 of file modules.cpp.

        References createcommand().

        -

        00395 {
-00396         createcommand(cmd,f,flags,minparams);
-00397 }
+
        00408 {
+00409         createcommand(cmd,f,flags,minparams);
+00410 }

        - +
        -
        + - - + + @@ -265,7 +294,7 @@ References createcommand().
        bool Server::AddExtendedListMode (  char   modechar )  modechar  )  [virtual]

        -Adds an extended mode letter which is parsed by a module and handled in a list fashion. +Adds an extended mode letter which is parsed by a module and handled in a list fashion.

        This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:

        (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL

        @@ -274,53 +303,53 @@ This call is used to implement modes like +q and +a. The characteristics of thes (4) The mode and its parameter are NOT stored in the channels modes structure

        It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.

        -Definition at line 539 of file modules.cpp. +Definition at line 552 of file modules.cpp.

        -References DoAddExtendedMode(), and ModeMakeList(). +References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.

        -

        00540 {
-00541         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00542         if (res)
-00543                 ModeMakeList(modechar);
-00544         return res;
-00545 }
+
        00553 {
+00554         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00555         if (res)
+00556                 ModeMakeList(modechar);
+00557         return res;
+00558 }

        - +
        -
        + - + - + - + - + - + @@ -340,63 +369,63 @@ References DoAddExtendedMod
        bool Server::AddExtendedMode (  char   modechar, modechar,
        int   type, type,
        bool   requires_oper, requires_oper,
        int   params_when_on, params_when_on,
        int   params_when_off params_when_off

        -Adds an extended mode letter which is parsed by a module. +Adds an extended mode letter which is parsed by a module.

        This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.

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

        -References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. -

        -

        00520 {
-00521         if (type == MT_SERVER)
-00522         {
-00523                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00524                 return false;
-00525         }
-00526         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00527         {
-00528                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00529                 return false;
-00530         }
-00531         if ((params_when_on>1) || (params_when_off>1))
-00532         {
-00533                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00534                 return false;
-00535         }
-00536         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00537 }
+Definition at line 532 of file modules.cpp.
+
        
+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+
        
+
        00533 {
+00534         if (type == MT_SERVER)
+00535         {
+00536                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00537                 return false;
+00538         }
+00539         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00540         {
+00541                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00542                 return false;
+00543         }
+00544         if ((params_when_on>1) || (params_when_off>1))
+00545         {
+00546                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00547                 return false;
+00548         }
+00549         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00550 }

        - +
        -
        + - + - + - + - + @@ -416,35 +445,35 @@ References DoAddExtendedMod
        void Server::CallCommandHandler (  std::string   commandname, commandname,
        char **   parameters, parameters,
        int   pcnt, pcnt,
        userrec *   user user

        -Calls the handler for a command, either implemented by the core or by another module. +Calls the handler for a command, either implemented by the core or by another module.

        You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or
        ) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.

        -Definition at line 384 of file modules.cpp. +Definition at line 397 of file modules.cpp.

        -

        00385 {
-00386         call_handler(commandname.c_str(),parameters,pcnt,user);
-00387 }
+
        00398 {
+00399         call_handler(commandname.c_str(),parameters,pcnt,user);
+00400 }

        - +
        -
        + - + - + @@ -464,36 +493,36 @@ Definition at line 384
        void Server::ChangeGECOS (  userrec *   user, user,
        std::string   gecos gecos

        -Change GECOS (fullname) of a user. +Change GECOS (fullname) of a user.

        You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.

        -Definition at line 472 of file modules.cpp. +Definition at line 485 of file modules.cpp.

        References ChangeName().

        -

        00473 {
-00474         ChangeName(user,gecos.c_str());
-00475 }
+
        00486 {
+00487         ChangeName(user,gecos.c_str());
+00488 }

        - +
        -
        + - + - + @@ -513,36 +542,36 @@ References ChangeName().
        void Server::ChangeHost (  userrec *   user, user,
        std::string   host host

        -Change displayed hostname of a user. +Change displayed hostname of a user.

        You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.

        -Definition at line 467 of file modules.cpp. +Definition at line 480 of file modules.cpp.

        References ChangeDisplayedHost().

        -

        00468 {
-00469         ChangeDisplayedHost(user,host.c_str());
-00470 }
+
        00481 {
+00482         ChangeDisplayedHost(user,host.c_str());
+00483 }

        - +
        -
        + - + - + @@ -562,34 +591,34 @@ References ChangeDisplayedHost().
        void Server::ChangeUserNick (  userrec *   user, user,
        std::string   nickname nickname

        -Forces a user nickchange. +Forces a user nickchange.

        This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.

        -Definition at line 368 of file modules.cpp. +Definition at line 381 of file modules.cpp.

        -

        00369 {
-00370         force_nickchange(user,nickname.c_str());
-00371 }
+
        00382 {
+00383         force_nickchange(user,nickname.c_str());
+00384 }

        - +
        -
        + - + - + @@ -609,36 +638,36 @@ Definition at line 368
        std::string Server::ChanMode (  userrec *   User, User,
        chanrec *   Chan Chan

        -Attempts to look up a user's privilages on a channel. +Attempts to look up a user's privilages on a channel.

        This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.

        -Definition at line 492 of file modules.cpp. +Definition at line 505 of file modules.cpp.

        References cmode().

        -

        00493 {
-00494         return cmode(User,Chan);
-00495 }
+
        00506 {
+00507         return cmode(User,Chan);
+00508 }

        - +
        -
        + - + - + @@ -658,31 +687,31 @@ References cmode().
        bool Server::CommonChannels (  userrec *   u1, u1,
        userrec *   u2 u2

        -Returns true if two users share a common channel. +Returns true if two users share a common channel.

        This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.

        -Definition at line 445 of file modules.cpp. +Definition at line 458 of file modules.cpp.

        References common_channels().

        -

        00446 {
-00447         return (common_channels(u1,u2) != 0);
-00448 }
+
        00459 {
+00460         return (common_channels(u1,u2) != 0);
+00461 }

        - +
        -
        + - - + + @@ -698,29 +727,29 @@ References common_channels().
        int Server::CountUsers (  chanrec *   c )  c  )  [virtual]

        -Returns a count of the number of users on a channel. +Returns a count of the number of users on a channel.

        This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.

        -Definition at line 547 of file modules.cpp. +Definition at line 560 of file modules.cpp.

        -

        00548 {
-00549         return usercount(c);
-00550 }
+
        00561 {
+00562         return usercount(c);
+00563 }

        - +
        -
        + - - + + @@ -736,29 +765,29 @@ Definition at line 547
        chanrec * Server::FindChannel (  std::string   channel )  channel  )  [virtual]

        -Attempts to look up a channel and return a pointer to it. +Attempts to look up a channel and return a pointer to it.

        This function will return NULL if the channel does not exist.

        -Definition at line 487 of file modules.cpp. +Definition at line 500 of file modules.cpp.

        -

        00488 {
-00489         return FindChan(channel.c_str());
-00490 }
+
        00501 {
+00502         return FindChan(channel.c_str());
+00503 }

        - +
        -
        + - - + + @@ -774,28 +803,28 @@ Definition at line 487
        userrec * Server::FindNick (  std::string   nick )  nick  )  [virtual]

        -Attempts to look up a nick and return a pointer to it. +Attempts to look up a nick and return a pointer to it.

        This function will return NULL if the nick does not exist.

        -Definition at line 482 of file modules.cpp. +Definition at line 495 of file modules.cpp.

        -

        00483 {
-00484         return Find(nick);
-00485 }
+
        00496 {
+00497         return Find(nick);
+00498 }

        - +
        -
        + - - + + @@ -811,28 +840,28 @@ Definition at line 482
        Admin Server::GetAdmin (   )   )  [virtual]

        -Returns the information of the server as returned by the /ADMIN command. +Returns the information of the server as returned by the /ADMIN command.

        -See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded. +See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.

        -Definition at line 512 of file modules.cpp. +Definition at line 525 of file modules.cpp.

        -

        00513 {
-00514         return Admin(getadminname(),getadminemail(),getadminnick());
-00515 }
+
        00526 {
+00527         return Admin(getadminname(),getadminemail(),getadminnick());
+00528 }

        - +
        -
        + - - + + @@ -848,28 +877,28 @@ Definition at line 512
        std::string Server::GetNetworkName (   )   )  [virtual]

        -Returns the network name, global to all linked servers. +Returns the network name, global to all linked servers.

        -Definition at line 507 of file modules.cpp. +Definition at line 520 of file modules.cpp.

        -

        00508 {
-00509         return getnetworkname();
-00510 }
+
        00521 {
+00522         return getnetworkname();
+00523 }

        - +
        -
        + - - + + @@ -885,29 +914,29 @@ Definition at line 507
        std::string Server::GetServerName (   )   )  [virtual]

        -Returns the server name of the server where the module is loaded. +Returns the server name of the server where the module is loaded.

        -Definition at line 502 of file modules.cpp. +Definition at line 515 of file modules.cpp.

        -

        00503 {
-00504         return getservername();
-00505 }
+
        00516 {
+00517         return getservername();
+00518 }

        - +
        -
        + - - + + @@ -923,46 +952,46 @@ Definition at line 502
        chanuserlist Server::GetUsers (  chanrec *   chan )  chan  )  [virtual]

        -Fetches the userlist of a channel. +Fetches the userlist of a channel.

        This function must be here and not a member of userrec or chanrec due to include constraints.

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

        -References chanuserlist, clientlist, has_channel(), and isnick(). -

        -

        00350 {
-00351         chanuserlist userl;
-00352         userl.clear();
-00353         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00354         {
-00355                 if (i->second)
-00356                 {
-00357                         if (has_channel(i->second,chan))
-00358                         {
-00359                                 if (isnick(i->second->nick))
-00360                                 {
-00361                                         userl.push_back(i->second);
-00362                                 }
-00363                         }
-00364                 }
-00365         }
-00366         return userl;
-00367 }
+Definition at line 362 of file modules.cpp.
+
        
+References chanuserlist, clientlist, has_channel(), and isnick().
+
        
+
        00363 {
+00364         chanuserlist userl;
+00365         userl.clear();
+00366         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+00367         {
+00368                 if (i->second)
+00369                 {
+00370                         if (has_channel(i->second,chan))
+00371                         {
+00372                                 if (isnick(i->second->nick))
+00373                                 {
+00374                                         userl.push_back(i->second);
+00375                                 }
+00376                         }
+00377                 }
+00378         }
+00379         return userl;
+00380 }

        - +
        -
        + - - + + @@ -978,36 +1007,36 @@ References chanuserlist,
        bool Server::IsNick (  std::string   nick )  nick  )  [virtual]

        -Returns true if a nick is valid. +Returns true if a nick is valid.

        Nicks for unregistered connections will return false.

        -Definition at line 477 of file modules.cpp. +Definition at line 490 of file modules.cpp.

        References isnick().

        -

        00478 {
-00479         return (isnick(nick.c_str()) != 0);
-00480 }
+
        00491 {
+00492         return (isnick(nick.c_str()) != 0);
+00493 }

        - +
        -
        + - + - + @@ -1027,31 +1056,31 @@ References isnick().
        bool Server::IsOnChannel (  userrec *   User, User,
        chanrec *   Chan Chan

        -Checks if a user is on a channel. +Checks if a user is on a channel.

        This function will return true or false to indicate if user 'User' is on channel 'Chan'.

        -Definition at line 497 of file modules.cpp. +Definition at line 510 of file modules.cpp.

        References has_channel().

        -

        00498 {
-00499         return has_channel(User,Chan);
-00500 }
+
        00511 {
+00512         return has_channel(User,Chan);
+00513 }

        - +
        -
        + - - + + @@ -1067,42 +1096,42 @@ References has_channel().
        bool Server::IsUlined (  std::string   server )  server  )  [virtual]

        -Returns true if the servername you give is ulined. +Returns true if the servername you give is ulined.

        ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.

        -Definition at line 379 of file modules.cpp. +Definition at line 392 of file modules.cpp.

        References is_uline().

        -

        00380 {
-00381         return is_uline(server.c_str());
-00382 }
+
        00393 {
+00394         return is_uline(server.c_str());
+00395 }

        - +
        -
        + - + - + - + @@ -1122,34 +1151,34 @@ References is_uline().
        chanrec * Server::JoinUserToChannel (  userrec *   user, user,
        std::string   cname, cname,
        std::string   key key

        -Forces a user to join a channel. +Forces a user to join a channel.

        This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.

        -Definition at line 339 of file modules.cpp. +Definition at line 352 of file modules.cpp.

        -

        00340 {
-00341         return add_channel(user,cname.c_str(),key.c_str(),true);
-00342 }
+
        00353 {
+00354         return add_channel(user,cname.c_str(),key.c_str(),true);
+00355 }

        - +
        -
        + - + - + @@ -1169,34 +1198,34 @@ Definition at line 339
        void Server::Log (  int   level, level,
        std::string   s s

        -Writes a log string. +Writes a log string.

        This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.

        -Definition at line 389 of file modules.cpp. +Definition at line 402 of file modules.cpp.

        -

        00390 {
-00391         log(level,"%s",s.c_str());
-00392 }
+
        00403 {
+00404         log(level,"%s",s.c_str());
+00405 }

        - +
        -
        + - + - + @@ -1216,43 +1245,43 @@ Definition at line 389
        bool Server::MatchText (  std::string   sliteral, sliteral,
        std::string   spattern spattern

        -Matches text against a glob pattern. +Matches text against a glob pattern.

        Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.

        -Definition at line 326 of file modules.cpp. +Definition at line 339 of file modules.cpp.

        -

        00327 {
-00328         char literal[MAXBUF],pattern[MAXBUF];
-00329         strncpy(literal,sliteral.c_str(),MAXBUF);
-00330         strncpy(pattern,spattern.c_str(),MAXBUF);
-00331         return match(literal,pattern);
-00332 }
+
        00340 {
+00341         char literal[MAXBUF],pattern[MAXBUF];
+00342         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00343         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00344         return match(literal,pattern);
+00345 }

        - +
        -
        + - + - + - + @@ -1272,34 +1301,34 @@ Definition at line 326
        chanrec * Server::PartUserFromChannel (  userrec *   user, user,
        std::string   cname, cname,
        std::string   reason reason

        -Forces a user to part a channel. +Forces a user to part a channel.

        This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.

        -Definition at line 344 of file modules.cpp. +Definition at line 357 of file modules.cpp.

        -

        00345 {
-00346         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00347 }
+
        00358 {
+00359         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00360 }

        - +
        -
        + - + - + @@ -1319,39 +1348,39 @@ Definition at line 344
        void Server::QuitUser (  userrec *   user, user,
        std::string   reason reason

        -Forces a user to quit with the specified reason. +Forces a user to quit with the specified reason.

        To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.

        WARNING!

        Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.

        -Definition at line 373 of file modules.cpp. +Definition at line 386 of file modules.cpp.

        -References userrec::nick, and send_network_quit(). +References userrec::nick, and send_network_quit().

        -

        00374 {
-00375         send_network_quit(user->nick,reason.c_str());
-00376         kill_link(user,reason.c_str());
-00377 }
+
        00387 {
+00388         send_network_quit(user->nick,reason.c_str());
+00389         kill_link(user,reason.c_str());
+00390 }

        - +
        -
        + - + - + @@ -1371,46 +1400,46 @@ References userrec::nick, a
        void Server::Send (  int   Socket, Socket,
        std::string   s s

        -Sends a line of text down a TCP/IP socket. +Sends a line of text down a TCP/IP socket.

        This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.

        -Definition at line 404 of file modules.cpp. +Definition at line 417 of file modules.cpp.

        -

        00405 {
-00406         Write(Socket,"%s",s.c_str());
-00407 }
+
        00418 {
+00419         Write(Socket,"%s",s.c_str());
+00420 }

        - +
        -
        + - + - + - + - + @@ -1430,47 +1459,47 @@ Definition at line 404
        void Server::SendChannel (  userrec *   User, User,
        chanrec *   Channel, Channel,
        std::string   s, s,
        bool   IncludeSender IncludeSender

        -Sends text from a user to a channel (mulicast). +Sends text from a user to a channel (mulicast).

        This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).

        -Definition at line 433 of file modules.cpp. +Definition at line 446 of file modules.cpp.

        -

        00434 {
-00435         if (IncludeSender)
-00436         {
-00437                 WriteChannel(Channel,User,"%s",s.c_str());
-00438         }
-00439         else
-00440         {
-00441                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00442         }
-00443 }
+
        00447 {
+00448         if (IncludeSender)
+00449         {
+00450                 WriteChannel(Channel,User,"%s",s.c_str());
+00451         }
+00452         else
+00453         {
+00454                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00455         }
+00456 }

        - +
        -
        + - + - + - + @@ -1490,47 +1519,47 @@ Definition at line 433
        void Server::SendCommon (  userrec *   User, User,
        std::string   text, text,
        bool   IncludeSender IncludeSender

        -Sends text from a user to one or more channels (mulicast). +Sends text from a user to one or more channels (mulicast).

        This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.

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

        -

        00451 {
-00452         if (IncludeSender)
-00453         {
-00454                 WriteCommon(User,"%s",text.c_str());
-00455         }
-00456         else
-00457         {
-00458                 WriteCommonExcept(User,"%s",text.c_str());
-00459         }
-00460 }
+Definition at line 463 of file modules.cpp.
+
        
+
        00464 {
+00465         if (IncludeSender)
+00466         {
+00467                 WriteCommon(User,"%s",text.c_str());
+00468         }
+00469         else
+00470         {
+00471                 WriteCommonExcept(User,"%s",text.c_str());
+00472         }
+00473 }

        - +
        -
        + - + - + - + @@ -1550,40 +1579,40 @@ Definition at line 450
        void Server::SendFrom (  int   Socket, Socket,
        userrec *   User, User,
        std::string   s s

        -Sends text from a user to a socket. +Sends text from a user to a socket.

        This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)

        -Definition at line 414 of file modules.cpp. +Definition at line 427 of file modules.cpp.

        -

        00415 {
-00416         WriteFrom(Socket,User,"%s",s.c_str());
-00417 }
+
        00428 {
+00429         WriteFrom(Socket,User,"%s",s.c_str());
+00430 }

        - +
        -
        + - + - + - + @@ -1603,7 +1632,7 @@ Definition at line 414
        void Server::SendMode (  char **   parameters, parameters,
        int   pcnt, pcnt,
        userrec *   user user

        -Sends a servermode. +Sends a servermode.

        you must format the parameters array with the target, modes and parameters for those modes.

        For example:

        @@ -1614,27 +1643,27 @@ modes[2] = user->nick;

        Srv->SendMode(modes,3,user);

        The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!

        -Definition at line 399 of file modules.cpp. +Definition at line 412 of file modules.cpp.

        References server_mode().

        -

        00400 {
-00401         server_mode(parameters,pcnt,user);
-00402 }
+
        00413 {
+00414         server_mode(parameters,pcnt,user);
+00415 }

        - +
        -
        + - - + + @@ -1650,34 +1679,34 @@ References server_mode().
        void Server::SendOpers (  std::string   s )  s  )  [virtual]

        -Sends text to all opers. +Sends text to all opers.

        This method sends a server notice to all opers with the usermode +s.

        -Definition at line 321 of file modules.cpp. +Definition at line 334 of file modules.cpp.

        -

        00322 {
-00323         WriteOpers("%s",s.c_str());
-00324 }
+
        00335 {
+00336         WriteOpers("%s",s.c_str());
+00337 }

        - +
        -
        + - + - + @@ -1697,40 +1726,40 @@ Definition at line 321
        void Server::SendServ (  int   Socket, Socket,
        std::string   s s

        -Sends text from the server to a socket. +Sends text from the server to a socket.

        This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)

        -Definition at line 409 of file modules.cpp. +Definition at line 422 of file modules.cpp.

        -

        00410 {
-00411         WriteServ(Socket,"%s",s.c_str());
-00412 }
+
        00423 {
+00424         WriteServ(Socket,"%s",s.c_str());
+00425 }

        - +
        -
        + - + - + - + @@ -1750,7 +1779,7 @@ Definition at line 409
        void Server::SendTo (  userrec *   Source, Source,
        userrec *   Dest, Dest,
        std::string   s s

        -Sends text from a user to another user. +Sends text from a user to another user.

        This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:

        :user!ident TEXT

        @@ -1758,47 +1787,47 @@ The format will become:

        :localserver TEXT

        Which is useful for numerics and server notices to single users, etc.

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

        -References connection::fd. -

        -

        00420 {
-00421         if (!Source)
-00422         {
-00423                 // if source is NULL, then the message originates from the local server
-00424                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00425         }
-00426         else
-00427         {
-00428                 // otherwise it comes from the user specified
-00429                 WriteTo(Source,Dest,"%s",s.c_str());
-00430         }
-00431 }
+Definition at line 432 of file modules.cpp.
+
        
+References connection::fd.
+
        
+
        00433 {
+00434         if (!Source)
+00435         {
+00436                 // if source is NULL, then the message originates from the local server
+00437                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00438         }
+00439         else
+00440         {
+00441                 // otherwise it comes from the user specified
+00442                 WriteTo(Source,Dest,"%s",s.c_str());
+00443         }
+00444 }

        - +
        -
        + - + - + - + @@ -1818,36 +1847,36 @@ References connection::fd<
        void Server::SendToModeMask (  std::string   modes, modes,
        int   flags, flags,
        std::string   text text

        -Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. +Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

        These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:

        Serv->SendToModeMask("xi", WM_OR, "m00");

        Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.

        -Definition at line 334 of file modules.cpp. +Definition at line 347 of file modules.cpp.

        -

        00335 {
-00336         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00337 }
+
        00348 {
+00349         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00350 }

        - +
        -
        + - + - + @@ -1867,23 +1896,23 @@ Definition at line 334
        void Server::SendWallops (  userrec *   User, User,
        std::string   text text

        -Sends a WALLOPS message. +Sends a WALLOPS message.

        This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.

        -Definition at line 462 of file modules.cpp. +Definition at line 475 of file modules.cpp.

        -

        00463 {
-00464         WriteWallOps(User,false,"%s",text.c_str());
-00465 }
+
        00476 {
+00477         WriteWallOps(User,false,"%s",text.c_str());
+00478 }
        The documentation for this class was generated from the following files: -
        Generated on Sun May 2 00:09:43 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classVersion-members.html b/docs/module-doc/classVersion-members.html index 5295c5b3a..c0a434dd8 100644 --- a/docs/module-doc/classVersion-members.html +++ b/docs/module-doc/classVersion-members.html @@ -1,23 +1,22 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Version Member List

        This is the complete list of members for Version, including all inherited members. - - - - - - - - -
        ageclassbase
        BuildVersion
        classbase()classbase [inline]
        MajorVersion
        MinorVersion
        RevisionVersion
        Version(int major, int minor, int revision, int build)Version
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:46 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Version Member List

        This is the complete list of members for Version, including all inherited members. + + + + + + + + +
        ageclassbase
        BuildVersion
        classbase()classbase [inline]
        MajorVersion
        MinorVersion
        RevisionVersion
        Version(int major, int minor, int revision, int build)Version
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classVersion.html b/docs/module-doc/classVersion.html index 01018e328..b3209d65e 100644 --- a/docs/module-doc/classVersion.html +++ b/docs/module-doc/classVersion.html @@ -1,70 +1,68 @@ -Version class Reference +InspIRCd: Version class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        Version Class Reference

        Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        Version Class Reference

        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...

        #include <modules.h>

        -Inheritance diagram for Version:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for Version:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

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

        Public Member Functions

         Version (int major, int minor, int revision, int build)
         Version (int major, int minor, int revision, int build)

        Public Attributes

        const int Major
        const int Minor
        const int Revision
        const int Build
        const int Major
        const int Minor
        const int Revision
        const int Build

        Detailed Description

        -Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. +Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module.

        A class of type Version is returned by the GetVersion method of the Module class.

        -Definition at line 92 of file modules.h.

        Constructor & Destructor Documentation

        +Definition at line 102 of file modules.h.

        Constructor & Destructor Documentation

        - +
        -
        + - + - + - + - + @@ -86,20 +84,20 @@ Definition at line 92 of

        -Definition at line 279 of file modules.cpp. +Definition at line 291 of file modules.cpp.

        -

        00279 : Major(major), Minor(minor), Revision(revision), Build(build) { };
+
        00291 : Major(major), Minor(minor), Revision(revision), Build(build) { };
        Version::Version (  int   major, major,
        int   minor, minor,
        int   revision, revision,
        int   build build

        Member Data Documentation

        -

        - +

        +

        - @@ -114,16 +112,16 @@ Definition at line 279

        -Definition at line 95 of file modules.h. +Definition at line 105 of file modules.h.

        + -
        const int Version::Build + const int Version::Build
        -

        - +

        +

        - @@ -138,16 +136,16 @@ Definition at line 95 of

        -Definition at line 95 of file modules.h. +Definition at line 105 of file modules.h.

        + -
        const int Version::Major + const int Version::Major
        -

        - +

        +

        - @@ -162,16 +160,16 @@ Definition at line 95 of

        -Definition at line 95 of file modules.h. +Definition at line 105 of file modules.h.

        + -
        const int Version::Minor + const int Version::Minor
        -

        - +

        +

        - @@ -186,14 +184,14 @@ Definition at line 95 of

        -Definition at line 95 of file modules.h. +Definition at line 105 of file modules.h.

        + -
        const int Version::Revision + const int Version::Revision

        The documentation for this class was generated from the following files: -
        Generated on Sun May 2 00:09:46 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classXLine-members.html b/docs/module-doc/classXLine-members.html index 527a77f8e..36c7eaf27 100644 --- a/docs/module-doc/classXLine-members.html +++ b/docs/module-doc/classXLine-members.html @@ -1,23 +1,22 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        XLine Member List

        This is the complete list of members for XLine, including all inherited members. - - - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        n_matchesXLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:46 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        XLine Member List

        This is the complete list of members for XLine, including all inherited members. + + + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        n_matchesXLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classXLine.html b/docs/module-doc/classXLine.html index ea9f00bad..e1e354cd8 100644 --- a/docs/module-doc/classXLine.html +++ b/docs/module-doc/classXLine.html @@ -1,55 +1,51 @@ -XLine class Reference +InspIRCd: XLine class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        XLine Class Reference

        XLine is the base class for ban lines such as G lines and K lines. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        XLine Class Reference

        XLine is the base class for ban lines such as G lines and K lines. More...

        #include <xline.h>

        -Inheritance diagram for XLine:

        Inheritance graph
        - - - - - - - -
        [legend]
        Collaboration diagram for XLine:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +Inherited by GLine, KLine, QLine, and ZLine. +

        +List of all members.

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

        Public Attributes

        time_t set_time
         The time the line was added.

        long duration
         The duration of the ban, or 0 if permenant.

        char source [MAXBUF]
         Source of the ban.

        char reason [MAXBUF]
         Reason for the ban.

        long n_matches
         Number of times the core matches the ban, for statistics.

        time_t set_time
         The time the line was added.

        long duration
         The duration of the ban, or 0 if permenant.

        char source [MAXBUF]
         Source of the ban.

        char reason [MAXBUF]
         Reason for the ban.

        long n_matches
         Number of times the core matches the ban, for statistics.

        Detailed Description

        -XLine is the base class for ban lines such as G lines and K lines. +XLine is the base class for ban lines such as G lines and K lines.

        -Definition at line 18 of file xline.h.

        Member Data Documentation

        -

        - +Definition at line 34 of file xline.h.

        Member Data Documentation

        +

        +

        - @@ -62,20 +58,20 @@ Definition at line 18 of fi +Definition at line 44 of file xline.h.
        + -
        long XLine::duration + long XLine::duration

        -The duration of the ban, or 0 if permenant. +The duration of the ban, or 0 if permenant.

        -Definition at line 28 of file xline.h.

        -

        - +

        +

        - @@ -88,20 +84,20 @@ Definition at line 28 of fi +Definition at line 56 of file xline.h.
        + -
        long XLine::n_matches + long XLine::n_matches

        -Number of times the core matches the ban, for statistics. +Number of times the core matches the ban, for statistics.

        -Definition at line 40 of file xline.h.

        -

        - +

        +

        - @@ -114,20 +110,20 @@ Definition at line 40 of fi +Definition at line 52 of file xline.h.
        + -
        char XLine::reason[MAXBUF] + char XLine::reason[MAXBUF]

        -Reason for the ban. +Reason for the ban.

        -Definition at line 36 of file xline.h.

        -

        - +

        +

        - @@ -140,20 +136,20 @@ Definition at line 36 of fi +Definition at line 40 of file xline.h.
        + -
        time_t XLine::set_time + time_t XLine::set_time

        -The time the line was added. +The time the line was added.

        -Definition at line 24 of file xline.h.

        -

        - +

        +

        - @@ -166,18 +162,18 @@ Definition at line 24 of fi +Definition at line 48 of file xline.h.
        + -
        char XLine::source[MAXBUF] + char XLine::source[MAXBUF]

        -Source of the ban. +Source of the ban.

        This can be a servername or an oper nickname

        -Definition at line 32 of file xline.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:46 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classZLine-members.html b/docs/module-doc/classZLine-members.html index 54c67ffe7..8aed6b908 100644 --- a/docs/module-doc/classZLine-members.html +++ b/docs/module-doc/classZLine-members.html @@ -1,25 +1,24 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ZLine Member List

        This is the complete list of members for ZLine, including all inherited members. - - - - - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        ipaddrZLine
        is_globalZLine
        n_matchesXLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:47 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ZLine Member List

        This is the complete list of members for ZLine, including all inherited members. + + + + + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        durationXLine
        ipaddrZLine
        is_globalZLine
        n_matchesXLine
        reasonXLine
        set_timeXLine
        sourceXLine
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classZLine.html b/docs/module-doc/classZLine.html index 48c52f37a..0ae5bb4cd 100644 --- a/docs/module-doc/classZLine.html +++ b/docs/module-doc/classZLine.html @@ -1,47 +1,40 @@ -ZLine class Reference +InspIRCd: ZLine class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ZLine Class Reference

        ZLine class. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ZLine Class Reference

        ZLine class. More...

        #include <xline.h>

        -Inheritance diagram for ZLine:

        Inheritance graph
        - - - - -
        [legend]
        Collaboration diagram for ZLine:

        Collaboration graph
        - - - - -
        [legend]
        List of all members. +Inherits XLine. +

        +List of all members.

        - - - - + + + + + +

        Public Attributes

        char ipaddr [MAXBUF]
         IP Address (xx.yy.zz.aa) to match against May contain wildcards.

        bool is_global
         Set if this is a global Z:line (e.g.

        char ipaddr [MAXBUF]
         IP Address (xx.yy.zz.aa) to match against May contain wildcards.

        bool is_global
         Set if this is a global Z:line (e.g.

        Detailed Description

        -ZLine class. +ZLine class.

        -Definition at line 68 of file xline.h.

        Member Data Documentation

        -

        - +Definition at line 84 of file xline.h.

        Member Data Documentation

        +

        +

        - @@ -54,20 +47,20 @@ Definition at line 68 of fi +Definition at line 90 of file xline.h.
        + -
        char ZLine::ipaddr[MAXBUF] + char ZLine::ipaddr[MAXBUF]

        -IP Address (xx.yy.zz.aa) to match against May contain wildcards. +IP Address (xx.yy.zz.aa) to match against May contain wildcards.

        -Definition at line 74 of file xline.h.

        -

        - +

        +

        - @@ -80,18 +73,18 @@ Definition at line 74 of fi +Definition at line 94 of file xline.h.
        + -
        bool ZLine::is_global + bool ZLine::is_global

        -Set if this is a global Z:line (e.g. +Set if this is a global Z:line (e.g.

        it came from another server)

        -Definition at line 78 of file xline.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classchanrec-members.html b/docs/module-doc/classchanrec-members.html index 558c9b3c6..9f1713a4b 100644 --- a/docs/module-doc/classchanrec-members.html +++ b/docs/module-doc/classchanrec-members.html @@ -1,42 +1,41 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        chanrec Member List

        This is the complete list of members for chanrec, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        ageclassbase
        banschanrec
        c_privatechanrec
        chanrec()chanrec
        classbase()classbase [inline]
        createdchanrec
        custom_modeschanrec
        Extend(std::string key, char *p)Extensible
        GetExt(std::string key)Extensible
        GetModeParameter(char mode)chanrec
        inviteonlychanrec
        IsCustomModeSet(char mode)chanrec
        keychanrec
        limitchanrec
        moderatedchanrec
        namechanrec
        noexternalchanrec
        secretchanrec
        setbychanrec
        SetCustomMode(char mode, bool mode_on)chanrec
        SetCustomModeParam(char mode, char *parameter, bool mode_on)chanrec
        Shrink(std::string key)Extensible
        topicchanrec
        topiclockchanrec
        topicsetchanrec
        ~chanrec()chanrec [inline, virtual]
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:31 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        chanrec Member List

        This is the complete list of members for chanrec, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ageclassbase
        banschanrec
        c_privatechanrec
        chanrec()chanrec
        classbase()classbase [inline]
        createdchanrec
        custom_modeschanrec
        Extend(std::string key, char *p)Extensible
        GetExt(std::string key)Extensible
        GetModeParameter(char mode)chanrec
        inviteonlychanrec
        IsCustomModeSet(char mode)chanrec
        keychanrec
        limitchanrec
        moderatedchanrec
        namechanrec
        noexternalchanrec
        secretchanrec
        setbychanrec
        SetCustomMode(char mode, bool mode_on)chanrec
        SetCustomModeParam(char mode, char *parameter, bool mode_on)chanrec
        Shrink(std::string key)Extensible
        topicchanrec
        topiclockchanrec
        topicsetchanrec
        ~chanrec()chanrec [inline, virtual]
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index 27763e5a6..c7c0a6a1b 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -1,90 +1,102 @@ -chanrec class Reference +InspIRCd: chanrec class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        chanrec Class Reference

        Holds all relevent information for a channel. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        chanrec Class Reference

        Holds all relevent information for a channel. More...

        #include <channels.h>

        -Inheritance diagram for chanrec:

        Inheritance graph
        - - - - -
        [legend]
        Collaboration diagram for chanrec:

        Collaboration graph
        - - - - -
        [legend]
        List of all members. +Inherits Extensible. +

        +List of all members.

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

        Public Member Functions

        void SetCustomMode (char mode, bool mode_on)
         Sets or unsets a custom mode in the channels info.

        void SetCustomModeParam (char mode, char *parameter, bool mode_on)
         Sets or unsets the parameters for a custom mode in a channels info.

        bool IsCustomModeSet (char mode)
         Returns true if a custom mode is set on a channel.

        std::string GetModeParameter (char mode)
         Returns the parameter for a custom mode on a channel.

         chanrec ()
         Creates a channel record and initialises it with default values.

        virtual ~chanrec ()
        void SetCustomMode (char mode, bool mode_on)
         Sets or unsets a custom mode in the channels info.

        void SetCustomModeParam (char mode, char *parameter, bool mode_on)
         Sets or unsets the parameters for a custom mode in a channels info.

        bool IsCustomModeSet (char mode)
         Returns true if a custom mode is set on a channel.

        std::string GetModeParameter (char mode)
         Returns the parameter for a custom mode on a channel.

         chanrec ()
         Creates a channel record and initialises it with default values.

        virtual ~chanrec ()

        Public Attributes

        char name [CHANMAX]
         The channels name.

        char custom_modes [MAXMODES]
         Custom modes for the channel.

        char topic [MAXBUF]
         Channel topic.

        time_t created
         Creation time.

        time_t topicset
         Time topic was set.

        char setby [NICKMAX]
         The last user to set the topic.

        long limit
         Contains the channel user limit.

        char key [32]
         Contains the channel key.

        short int topiclock
         Nonzero if the mode +t is set.

        short int noexternal
         Nonzero if the mode +n is set.

        short int inviteonly
         Nonzero if the mode +i is set.

        short int moderated
         Nonzero if the mode +m is set.

        short int secret
         Nonzero if the mode +s is set.

        short int c_private
         Nonzero if the mode +p is set.

        BanList bans
         The list of all bans set on the channel.

        char name [CHANMAX]
         The channels name.

        char custom_modes [MAXMODES]
         Custom modes for the channel.

        char topic [MAXBUF]
         Channel topic.

        time_t created
         Creation time.

        time_t topicset
         Time topic was set.

        char setby [NICKMAX]
         The last user to set the topic.

        long limit
         Contains the channel user limit.

        char key [32]
         Contains the channel key.

        short int topiclock
         Nonzero if the mode +t is set.

        short int noexternal
         Nonzero if the mode +n is set.

        short int inviteonly
         Nonzero if the mode +i is set.

        short int moderated
         Nonzero if the mode +m is set.

        short int secret
         Nonzero if the mode +s is set.

        short int c_private
         Nonzero if the mode +p is set.

        BanList bans
         The list of all bans set on the channel.

        Detailed Description

        -Holds all relevent information for a channel. +Holds all relevent information for a channel.

        This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.

        -Definition at line 83 of file channels.h.

        Constructor & Destructor Documentation

        +Definition at line 94 of file channels.h.

        Constructor & Destructor Documentation

        - +
        -
        + - - + + @@ -100,36 +112,36 @@ Definition at line 83 of
        chanrec::chanrec (   )   ) 

        -Creates a channel record and initialises it with default values. +Creates a channel record and initialises it with default values.

        -Definition at line 96 of file channels.cpp. +Definition at line 111 of file channels.cpp.

        -References c_private, created, inviteonly, limit, moderated, noexternal, secret, topiclock, and topicset. +References c_private, created, custom_modes, inviteonly, key, limit, moderated, name, noexternal, secret, setby, topic, topiclock, and topicset.

        -

        00097 {
-00098         strcpy(name,"");
-00099         strcpy(custom_modes,"");
-00100         strcpy(topic,"");
-00101         strcpy(setby,"");
-00102         strcpy(key,"");
-00103         created = topicset = limit = 0;
-00104         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
-00105 }
+
        00112 {
+00113         strcpy(name,"");
+00114         strcpy(custom_modes,"");
+00115         strcpy(topic,"");
+00116         strcpy(setby,"");
+00117         strcpy(key,"");
+00118         created = topicset = limit = 0;
+00119         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
+00120 }

        - +
        -
        + - + - - + + @@ -147,24 +159,24 @@ References c_private,

        -Definition at line 174 of file channels.h. +Definition at line 185 of file channels.h.

        -

        00174 { /* stub */ }
+
        00185 { /* stub */ }
        virtual chanrec::~chanrec virtual chanrec::~chanrec (   )   )  [inline, virtual]

        Member Function Documentation

        - +
        -
        + - - + + @@ -180,41 +192,41 @@ Definition at line 174 o
        std::string chanrec::GetModeParameter (  char   mode )  mode  ) 

        -Returns the parameter for a custom mode on a channel. +Returns the parameter for a custom mode on a channel.

        For example if "+L #foo" is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.

        -Definition at line 172 of file channels.cpp. -

        -References custom_mode_params. -

        -

        00173 {
-00174         if (custom_mode_params.size())
-00175         {
-00176                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00177                 {
-00178                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00179                         {
-00180                                 return std::string(i->parameter);
-00181                         }
-00182                 }
-00183         }
-00184         return std::string("");
-00185 }
+Definition at line 184 of file channels.cpp.
+
        
+References custom_mode_params.
+
        
+
        00185 {
+00186         if (custom_mode_params.size())
+00187         {
+00188                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00189                 {
+00190                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00191                         {
+00192                                 return std::string(i->parameter);
+00193                         }
+00194                 }
+00195         }
+00196         return std::string("");
+00197 }

        - +
        -
        + - - + + @@ -230,35 +242,37 @@ References custom_mode_par
        bool chanrec::IsCustomModeSet (  char   mode )  mode  ) 

        -Returns true if a custom mode is set on a channel. +Returns true if a custom mode is set on a channel.

        -Definition at line 166 of file channels.cpp. +Definition at line 178 of file channels.cpp. +

        +References DEBUG.

        -

        00167 {
-00168         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
-00169         return (strchr(this->custom_modes,mode) != 0);
-00170 }
+
        00179 {
+00180         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
+00181         return (strchr(this->custom_modes,mode) != 0);
+00182 }

        - +
        -
        + - + - + @@ -278,64 +292,61 @@ Definition at line 166
        void chanrec::SetCustomMode (  char   mode, mode,
        bool   mode_on mode_on

        -Sets or unsets a custom mode in the channels info. +Sets or unsets a custom mode in the channels info.

        -Definition at line 107 of file channels.cpp. +Definition at line 122 of file channels.cpp.

        -References custom_modes, and SetCustomModeParam(). +References custom_modes, DEBUG, and SetCustomModeParam().

        -

        00108 {
-00109         if (mode_on) {
-00110                 char m[3];
-00111                 m[0] = mode;
-00112                 m[1] = '\0';
-00113                 if (!strchr(this->custom_modes,mode))
-00114                 {
-00115                         strncat(custom_modes,m,MAXMODES);
-00116                 }
-00117                 log(DEBUG,"Custom mode %c set",mode);
-00118         }
-00119         else {
-00120                 char temp[MAXBUF];
-00121                 int count = 0;
-00122                 for (int q = 0; q < strlen(custom_modes); q++) {
-00123                         if (custom_modes[q] != mode) {
-00124                                 temp[count++] = mode;
-00125                         }
-00126                 }
-00127                 temp[count] = '\0';
-00128                 strncpy(custom_modes,temp,MAXMODES);
-00129                 log(DEBUG,"Custom mode %c removed",mode);
-00130                 this->SetCustomModeParam(mode,"",false);
-00131         }
-00132 }
+
        00123 {
+00124         if (mode_on) {
+00125                 char m[3];
+00126                 m[0] = mode;
+00127                 m[1] = '\0';
+00128                 if (!strchr(this->custom_modes,mode))
+00129                 {
+00130                         strlcat(custom_modes,m,MAXMODES);
+00131                 }
+00132                 log(DEBUG,"Custom mode %c set",mode);
+00133         }
+00134         else {
+00135 
+00136                 std::string a = this->custom_modes;
+00137                 int pos = a.find(mode);
+00138                 a.erase(pos,1);
+00139                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
+00140 
+00141                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
+00142                 this->SetCustomModeParam(mode,"",false);
+00143         }
+00144 }

        - +
        -
        + - + - + - + @@ -355,56 +366,56 @@ References custom_modes,
        void chanrec::SetCustomModeParam (  char   mode, mode,
        char *   parameter, parameter,
        bool   mode_on mode_on

        -Sets or unsets the parameters for a custom mode in a channels info. +Sets or unsets the parameters for a custom mode in a channels info.

        -Definition at line 135 of file channels.cpp. +Definition at line 147 of file channels.cpp.

        -References ModeParameter::channel, custom_mode_params, ModeParameter::mode, and ModeParameter::parameter. +References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.

        -Referenced by SetCustomMode(). +Referenced by SetCustomMode().

        -

        00136 {
-00137 
-00138         log(DEBUG,"SetCustomModeParam called");
-00139         ModeParameter M;
-00140         M.mode = mode;
-00141         strcpy(M.channel,this->name);
-00142         strcpy(M.parameter,parameter);
-00143         if (mode_on)
-00144         {
-00145                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
-00146                 custom_mode_params.push_back(M);
-00147         }
-00148         else
-00149         {
-00150                 if (custom_mode_params.size())
-00151                 {
-00152                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00153                         {
-00154                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00155                                 {
-00156                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
-00157                                         custom_mode_params.erase(i);
-00158                                         return;
-00159                                 }
-00160                         }
-00161                 }
-00162                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
-00163         }
-00164 }
+
        00148 {
+00149 
+00150         log(DEBUG,"SetCustomModeParam called");
+00151         ModeParameter M;
+00152         M.mode = mode;
+00153         strlcpy(M.channel,this->name,CHANMAX);
+00154         strlcpy(M.parameter,parameter,MAXBUF);
+00155         if (mode_on)
+00156         {
+00157                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
+00158                 custom_mode_params.push_back(M);
+00159         }
+00160         else
+00161         {
+00162                 if (custom_mode_params.size())
+00163                 {
+00164                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00165                         {
+00166                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00167                                 {
+00168                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
+00169                                         custom_mode_params.erase(i);
+00170                                         return;
+00171                                 }
+00172                         }
+00173                 }
+00174                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
+00175         }
+00176 }

        Member Data Documentation

        -

        - +

        +

        - @@ -417,20 +428,20 @@ Referenced by SetCustomMod +Definition at line 159 of file channels.h.
        + -
        BanList chanrec::bans + BanList chanrec::bans

        -The list of all bans set on the channel. +The list of all bans set on the channel.

        -Definition at line 148 of file channels.h.

        -

        - +

        +

        - @@ -443,22 +454,22 @@ Definition at line 148 o +Referenced by chanrec().
        + -
        short int chanrec::c_private + short int chanrec::c_private

        -Nonzero if the mode +p is set. +Nonzero if the mode +p is set.

        -This value cannot be set at the same time as chanrec::secret +This value cannot be set at the same time as chanrec::secret

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

        -Referenced by chanrec().

        -

        - +

        +

        - @@ -471,22 +482,22 @@ Referenced by chanrec()

        -Creation time. +Creation time.

        -Definition at line 100 of file channels.h. +Definition at line 111 of file channels.h.

        -Referenced by chanrec(). +Referenced by chanrec().

        + -
        time_t chanrec::created + time_t chanrec::created
        -

        - +

        +

        - @@ -499,22 +510,22 @@ Referenced by chanrec()

        -Custom modes for the channel. +Custom modes for the channel.

        Plugins may use this field in any way they see fit.

        -Definition at line 92 of file channels.h. +Definition at line 103 of file channels.h.

        -Referenced by SetCustomMode(). +Referenced by chanrec(), and SetCustomMode().

        + -
        char chanrec::custom_modes[MAXMODES] + char chanrec::custom_modes[MAXMODES]
        -

        - +

        +

        - @@ -527,22 +538,22 @@ Referenced by SetCustomMod +Referenced by chanrec().
        + -
        short int chanrec::inviteonly + short int chanrec::inviteonly

        -Nonzero if the mode +i is set. +Nonzero if the mode +i is set.

        -Definition at line 130 of file channels.h. +Definition at line 141 of file channels.h.

        -Referenced by chanrec().

        -

        - +

        +

        - @@ -555,20 +566,22 @@ Referenced by chanrec()

        -Contains the channel key. +Contains the channel key.

        If this value is an empty string, there is no channel key in place.

        -Definition at line 118 of file channels.h. +Definition at line 129 of file channels.h. +

        +Referenced by chanrec().

        + -
        char chanrec::key[32] + char chanrec::key[32]
        -

        - +

        +

        - @@ -581,22 +594,22 @@ Definition at line 118 o +Referenced by chanrec().
        + -
        long chanrec::limit + long chanrec::limit

        -Contains the channel user limit. +Contains the channel user limit.

        If this value is zero, there is no limit in place.

        -Definition at line 113 of file channels.h. +Definition at line 124 of file channels.h.

        -Referenced by chanrec().

        -

        - +

        +

        - @@ -609,22 +622,22 @@ Referenced by chanrec()

        -Nonzero if the mode +m is set. +Nonzero if the mode +m is set.

        -Definition at line 134 of file channels.h. +Definition at line 145 of file channels.h.

        -Referenced by chanrec(). +Referenced by chanrec().

        + -
        short int chanrec::moderated + short int chanrec::moderated
        -

        - +

        +

        - @@ -637,20 +650,22 @@ Referenced by chanrec()

        -The channels name. +The channels name.

        -Definition at line 88 of file channels.h. +Definition at line 99 of file channels.h. +

        +Referenced by chanrec().

        + -
        char chanrec::name[CHANMAX] + char chanrec::name[CHANMAX]
        -

        - +

        +

        - @@ -663,22 +678,22 @@ Definition at line 88 of +Referenced by chanrec().
        + -
        short int chanrec::noexternal + short int chanrec::noexternal

        -Nonzero if the mode +n is set. +Nonzero if the mode +n is set.

        -Definition at line 126 of file channels.h. +Definition at line 137 of file channels.h.

        -Referenced by chanrec().

        -

        - +

        +

        - @@ -691,22 +706,22 @@ Referenced by chanrec()

        -Nonzero if the mode +s is set. +Nonzero if the mode +s is set.

        -This value cannot be set at the same time as chanrec::c_private +This value cannot be set at the same time as chanrec::c_private

        -Definition at line 139 of file channels.h. +Definition at line 150 of file channels.h.

        -Referenced by chanrec(). +Referenced by chanrec().

        + -
        short int chanrec::secret + short int chanrec::secret
        -

        - +

        +

        - @@ -719,20 +734,22 @@ Referenced by chanrec()

        -The last user to set the topic. +The last user to set the topic.

        If this member is an empty string, no topic was ever set.

        -Definition at line 108 of file channels.h. +Definition at line 119 of file channels.h. +

        +Referenced by chanrec().

        + -
        char chanrec::setby[NICKMAX] + char chanrec::setby[NICKMAX]
        -

        - +

        +

        - @@ -745,20 +762,22 @@ Definition at line 108 o +Definition at line 108 of file channels.h. +

        +Referenced by chanrec().

        + -
        char chanrec::topic[MAXBUF] + char chanrec::topic[MAXBUF]

        -Channel topic. +Channel topic.

        If this is an empty string, no channel topic is set.

        -Definition at line 97 of file channels.h.

        -

        - +

        +

        - @@ -771,22 +790,22 @@ Definition at line 97 of +Referenced by chanrec().
        + -
        short int chanrec::topiclock + short int chanrec::topiclock

        -Nonzero if the mode +t is set. +Nonzero if the mode +t is set.

        -Definition at line 122 of file channels.h. +Definition at line 133 of file channels.h.

        -Referenced by chanrec().

        -

        - +

        +

        - @@ -799,20 +818,20 @@ Referenced by chanrec()

        -Time topic was set. +Time topic was set.

        -If no topic was ever set, this will be equal to chanrec::created +If no topic was ever set, this will be equal to chanrec::created

        -Definition at line 104 of file channels.h. +Definition at line 115 of file channels.h.

        -Referenced by chanrec(). +Referenced by chanrec().

        + -
        time_t chanrec::topicset + time_t chanrec::topicset

        The documentation for this class was generated from the following files: -
        Generated on Sun May 2 00:09:31 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classclassbase-members.html b/docs/module-doc/classclassbase-members.html index 6932f3542..1a2510564 100644 --- a/docs/module-doc/classclassbase-members.html +++ b/docs/module-doc/classclassbase-members.html @@ -1,18 +1,17 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        classbase Member List

        This is the complete list of members for classbase, including all inherited members. - - - -
        ageclassbase
        classbase()classbase [inline]
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:31 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        classbase Member List

        This is the complete list of members for classbase, including all inherited members. + + + +
        ageclassbase
        classbase()classbase [inline]
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classclassbase.html b/docs/module-doc/classclassbase.html index 23a9b6177..ae7de8465 100644 --- a/docs/module-doc/classclassbase.html +++ b/docs/module-doc/classclassbase.html @@ -1,62 +1,46 @@ -classbase class Reference +InspIRCd: classbase class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        classbase Class Reference

        The base class for all inspircd classes. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        classbase Class Reference

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

        #include <base.h>

        -Inheritance diagram for classbase:

        Inheritance graph
        - - - - - - - - - - - - - - - - - - -
        [legend]
        Collaboration diagram for classbase:

        Collaboration graph
        -
        [legend]
        List of all members. +Inherited by Admin, ConfigReader, ConnectClass, Extensible, ExtMode, FileReader, HostItem, Invited, ModeParameter, Module, ModuleFactory, packet, Server, ucrec, Version, and XLine. +

        +List of all members.

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

        Public Member Functions

         classbase ()
         Constructor, Sets the object's time.

         ~classbase ()
         classbase ()
         Constructor, Sets the object's time.

         ~classbase ()

        Public Attributes

        time_t age
         Time that the object was instantiated (used for TS calculation etc).

        time_t age
         Time that the object was instantiated (used for TS calculation etc).

        Detailed Description

        -The base class for all inspircd classes. +The base class for all inspircd classes.

        -Definition at line 17 of file base.h.

        Constructor & Destructor Documentation

        +Definition at line 29 of file base.h.

        Constructor & Destructor Documentation

        - +
        -
        + - - + + @@ -72,26 +56,28 @@ Definition at line 17 of fil
        classbase::classbase (   )   )  [inline]

        -Constructor, Sets the object's time. +Constructor, Sets the object's time.

        -Definition at line 27 of file base.h. +Definition at line 39 of file base.h. +

        +References age.

        -

        00027 { age = time(NULL); }
+
        00039 { age = time(NULL); }

        - +
        -
        + - + - - + + @@ -109,20 +95,20 @@ Definition at line 27 of fil

        -Definition at line 28 of file base.h. +Definition at line 40 of file base.h.

        -

        00028 { }
+
        00040 { }
        classbase::~classbase classbase::~classbase (   )   )  [inline]

        Member Data Documentation

        -

        - +

        +

        - @@ -135,18 +121,20 @@ Definition at line 28 of fil +Definition at line 34 of file base.h. +

        +Referenced by classbase().

        + -
        time_t classbase::age + time_t classbase::age

        -Time that the object was instantiated (used for TS calculation etc). +Time that the object was instantiated (used for TS calculation etc).

        -Definition at line 22 of file base.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:31 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classcommand__t-members.html b/docs/module-doc/classcommand__t-members.html index d84afd6dd..8c2cd466a 100644 --- a/docs/module-doc/classcommand__t-members.html +++ b/docs/module-doc/classcommand__t-members.html @@ -1,27 +1,26 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        command_t Member List

        This is the complete list of members for command_t, including all inherited members. - - - - - - - - - - - - -
        ageclassbase
        classbase()classbase [inline]
        commandcommand_t
        Extend(std::string key, char *p)Extensible
        flags_neededcommand_t
        GetExt(std::string key)Extensible
        handler_functioncommand_t
        min_paramscommand_t
        Shrink(std::string key)Extensible
        total_bytescommand_t
        use_countcommand_t
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:32 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        command_t Member List

        This is the complete list of members for command_t, including all inherited members. + + + + + + + + + + + + +
        ageclassbase
        classbase()classbase [inline]
        commandcommand_t
        Extend(std::string key, char *p)Extensible
        flags_neededcommand_t
        GetExt(std::string key)Extensible
        handler_functioncommand_t
        min_paramscommand_t
        Shrink(std::string key)Extensible
        total_bytescommand_t
        use_countcommand_t
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classcommand__t.html b/docs/module-doc/classcommand__t.html index ba4f0ef58..fd1d9571a 100644 --- a/docs/module-doc/classcommand__t.html +++ b/docs/module-doc/classcommand__t.html @@ -1,54 +1,52 @@ -command_t class Reference +InspIRCd: command_t class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        command_t Class Reference

        A structure that defines a command. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        command_t Class Reference

        A structure that defines a command. More...

        #include <ctables.h>

        -Inheritance diagram for command_t:

        Inheritance graph
        - - - - -
        [legend]
        Collaboration diagram for command_t:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits Extensible. +

        +List of all members.

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

        Public Attributes

        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

        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

        Detailed Description

        -A structure that defines a command. +A structure that defines a command.

        -Definition at line 25 of file ctables.h.

        Member Data Documentation

        -

        - +Definition at line 26 of file ctables.h.

        Member Data Documentation

        +

        +

        - @@ -61,20 +59,20 @@ Definition at line 25 of +Definition at line 31 of file ctables.h.
        + -
        char command_t::command[MAXBUF] + char command_t::command[MAXBUF]

        -Command name. +Command name.

        -Definition at line 30 of file ctables.h.

        -

        - +

        +

        - @@ -87,20 +85,20 @@ Definition at line 30 of +Definition at line 37 of file ctables.h.
        + -
        char command_t::flags_needed + char command_t::flags_needed

        -User flags needed to execute the command or 0. +User flags needed to execute the command or 0.

        -Definition at line 36 of file ctables.h.

        -

        - +

        +

        - @@ -113,20 +111,20 @@ Definition at line 36 of +Definition at line 34 of file ctables.h.
        + -
        handlerfunc* command_t::handler_function + handlerfunc* command_t::handler_function

        -Handler function as in typedef. +Handler function as in typedef.

        -Definition at line 33 of file ctables.h.

        -

        - +

        +

        - @@ -139,20 +137,20 @@ Definition at line 33 of +Definition at line 40 of file ctables.h.
        + -
        int command_t::min_params + int command_t::min_params

        -Minimum number of parameters command takes. +Minimum number of parameters command takes.

        -Definition at line 39 of file ctables.h.

        -

        - +

        +

        - @@ -165,20 +163,20 @@ Definition at line 39 of +Definition at line 46 of file ctables.h.
        + -
        long command_t::total_bytes + long command_t::total_bytes

        -used by /stats m +used by /stats m

        -Definition at line 45 of file ctables.h.

        -

        - +

        +

        - @@ -191,18 +189,18 @@ Definition at line 45 of +Definition at line 43 of file ctables.h.
        + -
        long command_t::use_count + long command_t::use_count

        -used by /stats m +used by /stats m

        -Definition at line 42 of file ctables.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:32 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classconnection-members.html b/docs/module-doc/classconnection-members.html index f328f505c..62c31e68b 100644 --- a/docs/module-doc/classconnection-members.html +++ b/docs/module-doc/classconnection-members.html @@ -1,50 +1,49 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        connection Member List

        This is the complete list of members for connection, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        AddIncoming(int fd, char *targethost, int sourceport)connection
        ageclassbase
        BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
        bytes_inconnection
        bytes_outconnection
        classbase()classbase [inline]
        cmds_inconnection
        cmds_outconnection
        connection()connection
        connectorsconnection
        CreateListener(char *host, int p)connection
        Extend(std::string key, char *p)Extensible
        fdconnection
        FindHost(std::string host)connection
        GenKey()connection
        GetExt(std::string key)Extensible
        haspassedconnection
        hostconnection
        idle_lastmsgconnection
        inbufconnection
        internal_addrconnection
        internal_portconnection
        ipconnection
        lastpingconnection
        MeshCookie(char *targethost, int port, long cookie, char *servername)connection
        npingconnection
        portconnection
        RecvPacket(std::deque< std::string > &messages, char *host)connection
        registeredconnection
        SendPacket(char *message, const char *host)connection
        Shrink(std::string key)Extensible
        signonconnection
        stateconnection
        TerminateLink(char *targethost)connection
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:34 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        connection Member List

        This is the complete list of members for connection, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AddIncoming(int fd, char *targethost, int sourceport)connection
        ageclassbase
        BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
        bytes_inconnection
        bytes_outconnection
        classbase()classbase [inline]
        cmds_inconnection
        cmds_outconnection
        connection()connection
        connectorsconnection
        CreateListener(char *host, int p)connection
        Extend(std::string key, char *p)Extensible
        fdconnection
        FindHost(std::string host)connection
        GenKey()connection
        GetExt(std::string key)Extensible
        haspassedconnection
        hostconnection
        idle_lastmsgconnection
        inbufconnection
        internal_addrconnection
        internal_portconnection
        ipconnection
        lastpingconnection
        MeshCookie(char *targethost, int port, long cookie, char *servername)connection
        npingconnection
        portconnection
        RecvPacket(std::deque< std::string > &messages, char *host)connection
        registeredconnection
        SendPacket(char *message, const char *host)connection
        Shrink(std::string key)Extensible
        signonconnection
        stateconnection
        TerminateLink(char *targethost)connection
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html index 8e4d6222d..3eb501874 100644 --- a/docs/module-doc/classconnection.html +++ b/docs/module-doc/classconnection.html @@ -1,106 +1,127 @@ -connection class Reference +InspIRCd: connection class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        connection Class Reference

        Please note: classes serverrec and userrec both inherit from class connection. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        connection Class Reference

        Please note: classes serverrec and userrec both inherit from class connection. More...

        #include <connection.h>

        -Inheritance diagram for connection:

        Inheritance graph
        - - - - - - -
        [legend]
        Collaboration diagram for connection:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits Extensible. +

        +Inherited by serverrec, and userrec. +

        +List of all members.

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

        Public Member Functions

         connection ()
         Default constructor.

        bool CreateListener (char *host, int p)
         Create a listening socket on 'host' using port number 'p'.

        bool BeginLink (char *targethost, int port, char *password, char *servername, int myport)
         Begin an outbound link to another ircd at targethost.

        bool MeshCookie (char *targethost, int port, long cookie, char *servername)
         Begin an outbound mesh link to another ircd on a network you are already an authenticated member of.

        void TerminateLink (char *targethost)
         Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.

        bool SendPacket (char *message, const char *host)
         Send a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false.

        bool RecvPacket (std::deque< std::string > &messages, char *host)
         Returns the next available packet and returns true if data is available.

        ircd_connector * FindHost (std::string host)
         Find the ircd_connector oject related to a certain servername given in 'host'.

        bool AddIncoming (int fd, char *targethost, int sourceport)
         Add an incoming connection to the connection pool.

        long GenKey ()
         This function is deprecated and may be removed in a later alpha/beta.

         connection ()
         Default constructor.

        bool CreateListener (char *host, int p)
         Create a listening socket on 'host' using port number 'p'.

        bool BeginLink (char *targethost, int port, char *password, char *servername, int myport)
         Begin an outbound link to another ircd at targethost.

        bool MeshCookie (char *targethost, int port, long cookie, char *servername)
         Begin an outbound mesh link to another ircd on a network you are already an authenticated member of.

        void TerminateLink (char *targethost)
         Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.

        bool SendPacket (char *message, const char *host)
         Send a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false.

        bool RecvPacket (std::deque< std::string > &messages, char *host)
         Returns the next available packet and returns true if data is available.

        ircd_connector * FindHost (std::string host)
         Find the ircd_connector oject related to a certain servername given in 'host'.

        bool AddIncoming (int fd, char *targethost, int sourceport)
         Add an incoming connection to the connection pool.

        long GenKey ()
         This function is deprecated and may be removed in a later alpha/beta.


        Public Attributes

        int fd
         File descriptor of the connection.

        char host [256]
         Hostname of connection.

        char ip [32]
         IP of connection.

        char inbuf [MAXBUF]
         Inbuf of connection.

        long bytes_in
         Stats counter for bytes inbound.

        long bytes_out
         Stats counter for bytes outbound.

        long cmds_in
         Stats counter for commands inbound.

        long cmds_out
         Stats counter for commands outbound.

        bool haspassed
         True if server/user has authenticated, false if otherwise.

        int port
         Port number For a userrec, this is the port they connected to the network on.

        int registered
         Used by userrec to indicate the registration status of the connection.

        short int state
         Reserved for future use.

        time_t lastping
         Time the connection was last pinged.

        time_t signon
         Time the connection was created, set in the constructor.

        time_t idle_lastmsg
         Time that the connection last sent data, used to calculate idle time.

        time_t nping
         Used by PING checks with clients.

        char internal_addr [MAXBUF]
         Unused, will be removed in a future alpha/beta.

        int internal_port
         Unused, will be removed in a future alpha/beta.

        std::vector< ircd_connector > connectors
         With a serverrec, this is a list of all established server connections.

        int fd
         File descriptor of the connection.

        char host [256]
         Hostname of connection.

        char ip [32]
         IP of connection.

        char inbuf [MAXBUF]
         Inbuf of connection.

        long bytes_in
         Stats counter for bytes inbound.

        long bytes_out
         Stats counter for bytes outbound.

        long cmds_in
         Stats counter for commands inbound.

        long cmds_out
         Stats counter for commands outbound.

        bool haspassed
         True if server/user has authenticated, false if otherwise.

        int port
         Port number For a userrec, this is the port they connected to the network on.

        int registered
         Used by userrec to indicate the registration status of the connection.

        short int state
         Reserved for future use.

        time_t lastping
         Time the connection was last pinged.

        time_t signon
         Time the connection was created, set in the constructor.

        time_t idle_lastmsg
         Time that the connection last sent data, used to calculate idle time.

        time_t nping
         Used by PING checks with clients.

        char internal_addr [MAXBUF]
         Unused, will be removed in a future alpha/beta.

        int internal_port
         Unused, will be removed in a future alpha/beta.

        std::vector< ircd_connector > connectors
         With a serverrec, this is a list of all established server connections.

        Detailed Description

        -Please note: classes serverrec and userrec both inherit from class connection. +Please note: classes serverrec and userrec both inherit from class connection.

        -Definition at line 161 of file connection.h.

        Constructor & Destructor Documentation

        +Definition at line 173 of file connection.h.

        Constructor & Destructor Documentation

        - +
        -
        + - - + + @@ -116,34 +137,34 @@ Definition at line 161
        connection::connection (   )   ) 

        -Default constructor. +Default constructor.

        Member Function Documentation

        - +
        -
        + - + - + - + @@ -163,45 +184,45 @@ Default constructor.
        bool connection::AddIncoming (  int   fd, fd,
        char *   targethost, targethost,
        int   sourceport sourceport

        -Add an incoming connection to the connection pool. +Add an incoming connection to the connection pool.

        (reserved for core use)

        - +
        -
        + - + - + - + - + - + @@ -221,27 +242,27 @@ Add an incoming connection to the connection pool.
        bool connection::BeginLink (  char *   targethost, targethost,
        int   port, port,
        char *   password, password,
        char *   servername, servername,
        int   myport myport

        -Begin an outbound link to another ircd at targethost. +Begin an outbound link to another ircd at targethost.

        - +
        -
        + - + - + @@ -261,22 +282,22 @@ Begin an outbound link to another ircd at targethost.
        bool connection::CreateListener (  char *   host, host,
        int   p p

        -Create a listening socket on 'host' using port number 'p'. +Create a listening socket on 'host' using port number 'p'.

        - +
        -
        + - - + + @@ -292,21 +313,21 @@ Create a listening socket on 'host' using port number 'p'.
        ircd_connector* connection::FindHost (  std::string   host )  host  ) 

        -Find the ircd_connector oject related to a certain servername given in 'host'. +Find the ircd_connector oject related to a certain servername given in 'host'.

        - +
        -
        + - - + + @@ -322,39 +343,39 @@ Find the ircd_connector oject
        long connection::GenKey (   )   ) 

        -This function is deprecated and may be removed in a later alpha/beta. +This function is deprecated and may be removed in a later alpha/beta.

        - +
        -
        + - + - + - + - + @@ -374,27 +395,27 @@ This function is deprecated and may be removed in a later alpha/beta.
        bool connection::MeshCookie (  char *   targethost, targethost,
        int   port, port,
        long   cookie, cookie,
        char *   servername servername

        -Begin an outbound mesh link to another ircd on a network you are already an authenticated member of. +Begin an outbound mesh link to another ircd on a network you are already an authenticated member of.

        - +
        -
        + - + - + @@ -414,27 +435,27 @@ Begin an outbound mesh link to another ircd on a network you are already an auth
        bool connection::RecvPacket (  std::deque< std::string > &   messages, messages,
        char *   host host

        -Returns the next available packet and returns true if data is available. +Returns the next available packet and returns true if data is available.

        Writes the servername the data came from to 'host'. If no data is available this function returns false. This function will automatically close broken links and reroute pathways, generating split messages on the network.

        - +
        -
        + - + - + @@ -454,22 +475,22 @@ Writes the servername the data came from to 'host'. If no data is available this
        bool connection::SendPacket (  char *   message, message,
        const char *   host host

        -Send a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false. +Send a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false.

        - +
        -
        + - - + + @@ -485,19 +506,19 @@ Send a message to a server by name, if the server is unavailable directly route
        void connection::TerminateLink (  char *   targethost )  targethost  ) 

        -Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method. +Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.

        Member Data Documentation

        -

        - +

        +

        - @@ -510,22 +531,22 @@ Terminate a link to 'targethost' by calling the 182 of file connection.h. +Definition at line 194 of file connection.h.

        -Referenced by userrec::userrec(). +Referenced by userrec::userrec().

        + -
        long connection::bytes_in + long connection::bytes_in
        -

        - +

        +

        - @@ -538,22 +559,22 @@ Referenced by userrec::userre +Referenced by userrec::userrec().
        + -
        long connection::bytes_out + long connection::bytes_out

        -Stats counter for bytes outbound. +Stats counter for bytes outbound.

        -Definition at line 186 of file connection.h. +Definition at line 198 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -566,22 +587,22 @@ Referenced by userrec::userre +Referenced by userrec::userrec().
        + -
        long connection::cmds_in + long connection::cmds_in

        -Stats counter for commands inbound. +Stats counter for commands inbound.

        -Definition at line 190 of file connection.h. +Definition at line 202 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -594,22 +615,22 @@ Referenced by userrec::userre +Referenced by userrec::userrec().
        + -
        long connection::cmds_out + long connection::cmds_out

        -Stats counter for commands outbound. +Stats counter for commands outbound.

        -Definition at line 194 of file connection.h. +Definition at line 206 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -622,20 +643,20 @@ Referenced by userrec::userre +Definition at line 253 of file connection.h.
        + -
        std::vector<ircd_connector> connection::connectors + std::vector<ircd_connector> connection::connectors

        -With a serverrec, this is a list of all established server connections. +With a serverrec, this is a list of all established server connections.

        With a userrec this is unused.

        -Definition at line 241 of file connection.h.

        -

        - +

        +

        - @@ -648,22 +669,22 @@ Definition at line 241 +Referenced by ConfigReader::DumpErrors(), Server::SendTo(), serverrec::serverrec(), and userrec::userrec().
        + -
        int connection::fd + int connection::fd

        -File descriptor of the connection. +File descriptor of the connection.

        -Definition at line 166 of file connection.h. +Definition at line 178 of file connection.h.

        -Referenced by Server::SendTo(), serverrec::serverrec(), and userrec::userrec().

        -

        - +

        +

        - @@ -676,22 +697,22 @@ Referenced by Server::SendT +Referenced by userrec::userrec().
        + -
        bool connection::haspassed + bool connection::haspassed

        -True if server/user has authenticated, false if otherwise. +True if server/user has authenticated, false if otherwise.

        -Definition at line 198 of file connection.h. +Definition at line 210 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -704,20 +725,22 @@ Referenced by userrec::userre +Definition at line 182 of file connection.h. +

        +Referenced by userrec::GetFullRealHost(), and userrec::userrec().

        + -
        char connection::host[256] + char connection::host[256]

        -Hostname of connection. +Hostname of connection.

        Not used if this is a serverrec

        -Definition at line 170 of file connection.h.

        -

        - +

        +

        - @@ -730,22 +753,22 @@ Definition at line 170 +Referenced by userrec::userrec().
        + -
        time_t connection::idle_lastmsg + time_t connection::idle_lastmsg

        -Time that the connection last sent data, used to calculate idle time. +Time that the connection last sent data, used to calculate idle time.

        -Definition at line 224 of file connection.h. +Definition at line 236 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -758,20 +781,22 @@ Referenced by userrec::userre +Definition at line 190 of file connection.h. +

        +Referenced by userrec::userrec().

        + -
        char connection::inbuf[MAXBUF] + char connection::inbuf[MAXBUF]

        -Inbuf of connection. +Inbuf of connection.

        Only used for userrec

        -Definition at line 178 of file connection.h.

        -

        - +

        +

        - @@ -784,20 +809,20 @@ Definition at line 178 +Definition at line 244 of file connection.h.
        + -
        char connection::internal_addr[MAXBUF] + char connection::internal_addr[MAXBUF]

        -Unused, will be removed in a future alpha/beta. +Unused, will be removed in a future alpha/beta.

        -Definition at line 232 of file connection.h.

        -

        - +

        +

        - @@ -810,20 +835,20 @@ Definition at line 232 +Definition at line 248 of file connection.h.
        + -
        int connection::internal_port + int connection::internal_port

        -Unused, will be removed in a future alpha/beta. +Unused, will be removed in a future alpha/beta.

        -Definition at line 236 of file connection.h.

        -

        - +

        +

        - @@ -836,20 +861,22 @@ Definition at line 236 +Definition at line 186 of file connection.h. +

        +Referenced by userrec::userrec().

        + -
        char connection::ip[32] + char connection::ip[32]

        -IP of connection. +IP of connection.

        Reserved for future use.

        -Definition at line 174 of file connection.h.

        -

        - +

        +

        - @@ -862,22 +889,22 @@ Definition at line 174 +Referenced by serverrec::serverrec(), and userrec::userrec().
        + -
        time_t connection::lastping + time_t connection::lastping

        -Time the connection was last pinged. +Time the connection was last pinged.

        -Definition at line 216 of file connection.h. +Definition at line 228 of file connection.h.

        -Referenced by serverrec::serverrec(), and userrec::userrec().

        -

        - +

        +

        - @@ -890,22 +917,22 @@ Referenced by serverrec::se +Referenced by userrec::userrec().
        + -
        time_t connection::nping + time_t connection::nping

        -Used by PING checks with clients. +Used by PING checks with clients.

        -Definition at line 228 of file connection.h. +Definition at line 240 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -918,22 +945,22 @@ Referenced by userrec::userre +Referenced by userrec::userrec().
        + -
        int connection::port + int connection::port

        -Port number For a userrec, this is the port they connected to the network on. +Port number For a userrec, this is the port they connected to the network on.

        For a serverrec this is the current listening port of the serverrec object.

        -Definition at line 204 of file connection.h. +Definition at line 216 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -946,22 +973,22 @@ Referenced by userrec::userre +Referenced by userrec::userrec().
        + -
        int connection::registered + int connection::registered

        -Used by userrec to indicate the registration status of the connection. +Used by userrec to indicate the registration status of the connection.

        -Definition at line 208 of file connection.h. +Definition at line 220 of file connection.h.

        -Referenced by userrec::userrec().

        -

        - +

        +

        - @@ -974,22 +1001,22 @@ Referenced by userrec::userre +Referenced by serverrec::serverrec(), and userrec::userrec().
        + -
        time_t connection::signon + time_t connection::signon

        -Time the connection was created, set in the constructor. +Time the connection was created, set in the constructor.

        -Definition at line 220 of file connection.h. +Definition at line 232 of file connection.h.

        -Referenced by serverrec::serverrec(), and userrec::userrec().

        -

        - +

        +

        - @@ -1002,18 +1029,18 @@ Referenced by serverrec::se +Definition at line 224 of file connection.h.
        + -
        short int connection::state + short int connection::state

        -Reserved for future use. +Reserved for future use.

        -Definition at line 212 of file connection.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:34 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classes.html b/docs/module-doc/classes.html index 4826b9356..2e8134723 100644 --- a/docs/module-doc/classes.html +++ b/docs/module-doc/classes.html @@ -1,32 +1,32 @@ -Alphabetical index +InspIRCd: Alphabetical index - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        InspIRCd Compound Index

        + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        InspIRCd Compound Index

          A  
          E  
        -        		hash< string > (nspace)   ModeParameter   StrHashComp   
        Admin   ExemptItem   HostItem   Module   
          U  
        +        		InAddr_HashComp   
          N  
        +        		StrHashComp   
        Admin   ExemptItem   Invited   nspace::hash< in_addr > (nspace)   
          U  
          B  
        -        		Extensible   
          I  
        -        		ModuleFactory   ucrec   
        BanItem   ExtMode   InAddr_HashComp   
          P  
        +        		Extensible   InviteItem   nspace::hash< string > (nspace)   ucrec   
        BanItem   ExtMode   ircd_connector   
          P  
        		userrec   
          C  
          F  
        -        		Invited   packet   
          V  
        -
        chanrec   FileReader   InviteItem   
          Q  
        +
          K  
        +        		packet   
          V  
        +
        chanrec   FileReader   KLine   
          Q  
        		Version   
        classbase   
          G  
        -        		ircd_connector   QLine   
          X  
        -
        command_t   GLine   
          K  
        -
          S  
        +
          M  
        +        		QLine   
          X  
        +
        command_t   GLine   ModeParameter   
          S  
        		XLine   
        ConfigReader   
          H  
        -        		KLine   Server   
          Z  
        -
        ConnectClass   hash< in_addr > (nspace)   
          M  
        -        		serverrec   ZLine   
        connection   
        Generated on Sun May 2 00:09:29 2004 for InspIRCd by +
        		Module   Server   
          Z  
        +
        ConnectClass   HostItem   ModuleFactory   serverrec   ZLine   
        connection   
          I  
        +

        Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3 diff --git a/docs/module-doc/classircd__connector-members.html b/docs/module-doc/classircd__connector-members.html index 8f82b7b4a..966335098 100644 --- a/docs/module-doc/classircd__connector-members.html +++ b/docs/module-doc/classircd__connector-members.html @@ -1,44 +1,43 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ircd_connector Member List

        This is the complete list of members for ircd_connector, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        addrircd_connector [private]
        ageclassbase
        classbase()classbase [inline]
        CloseConnection()ircd_connector
        descriptionircd_connector [private]
        Extend(std::string key, char *p)Extensible
        fdircd_connector [private]
        GetDescription()ircd_connector
        GetDescriptor()ircd_connector
        GetExt(std::string key)Extensible
        GetServerIP()ircd_connector
        GetServerName()ircd_connector
        GetServerPort()ircd_connector
        GetState()ircd_connector
        hostircd_connector
        MakeOutboundConnection(char *host, int port)ircd_connector
        portircd_connector
        routesircd_connector
        servernameircd_connector [private]
        SetDescription(std::string desc)ircd_connector
        SetDescriptor(int fd)ircd_connector
        SetHostAddress(char *host, int port)ircd_connector [private]
        SetHostAndPort(char *host, int port)ircd_connector
        SetServerName(std::string serv)ircd_connector
        SetServerPort(int p)ircd_connector
        SetState(int state)ircd_connector
        Shrink(std::string key)Extensible
        stateircd_connector [private]
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:39 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ircd_connector Member List

        This is the complete list of members for ircd_connector, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        addrircd_connector [private]
        ageclassbase
        classbase()classbase [inline]
        CloseConnection()ircd_connector
        descriptionircd_connector [private]
        Extend(std::string key, char *p)Extensible
        fdircd_connector [private]
        GetDescription()ircd_connector
        GetDescriptor()ircd_connector
        GetExt(std::string key)Extensible
        GetServerIP()ircd_connector
        GetServerName()ircd_connector
        GetServerPort()ircd_connector
        GetState()ircd_connector
        hostircd_connector
        MakeOutboundConnection(char *host, int port)ircd_connector
        portircd_connector
        routesircd_connector
        servernameircd_connector [private]
        SetDescription(std::string desc)ircd_connector
        SetDescriptor(int fd)ircd_connector
        SetHostAddress(char *host, int port)ircd_connector [private]
        SetHostAndPort(char *host, int port)ircd_connector
        SetServerName(std::string serv)ircd_connector
        SetServerPort(int p)ircd_connector
        SetState(int state)ircd_connector
        Shrink(std::string key)Extensible
        stateircd_connector [private]
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html index c88a7a0da..5d2bd7d4f 100644 --- a/docs/module-doc/classircd__connector.html +++ b/docs/module-doc/classircd__connector.html @@ -1,96 +1,111 @@ -ircd_connector class Reference +InspIRCd: ircd_connector class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        ircd_connector Class Reference

        Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        ircd_connector Class Reference

        Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. More...

        #include <connection.h>

        -Inheritance diagram for ircd_connector:

        Inheritance graph
        - - - - -
        [legend]
        Collaboration diagram for ircd_connector:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits Extensible. +

        +List of all members.

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

        Public Member Functions

        bool MakeOutboundConnection (char *host, int port)
         Create an outbound connection to a listening socket.

        std::string GetServerName ()
         Return the servername on this established connection.

        void SetServerName (std::string serv)
         Set the server name of this connection.

        int GetDescriptor ()
         Get the file descriptor associated with this connection.

        void SetDescriptor (int fd)
         Set the file descriptor for this connection.

        int GetState ()
         Get the state flags for this connection.

        void SetState (int state)
         Set the state flags for this connection.

        char * GetServerIP ()
         Get the ip address (not servername) associated with this connection.

        std::string GetDescription ()
         Get the server description of this connection.

        void SetDescription (std::string desc)
         Set the server description of this connection.

        int GetServerPort ()
         Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in GetServerIP().

        void SetServerPort (int p)
         Set the port used by this connection.

        bool SetHostAndPort (char *host, int port)
         Set both the host and the port in one operation for this connection.

        void CloseConnection ()
         Close the connection by calling close() on its file descriptor This function call updates no other data.

        bool MakeOutboundConnection (char *host, int port)
         Create an outbound connection to a listening socket.

        std::string GetServerName ()
         Return the servername on this established connection.

        void SetServerName (std::string serv)
         Set the server name of this connection.

        int GetDescriptor ()
         Get the file descriptor associated with this connection.

        void SetDescriptor (int fd)
         Set the file descriptor for this connection.

        int GetState ()
         Get the state flags for this connection.

        void SetState (int state)
         Set the state flags for this connection.

        char * GetServerIP ()
         Get the ip address (not servername) associated with this connection.

        std::string GetDescription ()
         Get the server description of this connection.

        void SetDescription (std::string desc)
         Set the server description of this connection.

        int GetServerPort ()
         Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in GetServerIP().

        void SetServerPort (int p)
         Set the port used by this connection.

        bool SetHostAndPort (char *host, int port)
         Set both the host and the port in one operation for this connection.

        void CloseConnection ()
         Close the connection by calling close() on its file descriptor This function call updates no other data.


        Public Attributes

        char host [MAXBUF]
         When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.

        int port
         When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.

        std::vector< std::string > routes
         Server names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B.

        char host [MAXBUF]
         When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.

        int port
         When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.

        std::vector< std::string > routes
         Server names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B.


        Private Member Functions

        bool SetHostAddress (char *host, int port)
         PRIVATE function to set the host address and port to connect to.

        bool SetHostAddress (char *host, int port)
         PRIVATE function to set the host address and port to connect to.


        Private Attributes

        sockaddr_in addr
         Sockaddr of the outbound ip and port.

        int fd
         File descriptor of the connection.

        std::string servername
         Server name.

        std::string description
         Server 'GECOS'.

        int state
         State.

        sockaddr_in addr
         Sockaddr of the outbound ip and port.

        int fd
         File descriptor of the connection.

        std::string servername
         Server name.

        std::string description
         Server 'GECOS'.

        int state
         State.

        Detailed Description

        -Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. +Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds.

        A listening socket that accepts server type connections is represented by one class serverrec. Class serverrec will instantiate several objects of type ircd_connector to represent each established connection, inbound or outbound. So, to determine all linked servers you must walk through all the serverrecs that the core defines, and in each one iterate through until you find connection(s) relating to the server you want information on. The core and module API provide functions for this.

        -Definition at line 41 of file connection.h.

        Member Function Documentation

        +Definition at line 53 of file connection.h.

        Member Function Documentation

        - +
        -
        + - - + + @@ -106,21 +121,21 @@ Definition at line 41
        void ircd_connector::CloseConnection (   )   ) 

        -Close the connection by calling close() on its file descriptor This function call updates no other data. +Close the connection by calling close() on its file descriptor This function call updates no other data.

        - +
        -
        + - - + + @@ -136,21 +151,21 @@ Close the connection by calling close() on its file descriptor This function cal
        std::string ircd_connector::GetDescription (   )   ) 

        -Get the server description of this connection. +Get the server description of this connection.

        - +
        -
        + - - + + @@ -166,21 +181,21 @@ Get the server description of this connection.
        int ircd_connector::GetDescriptor (   )   ) 

        -Get the file descriptor associated with this connection. +Get the file descriptor associated with this connection.

        - +
        -
        + - - + + @@ -196,21 +211,21 @@ Get the file descriptor associated with this connection.
        char* ircd_connector::GetServerIP (   )   ) 

        -Get the ip address (not servername) associated with this connection. +Get the ip address (not servername) associated with this connection.

        - +
        -
        + - - + + @@ -226,21 +241,21 @@ Get the ip address (not servername) associated with this connection.
        std::string ircd_connector::GetServerName (   )   ) 

        -Return the servername on this established connection. +Return the servername on this established connection.

        - +
        -
        + - - + + @@ -256,21 +271,21 @@ Return the servername on this established connection.
        int ircd_connector::GetServerPort (   )   ) 

        -Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in GetServerIP(). +Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in GetServerIP().

        - +
        -
        + - - + + @@ -286,27 +301,27 @@ Get the port number being used for this connection If the connection is outbound
        int ircd_connector::GetState (   )   ) 

        -Get the state flags for this connection. +Get the state flags for this connection.

        - +
        -
        + - + - + @@ -326,22 +341,22 @@ Get the state flags for this connection.
        bool ircd_connector::MakeOutboundConnection (  char *   host, host,
        int   port port

        -Create an outbound connection to a listening socket. +Create an outbound connection to a listening socket.

        - +
        -
        + - - + + @@ -357,22 +372,22 @@ Create an outbound connection to a listening socket.
        void ircd_connector::SetDescription (  std::string   desc )  desc  ) 

        -Set the server description of this connection. +Set the server description of this connection.

        - +
        -
        + - - + + @@ -388,27 +403,27 @@ Set the server description of this connection.
        void ircd_connector::SetDescriptor (  int   fd )  fd  ) 

        -Set the file descriptor for this connection. +Set the file descriptor for this connection.

        -

        - +

        +

        -
        + - + - + @@ -428,27 +443,27 @@ Set the file descriptor for this connection.
        bool ircd_connector::SetHostAddress (  char *   host, host,
        int   port port

        -PRIVATE function to set the host address and port to connect to. +PRIVATE function to set the host address and port to connect to.

        - +
        -
        + - + - + @@ -468,22 +483,22 @@ PRIVATE function to set the host address and port to connect to.
        bool ircd_connector::SetHostAndPort (  char *   host, host,
        int   port port

        -Set both the host and the port in one operation for this connection. +Set both the host and the port in one operation for this connection.

        - +
        -
        + - - + + @@ -499,22 +514,22 @@ Set both the host and the port in one operation for this connection.
        void ircd_connector::SetServerName (  std::string   serv )  serv  ) 

        -Set the server name of this connection. +Set the server name of this connection.

        - +
        -
        + - - + + @@ -530,22 +545,22 @@ Set the server name of this connection.
        void ircd_connector::SetServerPort (  int   p )  p  ) 

        -Set the port used by this connection. +Set the port used by this connection.

        - +
        -
        + - - + + @@ -561,19 +576,19 @@ Set the port used by this connection.
        void ircd_connector::SetState (  int   state )  state  ) 

        -Set the state flags for this connection. +Set the state flags for this connection.

        Member Data Documentation

        -

        - +

        +

        - @@ -586,20 +601,20 @@ Set the state flags for this connection. +Definition at line 58 of file connection.h.
        + -
        sockaddr_in ircd_connector::addr [private] + sockaddr_in ircd_connector::addr [private]

        -Sockaddr of the outbound ip and port. +Sockaddr of the outbound ip and port.

        -Definition at line 46 of file connection.h.

        -

        - +

        +

        - @@ -612,20 +627,20 @@ Definition at line 46 +Definition at line 70 of file connection.h.
        + -
        std::string ircd_connector::description [private] + std::string ircd_connector::description [private]

        -Server 'GECOS'. +Server 'GECOS'.

        -Definition at line 58 of file connection.h.

        -

        - +

        +

        - @@ -638,20 +653,20 @@ Definition at line 58 +Definition at line 62 of file connection.h.
        + -
        int ircd_connector::fd [private] + int ircd_connector::fd [private]

        -File descriptor of the connection. +File descriptor of the connection.

        -Definition at line 50 of file connection.h.

        -

        - +

        +

        - @@ -664,20 +679,20 @@ Definition at line 50 +Definition at line 87 of file connection.h.
        + -
        char ircd_connector::host[MAXBUF] + char ircd_connector::host[MAXBUF]

        -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.

        -Definition at line 75 of file connection.h.

        -

        - +

        +

        - @@ -690,20 +705,20 @@ Definition at line 75 +Definition at line 93 of file connection.h.
        + -
        int ircd_connector::port + int ircd_connector::port

        -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.

        -Definition at line 81 of file connection.h.

        -

        - +

        +

        - @@ -716,20 +731,20 @@ Definition at line 81 +Definition at line 99 of file connection.h.
        + -
        std::vector<std::string> ircd_connector::routes + std::vector<std::string> ircd_connector::routes

        -Server names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. +Server names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B.

        -Definition at line 87 of file connection.h.

        -

        - +

        +

        - @@ -742,20 +757,20 @@ Definition at line 87 +Definition at line 66 of file connection.h.
        + -
        std::string ircd_connector::servername [private] + std::string ircd_connector::servername [private]

        -Server name. +Server name.

        -Definition at line 54 of file connection.h.

        -

        - +

        +

        - @@ -768,18 +783,18 @@ Definition at line 54 +Definition at line 75 of file connection.h.
        + -
        int ircd_connector::state [private] + int ircd_connector::state [private]

        -State. +State.

        STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED

        -Definition at line 63 of file connection.h.

        The documentation for this class was generated from the following file: -
        Generated on Sun May 2 00:09:39 2004 for InspIRCd by +
        Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classpacket-members.html b/docs/module-doc/classpacket-members.html index 815af335d..9991099b9 100644 --- a/docs/module-doc/classpacket-members.html +++ b/docs/module-doc/classpacket-members.html @@ -1,18 +1,17 @@ -Member List +InspIRCd: Member List - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        packet Member List

        This is the complete list of members for packet, including all inherited members. - - - -
        ageclassbase
        classbase()classbase [inline]
        ~classbase()classbase [inline]
        Generated on Sun May 2 00:09:42 2004 for InspIRCd by + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        packet Member List

        This is the complete list of members for packet, including all inherited members. + + + +
        ageclassbase
        classbase()classbase [inline]
        ~classbase()classbase [inline]
        Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
        +doxygen +1.3.3
        diff --git a/docs/module-doc/classpacket.html b/docs/module-doc/classpacket.html index f286b0c6b..29c23b5f1 100644 --- a/docs/module-doc/classpacket.html +++ b/docs/module-doc/classpacket.html @@ -1,39 +1,32 @@ -packet class Reference +InspIRCd: packet class Reference - -
        -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
        -

        packet Class Reference

        Class packet is deprecated. + +
        Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
        +

        packet Class Reference

        Class packet is deprecated. More...

        #include <connection.h>

        -Inheritance diagram for packet:

        Inheritance graph
        - - - -
        [legend]
        Collaboration diagram for packet:

        Collaboration graph
        - - - -
        [legend]
        List of all members. +Inherits classbase. +

        +List of all members.

        Detailed Description

        -Class packet is deprecated. +Class packet is deprecated.

        This declaration is preserved here to maintain documentation only.

        -Definition at line 155 of file connection.h.

        The documentation for this class was generated from the following file:
          +Definition at line 167 of file connection.h.
          The documentation for this class was generated from the following file: -
          Generated on Sun May 2 00:09:42 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/classserverrec-members.html b/docs/module-doc/classserverrec-members.html index e41138571..dd9643aa3 100644 --- a/docs/module-doc/classserverrec-members.html +++ b/docs/module-doc/classserverrec-members.html @@ -1,63 +1,63 @@ -Member List +InspIRCd: Member List - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          serverrec Member List

          This is the complete list of members for serverrec, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          AddIncoming(int fd, char *targethost, int sourceport)connection
          ageclassbase
          BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
          bytes_inconnection
          bytes_outconnection
          classbase()classbase [inline]
          cmds_inconnection
          cmds_outconnection
          connection()connection
          connectorsconnection
          CreateListener(char *host, int p)connection
          descriptionserverrec
          Extend(std::string key, char *p)Extensible
          fdconnection
          FindHost(std::string host)connection
          GenKey()connection
          GetExt(std::string key)Extensible
          haspassedconnection
          hops_awayserverrec
          hostconnection
          idle_lastmsgconnection
          inbufconnection
          internal_addrconnection
          internal_portconnection
          ipconnection
          jupiterserverrec
          lastpingconnection
          MeshCookie(char *targethost, int port, long cookie, char *servername)connection
          nameserverrec
          npingconnection
          opercountserverrec
          pingtimeserverrec
          portconnection
          RecvPacket(std::deque< std::string > &messages, char *host)connection
          registeredconnection
          SendPacket(char *message, const char *host)connection
          serverrec()serverrec
          serverrec(char *n, long ver, bool jupe)serverrec
          Shrink(std::string key)Extensible
          signonconnection
          stateconnection
          sync_soonserverrec
          TerminateLink(char *targethost)connection
          usercountserverrec
          usercount_iserverrec
          versionserverrec
          ~classbase()classbase [inline]
          ~serverrec()serverrec
          Generated on Sun May 2 00:09:44 2004 for InspIRCd by + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          serverrec Member List

          This is the complete list of members for serverrec, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          AddIncoming(int fd, char *targethost, int sourceport)connection
          ageclassbase
          BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
          bytes_inconnection
          bytes_outconnection
          classbase()classbase [inline]
          cmds_inconnection
          cmds_outconnection
          connection()connection
          connectorsconnection
          CreateListener(char *host, int p)connection
          descriptionserverrec
          Extend(std::string key, char *p)Extensible
          fdconnection
          FindHost(std::string host)connection
          GenKey()connection
          GetExt(std::string key)Extensible
          haspassedconnection
          hops_awayserverrec
          hostconnection
          idle_lastmsgconnection
          inbufconnection
          internal_addrconnection
          internal_portconnection
          ipconnection
          jupiterserverrec
          lastpingconnection
          MeshCookie(char *targethost, int port, long cookie, char *servername)connection
          nameserverrec
          nickservserverrec
          npingconnection
          opercountserverrec
          pingtimeserverrec
          portconnection
          RecvPacket(std::deque< std::string > &messages, char *host)connection
          registeredconnection
          SendPacket(char *message, const char *host)connection
          serverrec()serverrec
          serverrec(char *n, long ver, bool jupe)serverrec
          Shrink(std::string key)Extensible
          signonconnection
          stateconnection
          sync_soonserverrec
          TerminateLink(char *targethost)connection
          usercountserverrec
          usercount_iserverrec
          versionserverrec
          ~classbase()classbase [inline]
          ~serverrec()serverrec
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/classserverrec.html b/docs/module-doc/classserverrec.html index e762c3878..aed076b09 100644 --- a/docs/module-doc/classserverrec.html +++ b/docs/module-doc/classserverrec.html @@ -1,72 +1,79 @@ -serverrec class Reference +InspIRCd: serverrec class Reference - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          serverrec Class Reference

          A class that defines the local server or a remote server. + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          serverrec Class Reference

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

          #include <servers.h>

          -Inheritance diagram for serverrec:

          Inheritance graph
          - - - - - -
          [legend]
          Collaboration diagram for serverrec:

          Collaboration graph
          - - - -
          [legend]
          List of all members. +Inherits connection. +

          +List of all members.

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

          Public Member Functions

           serverrec ()
           Constructor.

           serverrec (char *n, long ver, bool jupe)
           Constructor which initialises some of the main variables.

           ~serverrec ()
           Destructor.

           serverrec ()
           Constructor.

           serverrec (char *n, long ver, bool jupe)
           Constructor which initialises some of the main variables.

           ~serverrec ()
           Destructor.


          Public Attributes

          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)

          char description [MAXBUF]
           Description of the server.

          bool sync_soon
          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)

          char description [MAXBUF]
           Description of the server.

          char nickserv [NICKMAX]
           Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/).

          bool sync_soon

          Detailed Description

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

          -Definition at line 19 of file servers.h.

          Constructor & Destructor Documentation

          +Definition at line 30 of file servers.h.

          Constructor & Destructor Documentation

          - +
          -
          + - - + + @@ -82,50 +89,51 @@ Definition at line 19 of
          serverrec::serverrec (   )   ) 

          -Constructor. +Constructor.

          -Definition at line 12 of file servers.cpp. -

          -References connection::fd, hops_away, jupiter, connection::lastping, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version. -

          -

          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         sync_soon = false;
-00023 }
+Definition at line 23 of file servers.cpp.
+
          
+References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version.
+
          
+
          00024 {
+00025         strlcpy(name,"",256);
+00026         pingtime = 0;
+00027         lastping = time(NULL);
+00028         usercount_i = usercount = opercount = version = 0;
+00029         hops_away = 1;
+00030         signon = time(NULL);
+00031         jupiter = false;
+00032         fd = 0;
+00033         sync_soon = false;
+00034         strlcpy(nickserv,"",NICKMAX);
+00035 }

          - +
          -
          + - + - + - + @@ -145,38 +153,39 @@ References connection::fd<
          serverrec::serverrec (  char *   n, n,
          long   ver, ver,
          bool   jupe jupe

          -Constructor which initialises some of the main variables. +Constructor which initialises some of the main variables.

          -Definition at line 30 of file servers.cpp. -

          -References connection::fd, hops_away, jupiter, connection::lastping, opercount, connection::signon, sync_soon, usercount, usercount_i, and version. -

          -

          00031 {
-00032         strcpy(name,n);
-00033         lastping = time(NULL);
-00034         usercount_i = usercount = opercount = 0;
-00035         version = ver;
-00036         hops_away = 1;
-00037         signon = time(NULL);
-00038         jupiter = jupe;
-00039         fd = 0;
-00040         sync_soon = false;
-00041 }
+Definition at line 42 of file servers.cpp.
+
          
+References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, usercount, usercount_i, and version.
+
          
+
          00043 {
+00044         strlcpy(name,n,256);
+00045         lastping = time(NULL);
+00046         usercount_i = usercount = opercount = 0;
+00047         version = ver;
+00048         hops_away = 1;
+00049         signon = time(NULL);
+00050         jupiter = jupe;
+00051         fd = 0;
+00052         sync_soon = false;
+00053         strlcpy(nickserv,"",NICKMAX);
+00054 }

          - +
          -
          + - + - - + + @@ -192,25 +201,25 @@ References connection::fd<
          serverrec::~serverrec serverrec::~serverrec (   )   ) 

          -Destructor. +Destructor.

          -Definition at line 26 of file servers.cpp. +Definition at line 38 of file servers.cpp.

          -

          00027 {
-00028 }
+
          00039 {
+00040 }

          Member Data Documentation

          -

          - +

          +

          - @@ -223,20 +232,20 @@ Definition at line 26 o +Definition at line 61 of file servers.h.
          + -
          char serverrec::description[MAXBUF] + char serverrec::description[MAXBUF]

          -Description of the server. +Description of the server.

          -Definition at line 50 of file servers.h.

          -

          - +

          +

          - @@ -249,22 +258,22 @@ Definition at line 50 of +Referenced by serverrec().
          + -
          int serverrec::hops_away + int serverrec::hops_away

          -number of hops away (for quick access) +number of hops away (for quick access)

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

          -Referenced by serverrec().

          -

          - +

          +

          - @@ -277,22 +286,22 @@ Referenced by serverrec()

          -is a JUPE server (faked to enforce a server ban) +is a JUPE server (faked to enforce a server ban)

          -Definition at line 46 of file servers.h. +Definition at line 57 of file servers.h.

          -Referenced by serverrec(). +Referenced by serverrec().

          + -
          bool serverrec::jupiter + bool serverrec::jupiter
          -

          - +

          +

          - @@ -305,20 +314,50 @@ Referenced by serverrec()

          -server name +server name

          -Definition at line 25 of file servers.h. +Definition at line 36 of file servers.h. +

          +Referenced by serverrec(). + +

          + -
          char serverrec::name[MAXBUF] + char serverrec::name[MAXBUF]
          +

          + + + + +
          + + +
          char serverrec::nickserv[NICKMAX] +
          +
          + + + +
          +   + + +

          +Holds nickserv's name on U:lined (services) servers (this is a kludge for ircservices which ASSUMES things :/). +

          + +

          +Definition at line 65 of file servers.h. +

          +Referenced by serverrec().

          -

          - +

          +

          - @@ -331,22 +370,22 @@ Definition at line 25 of +Referenced by serverrec().
          + -
          long serverrec::opercount + long serverrec::opercount

          -opers on server +opers on server

          -Definition at line 37 of file servers.h. +Definition at line 48 of file servers.h.

          -Referenced by serverrec().

          -

          - +

          +

          - @@ -359,22 +398,22 @@ Referenced by serverrec()

          -last ping response (ms) +last ping response (ms)

          -Definition at line 28 of file servers.h. +Definition at line 39 of file servers.h.

          -Referenced by serverrec(). +Referenced by serverrec().

          + -
          long serverrec::pingtime + long serverrec::pingtime
          -

          - +

          +

          - @@ -389,18 +428,18 @@ Referenced by serverrec()

          -Definition at line 52 of file servers.h. +Definition at line 67 of file servers.h.

          -Referenced by serverrec(). +Referenced by serverrec().

          + -
          bool serverrec::sync_soon + bool serverrec::sync_soon
          -

          - +

          +

          - @@ -413,22 +452,22 @@ Referenced by serverrec()

          -non-invisible users on server +non-invisible users on server

          -Definition at line 34 of file servers.h. +Definition at line 45 of file servers.h.

          -Referenced by serverrec(). +Referenced by serverrec().

          + -
          long serverrec::usercount + long serverrec::usercount
          -

          - +

          +

          - @@ -441,22 +480,22 @@ Referenced by serverrec()

          -invisible users on server +invisible users on server

          -Definition at line 31 of file servers.h. +Definition at line 42 of file servers.h.

          -Referenced by serverrec(). +Referenced by serverrec().

          + -
          long serverrec::usercount_i + long serverrec::usercount_i
          -

          - +

          +

          - @@ -469,20 +508,20 @@ Referenced by serverrec()

          -ircd version +ircd version

          -Definition at line 43 of file servers.h. +Definition at line 54 of file servers.h.

          -Referenced by serverrec(). +Referenced by serverrec().

          + -
          long serverrec::version + long serverrec::version

          The documentation for this class was generated from the following files: -
          Generated on Sun May 2 00:09:44 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/classucrec-members.html b/docs/module-doc/classucrec-members.html index 402e7f606..41b0503d2 100644 --- a/docs/module-doc/classucrec-members.html +++ b/docs/module-doc/classucrec-members.html @@ -1,22 +1,21 @@ -Member List +InspIRCd: Member List - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          ucrec Member List

          This is the complete list of members for ucrec, including all inherited members. - - - - - - - -
          ageclassbase
          channelucrec
          classbase()classbase [inline]
          uc_modesucrec
          ucrec()ucrec [inline]
          ~classbase()classbase [inline]
          ~ucrec()ucrec [inline, virtual]
          Generated on Sun May 2 00:09:45 2004 for InspIRCd by + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          ucrec Member List

          This is the complete list of members for ucrec, including all inherited members. + + + + + + + +
          ageclassbase
          channelucrec
          classbase()classbase [inline]
          uc_modesucrec
          ucrec()ucrec [inline]
          ~classbase()classbase [inline]
          ~ucrec()ucrec [inline, virtual]
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/classucrec.html b/docs/module-doc/classucrec.html index dd419fdc6..d0475a5ba 100644 --- a/docs/module-doc/classucrec.html +++ b/docs/module-doc/classucrec.html @@ -1,54 +1,50 @@ -ucrec class Reference +InspIRCd: ucrec class Reference - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          ucrec Class Reference

          Holds 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. + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          ucrec Class Reference

          Holds 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. More...

          #include <channels.h>

          -Inheritance diagram for ucrec:

          Inheritance graph
          - - - -
          [legend]
          Collaboration diagram for ucrec:

          Collaboration graph
          - - - - -
          [legend]
          List of all members. +Inherits classbase. +

          +List of all members.

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

          Public Member Functions

           ucrec ()
          virtual ~ucrec ()
           ucrec ()
          virtual ~ucrec ()

          Public Attributes

          long uc_modes
           Contains a bitmask of the UCMODE_OP ...

          chanrec * channel
           Points to the channel record where the given modes apply.

          long uc_modes
           Contains a bitmask of the UCMODE_OP ...

          chanrec * channel
           Points to the channel record where the given modes apply.

          Detailed Description

          -Holds 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. +Holds 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.

          The uc_modes member holds a bitmask of which privilages the user has on the channel, such as op, voice, etc.

          -Definition at line 191 of file channels.h.

          Constructor & Destructor Documentation

          +Definition at line 202 of file channels.h.

          Constructor & Destructor Documentation

          - +
          -
          + - - + + @@ -66,22 +62,22 @@ Definition at line 191 o

          -Definition at line 204 of file channels.h. +Definition at line 215 of file channels.h.

          -

          00204 { /* stub */ }
+
          00215 { /* stub */ }
          ucrec::ucrec (   )   )  [inline]

          - +
          -
          + - + - - + + @@ -99,20 +95,20 @@ Definition at line 204 o

          -Definition at line 205 of file channels.h. +Definition at line 216 of file channels.h.

          -

          00205 { /* stub */ }
+
          00216 { /* stub */ }
          virtual ucrec::~ucrec virtual ucrec::~ucrec (   )   )  [inline, virtual]

          Member Data Documentation

          -

          - +

          +

          - @@ -125,22 +121,22 @@ Definition at line 205 o +Referenced by userrec::userrec().
          + -
          chanrec* ucrec::channel + chanrec* ucrec::channel

          -Points to the channel record where the given modes apply. +Points to the channel record where the given modes apply.

          If the record is not in use, this value will be NULL.

          -Definition at line 202 of file channels.h. +Definition at line 213 of file channels.h.

          -Referenced by userrec::userrec().

          -

          - +

          +

          - @@ -153,20 +149,20 @@ Referenced by userrec::userre +Referenced by userrec::userrec().
          + -
          long ucrec::uc_modes + long ucrec::uc_modes

          -Contains a bitmask of the UCMODE_OP ... +Contains a bitmask of the UCMODE_OP ...

          UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.

          -Definition at line 197 of file channels.h. +Definition at line 208 of file channels.h.

          -Referenced by userrec::userrec().

          The documentation for this class was generated from the following file: -
          Generated on Sun May 2 00:09:44 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/classuserrec-members.html b/docs/module-doc/classuserrec-members.html index 0292d02c2..83df506d2 100644 --- a/docs/module-doc/classuserrec-members.html +++ b/docs/module-doc/classuserrec-members.html @@ -1,71 +1,70 @@ -Member List +InspIRCd: Member List - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          userrec Member List

          This is the complete list of members for userrec, including all inherited members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          AddIncoming(int fd, char *targethost, int sourceport)connection
          ageclassbase
          awaymsguserrec
          BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
          bytes_inconnection
          bytes_outconnection
          chansuserrec
          classbase()classbase [inline]
          cmds_inconnection
          cmds_outconnection
          connection()connection
          connectorsconnection
          CreateListener(char *host, int p)connection
          dhostuserrec
          Extend(std::string key, char *p)Extensible
          fdconnection
          FindHost(std::string host)connection
          flooduserrec
          fullnameuserrec
          GenKey()connection
          GetExt(std::string key)Extensible
          GetFullHost()userrec [virtual]
          GetFullRealHost()userrec [virtual]
          haspassedconnection
          HasPermission(char *command)userrec
          hostconnection
          identuserrec
          idle_lastmsgconnection
          inbufconnection
          internal_addrconnection
          internal_portconnection
          invitesuserrec [private]
          InviteTo(char *channel)userrec [virtual]
          ipconnection
          IsInvited(char *channel)userrec [virtual]
          lastpingconnection
          MeshCookie(char *targethost, int port, long cookie, char *servername)connection
          modesuserrec
          nickuserrec
          npingconnection
          operuserrec
          portconnection
          RecvPacket(std::deque< std::string > &messages, char *host)connection
          registeredconnection
          RemoveInvite(char *channel)userrec [virtual]
          resultuserrec
          SendPacket(char *message, const char *host)connection
          serveruserrec
          Shrink(std::string key)Extensible
          signonconnection
          stateconnection
          TerminateLink(char *targethost)connection
          timeoutuserrec
          userrec()userrec
          ~classbase()classbase [inline]
          ~userrec()userrec [inline, virtual]
          Generated on Sun May 2 00:09:45 2004 for InspIRCd by + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          userrec Member List

          This is the complete list of members for userrec, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          AddIncoming(int fd, char *targethost, int sourceport)connection
          ageclassbase
          awaymsguserrec
          BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
          bytes_inconnection
          bytes_outconnection
          chansuserrec
          classbase()classbase [inline]
          cmds_inconnection
          cmds_outconnection
          connection()connection
          connectorsconnection
          CreateListener(char *host, int p)connection
          dhostuserrec
          Extend(std::string key, char *p)Extensible
          fdconnection
          FindHost(std::string host)connection
          flooduserrec
          fullnameuserrec
          GenKey()connection
          GetExt(std::string key)Extensible
          GetFullHost()userrec [virtual]
          GetFullRealHost()userrec [virtual]
          haspassedconnection
          HasPermission(char *command)userrec
          hostconnection
          identuserrec
          idle_lastmsgconnection
          inbufconnection
          internal_addrconnection
          internal_portconnection
          invitesuserrec [private]
          InviteTo(char *channel)userrec [virtual]
          ipconnection
          IsInvited(char *channel)userrec [virtual]
          lastpingconnection
          MeshCookie(char *targethost, int port, long cookie, char *servername)connection
          modesuserrec
          nickuserrec
          npingconnection
          operuserrec
          portconnection
          RecvPacket(std::deque< std::string > &messages, char *host)connection
          registeredconnection
          RemoveInvite(char *channel)userrec [virtual]
          resultuserrec
          SendPacket(char *message, const char *host)connection
          serveruserrec
          Shrink(std::string key)Extensible
          signonconnection
          stateconnection
          TerminateLink(char *targethost)connection
          timeoutuserrec
          userrec()userrec
          ~classbase()classbase [inline]
          ~userrec()userrec [inline, virtual]
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 661dd1b7e..7f5755497 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -1,90 +1,101 @@ -userrec class Reference +InspIRCd: userrec class Reference - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          userrec Class Reference

          Holds all information about a user This class stores all information about a user connected to the irc server. + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          userrec Class Reference

          Holds all information about a user This class stores all information about a user connected to the irc server. More...

          #include <users.h>

          -Inheritance diagram for userrec:

          Inheritance graph
          - - - - - -
          [legend]
          Collaboration diagram for userrec:

          Collaboration graph
          - - - - -
          [legend]
          List of all members. +Inherits connection. +

          +List of all members.

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

          Public Member Functions

           userrec ()
          virtual ~userrec ()
          virtual char * GetFullHost ()
           Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

          virtual char * GetFullRealHost ()
           Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

          virtual bool IsInvited (char *channel)
           Returns true if a user is invited to a channel.

          virtual void InviteTo (char *channel)
           Adds a channel to a users invite list (invites them to a channel).

          virtual void RemoveInvite (char *channel)
           Removes a channel from a users invite list.

          bool HasPermission (char *command)
           Returns true or false for if a user can execute a privilaged oper command.

           userrec ()
          virtual ~userrec ()
          virtual char * GetFullHost ()
           Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

          virtual char * GetFullRealHost ()
           Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

          virtual bool IsInvited (char *channel)
           Returns true if a user is invited to a channel.

          virtual void InviteTo (char *channel)
           Adds a channel to a users invite list (invites them to a channel).

          virtual void RemoveInvite (char *channel)
           Removes a channel from a users invite list.

          bool HasPermission (char *command)
           Returns true or false for if a user can execute a privilaged oper command.


          Public Attributes

          char nick [NICKMAX]
           The users nickname.

          char ident [64]
           The users ident reply.

          char dhost [256]
           The host displayed to non-opers (used for cloaking etc).

          char fullname [128]
           The users full name.

          char modes [MAXBUF]
           The user's mode string.

          ucrec chans [MAXCHANS]
          char server [256]
           The server the user is connected to.

          char awaymsg [512]
           The user's away message.

          char result [256]
           Stores the result of the last GetFullHost or GetRealHost call.

          int flood
           Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.

          unsigned long timeout
           Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.

          char oper [NICKMAX]
           The oper type they logged in as, if they are an oper.

          char nick [NICKMAX]
           The users nickname.

          char ident [64]
           The users ident reply.

          char dhost [256]
           The host displayed to non-opers (used for cloaking etc).

          char fullname [128]
           The users full name.

          char modes [MAXBUF]
           The user's mode string.

          ucrec chans [MAXCHANS]
          char server [256]
           The server the user is connected to.

          char awaymsg [512]
           The user's away message.

          char result [256]
           Stores the result of the last GetFullHost or GetRealHost call.

          int flood
           Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.

          unsigned long timeout
           Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.

          char oper [NICKMAX]
           The oper type they logged in as, if they are an oper.


          Private Attributes

          InvitedList invites
           A list of channels the user has a pending invite to.

          InvitedList invites
           A list of channels the user has a pending invite to.

          Detailed Description

          -Holds all information about a user This class stores all information about a user connected to the irc server. +Holds all information about a user This class stores all information about a user connected to the irc server.

          Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname.

          -Definition at line 78 of file users.h.

          Constructor & Destructor Documentation

          +Definition at line 89 of file users.h.

          Constructor & Destructor Documentation

          - +
          -
          + - - + + @@ -102,47 +113,47 @@ Definition at line 78 of fi

          -Definition at line 13 of file users.cpp. +Definition at line 25 of file users.cpp.

          -References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, flood, connection::haspassed, connection::idle_lastmsg, invites, connection::lastping, connection::nping, connection::port, connection::registered, connection::signon, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes.

          -

          00014 {
-00015         // the PROPER way to do it, AVOID bzero at *ALL* costs
-00016         strcpy(nick,"");
-00017         strcpy(ip,"127.0.0.1");
-00018         timeout = 0;
-00019         strcpy(ident,"");
-00020         strcpy(host,"");
-00021         strcpy(dhost,"");
-00022         strcpy(fullname,"");
-00023         strcpy(modes,"");
-00024         strcpy(inbuf,"");
-00025         strcpy(server,"");
-00026         strcpy(awaymsg,"");
-00027         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00028         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00029         haspassed = false;
-00030         strcpy(result,"");
-00031         for (int i = 0; i < MAXCHANS; i++)
-00032         {
-00033                 this->chans[i].channel = NULL;
-00034                 this->chans[i].uc_modes = 0;
-00035         }
-00036         invites.clear();
-00037 }
+
          00026 {
+00027         // the PROPER way to do it, AVOID bzero at *ALL* costs
+00028         strcpy(nick,"");
+00029         strcpy(ip,"127.0.0.1");
+00030         timeout = 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         flood = 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                 this->chans[i].channel = NULL;
+00046                 this->chans[i].uc_modes = 0;
+00047         }
+00048         invites.clear();
+00049 }
          userrec::userrec (   )   ) 

          - +
          -
          + - + - - + + @@ -160,23 +171,23 @@ References connection::byt

          -Definition at line 149 of file users.h. +Definition at line 160 of file users.h.

          -

          00149 {  }
+
          00160 {  }
          virtual userrec::~userrec virtual userrec::~userrec (   )   )  [inline, virtual]

          Member Function Documentation

          - +
          -
          + - - + + @@ -192,31 +203,31 @@ Definition at line 149 of f
          char * userrec::GetFullHost (   )   )  [virtual]

          -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

          -Definition at line 41 of file users.cpp. +Definition at line 53 of file users.cpp.

          -References result. +References dhost, ident, nick, and result.

          -

          00042 {
-00043         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00044         return result;
-00045 }
+
          00054 {
+00055         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00056         return result;
+00057 }

          - +
          -
          + - - + + @@ -232,32 +243,32 @@ References result.
          char * userrec::GetFullRealHost (   )   )  [virtual]

          -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

          If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.

          -Definition at line 48 of file users.cpp. +Definition at line 60 of file users.cpp.

          -References result. +References connection::host, ident, nick, and result.

          -

          00049 {
-00050         sprintf(result,"%s!%s@%s",nick,ident,host);
-00051         return result;
-00052 }
+
          00061 {
+00062         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00063         return result;
+00064 }

          - +
          -
          + - - + + @@ -273,76 +284,78 @@ References result.
          bool userrec::HasPermission (  char *   command )  command  ) 

          -Returns true or false for if a user can execute a privilaged oper command. -

          -This is done by looking up their oper type from userrec::oper, then referencing this to their oper classes and checking the commands they can execute. -

          -Definition at line 97 of file users.cpp. -

          -

          00098 {
-00099         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
-00100         char* myclass;
-00101         char* mycmd;
-00102         char* savept;
-00103         char* savept2;
-00104         
-00105         // are they even an oper at all?
-00106         if (strchr(this->modes,'o'))
-00107         {
-00108                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
-00109                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
-00110                 {
-00111                         ConfValue("type","name",j,TypeName,&config_f);
-00112                         if (!strcmp(TypeName,this->oper))
-00113                         {
-00114                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
-00115                                 ConfValue("type","classes",j,Classes,&config_f);
-00116                                 char* myclass = strtok_r(Classes," ",&savept);
-00117                                 while (myclass)
-00118                                 {
-00119                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
-00120                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
-00121                                         {
-00122                                                 ConfValue("class","name",k,ClassName,&config_f);
-00123                                                 if (!strcmp(ClassName,myclass))
-00124                                                 {
-00125                                                         ConfValue("class","commands",k,CommandList,&config_f);
-00126                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
-00127                                                         
-00128                                                         
-00129                                                         mycmd = strtok_r(CommandList," ",&savept2);
-00130                                                         while (mycmd)
-00131                                                         {
-00132                                                                 if (!strcasecmp(mycmd,command))
-00133                                                                 {
-00134                                                                         log(DEBUG,"*** Command %s found, returning true",command);
-00135                                                                         return true;
-00136                                                                 }
-00137                                                                 mycmd = strtok_r(NULL," ",&savept2);
-00138                                                         }
-00139                                                 }
-00140                                         }
-00141                                         myclass = strtok_r(NULL," ",&savept);
-00142                                 }
-00143                         }
-00144                 }
-00145         }
-00146         return false;
-00147 }
+Returns true or false for if a user can execute a privilaged oper command. 
+
          
+This is done by looking up their oper type from userrec::oper, then referencing this to their oper classes and checking the commands they can execute.
+
          
+Definition at line 109 of file users.cpp.
+
          
+References config_f, and DEBUG.
+
          
+
          00110 {
+00111         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
+00112         char* myclass;
+00113         char* mycmd;
+00114         char* savept;
+00115         char* savept2;
+00116         
+00117         // are they even an oper at all?
+00118         if (strchr(this->modes,'o'))
+00119         {
+00120                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
+00121                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
+00122                 {
+00123                         ConfValue("type","name",j,TypeName,&config_f);
+00124                         if (!strcmp(TypeName,this->oper))
+00125                         {
+00126                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
+00127                                 ConfValue("type","classes",j,Classes,&config_f);
+00128                                 char* myclass = strtok_r(Classes," ",&savept);
+00129                                 while (myclass)
+00130                                 {
+00131                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
+00132                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
+00133                                         {
+00134                                                 ConfValue("class","name",k,ClassName,&config_f);
+00135                                                 if (!strcmp(ClassName,myclass))
+00136                                                 {
+00137                                                         ConfValue("class","commands",k,CommandList,&config_f);
+00138                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
+00139                                                         
+00140                                                         
+00141                                                         mycmd = strtok_r(CommandList," ",&savept2);
+00142                                                         while (mycmd)
+00143                                                         {
+00144                                                                 if (!strcasecmp(mycmd,command))
+00145                                                                 {
+00146                                                                         log(DEBUG,"*** Command %s found, returning true",command);
+00147                                                                         return true;
+00148                                                                 }
+00149                                                                 mycmd = strtok_r(NULL," ",&savept2);
+00150                                                         }
+00151                                                 }
+00152                                         }
+00153                                         myclass = strtok_r(NULL," ",&savept);
+00154                                 }
+00155                         }
+00156                 }
+00157         }
+00158         return false;
+00159 }

          - +
          -
          + - - + + @@ -358,33 +371,33 @@ Definition at line 97 of
          void userrec::InviteTo (  char *   channel )  channel  )  [virtual]

          -Adds a channel to a users invite list (invites them to a channel). +Adds a channel to a users invite list (invites them to a channel).

          -Definition at line 68 of file users.cpp. +Definition at line 80 of file users.cpp.

          -References Invited::channel, and invites. +References Invited::channel, and invites.

          -

          00069 {
-00070         Invited i;
-00071         strcpy(i.channel,channel);
-00072         invites.push_back(i);
-00073 }
+
          00081 {
+00082         Invited i;
+00083         strlcpy(i.channel,channel,CHANMAX);
+00084         invites.push_back(i);
+00085 }

          - +
          -
          + - - + + @@ -400,40 +413,40 @@ References Invited::channel
          bool userrec::IsInvited (  char *   channel )  channel  )  [virtual]

          -Returns true if a user is invited to a channel. +Returns true if a user is invited to a channel.

          -Definition at line 54 of file users.cpp. +Definition at line 66 of file users.cpp.

          -References invites. +References invites.

          -

          00055 {
-00056         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00057         {
-00058                 if (i->channel) {
-00059                         if (!strcasecmp(i->channel,channel))
-00060                         {
-00061                                 return true;
-00062                         }
-00063                 }
-00064         }
-00065         return false;
-00066 }
+
          00067 {
+00068         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00069         {
+00070                 if (i->channel) {
+00071                         if (!strcasecmp(i->channel,channel))
+00072                         {
+00073                                 return true;
+00074                         }
+00075                 }
+00076         }
+00077         return false;
+00078 }

          - +
          -
          + - - + + @@ -449,45 +462,45 @@ References invites.
          void userrec::RemoveInvite (  char *   channel )  channel  )  [virtual]

          -Removes a channel from a users invite list. +Removes a channel from a users invite list.

          This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.

          -Definition at line 75 of file users.cpp. -

          -References invites. -

          -

          00076 {
-00077         log(DEBUG,"Removing invites");
-00078         if (channel)
-00079         {
-00080                 if (invites.size())
-00081                 {
-00082                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00083                         {
-00084                                 if (i->channel)
-00085                                 {
-00086                                         if (!strcasecmp(i->channel,channel))
-00087                                         {
-00088                                                 invites.erase(i);
-00089                                                 return;
-00090                                         }
-00091                                 }
-00092                         }
-00093                 }
-00094         }
-00095 }
+Definition at line 87 of file users.cpp.
+
          
+References DEBUG, and invites.
+
          
+
          00088 {
+00089         log(DEBUG,"Removing invites");
+00090         if (channel)
+00091         {
+00092                 if (invites.size())
+00093                 {
+00094                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00095                         {
+00096                                 if (i->channel)
+00097                                 {
+00098                                         if (!strcasecmp(i->channel,channel))
+00099                                         {
+00100                                                 invites.erase(i);
+00101                                                 return;
+00102                                         }
+00103                                 }
+00104                         }
+00105                 }
+00106         }
+00107 }

          Member Data Documentation

          -

          - +

          +

          - @@ -500,20 +513,22 @@ References invites. +Definition at line 132 of file users.h. +

          +Referenced by userrec().

          + -
          char userrec::awaymsg[512] + char userrec::awaymsg[512]

          -The user's away message. +The user's away message.

          If this string is empty, the user is not marked as away.

          -Definition at line 121 of file users.h.

          -

          - +

          +

          - @@ -528,18 +543,18 @@ Definition at line 121 of f

          -Definition at line 112 of file users.h. +Definition at line 123 of file users.h.

          -Referenced by userrec(). +Referenced by userrec().

          + -
          ucrec userrec::chans[MAXCHANS] + ucrec userrec::chans[MAXCHANS]
          -

          - +

          +

          - @@ -552,20 +567,22 @@ Referenced by userrec(). +Referenced by GetFullHost(), and userrec().
          + -
          char userrec::dhost[256] + char userrec::dhost[256]

          -The host displayed to non-opers (used for cloaking etc). +The host displayed to non-opers (used for cloaking etc). +

          +This usually matches the value of userrec::host.

          -This usually matches the value of userrec::host. +Definition at line 111 of file users.h.

          -Definition at line 100 of file users.h.

          -

          - +

          +

          - @@ -578,22 +595,22 @@ Definition at line 100 of f +Referenced by userrec().
          + -
          int userrec::flood + int userrec::flood

          -Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. +Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.

          -Definition at line 132 of file users.h. +Definition at line 143 of file users.h.

          -Referenced by userrec().

          -

          - +

          +

          - @@ -606,20 +623,22 @@ Referenced by userrec(). +Definition at line 115 of file users.h. +

          +Referenced by userrec().

          + -
          char userrec::fullname[128] + char userrec::fullname[128]

          -The users full name. +The users full name.

          -Definition at line 104 of file users.h.

          -

          - +

          +

          - @@ -632,20 +651,22 @@ Definition at line 104 of f +Definition at line 106 of file users.h. +

          +Referenced by GetFullHost(), GetFullRealHost(), and userrec().

          + -
          char userrec::ident[64] + char userrec::ident[64]

          -The users ident reply. +The users ident reply.

          -Definition at line 95 of file users.h.

          -

          - +

          +

          - @@ -658,22 +679,22 @@ Definition at line 95 of fi +Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().
          + -
          InvitedList userrec::invites [private] + InvitedList userrec::invites [private]

          -A list of channels the user has a pending invite to. +A list of channels the user has a pending invite to.

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

          -Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().

          -

          - +

          +

          - @@ -686,20 +707,22 @@ Referenced by InviteTo(), +Definition at line 121 of file users.h. +

          +Referenced by userrec().

          + -
          char userrec::modes[MAXBUF] + char userrec::modes[MAXBUF]

          -The user's mode string. +The user's mode string.

          This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.

          -Definition at line 110 of file users.h.

          -

          - +

          +

          - @@ -712,22 +735,22 @@ Definition at line 110 of f +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::QuitUser(), and userrec().
          + -
          char userrec::nick[NICKMAX] + char userrec::nick[NICKMAX]

          -The users nickname. +The users nickname.

          An invalid nickname indicates an unregistered connection prior to the NICK command.

          -Definition at line 91 of file users.h. +Definition at line 102 of file users.h.

          -Referenced by Server::QuitUser().

          -

          - +

          +

          - @@ -740,20 +763,20 @@ Referenced by Server::QuitU +Definition at line 156 of file users.h.
          + -
          char userrec::oper[NICKMAX] + char userrec::oper[NICKMAX]

          -The oper type they logged in as, if they are an oper. +The oper type they logged in as, if they are an oper.

          This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.

          -Definition at line 145 of file users.h.

          -

          - +

          +

          - @@ -766,22 +789,22 @@ Definition at line 145 of f +Referenced by GetFullHost(), GetFullRealHost(), and userrec().
          + -
          char userrec::result[256] + char userrec::result[256]

          -Stores the result of the last GetFullHost or GetRealHost call. +Stores the result of the last GetFullHost or GetRealHost call.

          You may use this to increase the speed of use of this class.

          -Definition at line 126 of file users.h. +Definition at line 137 of file users.h.

          -Referenced by GetFullHost(), and GetFullRealHost().

          -

          - +

          +

          - @@ -794,20 +817,22 @@ Referenced by GetFullHost()

          -The server the user is connected to. +The server the user is connected to.

          -Definition at line 116 of file users.h. +Definition at line 127 of file users.h. +

          +Referenced by userrec().

          + -
          char userrec::server[256] + char userrec::server[256]
          -

          - +

          +

          - @@ -820,20 +845,20 @@ Definition at line 116 of f +Referenced by userrec().
          + -
          unsigned long userrec::timeout + unsigned long userrec::timeout

          -Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. +Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.

          -Definition at line 138 of file users.h. +Definition at line 149 of file users.h.

          -Referenced by userrec().

          The documentation for this class was generated from the following files: -
          Generated on Sun May 2 00:09:45 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/commands_8h-source.html b/docs/module-doc/commands_8h-source.html index d1e6d5017..0f09a8152 100644 --- a/docs/module-doc/commands_8h-source.html +++ b/docs/module-doc/commands_8h-source.html @@ -1,106 +1,121 @@ -commands.h Source File +InspIRCd: commands.h Source File - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          commands.h

          Go to the documentation of this file.
          00001 #ifndef __COMMANDS_H
-00002 #define __COMMANDS_H
-00003 
-00004 // include the common header files
-00005 
-00006 #include <typeinfo>
-00007 #include <iostream>
-00008 #include <string>
-00009 #include <deque>
-00010 #include <sstream>
-00011 #include <vector>
-00012 #include "users.h"
-00013 #include "channels.h"
-00014 
-00015 
-00018 void handle_join(char **parameters, int pcnt, userrec *user);
-00019 void handle_part(char **parameters, int pcnt, userrec *user);
-00020 void handle_kick(char **parameters, int pcnt, userrec *user);
-00021 void handle_die(char **parameters, int pcnt, userrec *user);
-00022 void handle_restart(char **parameters, int pcnt, userrec *user);
-00023 void handle_kill(char **parameters, int pcnt, userrec *user);
-00024 void handle_summon(char **parameters, int pcnt, userrec *user);
-00025 void handle_users(char **parameters, int pcnt, userrec *user);
-00026 void handle_pass(char **parameters, int pcnt, userrec *user);
-00027 void handle_invite(char **parameters, int pcnt, userrec *user);
-00028 void handle_topic(char **parameters, int pcnt, userrec *user);
-00029 void handle_names(char **parameters, int pcnt, userrec *user);
-00030 void handle_privmsg(char **parameters, int pcnt, userrec *user);
-00031 void handle_notice(char **parameters, int pcnt, userrec *user);
-00032 void handle_info(char **parameters, int pcnt, userrec *user);
-00033 void handle_time(char **parameters, int pcnt, userrec *user);
-00034 void handle_whois(char **parameters, int pcnt, userrec *user);
-00035 void handle_quit(char **parameters, int pcnt, userrec *user);
-00036 void handle_who(char **parameters, int pcnt, userrec *user);
-00037 void handle_wallops(char **parameters, int pcnt, userrec *user);
-00038 void handle_list(char **parameters, int pcnt, userrec *user);
-00039 void handle_rehash(char **parameters, int pcnt, userrec *user);
-00040 void handle_lusers(char **parameters, int pcnt, userrec *user);
-00041 void handle_admin(char **parameters, int pcnt, userrec *user);
-00042 void handle_ping(char **parameters, int pcnt, userrec *user);
-00043 void handle_pong(char **parameters, int pcnt, userrec *user);
-00044 void handle_motd(char **parameters, int pcnt, userrec *user);
-00045 void handle_rules(char **parameters, int pcnt, userrec *user);
-00046 void handle_user(char **parameters, int pcnt, userrec *user);
-00047 void handle_userhost(char **parameters, int pcnt, userrec *user);
-00048 void handle_ison(char **parameters, int pcnt, userrec *user);
-00049 void handle_away(char **parameters, int pcnt, userrec *user);
-00050 void handle_whowas(char **parameters, int pcnt, userrec *user);
-00051 void handle_trace(char **parameters, int pcnt, userrec *user);
-00052 void handle_modules(char **parameters, int pcnt, userrec *user);
-00053 void handle_stats(char **parameters, int pcnt, userrec *user);
-00054 void handle_connect(char **parameters, int pcnt, userrec *user);
-00055 void handle_squit(char **parameters, int pcnt, userrec *user);
-00056 void handle_links(char **parameters, int pcnt, userrec *user);
-00057 void handle_map(char **parameters, int pcnt, userrec *user);
-00058 void handle_oper(char **parameters, int pcnt, userrec *user);
-00059 void handle_nick(char **parameters, int pcnt, userrec *user);
-00060 void handle_kline(char **parameters, int pcnt, userrec *user);
-00061 void handle_gline(char **parameters, int pcnt, userrec *user);
-00062 void handle_zline(char **parameters, int pcnt, userrec *user);
-00063 void handle_qline(char **parameters, int pcnt, userrec *user);
-00064 void handle_server(char **parameters, int pcnt, userrec *user);
-00065 
-00068 void handle_link_packet(char* udp_msg, char* tcp_host, serverrec *serv);
-00069 void process_restricted_commands(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host,char* ipaddr,int port);
-00070 
-00073 void handle_amp(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00074 void handle_dollar(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00075 void handle_J(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00076 void handle_R(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00077 void handle_plus(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00078 void handle_b(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00079 void handle_a(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00080 void handle_F(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00081 void handle_N(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00082 void handle_AT(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00083 void handle_k(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00084 void handle_n(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00085 void handle_Q(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00086 void handle_K(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00087 void handle_L(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00088 void handle_m(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00089 void handle_M(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00090 void handle_T(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00091 void handle_t(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00092 void handle_i(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00093 void handle_P(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00094 void handle_V(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
-00095 
-00098 bool is_uline(const char* server);
-00099 
-00100 #endif
-
          Generated on Sun May 2 00:09:18 2004 for InspIRCd by + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          commands.h

          Go to the documentation of this file.
          00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #ifndef __COMMANDS_H
+00018 #define __COMMANDS_H
+00019 
+00020 // include the common header files
+00021 
+00022 #include <typeinfo>
+00023 #include <iostream>
+00024 #include <string>
+00025 #include <deque>
+00026 #include <sstream>
+00027 #include <vector>
+00028 #include "users.h"
+00029 #include "channels.h"
+00030 
+00031 
+00034 void handle_join(char **parameters, int pcnt, userrec *user);
+00035 void handle_part(char **parameters, int pcnt, userrec *user);
+00036 void handle_kick(char **parameters, int pcnt, userrec *user);
+00037 void handle_die(char **parameters, int pcnt, userrec *user);
+00038 void handle_restart(char **parameters, int pcnt, userrec *user);
+00039 void handle_kill(char **parameters, int pcnt, userrec *user);
+00040 void handle_summon(char **parameters, int pcnt, userrec *user);
+00041 void handle_users(char **parameters, int pcnt, userrec *user);
+00042 void handle_pass(char **parameters, int pcnt, userrec *user);
+00043 void handle_invite(char **parameters, int pcnt, userrec *user);
+00044 void handle_topic(char **parameters, int pcnt, userrec *user);
+00045 void handle_names(char **parameters, int pcnt, userrec *user);
+00046 void handle_privmsg(char **parameters, int pcnt, userrec *user);
+00047 void handle_notice(char **parameters, int pcnt, userrec *user);
+00048 void handle_info(char **parameters, int pcnt, userrec *user);
+00049 void handle_time(char **parameters, int pcnt, userrec *user);
+00050 void handle_whois(char **parameters, int pcnt, userrec *user);
+00051 void handle_quit(char **parameters, int pcnt, userrec *user);
+00052 void handle_who(char **parameters, int pcnt, userrec *user);
+00053 void handle_wallops(char **parameters, int pcnt, userrec *user);
+00054 void handle_list(char **parameters, int pcnt, userrec *user);
+00055 void handle_rehash(char **parameters, int pcnt, userrec *user);
+00056 void handle_lusers(char **parameters, int pcnt, userrec *user);
+00057 void handle_admin(char **parameters, int pcnt, userrec *user);
+00058 void handle_ping(char **parameters, int pcnt, userrec *user);
+00059 void handle_pong(char **parameters, int pcnt, userrec *user);
+00060 void handle_motd(char **parameters, int pcnt, userrec *user);
+00061 void handle_rules(char **parameters, int pcnt, userrec *user);
+00062 void handle_user(char **parameters, int pcnt, userrec *user);
+00063 void handle_userhost(char **parameters, int pcnt, userrec *user);
+00064 void handle_ison(char **parameters, int pcnt, userrec *user);
+00065 void handle_away(char **parameters, int pcnt, userrec *user);
+00066 void handle_whowas(char **parameters, int pcnt, userrec *user);
+00067 void handle_trace(char **parameters, int pcnt, userrec *user);
+00068 void handle_modules(char **parameters, int pcnt, userrec *user);
+00069 void handle_stats(char **parameters, int pcnt, userrec *user);
+00070 void handle_connect(char **parameters, int pcnt, userrec *user);
+00071 void handle_squit(char **parameters, int pcnt, userrec *user);
+00072 void handle_links(char **parameters, int pcnt, userrec *user);
+00073 void handle_map(char **parameters, int pcnt, userrec *user);
+00074 void handle_oper(char **parameters, int pcnt, userrec *user);
+00075 void handle_nick(char **parameters, int pcnt, userrec *user);
+00076 void handle_kline(char **parameters, int pcnt, userrec *user);
+00077 void handle_gline(char **parameters, int pcnt, userrec *user);
+00078 void handle_zline(char **parameters, int pcnt, userrec *user);
+00079 void handle_qline(char **parameters, int pcnt, userrec *user);
+00080 void handle_server(char **parameters, int pcnt, userrec *user);
+00081 
+00084 void handle_link_packet(char* udp_msg, char* tcp_host, serverrec *serv);
+00085 void process_restricted_commands(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host,char* ipaddr,int port);
+00086 
+00089 void handle_amp(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00090 void handle_dollar(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00091 void handle_J(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00092 void handle_R(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00093 void handle_plus(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00094 void handle_b(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00095 void handle_a(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00096 void handle_F(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00097 void handle_N(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00098 void handle_AT(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00099 void handle_k(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00100 void handle_n(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00101 void handle_Q(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00102 void handle_K(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00103 void handle_L(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00104 void handle_m(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00105 void handle_M(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00106 void handle_T(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00107 void handle_t(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00108 void handle_i(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00109 void handle_P(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00110 void handle_V(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host);
+00111 
+00114 bool is_uline(const char* server);
+00115 
+00116 #endif
+
          Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/commands_8h.html b/docs/module-doc/commands_8h.html index e4859892f..0896615b4 100644 --- a/docs/module-doc/commands_8h.html +++ b/docs/module-doc/commands_8h.html @@ -1,12 +1,11 @@ -commands.h File Reference +InspIRCd: commands.h File Reference - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          commands.h File Reference

          #include <typeinfo>
          + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          commands.h File Reference

          #include <typeinfo>
          #include <iostream>
          #include <string>
          #include <deque>
          @@ -15,136 +14,194 @@ #include "users.h"
          #include "channels.h"
          -

          -Include dependency graph for commands.h:

          Include dependency graph
          - - - - - - -

          -This graph shows which files directly or indirectly include this file:

          Included by dependency graph
          - - - -

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

          Functions

          void handle_join (char **parameters, int pcnt, userrec *user)
           These are the handlers for user commands.

          void handle_part (char **parameters, int pcnt, userrec *user)
          void handle_kick (char **parameters, int pcnt, userrec *user)
          void handle_die (char **parameters, int pcnt, userrec *user)
          void handle_restart (char **parameters, int pcnt, userrec *user)
          void handle_kill (char **parameters, int pcnt, userrec *user)
          void handle_summon (char **parameters, int pcnt, userrec *user)
          void handle_users (char **parameters, int pcnt, userrec *user)
          void handle_pass (char **parameters, int pcnt, userrec *user)
          void handle_invite (char **parameters, int pcnt, userrec *user)
          void handle_topic (char **parameters, int pcnt, userrec *user)
          void handle_names (char **parameters, int pcnt, userrec *user)
          void handle_privmsg (char **parameters, int pcnt, userrec *user)
          void handle_notice (char **parameters, int pcnt, userrec *user)
          void handle_info (char **parameters, int pcnt, userrec *user)
          void handle_time (char **parameters, int pcnt, userrec *user)
          void handle_whois (char **parameters, int pcnt, userrec *user)
          void handle_quit (char **parameters, int pcnt, userrec *user)
          void handle_who (char **parameters, int pcnt, userrec *user)
          void handle_wallops (char **parameters, int pcnt, userrec *user)
          void handle_list (char **parameters, int pcnt, userrec *user)
          void handle_rehash (char **parameters, int pcnt, userrec *user)
          void handle_lusers (char **parameters, int pcnt, userrec *user)
          void handle_admin (char **parameters, int pcnt, userrec *user)
          void handle_ping (char **parameters, int pcnt, userrec *user)
          void handle_pong (char **parameters, int pcnt, userrec *user)
          void handle_motd (char **parameters, int pcnt, userrec *user)
          void handle_rules (char **parameters, int pcnt, userrec *user)
          void handle_user (char **parameters, int pcnt, userrec *user)
          void handle_userhost (char **parameters, int pcnt, userrec *user)
          void handle_ison (char **parameters, int pcnt, userrec *user)
          void handle_away (char **parameters, int pcnt, userrec *user)
          void handle_whowas (char **parameters, int pcnt, userrec *user)
          void handle_trace (char **parameters, int pcnt, userrec *user)
          void handle_modules (char **parameters, int pcnt, userrec *user)
          void handle_stats (char **parameters, int pcnt, userrec *user)
          void handle_connect (char **parameters, int pcnt, userrec *user)
          void handle_squit (char **parameters, int pcnt, userrec *user)
          void handle_links (char **parameters, int pcnt, userrec *user)
          void handle_map (char **parameters, int pcnt, userrec *user)
          void handle_oper (char **parameters, int pcnt, userrec *user)
          void handle_nick (char **parameters, int pcnt, userrec *user)
          void handle_kline (char **parameters, int pcnt, userrec *user)
          void handle_gline (char **parameters, int pcnt, userrec *user)
          void handle_zline (char **parameters, int pcnt, userrec *user)
          void handle_qline (char **parameters, int pcnt, userrec *user)
          void handle_server (char **parameters, int pcnt, userrec *user)
          void handle_link_packet (char *udp_msg, char *tcp_host, serverrec *serv)
           Special functions for processing server to server traffic.

          void process_restricted_commands (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host, char *ipaddr, int port)
          void handle_amp (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
           These are the handlers for server commands (tokens).

          void handle_dollar (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_J (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_R (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_plus (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_b (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_a (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_F (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_N (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_AT (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_k (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_n (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_Q (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_K (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_L (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_m (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_M (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_T (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_t (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_i (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_P (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_V (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          bool is_uline (const char *server)
           Functions for u:lined servers.

          void handle_join (char **parameters, int pcnt, userrec *user)
           These are the handlers for user commands.

          void handle_part (char **parameters, int pcnt, userrec *user)
          void handle_kick (char **parameters, int pcnt, userrec *user)
          void handle_die (char **parameters, int pcnt, userrec *user)
          void handle_restart (char **parameters, int pcnt, userrec *user)
          void handle_kill (char **parameters, int pcnt, userrec *user)
          void handle_summon (char **parameters, int pcnt, userrec *user)
          void handle_users (char **parameters, int pcnt, userrec *user)
          void handle_pass (char **parameters, int pcnt, userrec *user)
          void handle_invite (char **parameters, int pcnt, userrec *user)
          void handle_topic (char **parameters, int pcnt, userrec *user)
          void handle_names (char **parameters, int pcnt, userrec *user)
          void handle_privmsg (char **parameters, int pcnt, userrec *user)
          void handle_notice (char **parameters, int pcnt, userrec *user)
          void handle_info (char **parameters, int pcnt, userrec *user)
          void handle_time (char **parameters, int pcnt, userrec *user)
          void handle_whois (char **parameters, int pcnt, userrec *user)
          void handle_quit (char **parameters, int pcnt, userrec *user)
          void handle_who (char **parameters, int pcnt, userrec *user)
          void handle_wallops (char **parameters, int pcnt, userrec *user)
          void handle_list (char **parameters, int pcnt, userrec *user)
          void handle_rehash (char **parameters, int pcnt, userrec *user)
          void handle_lusers (char **parameters, int pcnt, userrec *user)
          void handle_admin (char **parameters, int pcnt, userrec *user)
          void handle_ping (char **parameters, int pcnt, userrec *user)
          void handle_pong (char **parameters, int pcnt, userrec *user)
          void handle_motd (char **parameters, int pcnt, userrec *user)
          void handle_rules (char **parameters, int pcnt, userrec *user)
          void handle_user (char **parameters, int pcnt, userrec *user)
          void handle_userhost (char **parameters, int pcnt, userrec *user)
          void handle_ison (char **parameters, int pcnt, userrec *user)
          void handle_away (char **parameters, int pcnt, userrec *user)
          void handle_whowas (char **parameters, int pcnt, userrec *user)
          void handle_trace (char **parameters, int pcnt, userrec *user)
          void handle_modules (char **parameters, int pcnt, userrec *user)
          void handle_stats (char **parameters, int pcnt, userrec *user)
          void handle_connect (char **parameters, int pcnt, userrec *user)
          void handle_squit (char **parameters, int pcnt, userrec *user)
          void handle_links (char **parameters, int pcnt, userrec *user)
          void handle_map (char **parameters, int pcnt, userrec *user)
          void handle_oper (char **parameters, int pcnt, userrec *user)
          void handle_nick (char **parameters, int pcnt, userrec *user)
          void handle_kline (char **parameters, int pcnt, userrec *user)
          void handle_gline (char **parameters, int pcnt, userrec *user)
          void handle_zline (char **parameters, int pcnt, userrec *user)
          void handle_qline (char **parameters, int pcnt, userrec *user)
          void handle_server (char **parameters, int pcnt, userrec *user)
          void handle_link_packet (char *udp_msg, char *tcp_host, serverrec *serv)
           Special functions for processing server to server traffic.

          void process_restricted_commands (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host, char *ipaddr, int port)
          void handle_amp (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
           These are the handlers for server commands (tokens).

          void handle_dollar (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_J (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_R (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_plus (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_b (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_a (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_F (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_N (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_AT (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_k (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_n (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_Q (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_K (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_L (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_m (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_M (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_T (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_t (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_i (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_P (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          void handle_V (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host)
          bool is_uline (const char *server)
           Functions for u:lined servers.

          Function Documentation

          - +
          -
          + - + - + - + - + - + @@ -168,27 +225,27 @@ This graph shows which files directly or indirectly include this file:

          void handle_a (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -212,39 +269,39 @@ This graph shows which files directly or indirectly include this file:

          void handle_admin (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -264,45 +321,45 @@ This graph shows which files directly or indirectly include this file:

          -These are the handlers for server commands (tokens). +These are the handlers for server commands (tokens).

          void handle_amp (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + - + - + @@ -326,27 +383,27 @@ These are the handlers for server commands (tokens).
          void handle_AT (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -370,39 +427,39 @@ These are the handlers for server commands (tokens).
          void handle_away (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -426,27 +483,27 @@ These are the handlers for server commands (tokens).
          void handle_b (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -470,27 +527,27 @@ These are the handlers for server commands (tokens).
          void handle_connect (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -514,39 +571,39 @@ These are the handlers for server commands (tokens).
          void handle_die (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -570,39 +627,39 @@ These are the handlers for server commands (tokens).
          void handle_dollar (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + - + - + @@ -626,27 +683,27 @@ These are the handlers for server commands (tokens).
          void handle_F (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -670,39 +727,39 @@ These are the handlers for server commands (tokens).
          void handle_gline (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -726,27 +783,27 @@ These are the handlers for server commands (tokens).
          void handle_i (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -770,27 +827,27 @@ These are the handlers for server commands (tokens).
          void handle_info (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -814,27 +871,27 @@ These are the handlers for server commands (tokens).
          void handle_invite (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -858,39 +915,39 @@ These are the handlers for server commands (tokens).
          void handle_ison (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -914,27 +971,27 @@ These are the handlers for server commands (tokens).
          void handle_J (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -954,45 +1011,45 @@ These are the handlers for server commands (tokens).
          void handle_join (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          -These are the handlers for user commands. +These are the handlers for user commands.

          - +
          -
          + - + - + - + - + - + @@ -1016,39 +1073,39 @@ These are the handlers for user commands.
          void handle_K (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + - + - + @@ -1072,27 +1129,27 @@ These are the handlers for user commands.
          void handle_k (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -1116,27 +1173,27 @@ These are the handlers for user commands.
          void handle_kick (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1160,27 +1217,27 @@ These are the handlers for user commands.
          void handle_kill (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1204,39 +1261,39 @@ These are the handlers for user commands.
          void handle_kline (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -1260,27 +1317,27 @@ These are the handlers for user commands.
          void handle_L (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -1300,33 +1357,33 @@ These are the handlers for user commands.
          void handle_link_packet (  char *   udp_msg, udp_msg,
          char *   tcp_host, tcp_host,
          serverrec *   serv serv

          -Special functions for processing server to server traffic. +Special functions for processing server to server traffic.

          - +
          -
          + - + - + - + @@ -1350,27 +1407,27 @@ Special functions for processing server to server traffic.
          void handle_links (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1394,27 +1451,27 @@ Special functions for processing server to server traffic.
          void handle_list (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1438,39 +1495,39 @@ Special functions for processing server to server traffic.
          void handle_lusers (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -1494,39 +1551,39 @@ Special functions for processing server to server traffic.
          void handle_M (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + - + - + @@ -1550,27 +1607,27 @@ Special functions for processing server to server traffic.
          void handle_m (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -1594,27 +1651,27 @@ Special functions for processing server to server traffic.
          void handle_map (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1638,27 +1695,27 @@ Special functions for processing server to server traffic.
          void handle_modules (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1682,39 +1739,39 @@ Special functions for processing server to server traffic.
          void handle_motd (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -1738,39 +1795,39 @@ Special functions for processing server to server traffic.
          void handle_n (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + - + - + @@ -1794,27 +1851,27 @@ Special functions for processing server to server traffic.
          void handle_N (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -1838,27 +1895,27 @@ Special functions for processing server to server traffic.
          void handle_names (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1882,27 +1939,27 @@ Special functions for processing server to server traffic.
          void handle_nick (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1926,27 +1983,27 @@ Special functions for processing server to server traffic.
          void handle_notice (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -1970,39 +2027,39 @@ Special functions for processing server to server traffic.
          void handle_oper (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -2026,27 +2083,27 @@ Special functions for processing server to server traffic.
          void handle_P (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -2070,27 +2127,27 @@ Special functions for processing server to server traffic.
          void handle_part (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2114,27 +2171,27 @@ Special functions for processing server to server traffic.
          void handle_pass (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2158,39 +2215,39 @@ Special functions for processing server to server traffic.
          void handle_ping (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -2214,27 +2271,27 @@ Special functions for processing server to server traffic.
          void handle_plus (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -2258,27 +2315,27 @@ Special functions for processing server to server traffic.
          void handle_pong (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2302,39 +2359,39 @@ Special functions for processing server to server traffic.
          void handle_privmsg (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -2358,27 +2415,27 @@ Special functions for processing server to server traffic.
          void handle_Q (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -2402,27 +2459,27 @@ Special functions for processing server to server traffic.
          void handle_qline (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2446,39 +2503,39 @@ Special functions for processing server to server traffic.
          void handle_quit (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -2502,27 +2559,27 @@ Special functions for processing server to server traffic.
          void handle_R (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -2546,27 +2603,27 @@ Special functions for processing server to server traffic.
          void handle_rehash (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2590,27 +2647,27 @@ Special functions for processing server to server traffic.
          void handle_restart (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2634,27 +2691,27 @@ Special functions for processing server to server traffic.
          void handle_rules (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2678,27 +2735,27 @@ Special functions for processing server to server traffic.
          void handle_server (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2722,27 +2779,27 @@ Special functions for processing server to server traffic.
          void handle_squit (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2766,27 +2823,27 @@ Special functions for processing server to server traffic.
          void handle_stats (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -2810,39 +2867,39 @@ Special functions for processing server to server traffic.
          void handle_summon (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -2866,39 +2923,39 @@ Special functions for processing server to server traffic.
          void handle_t (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + - + - + @@ -2922,27 +2979,27 @@ Special functions for processing server to server traffic.
          void handle_T (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -2966,27 +3023,27 @@ Special functions for processing server to server traffic.
          void handle_time (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3010,27 +3067,27 @@ Special functions for processing server to server traffic.
          void handle_topic (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3054,27 +3111,27 @@ Special functions for processing server to server traffic.
          void handle_trace (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3098,27 +3155,27 @@ Special functions for processing server to server traffic.
          void handle_user (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3142,27 +3199,27 @@ Special functions for processing server to server traffic.
          void handle_userhost (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3186,39 +3243,39 @@ Special functions for processing server to server traffic.
          void handle_users (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + - + - + @@ -3242,27 +3299,27 @@ Special functions for processing server to server traffic.
          void handle_V (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host tcp_host

          - +
          -
          + - + - + - + @@ -3286,27 +3343,27 @@ Special functions for processing server to server traffic.
          void handle_wallops (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3330,27 +3387,27 @@ Special functions for processing server to server traffic.
          void handle_who (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3374,27 +3431,27 @@ Special functions for processing server to server traffic.
          void handle_whois (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3418,27 +3475,27 @@ Special functions for processing server to server traffic.
          void handle_whowas (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - + - + - + @@ -3462,16 +3519,16 @@ Special functions for processing server to server traffic.
          void handle_zline (  char **   parameters, parameters,
          int   pcnt, pcnt,
          userrec *   user user

          - +
          -
          + - - + + @@ -3487,59 +3544,59 @@ Special functions for processing server to server traffic. +Referenced by Server::IsUlined().
          bool is_uline (  const char *   server )  server  ) 

          -Functions for u:lined servers. +Functions for u:lined servers.

          -Referenced by Server::IsUlined().

          - +
          -
          + - + - + - + - + - + - + - + @@ -3562,9 +3619,9 @@ Referenced by Server::IsUli
          void process_restricted_commands (  char   token, token,
          char *   params, params,
          serverrec *   source, source,
          serverrec *   reply, reply,
          char *   tcp_host, tcp_host,
          char *   ipaddr, ipaddr,
          int   port port
          -
          Generated on Sun May 2 00:09:21 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/connection_8h-source.html b/docs/module-doc/connection_8h-source.html index d938ba327..b63a55de3 100644 --- a/docs/module-doc/connection_8h-source.html +++ b/docs/module-doc/connection_8h-source.html @@ -1,165 +1,176 @@ -connection.h Source File +InspIRCd: connection.h Source File - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          connection.h

          Go to the documentation of this file.
          00001 /*
-00002 
-00003 */
-00004 
-00005 #include "inspircd_config.h"
-00006 #include "base.h"
-00007 #include <string>
-00008 #include <map>
-00009 #include <sys/socket.h>
-00010 #include <sys/types.h>
-00011 #include <netdb.h>
-00012 #include <netinet/in.h>
-00013 #include <unistd.h>
-00014 #include <errno.h>
-00015 #include <time.h>
-00016 #include <vector>
-00017 #include <deque>
-00018 
-00019 #ifndef __CONNECTION_H__
-00020 #define __CONNECTION_H__
-00021 
-00022 #define STATE_DISCONNECTED      0
-00023 #define STATE_CONNECTED         1
-00024 #define STATE_SYNC              2
-00025 #define STATE_NOAUTH_INBOUND    3
-00026 #define STATE_NOAUTH_OUTBOUND   4
-00027 #define STATE_SERVICES          5
-00028 
-00041 class ircd_connector : public Extensible
-00042 {
-00043  private:
-00046         sockaddr_in addr;
-00047         
-00050         int fd;
-00051         
-00054         std::string servername;
-00055         
-00058         std::string description;
+
+
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          
+
          connection.h
          Go to the documentation of this file.
          00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #include "inspircd_config.h"
+00018 #include "base.h"
+00019 #include <string>
+00020 #include <map>
+00021 #include <sys/types.h>
+00022 #include <sys/socket.h>
+00023 #include <netdb.h>
+00024 #include <netinet/in.h>
+00025 #include <unistd.h>
+00026 #include <errno.h>
+00027 #include <time.h>
+00028 #include <vector>
+00029 #include <deque>
+00030 
+00031 #ifndef __CONNECTION_H__
+00032 #define __CONNECTION_H__
+00033 
+00034 #define STATE_DISCONNECTED      0
+00035 #define STATE_CONNECTED         1
+00036 #define STATE_SYNC              2
+00037 #define STATE_NOAUTH_INBOUND    3
+00038 #define STATE_NOAUTH_OUTBOUND   4
+00039 #define STATE_SERVICES          5
+00040 
+00053 class ircd_connector : public Extensible
+00054 {
+00055  private:
+00058         sockaddr_in addr;
 00059         
-00063         int state;
-00064         
-00067         bool SetHostAddress(char* host, int port);
-00068 
-00069  public:
-00070  
-00075         char host[MAXBUF];
-00076 
-00081         int port;
-00082         
-00087         std::vector<std::string> routes;
-00088         
-00089 
-00092         bool MakeOutboundConnection(char* host, int port);
-00093         
-00096         std::string GetServerName();
-00097         
-00100         void SetServerName(std::string serv);
-00101         
-00104         int GetDescriptor();
+00062         int fd;
+00063         
+00066         std::string servername;
+00067         
+00070         std::string description;
+00071         
+00075         int state;
+00076         
+00079         bool SetHostAddress(char* host, int port);
+00080 
+00081  public:
+00082  
+00087         char host[MAXBUF];
+00088 
+00093         int port;
+00094         
+00099         std::vector<std::string> routes;
+00100         
+00101 
+00104         bool MakeOutboundConnection(char* host, int port);
 00105         
-00108         void SetDescriptor(int fd);
+00108         std::string GetServerName();
 00109         
-00112         int GetState();
+00112         void SetServerName(std::string serv);
 00113         
-00116         void SetState(int state);
+00116         int GetDescriptor();
 00117         
-00120         char* GetServerIP();
+00120         void SetDescriptor(int fd);
 00121         
-00124         std::string GetDescription();
+00124         int GetState();
 00125         
-00128         void SetDescription(std::string desc);
+00128         void SetState(int state);
 00129         
-00135         int GetServerPort();
-00136         
-00139         void SetServerPort(int p);
-00140         
-00143         bool SetHostAndPort(char* host, int port);
-00144         
-00148         void CloseConnection();
-00149 };
-00150 
-00151 
-00155 class packet : public classbase
-00156 {
-00157 };
-00158 
-00161 class connection : public Extensible
-00162 {
-00163  public:
-00166         int fd;
-00167         
-00170         char host[256];
-00171         
-00174         char ip[32];
-00175         
-00178         char inbuf[MAXBUF];
+00132         char* GetServerIP();
+00133         
+00136         std::string GetDescription();
+00137         
+00140         void SetDescription(std::string desc);
+00141         
+00147         int GetServerPort();
+00148         
+00151         void SetServerPort(int p);
+00152         
+00155         bool SetHostAndPort(char* host, int port);
+00156         
+00160         void CloseConnection();
+00161 };
+00162 
+00163 
+00167 class packet : public classbase
+00168 {
+00169 };
+00170 
+00173 class connection : public Extensible
+00174 {
+00175  public:
+00178         int fd;
 00179         
-00182         long bytes_in;
-00183 
-00186         long bytes_out;
-00187 
-00190         long cmds_in;
-00191 
-00194         long cmds_out;
+00182         char host[256];
+00183         
+00186         char ip[32];
+00187         
+00190         char inbuf[MAXBUF];
+00191         
+00194         long bytes_in;
 00195 
-00198         bool haspassed;
+00198         long bytes_out;
 00199 
-00204         int port;
-00205         
-00208         int registered;
-00209         
-00212         short int state;
-00213         
-00216         time_t lastping;
+00202         long cmds_in;
+00203 
+00206         long cmds_out;
+00207 
+00210         bool haspassed;
+00211 
+00216         int port;
 00217         
-00220         time_t signon;
+00220         int registered;
 00221         
-00224         time_t idle_lastmsg;
+00224         short int state;
 00225         
-00228         time_t nping;
+00228         time_t lastping;
 00229         
-00232         char internal_addr[MAXBUF];
+00232         time_t signon;
 00233         
-00236         int internal_port;
-00237 
-00241         std::vector<ircd_connector> connectors;
-00242         
-00245         connection();
-00246         
-00249         bool CreateListener(char* host, int p);
-00250         
-00253         bool BeginLink(char* targethost, int port, char* password, char* servername, int myport);
+00236         time_t idle_lastmsg;
+00237         
+00240         time_t nping;
+00241         
+00244         char internal_addr[MAXBUF];
+00245         
+00248         int internal_port;
+00249 
+00253         std::vector<ircd_connector> connectors;
 00254         
-00257         bool MeshCookie(char* targethost, int port, long cookie, char* servername);
+00257         connection();
 00258         
-00261         void TerminateLink(char* targethost);
+00261         bool CreateListener(char* host, int p);
 00262         
-00266         bool SendPacket(char *message, const char* host);
-00267         
-00272         bool RecvPacket(std::deque<std::string> &messages, char* host);
-00273         
-00276         ircd_connector* FindHost(std::string host);
-00277         
-00281         bool AddIncoming(int fd,char* targethost, int sourceport);
-00282         
-00285         long GenKey();
-00286 };
-00287 
-00288 
-00289 #endif
-00290 
-
          Generated on Sun May 2 00:09:18 2004 for InspIRCd by
+00265         bool BeginLink(char* targethost, int port, char* password, char* servername, int myport);
+00266         
+00269         bool MeshCookie(char* targethost, int port, long cookie, char* servername);
+00270         
+00273         void TerminateLink(char* targethost);
+00274         
+00278         bool SendPacket(char *message, const char* host);
+00279         
+00284         bool RecvPacket(std::deque<std::string> &messages, char* host);
+00285         
+00288         ircd_connector* FindHost(std::string host);
+00289         
+00293         bool AddIncoming(int fd,char* targethost, int sourceport);
+00294         
+00297         long GenKey();
+00298 };
+00299 
+00300 
+00301 #endif
+00302 
+
          Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3 diff --git a/docs/module-doc/connection_8h.html b/docs/module-doc/connection_8h.html index 946a8e940..7a1b5130d 100644 --- a/docs/module-doc/connection_8h.html +++ b/docs/module-doc/connection_8h.html @@ -1,17 +1,16 @@ -connection.h File Reference +InspIRCd: connection.h File Reference - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          connection.h File Reference

          #include "inspircd_config.h"
          + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          connection.h File Reference

          #include "inspircd_config.h"
          #include "base.h"
          #include <string>
          #include <map>
          -#include <sys/socket.h>
          #include <sys/types.h>
          +#include <sys/socket.h>
          #include <netdb.h>
          #include <netinet/in.h>
          #include <unistd.h>
          @@ -20,44 +19,38 @@ #include <vector>
          #include <deque>
          -

          -Include dependency graph for connection.h:

          Include dependency graph
          - - - - -

          -This graph shows which files directly or indirectly include this file:

          Included by dependency graph
          - - - - - - -

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

          Compounds

          class  connection
           Please note: classes serverrec and userrec both inherit from class connection. More...

          class  ircd_connector
           Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. More...

          class  packet
           Class packet is deprecated. More...

          class  connection
           Please note: classes serverrec and userrec both inherit from class connection. More...

          class  ircd_connector
           Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. More...

          class  packet
           Class packet is deprecated. More...


          Defines

          #define STATE_DISCONNECTED   0
          #define STATE_CONNECTED   1
          #define STATE_SYNC   2
          #define STATE_NOAUTH_INBOUND   3
          #define STATE_NOAUTH_OUTBOUND   4
          #define STATE_SERVICES   5
          #define STATE_DISCONNECTED   0
          #define STATE_CONNECTED   1
          #define STATE_SYNC   2
          #define STATE_NOAUTH_INBOUND   3
          #define STATE_NOAUTH_OUTBOUND   4
          #define STATE_SERVICES   5

          Define Documentation

          - +
          -
          + +Definition at line 35 of file connection.h.
          #define STATE_CONNECTED   1 @@ -75,13 +68,13 @@ This graph shows which files directly or indirectly include this file:

          -Definition at line 23 of file connection.h.

          - +
          -
          + +Definition at line 34 of file connection.h.
          #define STATE_DISCONNECTED   0 @@ -99,13 +92,13 @@ Definition at line 23

          -Definition at line 22 of file connection.h.

          - +
          -
          + +Definition at line 37 of file connection.h.
          #define STATE_NOAUTH_INBOUND   3 @@ -123,13 +116,13 @@ Definition at line 22

          -Definition at line 25 of file connection.h.

          - +
          -
          + +Definition at line 38 of file connection.h.
          #define STATE_NOAUTH_OUTBOUND   4 @@ -147,13 +140,13 @@ Definition at line 25

          -Definition at line 26 of file connection.h.

          - +
          -
          + +Definition at line 39 of file connection.h.
          #define STATE_SERVICES   5 @@ -171,13 +164,13 @@ Definition at line 26

          -Definition at line 27 of file connection.h.

          - +
          -
          + +Definition at line 36 of file connection.h.
          #define STATE_SYNC   2 @@ -195,12 +188,12 @@ Definition at line 27

          -Definition at line 24 of file connection.h.

          -
          Generated on Sun May 2 00:09:22 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/ctables_8h-source.html b/docs/module-doc/ctables_8h-source.html index 75bc84e4d..58c4c7747 100644 --- a/docs/module-doc/ctables_8h-source.html +++ b/docs/module-doc/ctables_8h-source.html @@ -1,16 +1,15 @@ -ctables.h Source File +InspIRCd: ctables.h Source File - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          ctables.h

          Go to the documentation of this file.
          00001 /*       +------------------------------------+
+
+
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          
+
          ctables.h
          Go to the documentation of this file.
          00001 /*       +------------------------------------+
 00002  *       | Inspire Internet Relay Chat Daemon |
 00003  *       +------------------------------------+
 00004  *
-00005  *  Inspire is copyright (C) 2002-2003 ChatSpike-Dev.
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
 00006  *                       E-mail:
 00007  *                <brain@chatspike.net>
 00008  *                <Craig@chatspike.net>
@@ -21,29 +20,30 @@
 00013  *
 00014  * ---------------------------------------------------
 00015  */
-00016 #ifndef __CTABLES_H__
-00017 #define __CTABLES_H__
-00018 
-00019 #include "inspircd_config.h"
-00020 #include "inspircd.h"
-00021 #include "base.h"
-00022 
-00025 class command_t : public Extensible
-00026 {
-00027  public:
-00030         char command[MAXBUF];
-00033         handlerfunc *handler_function; 
-00036         char flags_needed;
-00039         int min_params;
-00042         long use_count;
-00045         long total_bytes;
-00046 };
-00047 
-00048 #endif
-00049 
-
          Generated on Sun May 2 00:09:18 2004 for InspIRCd by
+00016  
+00017 #ifndef __CTABLES_H__
+00018 #define __CTABLES_H__
+00019 
+00020 #include "inspircd_config.h"
+00021 #include "inspircd.h"
+00022 #include "base.h"
+00023 
+00026 class command_t : public Extensible
+00027 {
+00028  public:
+00031         char command[MAXBUF];
+00034         handlerfunc *handler_function; 
+00037         char flags_needed;
+00040         int min_params;
+00043         long use_count;
+00046         long total_bytes;
+00047 };
+00048 
+00049 #endif
+00050 
+
          Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3 diff --git a/docs/module-doc/ctables_8h.html b/docs/module-doc/ctables_8h.html index fccdd49e6..f49ddf7f8 100644 --- a/docs/module-doc/ctables_8h.html +++ b/docs/module-doc/ctables_8h.html @@ -1,39 +1,25 @@ -ctables.h File Reference +InspIRCd: ctables.h File Reference - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          ctables.h File Reference

          #include "inspircd_config.h"
          + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          ctables.h File Reference

          #include "inspircd_config.h"
          #include "inspircd.h"
          #include "base.h"
          -

          -Include dependency graph for ctables.h:

          Include dependency graph
          - - - - -

          -This graph shows which files directly or indirectly include this file:

          Included by dependency graph
          - - - - - -

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

          Compounds

          class  command_t
           A structure that defines a command. More...

          class  command_t
           A structure that defines a command. More...

          -

          Generated on Sun May 2 00:09:23 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/files.html b/docs/module-doc/files.html index 24cfa6f76..670c40590 100644 --- a/docs/module-doc/files.html +++ b/docs/module-doc/files.html @@ -1,12 +1,11 @@ -File Index +InspIRCd: File Index - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          InspIRCd File List

          Here is a list of all files with brief descriptions: + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +

          InspIRCd File List

          Here is a list of all files with brief descriptions:
          @@ -23,9 +22,9 @@
          base.h [code]
          channels.cpp [code]
          channels.h [code]
          users.h [code]
          xline.h [code]
          -
          Generated on Sun May 2 00:09:18 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:26 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/functions.html b/docs/module-doc/functions.html index d66e1db41..6a5ca8840 100644 --- a/docs/module-doc/functions.html +++ b/docs/module-doc/functions.html @@ -1,13 +1,14 @@ -Compound Member Index +InspIRCd: Compound Member Index - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          InspIRCd Compound Members

          -a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | ~
          + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables
          +
          a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | ~
          + +

          Here is a list of all class members with links to the classes they belong to:

          - a - @@ -17,77 +18,79 @@ Here is a list of all class members with links to the classes they belong to:

          Server
        • AddExtendedMode() : Server
        • AddIncoming() : connection
        • addr -: ircd_connector
        • Admin() +: ircd_connector
        • Admin() : Admin
        • age -: classbase
        • awaymsg -: userrec +: classbase
        • awaymsg +: userrec

          - b -

          +: Version
        • bytes_in +: connection
        • bytes_out +: connection

          - c -

          +: chanrec

          - d -

          +: HostItem
        • description +: serverrec, ircd_connector
        • dhost +: userrec
        • DumpErrors() +: ConfigReader
        • duration +: XLine

          - e -

          - f -

          +: command_t
        • flood +: userrec, ConnectClass
        • fullname +: userrec

          - g -

          - i -

          - k -

          +: chanrec

          - l -

          - m -

          - n -

          +: XLine
        • Name +: Admin
        • name +: serverrec, chanrec
        • needsoper +: ExtMode
        • Nick +: Admin
        • nick +: QLine, userrec
        • nickserv +: serverrec
        • noexternal +: chanrec
        • nping +: connection

          - o -

          +: serverrec

          - p -

          +: ConnectClass
        • pingtime +: serverrec
        • port +: connection, ircd_connector

          - q -

          - s -

          +: connection
        • source +: XLine
        • state +: connection, ircd_connector
        • sync_soon +: serverrec

          - t -

          +: userrec
        • topic +: chanrec
        • topiclock +: chanrec
        • topicset +: chanrec
        • total_bytes +: command_t
        • type +: ConnectClass, ExtMode

          - u -

          - v -

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

          - ~ -

          • ~chanrec() @@ -309,9 +314,9 @@ Here is a list of all class members with links to the classes they belong to:

            serverrec
          • ~ucrec() : ucrec
          • ~userrec() : userrec

          -
          Generated on Sun May 2 00:09:29 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/functions_func.html b/docs/module-doc/functions_func.html new file mode 100644 index 000000000..dfce49e59 --- /dev/null +++ b/docs/module-doc/functions_func.html @@ -0,0 +1,214 @@ + + +InspIRCd: Compound Member Index + + + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables
          +
          a | b | c | d | e | f | g | h | i | j | l | m | o | p | q | r | s | t | u | v | ~
          + +

          + +

          +

          - a - +

          +

          - b - +

          +

          - c - +

          +

          - d - +

          +

          - e - +

          +

          - f - +

          +

          - g - +

          +

          - h - +

          +

          - i - +

          +

          - j - +

            +
          • JoinUserToChannel() +: Server
          +

          - l - +

          +

          - m - +

          +

          - o - +

          +

          - p - +

            +
          • PartUserFromChannel() +: Server
          +

          - q - +

          +

          - r - +

          +

          - s - +

          +

          - t - +

          +

          - u - +

          +

          - v - +

          +

          - ~ - +

          +
          Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by + +doxygen +1.3.3
          + + diff --git a/docs/module-doc/functions_vars.html b/docs/module-doc/functions_vars.html new file mode 100644 index 000000000..448444fdd --- /dev/null +++ b/docs/module-doc/functions_vars.html @@ -0,0 +1,181 @@ + + +InspIRCd: Compound Member Index + + + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables
          +
          a | b | c | d | e | f | h | i | j | k | l | m | n | o | p | r | s | t | u | v
          + +

          + +

          +

          - a - +

          +

          - b - +

          +

          - c - +

          +

          - d - +

          +

          - e - +

          +

          - f - +

          +

          - h - +

          +

          - i - +

          +

          - j - +

          +

          - k - +

          +

          - l - +

          +

          - m - +

          +

          - n - +

          +

          - o - +

          +

          - p - +

          +

          - r - +

          +

          - s - +

          +

          - t - +

          +

          - u - +

          +

          - v - +

          +
          Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by + +doxygen +1.3.3
          + + diff --git a/docs/module-doc/globals.html b/docs/module-doc/globals.html index bce848924..d6a7125ab 100644 --- a/docs/module-doc/globals.html +++ b/docs/module-doc/globals.html @@ -1,13 +1,14 @@ -File Member Index +InspIRCd: File Member Index - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          InspIRCd File Members

          -a | b | c | d | e | f | g | h | i | l | m | n | p | q | r | s | t | u | v | w | z
          + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables | Typedefs | Defines
          +
          a | b | c | d | e | f | g | h | i | l | m | n | p | q | r | s | t | u | v | w | z
          + +

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

          - a - @@ -30,55 +31,54 @@ Here is a list of all file members with links to the files they belong to:

          xline.h
        • add_qline() : xline.h
        • add_zline() : xline.h
        • address_cache -: modules.cpp
        • AdminEmail +: modules.cpp
        • AdminEmail : modules.cpp, channels.cpp
        • AdminName : modules.cpp, channels.cpp
        • AdminNick : modules.cpp, channels.cpp
        • allowed_umode() : mode.h
        • apply_lines() : xline.h
        • auth_cookies -: modules.cpp, channels.cpp +: modules.cpp, channels.cpp

          - b -

          +: modules.cpp, channels.cpp

          - c -

          +: channels.cpp

          - d -

          +: modules.cpp

          - e -

          +: modules.cpp
        • ExtModeListIter +: modules.cpp

          - f -

          - m -

          @@ -241,8 +241,8 @@ Here is a list of all file members with links to the files they belong to:

          - p -

          +: modules.cpp

          - s -

          +: modules.cpp, channels.cpp
        • user_hash +: modules.cpp

          - v -

          -
          Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
          Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
          +doxygen +1.3.3
          diff --git a/docs/module-doc/globals_defs.html b/docs/module-doc/globals_defs.html new file mode 100644 index 000000000..fbd70e221 --- /dev/null +++ b/docs/module-doc/globals_defs.html @@ -0,0 +1,95 @@ + + +InspIRCd: File Member Index + + + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables | Typedefs | Defines
          +
          a | c | d | f | l | m | n | s | u | v
          + +

          + +

          +

          - a - +

          +

          - c - +

          +

          - d - +

          +

          - f - +

          +

          - l - +

          +

          - m - +

          +

          - n - +

          +

          - s - +

          +

          - u - +

          +

          - v - +

          +
          Generated on Fri Mar 25 03:49:35 2005 for InspIRCd by + +doxygen +1.3.3
          + + diff --git a/docs/module-doc/globals_func.html b/docs/module-doc/globals_func.html new file mode 100644 index 000000000..f72bb0444 --- /dev/null +++ b/docs/module-doc/globals_func.html @@ -0,0 +1,211 @@ + + +InspIRCd: File Member Index + + + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables | Typedefs | Defines
          +
          a | b | c | d | e | f | g | h | i | m | n | p | q | r | s | t | z
          + +

          + +

          +

          - a - +

          +

          - b - +

          +

          - c - +

          +

          - d - +

          +

          - e - +

          +

          - f - +

          +

          - g - +

          +

          - h - +

          +

          - i - +

          +

          - m - +

          +

          - n - +

          +

          - p - +

          +

          - q - +

          +

          - r - +

          +

          - s - +

          +

          - t - +

          +

          - z - +

          +
          Generated on Fri Mar 25 03:49:35 2005 for InspIRCd by + +doxygen +1.3.3
          + + diff --git a/docs/module-doc/globals_type.html b/docs/module-doc/globals_type.html new file mode 100644 index 000000000..e1eede3f6 --- /dev/null +++ b/docs/module-doc/globals_type.html @@ -0,0 +1,34 @@ + + +InspIRCd: File Member Index + + + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables | Typedefs | Defines
          + +

          +

          +
          Generated on Fri Mar 25 03:49:35 2005 for InspIRCd by + +doxygen +1.3.3
          + + diff --git a/docs/module-doc/globals_vars.html b/docs/module-doc/globals_vars.html new file mode 100644 index 000000000..a1cbb448c --- /dev/null +++ b/docs/module-doc/globals_vars.html @@ -0,0 +1,109 @@ + + +InspIRCd: File Member Index + + + +
          Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
          +
          All | Functions | Variables | Typedefs | Defines
          +
          a | b | c | d | e | f | i | l | m | n | p | r | s | u | w
          + +

          + +

          +

          - a - +

          +

          - b - +

          +

          - c - +

          +

          - d - +

          +

          - e - +

          +

          - f - +

          +

          - i - +

          +

          - l - +

          +

          - m - +

          +

          - n - +

          +

          - p - +

          +

          - r - +

          +

          - s - +

          +

          - u - +

          +

          - w - +

          +
          Generated on Fri Mar 25 03:49:35 2005 for InspIRCd by + +doxygen +1.3.3
          + + diff --git a/docs/module-doc/hierarchy.html b/docs/module-doc/hierarchy.html index 9a88ae9c4..3e21d851d 100644 --- a/docs/module-doc/hierarchy.html +++ b/docs/module-doc/hierarchy.html @@ -1,14 +1,11 @@ -Hierarchical Index +InspIRCd: Hierarchical Index - -
          -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
          -

          InspIRCd Class Hierarchy

          Go to the graphical class hierarchy -

          -This inheritance list is sorted roughly, but not completely, alphabetically:

            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            InspIRCd Class Hierarchy

            This inheritance list is sorted roughly, but not completely, alphabetically: -
            Generated on Sun May 2 00:09:29 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/index.html b/docs/module-doc/index.html index 752d21b2d..212bbdf53 100644 --- a/docs/module-doc/index.html +++ b/docs/module-doc/index.html @@ -1,3 +1,4 @@ + InspIRCd diff --git a/docs/module-doc/inspircd.css b/docs/module-doc/inspircd.css index dd504c2e4..e69de29bb 100644 --- a/docs/module-doc/inspircd.css +++ b/docs/module-doc/inspircd.css @@ -1,50 +0,0 @@ -H1 { text-align: center; } -CAPTION { font-weight: bold } -a:link, a:visited, a:active { text-decoration: none; color: #3F495F } -a:hover { color: #000; text-decoration: none } -A.qindex {} -A.qindexRef {} -A.el { text-decoration: none; font-weight: bold } -A.elRef { font-weight: bold } -A.code { text-decoration: none; font-weight: normal; color: #4444ee } -A.codeRef { font-weight: normal; color: #4444ee } -DL.el { margin-left: -1cm } -DIV.fragment { width: 100%; border: none; background-color: #eeeeee } -DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } -TD.md { background-color: #f2f2ff; font-weight: bold; } -TD.mdname1 { background-color: #f2f2ff; font-weight: bold; color: #602020; } -TD.mdname { background-color: #f2f2ff; font-weight: bold; color: #602020; width: 600px; } -DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } -DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } -BODY { background: #d4d4d4; color: #3F495F; font-family: Verdana, Tahoma, Arial, sans-serif; font-size: 11px; color: #333333; } -TABLE, TR, TD { font-family: Verdana, Tahoma, Arial, sans-serif; font-size: 11px; color: #333333; } -TH { border:0px solid #d4d4d4;background-color:#3F495F; padding:0; margin:0; border-top-style: none; padding:8px } -TD.indexkey { - font-weight: bold; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px -} -TD.indexvalue { - font-style: italic; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px -} -span.keyword { color: #008000 } -span.keywordtype { color: #604020 } -span.keywordflow { color: #e08000 } -span.comment { color: #800000 } -span.preprocessor { color: #806020 } -span.stringliteral { color: #002080 } -span.charliteral { color: #008080 } diff --git a/docs/module-doc/main.html b/docs/module-doc/main.html index 7ee9dc645..a85445e6c 100644 --- a/docs/module-doc/main.html +++ b/docs/module-doc/main.html @@ -1,16 +1,15 @@ -Main Page +InspIRCd: Main Page - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            InspIRCd Documentation

            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            InspIRCd Documentation

            -

            Generated on Sun May 2 00:09:18 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:26 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/message_8h-source.html b/docs/module-doc/message_8h-source.html index afe76da40..507b78ada 100644 --- a/docs/module-doc/message_8h-source.html +++ b/docs/module-doc/message_8h-source.html @@ -1,50 +1,65 @@ -message.h Source File +InspIRCd: message.h Source File - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            message.h

            Go to the documentation of this file.
            00001 #ifndef __MESSAGE_H
-00002 #define __MESSAGE_H
-00003 
-00004 // include the common header files
-00005 
-00006 #include <typeinfo>
-00007 #include <iostream>
-00008 #include <string>
-00009 #include <deque>
-00010 #include <sstream>
-00011 #include <vector>
-00012 #include "users.h"
-00013 #include "channels.h"
-00014 
-00015 int common_channels(userrec *u, userrec *u2);
-00016 void chop(char* str);
-00017 void tidystring(char* str);
-00018 void safedelete(chanrec *p);
-00019 void safedelete(userrec *p);
-00020 void Blocking(int s);
-00021 void NonBlocking(int s);
-00022 int CleanAndResolve (char *resolvedHost, const char *unresolvedHost);
-00023 int c_count(userrec* u);
-00024 bool hasumode(userrec* user, char mode);
-00025 void ChangeName(userrec* user, const char* gecos);
-00026 void ChangeDisplayedHost(userrec* user, const char* host);
-00027 int isident(const char* n);
-00028 int isnick(const char* n);
-00029 char* cmode(userrec *user, chanrec *chan);
-00030 int cstatus(userrec *user, chanrec *chan);
-00031 int has_channel(userrec *u, chanrec *c);
-00032 void TidyBan(char *ban);
-00033 char* chlist(userrec *user);
-00034 void send_network_quit(const char* nick, const char* reason);
-00035 
-00036 #endif
-
            Generated on Sun May 2 00:09:18 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            message.h

            Go to the documentation of this file.
            00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #ifndef __MESSAGE_H
+00018 #define __MESSAGE_H
+00019 
+00020 // include the common header files
+00021 
+00022 #include <typeinfo>
+00023 #include <iostream>
+00024 #include <string>
+00025 #include <deque>
+00026 #include <sstream>
+00027 #include <vector>
+00028 #include "users.h"
+00029 #include "channels.h"
+00030 
+00031 int common_channels(userrec *u, userrec *u2);
+00032 void chop(char* str);
+00033 void tidystring(char* str);
+00034 void safedelete(chanrec *p);
+00035 void safedelete(userrec *p);
+00036 void Blocking(int s);
+00037 void NonBlocking(int s);
+00038 int CleanAndResolve (char *resolvedHost, const char *unresolvedHost);
+00039 int c_count(userrec* u);
+00040 bool hasumode(userrec* user, char mode);
+00041 void ChangeName(userrec* user, const char* gecos);
+00042 void ChangeDisplayedHost(userrec* user, const char* host);
+00043 int isident(const char* n);
+00044 int isnick(const char* n);
+00045 char* cmode(userrec *user, chanrec *chan);
+00046 int cstatus(userrec *user, chanrec *chan);
+00047 int has_channel(userrec *u, chanrec *c);
+00048 void TidyBan(char *ban);
+00049 char* chlist(userrec *user);
+00050 void send_network_quit(const char* nick, const char* reason);
+00051 
+00052 #endif
+
            Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/message_8h.html b/docs/module-doc/message_8h.html index 584ee4f9f..80adff029 100644 --- a/docs/module-doc/message_8h.html +++ b/docs/module-doc/message_8h.html @@ -1,12 +1,11 @@ -message.h File Reference +InspIRCd: message.h File Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            message.h File Reference

            #include <typeinfo>
            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            message.h File Reference

            #include <typeinfo>
            #include <iostream>
            #include <string>
            #include <deque>
            @@ -15,58 +14,63 @@ #include "users.h"
            #include "channels.h"
            -

            -Include dependency graph for message.h:

            Include dependency graph
            - - - - - - -

            -This graph shows which files directly or indirectly include this file:

            Included by dependency graph
            - - - - -

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

            Functions

            int common_channels (userrec *u, userrec *u2)
            void chop (char *str)
            void tidystring (char *str)
            void safedelete (chanrec *p)
            void safedelete (userrec *p)
            void Blocking (int s)
            void NonBlocking (int s)
            int CleanAndResolve (char *resolvedHost, const char *unresolvedHost)
            int c_count (userrec *u)
            bool hasumode (userrec *user, char mode)
            void ChangeName (userrec *user, const char *gecos)
            void ChangeDisplayedHost (userrec *user, const char *host)
            int isident (const char *n)
            int isnick (const char *n)
            char * cmode (userrec *user, chanrec *chan)
            int cstatus (userrec *user, chanrec *chan)
            int has_channel (userrec *u, chanrec *c)
            void TidyBan (char *ban)
            char * chlist (userrec *user)
            void send_network_quit (const char *nick, const char *reason)
            int common_channels (userrec *u, userrec *u2)
            void chop (char *str)
            void tidystring (char *str)
            void safedelete (chanrec *p)
            void safedelete (userrec *p)
            void Blocking (int s)
            void NonBlocking (int s)
            int CleanAndResolve (char *resolvedHost, const char *unresolvedHost)
            int c_count (userrec *u)
            bool hasumode (userrec *user, char mode)
            void ChangeName (userrec *user, const char *gecos)
            void ChangeDisplayedHost (userrec *user, const char *host)
            int isident (const char *n)
            int isnick (const char *n)
            char * cmode (userrec *user, chanrec *chan)
            int cstatus (userrec *user, chanrec *chan)
            int has_channel (userrec *u, chanrec *c)
            void TidyBan (char *ban)
            char * chlist (userrec *user)
            void send_network_quit (const char *nick, const char *reason)

            Function Documentation

            - +
            -
            + - - + + @@ -86,16 +90,16 @@ This graph shows which files directly or indirectly include this file:

            void Blocking (  int   s )  s  ) 

            - +
            -
            + - - + + @@ -115,21 +119,21 @@ This graph shows which files directly or indirectly include this file:

            int c_count (  userrec *   u )  u  ) 

            - +
            -
            + - + - + @@ -151,25 +155,25 @@ This graph shows which files directly or indirectly include this file:

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

            void ChangeDisplayedHost (  userrec *   user, user,
            const char *   host host

            - +
            -
            + - + - + @@ -191,20 +195,20 @@ Referenced by Server::Chang

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

            void ChangeName (  userrec *   user, user,
            const char *   gecos gecos

            - +
            -
            + - - + + @@ -224,16 +228,16 @@ Referenced by Server::Chang
            char* chlist (  userrec *   user )  user  ) 

            - +
            -
            + - - + + @@ -253,21 +257,21 @@ Referenced by Server::Chang
            void chop (  char *   str )  str  ) 

            - +
            -
            + - + - + @@ -291,21 +295,21 @@ Referenced by Server::Chang
            int CleanAndResolve (  char *   resolvedHost, resolvedHost,
            const char *   unresolvedHost unresolvedHost

            - +
            -
            + - + - + @@ -327,25 +331,25 @@ Referenced by Server::Chang

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

            char* cmode (  userrec *   user, user,
            chanrec *   chan chan

            - +
            -
            + - + - + @@ -367,25 +371,25 @@ Referenced by Server::ChanM

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

            int common_channels (  userrec *   u, u,
            userrec *   u2 u2

            - +
            -
            + - + - + @@ -409,21 +413,21 @@ Referenced by Server::Commo
            int cstatus (  userrec *   user, user,
            chanrec *   chan chan

            - +
            -
            + - + - + @@ -445,25 +449,25 @@ Referenced by Server::Commo

            -Referenced by Server::GetUsers(), and Server::IsOnChannel(). +Referenced by Server::GetUsers(), and Server::IsOnChannel().

            int has_channel (  userrec *   u, u,
            chanrec *   c c

            - +
            -
            + - + - + @@ -487,16 +491,16 @@ Referenced by Server::GetUs
            bool hasumode (  userrec *   user, user,
            char   mode mode

            - +
            -
            + - - + + @@ -516,16 +520,16 @@ Referenced by Server::GetUs
            int isident (  const char *   n )  n  ) 

            - +
            -
            + - - + + @@ -543,20 +547,20 @@ Referenced by Server::GetUs

            -Referenced by Server::GetUsers(), and Server::IsNick(). +Referenced by Server::GetUsers(), and Server::IsNick().

            int isnick (  const char *   n )  n  ) 

            - +
            -
            + - - + + @@ -576,16 +580,16 @@ Referenced by Server::GetUs
            void NonBlocking (  int   s )  s  ) 

            - +
            -
            + - - + + @@ -605,16 +609,16 @@ Referenced by Server::GetUs
            void safedelete (  userrec *   p )  p  ) 

            - +
            -
            + - - + + @@ -634,21 +638,21 @@ Referenced by Server::GetUs
            void safedelete (  chanrec *   p )  p  ) 

            - +
            -
            + - + - + @@ -670,20 +674,20 @@ Referenced by Server::GetUs

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

            void send_network_quit (  const char *   nick, nick,
            const char *   reason reason

            - +
            -
            + - - + + @@ -703,16 +707,16 @@ Referenced by Server::QuitU
            void TidyBan (  char *   ban )  ban  ) 

            - +
            -
            + - - + + @@ -731,9 +735,9 @@ Referenced by Server::QuitU
            void tidystring (  char *   str )  str  ) 
            -
            Generated on Sun May 2 00:09:23 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/mode_8h-source.html b/docs/module-doc/mode_8h-source.html index 204b69372..833ab2396 100644 --- a/docs/module-doc/mode_8h-source.html +++ b/docs/module-doc/mode_8h-source.html @@ -1,47 +1,61 @@ -mode.h Source File +InspIRCd: mode.h Source File - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            mode.h

            Go to the documentation of this file.
            00001 #ifndef __MODE_H
-00002 #define __MODE_H
-00003 
-00004 // include the common header files
-00005 
-00006 #include <typeinfo>
-00007 #include <iostream>
-00008 #include <string>
-00009 #include <deque>
-00010 #include <sstream>
-00011 #include <vector>
-00012 #include "users.h"
-00013 #include "channels.h"
-00014 
-00015 
-00016 char* give_ops(userrec *user,char *dest,chanrec *chan,int status);
-00017 char* give_hops(userrec *user,char *dest,chanrec *chan,int status);
-00018 char* give_voice(userrec *user,char *dest,chanrec *chan,int status);
-00019 char* take_ops(userrec *user,char *dest,chanrec *chan,int status);
-00020 char* take_hops(userrec *user,char *dest,chanrec *chan,int status);
-00021 char* take_voice(userrec *user,char *dest,chanrec *chan,int status);
-00022 char* add_ban(userrec *user,char *dest,chanrec *chan,int status);
-00023 char* take_ban(userrec *user,char *dest,chanrec *chan,int status);
-00024 void process_modes(char **parameters,userrec* user,chanrec *chan,int status, int pcnt, bool servermode, bool silent, bool local);
-00025 bool allowed_umode(char umode, char* sourcemodes,bool adding);
-00026 bool process_module_umode(char umode, userrec* source, void* dest, bool adding);
-00027 void handle_mode(char **parameters, int pcnt, userrec *user);
-00028 void server_mode(char **parameters, int pcnt, userrec *user);
-00029 void merge_mode(char **parameters, int pcnt);
-00030 void merge_mode2(char **parameters, int pcnt, userrec* user);
-00031 
-00032 
-00033 #endif
-
            Generated on Sun May 2 00:09:18 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            mode.h

            Go to the documentation of this file.
            00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #ifndef __MODE_H
+00018 #define __MODE_H
+00019 
+00020 // include the common header files
+00021 
+00022 #include <typeinfo>
+00023 #include <iostream>
+00024 #include <string>
+00025 #include <deque>
+00026 #include <sstream>
+00027 #include <vector>
+00028 #include "users.h"
+00029 #include "channels.h"
+00030 
+00031 char* give_ops(userrec *user,char *dest,chanrec *chan,int status);
+00032 char* give_hops(userrec *user,char *dest,chanrec *chan,int status);
+00033 char* give_voice(userrec *user,char *dest,chanrec *chan,int status);
+00034 char* take_ops(userrec *user,char *dest,chanrec *chan,int status);
+00035 char* take_hops(userrec *user,char *dest,chanrec *chan,int status);
+00036 char* take_voice(userrec *user,char *dest,chanrec *chan,int status);
+00037 char* add_ban(userrec *user,char *dest,chanrec *chan,int status);
+00038 char* take_ban(userrec *user,char *dest,chanrec *chan,int status);
+00039 void process_modes(char **parameters,userrec* user,chanrec *chan,int status, int pcnt, bool servermode, bool silent, bool local);
+00040 bool allowed_umode(char umode, char* sourcemodes,bool adding);
+00041 bool process_module_umode(char umode, userrec* source, void* dest, bool adding);
+00042 void handle_mode(char **parameters, int pcnt, userrec *user);
+00043 void server_mode(char **parameters, int pcnt, userrec *user);
+00044 void merge_mode(char **parameters, int pcnt);
+00045 void merge_mode2(char **parameters, int pcnt, userrec* user);
+00046 
+00047 
+00048 #endif
+
            Generated on Fri Mar 25 03:49:27 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/mode_8h.html b/docs/module-doc/mode_8h.html index 50e9f95ec..fb4674b0b 100644 --- a/docs/module-doc/mode_8h.html +++ b/docs/module-doc/mode_8h.html @@ -1,12 +1,11 @@ -mode.h File Reference +InspIRCd: mode.h File Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            mode.h File Reference

            #include <typeinfo>
            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            mode.h File Reference

            #include <typeinfo>
            #include <iostream>
            #include <string>
            #include <deque>
            @@ -15,70 +14,70 @@ #include "users.h"
            #include "channels.h"
            -

            -Include dependency graph for mode.h:

            Include dependency graph
            - - - - - - -

            -This graph shows which files directly or indirectly include this file:

            Included by dependency graph
            - - - - -

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

            Functions

            char * give_ops (userrec *user, char *dest, chanrec *chan, int status)
            char * give_hops (userrec *user, char *dest, chanrec *chan, int status)
            char * give_voice (userrec *user, char *dest, chanrec *chan, int status)
            char * take_ops (userrec *user, char *dest, chanrec *chan, int status)
            char * take_hops (userrec *user, char *dest, chanrec *chan, int status)
            char * take_voice (userrec *user, char *dest, chanrec *chan, int status)
            char * add_ban (userrec *user, char *dest, chanrec *chan, int status)
            char * take_ban (userrec *user, char *dest, chanrec *chan, int status)
            void process_modes (char **parameters, userrec *user, chanrec *chan, int status, int pcnt, bool servermode, bool silent, bool local)
            bool allowed_umode (char umode, char *sourcemodes, bool adding)
            bool process_module_umode (char umode, userrec *source, void *dest, bool adding)
            void handle_mode (char **parameters, int pcnt, userrec *user)
            void server_mode (char **parameters, int pcnt, userrec *user)
            void merge_mode (char **parameters, int pcnt)
            void merge_mode2 (char **parameters, int pcnt, userrec *user)
            char * give_ops (userrec *user, char *dest, chanrec *chan, int status)
            char * give_hops (userrec *user, char *dest, chanrec *chan, int status)
            char * give_voice (userrec *user, char *dest, chanrec *chan, int status)
            char * take_ops (userrec *user, char *dest, chanrec *chan, int status)
            char * take_hops (userrec *user, char *dest, chanrec *chan, int status)
            char * take_voice (userrec *user, char *dest, chanrec *chan, int status)
            char * add_ban (userrec *user, char *dest, chanrec *chan, int status)
            char * take_ban (userrec *user, char *dest, chanrec *chan, int status)
            void process_modes (char **parameters, userrec *user, chanrec *chan, int status, int pcnt, bool servermode, bool silent, bool local)
            bool allowed_umode (char umode, char *sourcemodes, bool adding)
            bool process_module_umode (char umode, userrec *source, void *dest, bool adding)
            void handle_mode (char **parameters, int pcnt, userrec *user)
            void server_mode (char **parameters, int pcnt, userrec *user)
            void merge_mode (char **parameters, int pcnt)
            void merge_mode2 (char **parameters, int pcnt, userrec *user)

            Function Documentation

            - +
            -
            + - + - + - + - + @@ -102,27 +101,27 @@ This graph shows which files directly or indirectly include this file:

            char* add_ban (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + @@ -146,33 +145,33 @@ This graph shows which files directly or indirectly include this file:

            bool allowed_umode (  char   umode, umode,
            char *   sourcemodes, sourcemodes,
            bool   adding adding

            - +
            -
            + - + - + - + - + @@ -196,33 +195,33 @@ This graph shows which files directly or indirectly include this file:

            char* give_hops (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + - + @@ -246,33 +245,33 @@ This graph shows which files directly or indirectly include this file:

            char* give_ops (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + - + @@ -296,27 +295,27 @@ This graph shows which files directly or indirectly include this file:

            char* give_voice (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + @@ -340,21 +339,21 @@ This graph shows which files directly or indirectly include this file:

            void handle_mode (  char **   parameters, parameters,
            int   pcnt, pcnt,
            userrec *   user user

            - +
            -
            + - + - + @@ -378,27 +377,27 @@ This graph shows which files directly or indirectly include this file:

            void merge_mode (  char **   parameters, parameters,
            int   pcnt pcnt

            - +
            -
            + - + - + - + @@ -422,57 +421,57 @@ This graph shows which files directly or indirectly include this file:

            void merge_mode2 (  char **   parameters, parameters,
            int   pcnt, pcnt,
            userrec *   user user

            - +
            -
            + - + - + - + - + - + - + - + - + @@ -496,33 +495,33 @@ This graph shows which files directly or indirectly include this file:

            void process_modes (  char **   parameters, parameters,
            userrec *   user, user,
            chanrec *   chan, chan,
            int   status, status,
            int   pcnt, pcnt,
            bool   servermode, servermode,
            bool   silent, silent,
            bool   local local

            - +
            -
            + - + - + - + - + @@ -546,27 +545,27 @@ This graph shows which files directly or indirectly include this file:

            bool process_module_umode (  char   umode, umode,
            userrec *   source, source,
            void *   dest, dest,
            bool   adding adding

            - +
            -
            + - + - + - + @@ -590,33 +589,33 @@ This graph shows which files directly or indirectly include this file:

            void server_mode (  char **   parameters, parameters,
            int   pcnt, pcnt,
            userrec *   user user

            - +
            -
            + - + - + - + - + @@ -640,33 +639,33 @@ This graph shows which files directly or indirectly include this file:

            char* take_ban (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + - + @@ -690,33 +689,33 @@ This graph shows which files directly or indirectly include this file:

            char* take_hops (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + - + @@ -740,33 +739,33 @@ This graph shows which files directly or indirectly include this file:

            char* take_ops (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status

            - +
            -
            + - + - + - + - + @@ -789,9 +788,9 @@ This graph shows which files directly or indirectly include this file:

            char* take_voice (  userrec *   user, user,
            char *   dest, dest,
            chanrec *   chan, chan,
            int   status status
            -
            Generated on Sun May 2 00:09:24 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/modules_8cpp-source.html b/docs/module-doc/modules_8cpp-source.html index 430e95164..fcf95d119 100644 --- a/docs/module-doc/modules_8cpp-source.html +++ b/docs/module-doc/modules_8cpp-source.html @@ -1,216 +1,215 @@ -modules.cpp Source File +InspIRCd: modules.cpp Source File - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            modules.cpp

            Go to the documentation of this file.
            00001 #include "inspircd.h"
-00002 #include "inspircd_io.h"
-00003 #include "inspircd_util.h"
-00004 #include "inspircd_config.h"
-00005 #include <unistd.h>
-00006 #include <fcntl.h>
-00007 #include <sys/errno.h>
-00008 #include <sys/ioctl.h>
-00009 #include <sys/utsname.h>
-00010 #include <cstdio>
-00011 #include <time.h>
-00012 #include <string>
-00013 #ifdef GCC3
-00014 #include <ext/hash_map>
-00015 #else
-00016 #include <hash_map>
-00017 #endif
-00018 #include <map>
-00019 #include <sstream>
-00020 #include <vector>
-00021 #include <errno.h>
-00022 #include <deque>
-00023 #include <errno.h>
-00024 #include <unistd.h>
-00025 #include <sched.h>
-00026 #include "connection.h"
-00027 #include "users.h"
-00028 #include "servers.h"
-00029 #include "ctables.h"
-00030 #include "globals.h"
-00031 #include "modules.h"
-00032 #include "dynamic.h"
-00033 #include "wildcard.h"
-00034 #include "message.h"
-00035 #include "mode.h"
-00036 #include "xline.h"
-00037 #include "commands.h"
-00038 
-00039 #ifdef GCC3
-00040 #define nspace __gnu_cxx
-00041 #else
-00042 #define nspace std
-00043 #endif
-00044 
-00045 using namespace std;
-00046 
-00047 extern int MODCOUNT;
-00048 extern vector<Module*> modules;
-00049 extern vector<ircd_module*> factory;
-00050 
-00051 extern int LogLevel;
-00052 extern char ServerName[MAXBUF];
-00053 extern char Network[MAXBUF];
-00054 extern char ServerDesc[MAXBUF];
-00055 extern char AdminName[MAXBUF];
-00056 extern char AdminEmail[MAXBUF];
-00057 extern char AdminNick[MAXBUF];
-00058 extern char diepass[MAXBUF];
-00059 extern char restartpass[MAXBUF];
-00060 extern char motd[MAXBUF];
-00061 extern char rules[MAXBUF];
-00062 extern char list[MAXBUF];
-00063 extern char PrefixQuit[MAXBUF];
-00064 extern char DieValue[MAXBUF];
-00065 
-00066 extern int debugging;
-00067 extern int WHOWAS_STALE;
-00068 extern int WHOWAS_MAX;
-00069 extern int DieDelay;
-00070 extern time_t startup_time;
-00071 extern int NetBufferSize;
-00072 extern int MaxWhoResults;
-00073 extern time_t nb_start;
-00074 
-00075 extern std::vector<int> fd_reap;
-00076 extern std::vector<std::string> module_names;
-00077 
-00078 extern char bannerBuffer[MAXBUF];
-00079 extern int boundPortCount;
-00080 extern int portCount;
-00081 extern int UDPportCount;
-00082 extern int ports[MAXSOCKS];
-00083 extern int defaultRoute;
-00084 
-00085 extern std::vector<long> auth_cookies;
-00086 extern std::stringstream config_f;
-00087 
-00088 extern serverrec* me[32];
-00089 
-00090 extern FILE *log_file;
-00091 
-00092 
-00093 namespace nspace
-00094 {
-00095         template<> struct nspace::hash<in_addr>
-00096         {
-00097                 size_t operator()(const struct in_addr &a) const
-00098                 {
-00099                         size_t q;
-00100                         memcpy(&q,&a,sizeof(size_t));
-00101                         return q;
-00102                 }
-00103         };
+
+
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            
+
            modules.cpp
            Go to the documentation of this file.
            00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #include "inspircd.h"
+00018 #include "inspircd_io.h"
+00019 #include "inspircd_util.h"
+00020 #include "inspircd_config.h"
+00021 #include <unistd.h>
+00022 #include <fcntl.h>
+00023 #include <sys/errno.h>
+00024 #include <sys/ioctl.h>
+00025 #include <sys/utsname.h>
+00026 #include <cstdio>
+00027 #include <time.h>
+00028 #include <string>
+00029 #ifdef GCC3
+00030 #include <ext/hash_map>
+00031 #else
+00032 #include <hash_map>
+00033 #endif
+00034 #include <map>
+00035 #include <sstream>
+00036 #include <vector>
+00037 #include <errno.h>
+00038 #include <deque>
+00039 #include <errno.h>
+00040 #include <unistd.h>
+00041 #include <sched.h>
+00042 #include "connection.h"
+00043 #include "users.h"
+00044 #include "servers.h"
+00045 #include "ctables.h"
+00046 #include "globals.h"
+00047 #include "modules.h"
+00048 #include "dynamic.h"
+00049 #include "wildcard.h"
+00050 #include "message.h"
+00051 #include "mode.h"
+00052 #include "xline.h"
+00053 #include "commands.h"
+00054 
+00055 #ifdef GCC3
+00056 #define nspace __gnu_cxx
+00057 #else
+00058 #define nspace std
+00059 #endif
+00060 
+00061 using namespace std;
+00062 
+00063 extern int MODCOUNT;
+00064 extern vector<Module*> modules;
+00065 extern vector<ircd_module*> factory;
+00066 
+00067 extern int LogLevel;
+00068 extern char ServerName[MAXBUF];
+00069 extern char Network[MAXBUF];
+00070 extern char ServerDesc[MAXBUF];
+00071 extern char AdminName[MAXBUF];
+00072 extern char AdminEmail[MAXBUF];
+00073 extern char AdminNick[MAXBUF];
+00074 extern char diepass[MAXBUF];
+00075 extern char restartpass[MAXBUF];
+00076 extern char motd[MAXBUF];
+00077 extern char rules[MAXBUF];
+00078 extern char list[MAXBUF];
+00079 extern char PrefixQuit[MAXBUF];
+00080 extern char DieValue[MAXBUF];
+00081 
+00082 extern int debugging;
+00083 extern int WHOWAS_STALE;
+00084 extern int WHOWAS_MAX;
+00085 extern int DieDelay;
+00086 extern time_t startup_time;
+00087 extern int NetBufferSize;
+00088 extern int MaxWhoResults;
+00089 extern time_t nb_start;
+00090 
+00091 extern std::vector<int> fd_reap;
+00092 extern std::vector<std::string> module_names;
+00093 
+00094 extern int boundPortCount;
+00095 extern int portCount;
+00096 extern int UDPportCount;
+00097 extern int ports[MAXSOCKS];
+00098 extern int defaultRoute;
+00099 
+00100 extern std::vector<long> auth_cookies;
+00101 extern std::stringstream config_f;
+00102 
+00103 extern serverrec* me[32];
 00104 
-00105         template<> struct nspace::hash<string>
-00106         {
-00107                 size_t operator()(const string &s) const
-00108                 {
-00109                         char a[MAXBUF];
-00110                         static struct hash<const char *> strhash;
-00111                         strcpy(a,s.c_str());
-00112                         strlower(a);
-00113                         return strhash(a);
-00114                 }
-00115         };
-00116 }       
-00117 
-00118 
-00119 struct StrHashComp
-00120 {
-00121 
-00122         bool operator()(const string& s1, const string& s2) const
-00123         {
-00124                 char a[MAXBUF],b[MAXBUF];
-00125                 strcpy(a,s1.c_str());
-00126                 strcpy(b,s2.c_str());
-00127                 return (strcasecmp(a,b) == 0);
-00128         }
-00129 
-00130 };
-00131 
-00132 struct InAddr_HashComp
-00133 {
-00134 
-00135         bool operator()(const in_addr &s1, const in_addr &s2) const
-00136         {
-00137                 size_t q;
-00138                 size_t p;
-00139                 
-00140                 memcpy(&q,&s1,sizeof(size_t));
-00141                 memcpy(&p,&s2,sizeof(size_t));
-00142                 
-00143                 return (q == p);
-00144         }
-00145 
-00146 };
-00147 
-00148 
-00149 typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, StrHashComp> user_hash;
-00150 typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, StrHashComp> chan_hash;
-00151 typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, InAddr_HashComp> address_cache;
-00152 typedef std::deque<command_t> command_table;
-00153 
-00154 
-00155 extern user_hash clientlist;
-00156 extern chan_hash chanlist;
-00157 extern user_hash whowas;
-00158 extern command_table cmdlist;
-00159 extern file_cache MOTD;
-00160 extern file_cache RULES;
-00161 extern address_cache IP;
+00105 extern FILE *log_file;
+00106 
+00107 
+00108 namespace nspace
+00109 {
+00110         template<> struct nspace::hash<in_addr>
+00111         {
+00112                 size_t operator()(const struct in_addr &a) const
+00113                 {
+00114                         size_t q;
+00115                         memcpy(&q,&a,sizeof(size_t));
+00116                         return q;
+00117                 }
+00118         };
+00119 
+00120         template<> struct nspace::hash<string>
+00121         {
+00122                 size_t operator()(const string &s) const
+00123                 {
+00124                         char a[MAXBUF];
+00125                         static struct hash<const char *> strhash;
+00126                         strlcpy(a,s.c_str(),MAXBUF);
+00127                         strlower(a);
+00128                         return strhash(a);
+00129                 }
+00130         };
+00131 }       
+00132 
+00133 
+00134 struct StrHashComp
+00135 {
+00136 
+00137         bool operator()(const string& s1, const string& s2) const
+00138         {
+00139                 char a[MAXBUF],b[MAXBUF];
+00140                 strlcpy(a,s1.c_str(),MAXBUF);
+00141                 strlcpy(b,s2.c_str(),MAXBUF);
+00142                 return (strcasecmp(a,b) == 0);
+00143         }
+00144 
+00145 };
+00146 
+00147 struct InAddr_HashComp
+00148 {
+00149 
+00150         bool operator()(const in_addr &s1, const in_addr &s2) const
+00151         {
+00152                 size_t q;
+00153                 size_t p;
+00154                 
+00155                 memcpy(&q,&s1,sizeof(size_t));
+00156                 memcpy(&p,&s2,sizeof(size_t));
+00157                 
+00158                 return (q == p);
+00159         }
+00160 
+00161 };
 00162 
 00163 
-00164 // class type for holding an extended mode character - internal to core
-00165 
-00166 class ExtMode : public classbase
-00167 {
-00168 public:
-00169         char modechar;
-00170         int type;
-00171         int params_when_on;
-00172         int params_when_off;
-00173         bool needsoper;
-00174         bool list;
-00175         ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
-00176 };                                     
+00164 typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, StrHashComp> user_hash;
+00165 typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, StrHashComp> chan_hash;
+00166 typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, InAddr_HashComp> address_cache;
+00167 typedef std::deque<command_t> command_table;
+00168 
+00169 
+00170 extern user_hash clientlist;
+00171 extern chan_hash chanlist;
+00172 extern user_hash whowas;
+00173 extern command_table cmdlist;
+00174 extern file_cache MOTD;
+00175 extern file_cache RULES;
+00176 extern address_cache IP;
 00177 
-00178 typedef std::vector<ExtMode> ExtModeList;
-00179 typedef ExtModeList::iterator ExtModeListIter;
+00178 
+00179 // class type for holding an extended mode character - internal to core
 00180 
-00181 
-00182 ExtModeList EMode;
-00183 
-00184 // returns true if an extended mode character is in use
-00185 bool ModeDefined(char modechar, int type)
-00186 {
-00187         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00188         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00189         {
-00190                 log(DEBUG,"i->modechar==%c, modechar=%c, i->type=%d, type=%d",i->modechar,modechar,i->type,type);
-00191                 if ((i->modechar == modechar) && (i->type == type))
-00192                 {
-00193                         return true;
-00194                 }
-00195         }
-00196         return false;
-00197 }
+00181 class ExtMode : public classbase
+00182 {
+00183 public:
+00184         char modechar;
+00185         int type;
+00186         int params_when_on;
+00187         int params_when_off;
+00188         bool needsoper;
+00189         bool list;
+00190         ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
+00191 };                                     
+00192 
+00193 typedef std::vector<ExtMode> ExtModeList;
+00194 typedef ExtModeList::iterator ExtModeListIter;
+00195 
+00196 
+00197 ExtModeList EMode;
 00198 
-00199 bool ModeIsListMode(char modechar, int type)
-00200 {
-00201         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00202         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00203         {
-00204                 log(DEBUG,"i->modechar==%c, modechar=%c, i->type=%d, type=%d",i->modechar,modechar,i->type,type);
-00205                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00199 // returns true if an extended mode character is in use
+00200 bool ModeDefined(char modechar, int type)
+00201 {
+00202         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00203         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00204         {
+00205                 if ((i->modechar == modechar) && (i->type == type))
 00206                 {
 00207                         return true;
 00208                 }
@@ -218,513 +217,562 @@
 00210         return false;
 00211 }
 00212 
-00213 bool ModeDefinedOper(char modechar, int type)
+00213 bool ModeIsListMode(char modechar, int type)
 00214 {
-00215         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00216         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00215         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00216         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
 00217         {
-00218                 log(DEBUG,"i->modechar==%c, modechar=%c, i->type=%d, type=%d",i->modechar,modechar,i->type,type);
-00219                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-00220                 {
-00221                         return true;
-00222                 }
-00223         }
-00224         return false;
-00225 }
-00226 
-00227 // returns number of parameters for a custom mode when it is switched on
-00228 int ModeDefinedOn(char modechar, int type)
-00229 {
-00230         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00231         {
-00232                 if ((i->modechar == modechar) && (i->type == type))
-00233                 {
-00234                         return i->params_when_on;
-00235                 }
-00236         }
-00237         return 0;
-00238 }
-00239 
-00240 // returns number of parameters for a custom mode when it is switched on
-00241 int ModeDefinedOff(char modechar, int type)
-00242 {
-00243         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00244         {
-00245                 if ((i->modechar == modechar) && (i->type == type))
-00246                 {
-00247                         return i->params_when_off;
-00248                 }
-00249         }
-00250         return 0;
-00251 }
-00252 
-00253 // returns true if an extended mode character is in use
-00254 bool DoAddExtendedMode(char modechar, int type, bool requires_oper, int params_on, int params_off)
-00255 {
-00256         if (ModeDefined(modechar,type)) {
-00257                 return false;
-00258         }
-00259         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
-00260         return true;
-00261 }
-00262 
-00263 // turns a mode into a listmode
-00264 void ModeMakeList(char modechar)
-00265 {
-00266         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00267         {
-00268                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-00269                 {
-00270                         i->list = true;
-00271                         return;
-00272                 }
-00273         }
-00274         return;
-00275 }
-00276 
-00277 // version is a simple class for holding a modules version number
-00278 
-00279 Version::Version(int major, int minor, int revision, int build) : Major(major), Minor(minor), Revision(revision), Build(build) { };
-00280 
-00281 // admin is a simple class for holding a server's administrative info
-00282 
-00283 Admin::Admin(std::string name, std::string email, std::string nick) : Name(name), Email(email), Nick(nick) { };
-00284 
-00285 Module::Module() { }
-00286 Module::~Module() { }
-00287 void Module::OnUserConnect(userrec* user) { }
-00288 void Module::OnUserQuit(userrec* user) { }
-00289 void Module::OnUserJoin(userrec* user, chanrec* channel) { }
-00290 void Module::OnUserPart(userrec* user, chanrec* channel) { }
-00291 void Module::OnPacketTransmit(char *p) { }
-00292 void Module::OnPacketReceive(char *p) { }
-00293 void Module::OnRehash() { }
-00294 void Module::OnServerRaw(std::string &raw, bool inbound, userrec* user) { }
-00295 int Module::OnUserPreJoin(userrec* user, chanrec* chan, const char* cname) { return 0; }
-00296 int Module::OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params) { return false; }
-00297 Version Module::GetVersion() { return Version(1,0,0,0); }
-00298 void Module::OnOper(userrec* user) { };
-00299 void Module::OnInfo(userrec* user) { };
-00300 void Module::OnWhois(userrec* source, userrec* dest) { };
-00301 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text) { return 0; };
-00302 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text) { return 0; };
-00303 int Module::OnUserPreNick(userrec* user, std::string newnick) { return 0; };
-00304 int Module::OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type) { return ACR_DEFAULT; };
-00305 string_list Module::OnUserSync(userrec* user) { string_list empty; return empty; }
-00306 string_list Module::OnChannelSync(chanrec* chan) { string_list empty; return empty; }
-00307 
-00308 
-00309 // server is a wrapper class that provides methods to all of the C-style
-00310 // exports in the core
-00311 //
-00312 
-00313 Server::Server()
-00314 {
-00315 }
-00316 
-00317 Server::~Server()
-00318 {
-00319 }
+00218                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00219                 {
+00220                         return true;
+00221                 }
+00222         }
+00223         return false;
+00224 }
+00225 
+00226 bool ModeDefinedOper(char modechar, int type)
+00227 {
+00228         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00229         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00230         {
+00231                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+00232                 {
+00233                         return true;
+00234                 }
+00235         }
+00236         return false;
+00237 }
+00238 
+00239 // returns number of parameters for a custom mode when it is switched on
+00240 int ModeDefinedOn(char modechar, int type)
+00241 {
+00242         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00243         {
+00244                 if ((i->modechar == modechar) && (i->type == type))
+00245                 {
+00246                         return i->params_when_on;
+00247                 }
+00248         }
+00249         return 0;
+00250 }
+00251 
+00252 // returns number of parameters for a custom mode when it is switched on
+00253 int ModeDefinedOff(char modechar, int type)
+00254 {
+00255         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00256         {
+00257                 if ((i->modechar == modechar) && (i->type == type))
+00258                 {
+00259                         return i->params_when_off;
+00260                 }
+00261         }
+00262         return 0;
+00263 }
+00264 
+00265 // returns true if an extended mode character is in use
+00266 bool DoAddExtendedMode(char modechar, int type, bool requires_oper, int params_on, int params_off)
+00267 {
+00268         if (ModeDefined(modechar,type)) {
+00269                 return false;
+00270         }
+00271         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
+00272         return true;
+00273 }
+00274 
+00275 // turns a mode into a listmode
+00276 void ModeMakeList(char modechar)
+00277 {
+00278         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00279         {
+00280                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+00281                 {
+00282                         i->list = true;
+00283                         return;
+00284                 }
+00285         }
+00286         return;
+00287 }
+00288 
+00289 // version is a simple class for holding a modules version number
+00290 
+00291 Version::Version(int major, int minor, int revision, int build) : Major(major), Minor(minor), Revision(revision), Build(build) { };
+00292 
+00293 // admin is a simple class for holding a server's administrative info
+00294 
+00295 Admin::Admin(std::string name, std::string email, std::string nick) : Name(name), Email(email), Nick(nick) { };
+00296 
+00297 Module::Module() { }
+00298 Module::~Module() { }
+00299 void Module::OnUserConnect(userrec* user) { }
+00300 void Module::OnUserQuit(userrec* user) { }
+00301 void Module::OnUserJoin(userrec* user, chanrec* channel) { }
+00302 void Module::OnUserPart(userrec* user, chanrec* channel) { }
+00303 void Module::OnPacketTransmit(char *p) { }
+00304 void Module::OnPacketReceive(char *p) { }
+00305 void Module::OnRehash() { }
+00306 void Module::OnServerRaw(std::string &raw, bool inbound, userrec* user) { }
+00307 int Module::OnUserPreJoin(userrec* user, chanrec* chan, const char* cname) { return 0; }
+00308 int Module::OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params) { return false; }
+00309 Version Module::GetVersion() { return Version(1,0,0,0); }
+00310 void Module::OnOper(userrec* user) { };
+00311 void Module::OnInfo(userrec* user) { };
+00312 void Module::OnWhois(userrec* source, userrec* dest) { };
+00313 int Module::OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel) { return 0; };
+00314 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text) { return 0; };
+00315 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text) { return 0; };
+00316 int Module::OnUserPreNick(userrec* user, std::string newnick) { return 0; };
+00317 int Module::OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type) { return ACR_DEFAULT; };
+00318 string_list Module::OnUserSync(userrec* user) { string_list empty; return empty; }
+00319 string_list Module::OnChannelSync(chanrec* chan) { string_list empty; return empty; }
 00320 
-00321 void Server::SendOpers(std::string s)
-00322 {
-00323         WriteOpers("%s",s.c_str());
-00324 }
+00321 
+00322 // server is a wrapper class that provides methods to all of the C-style
+00323 // exports in the core
+00324 //
 00325 
-00326 bool Server::MatchText(std::string sliteral, std::string spattern)
+00326 Server::Server()
 00327 {
-00328         char literal[MAXBUF],pattern[MAXBUF];
-00329         strncpy(literal,sliteral.c_str(),MAXBUF);
-00330         strncpy(pattern,spattern.c_str(),MAXBUF);
-00331         return match(literal,pattern);
+00328 }
+00329 
+00330 Server::~Server()
+00331 {
 00332 }
 00333 
-00334 void Server::SendToModeMask(std::string modes, int flags, std::string text)
+00334 void Server::SendOpers(std::string s)
 00335 {
-00336         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00336         WriteOpers("%s",s.c_str());
 00337 }
 00338 
-00339 chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key)
+00339 bool Server::MatchText(std::string sliteral, std::string spattern)
 00340 {
-00341         return add_channel(user,cname.c_str(),key.c_str(),true);
-00342 }
-00343 
-00344 chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason)
-00345 {
-00346         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00347 }
-00348 
-00349 chanuserlist Server::GetUsers(chanrec* chan)
-00350 {
-00351         chanuserlist userl;
-00352         userl.clear();
-00353         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00354         {
-00355                 if (i->second)
-00356                 {
-00357                         if (has_channel(i->second,chan))
-00358                         {
-00359                                 if (isnick(i->second->nick))
-00360                                 {
-00361                                         userl.push_back(i->second);
-00362                                 }
-00363                         }
-00364                 }
-00365         }
-00366         return userl;
-00367 }
-00368 void Server::ChangeUserNick(userrec* user, std::string nickname)
-00369 {
-00370         force_nickchange(user,nickname.c_str());
-00371 }
-00372 
-00373 void Server::QuitUser(userrec* user, std::string reason)
-00374 {
-00375         send_network_quit(user->nick,reason.c_str());
-00376         kill_link(user,reason.c_str());
-00377 }
-00378 
-00379 bool Server::IsUlined(std::string server)
-00380 {
-00381         return is_uline(server.c_str());
-00382 }
-00383 
-00384 void Server::CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user)
-00385 {
-00386         call_handler(commandname.c_str(),parameters,pcnt,user);
-00387 }
-00388 
-00389 void Server::Log(int level, std::string s)
-00390 {
-00391         log(level,"%s",s.c_str());
-00392 }
-00393 
-00394 void Server::AddCommand(char* cmd, handlerfunc f, char flags, int minparams)
-00395 {
-00396         createcommand(cmd,f,flags,minparams);
-00397 }
-00398 
-00399 void Server::SendMode(char **parameters, int pcnt, userrec *user)
-00400 {
-00401         server_mode(parameters,pcnt,user);
-00402 }
-00403 
-00404 void Server::Send(int Socket, std::string s)
-00405 {
-00406         Write(Socket,"%s",s.c_str());
-00407 }
-00408 
-00409 void Server::SendServ(int Socket, std::string s)
-00410 {
-00411         WriteServ(Socket,"%s",s.c_str());
-00412 }
-00413 
-00414 void Server::SendFrom(int Socket, userrec* User, std::string s)
-00415 {
-00416         WriteFrom(Socket,User,"%s",s.c_str());
-00417 }
-00418 
-00419 void Server::SendTo(userrec* Source, userrec* Dest, std::string s)
-00420 {
-00421         if (!Source)
-00422         {
-00423                 // if source is NULL, then the message originates from the local server
-00424                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00425         }
-00426         else
-00427         {
-00428                 // otherwise it comes from the user specified
-00429                 WriteTo(Source,Dest,"%s",s.c_str());
-00430         }
-00431 }
-00432 
-00433 void Server::SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender)
-00434 {
-00435         if (IncludeSender)
-00436         {
-00437                 WriteChannel(Channel,User,"%s",s.c_str());
+00341         char literal[MAXBUF],pattern[MAXBUF];
+00342         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00343         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00344         return match(literal,pattern);
+00345 }
+00346 
+00347 void Server::SendToModeMask(std::string modes, int flags, std::string text)
+00348 {
+00349         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00350 }
+00351 
+00352 chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key)
+00353 {
+00354         return add_channel(user,cname.c_str(),key.c_str(),true);
+00355 }
+00356 
+00357 chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason)
+00358 {
+00359         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00360 }
+00361 
+00362 chanuserlist Server::GetUsers(chanrec* chan)
+00363 {
+00364         chanuserlist userl;
+00365         userl.clear();
+00366         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+00367         {
+00368                 if (i->second)
+00369                 {
+00370                         if (has_channel(i->second,chan))
+00371                         {
+00372                                 if (isnick(i->second->nick))
+00373                                 {
+00374                                         userl.push_back(i->second);
+00375                                 }
+00376                         }
+00377                 }
+00378         }
+00379         return userl;
+00380 }
+00381 void Server::ChangeUserNick(userrec* user, std::string nickname)
+00382 {
+00383         force_nickchange(user,nickname.c_str());
+00384 }
+00385 
+00386 void Server::QuitUser(userrec* user, std::string reason)
+00387 {
+00388         send_network_quit(user->nick,reason.c_str());
+00389         kill_link(user,reason.c_str());
+00390 }
+00391 
+00392 bool Server::IsUlined(std::string server)
+00393 {
+00394         return is_uline(server.c_str());
+00395 }
+00396 
+00397 void Server::CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user)
+00398 {
+00399         call_handler(commandname.c_str(),parameters,pcnt,user);
+00400 }
+00401 
+00402 void Server::Log(int level, std::string s)
+00403 {
+00404         log(level,"%s",s.c_str());
+00405 }
+00406 
+00407 void Server::AddCommand(char* cmd, handlerfunc f, char flags, int minparams)
+00408 {
+00409         createcommand(cmd,f,flags,minparams);
+00410 }
+00411 
+00412 void Server::SendMode(char **parameters, int pcnt, userrec *user)
+00413 {
+00414         server_mode(parameters,pcnt,user);
+00415 }
+00416 
+00417 void Server::Send(int Socket, std::string s)
+00418 {
+00419         Write(Socket,"%s",s.c_str());
+00420 }
+00421 
+00422 void Server::SendServ(int Socket, std::string s)
+00423 {
+00424         WriteServ(Socket,"%s",s.c_str());
+00425 }
+00426 
+00427 void Server::SendFrom(int Socket, userrec* User, std::string s)
+00428 {
+00429         WriteFrom(Socket,User,"%s",s.c_str());
+00430 }
+00431 
+00432 void Server::SendTo(userrec* Source, userrec* Dest, std::string s)
+00433 {
+00434         if (!Source)
+00435         {
+00436                 // if source is NULL, then the message originates from the local server
+00437                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
 00438         }
 00439         else
 00440         {
-00441                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00442         }
-00443 }
-00444 
-00445 bool Server::CommonChannels(userrec* u1, userrec* u2)
-00446 {
-00447         return (common_channels(u1,u2) != 0);
-00448 }
-00449 
-00450 void Server::SendCommon(userrec* User, std::string text,bool IncludeSender)
-00451 {
-00452         if (IncludeSender)
+00441                 // otherwise it comes from the user specified
+00442                 WriteTo(Source,Dest,"%s",s.c_str());
+00443         }
+00444 }
+00445 
+00446 void Server::SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender)
+00447 {
+00448         if (IncludeSender)
+00449         {
+00450                 WriteChannel(Channel,User,"%s",s.c_str());
+00451         }
+00452         else
 00453         {
-00454                 WriteCommon(User,"%s",text.c_str());
+00454                 ChanExceptSender(Channel,User,"%s",s.c_str());
 00455         }
-00456         else
-00457         {
-00458                 WriteCommonExcept(User,"%s",text.c_str());
-00459         }
-00460 }
-00461 
-00462 void Server::SendWallops(userrec* User, std::string text)
-00463 {
-00464         WriteWallOps(User,false,"%s",text.c_str());
-00465 }
-00466 
-00467 void Server::ChangeHost(userrec* user, std::string host)
-00468 {
-00469         ChangeDisplayedHost(user,host.c_str());
-00470 }
-00471 
-00472 void Server::ChangeGECOS(userrec* user, std::string gecos)
-00473 {
-00474         ChangeName(user,gecos.c_str());
-00475 }
-00476 
-00477 bool Server::IsNick(std::string nick)
-00478 {
-00479         return (isnick(nick.c_str()) != 0);
-00480 }
-00481 
-00482 userrec* Server::FindNick(std::string nick)
-00483 {
-00484         return Find(nick);
-00485 }
-00486 
-00487 chanrec* Server::FindChannel(std::string channel)
-00488 {
-00489         return FindChan(channel.c_str());
-00490 }
-00491 
-00492 std::string Server::ChanMode(userrec* User, chanrec* Chan)
-00493 {
-00494         return cmode(User,Chan);
-00495 }
-00496 
-00497 bool Server::IsOnChannel(userrec* User, chanrec* Chan)
-00498 {
-00499         return has_channel(User,Chan);
-00500 }
-00501 
-00502 std::string Server::GetServerName()
-00503 {
-00504         return getservername();
-00505 }
-00506 
-00507 std::string Server::GetNetworkName()
-00508 {
-00509         return getnetworkname();
-00510 }
-00511 
-00512 Admin Server::GetAdmin()
-00513 {
-00514         return Admin(getadminname(),getadminemail(),getadminnick());
-00515 }
-00516 
-00517 
-00518 
-00519 bool Server::AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
-00520 {
-00521         if (type == MT_SERVER)
-00522         {
-00523                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00524                 return false;
-00525         }
-00526         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00527         {
-00528                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00529                 return false;
-00530         }
-00531         if ((params_when_on>1) || (params_when_off>1))
-00532         {
-00533                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00534                 return false;
-00535         }
-00536         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00537 }
-00538 
-00539 bool Server::AddExtendedListMode(char modechar)
-00540 {
-00541         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00542         if (res)
-00543                 ModeMakeList(modechar);
-00544         return res;
-00545 }
-00546 
-00547 int Server::CountUsers(chanrec* c)
-00548 {
-00549         return usercount(c);
+00456 }
+00457 
+00458 bool Server::CommonChannels(userrec* u1, userrec* u2)
+00459 {
+00460         return (common_channels(u1,u2) != 0);
+00461 }
+00462 
+00463 void Server::SendCommon(userrec* User, std::string text,bool IncludeSender)
+00464 {
+00465         if (IncludeSender)
+00466         {
+00467                 WriteCommon(User,"%s",text.c_str());
+00468         }
+00469         else
+00470         {
+00471                 WriteCommonExcept(User,"%s",text.c_str());
+00472         }
+00473 }
+00474 
+00475 void Server::SendWallops(userrec* User, std::string text)
+00476 {
+00477         WriteWallOps(User,false,"%s",text.c_str());
+00478 }
+00479 
+00480 void Server::ChangeHost(userrec* user, std::string host)
+00481 {
+00482         ChangeDisplayedHost(user,host.c_str());
+00483 }
+00484 
+00485 void Server::ChangeGECOS(userrec* user, std::string gecos)
+00486 {
+00487         ChangeName(user,gecos.c_str());
+00488 }
+00489 
+00490 bool Server::IsNick(std::string nick)
+00491 {
+00492         return (isnick(nick.c_str()) != 0);
+00493 }
+00494 
+00495 userrec* Server::FindNick(std::string nick)
+00496 {
+00497         return Find(nick);
+00498 }
+00499 
+00500 chanrec* Server::FindChannel(std::string channel)
+00501 {
+00502         return FindChan(channel.c_str());
+00503 }
+00504 
+00505 std::string Server::ChanMode(userrec* User, chanrec* Chan)
+00506 {
+00507         return cmode(User,Chan);
+00508 }
+00509 
+00510 bool Server::IsOnChannel(userrec* User, chanrec* Chan)
+00511 {
+00512         return has_channel(User,Chan);
+00513 }
+00514 
+00515 std::string Server::GetServerName()
+00516 {
+00517         return getservername();
+00518 }
+00519 
+00520 std::string Server::GetNetworkName()
+00521 {
+00522         return getnetworkname();
+00523 }
+00524 
+00525 Admin Server::GetAdmin()
+00526 {
+00527         return Admin(getadminname(),getadminemail(),getadminnick());
+00528 }
+00529 
+00530 
+00531 
+00532 bool Server::AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
+00533 {
+00534         if (type == MT_SERVER)
+00535         {
+00536                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00537                 return false;
+00538         }
+00539         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00540         {
+00541                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00542                 return false;
+00543         }
+00544         if ((params_when_on>1) || (params_when_off>1))
+00545         {
+00546                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00547                 return false;
+00548         }
+00549         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 00550 }
 00551 
-00552 
-00553 ConfigReader::ConfigReader()
-00554 {
-00555         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00556         this->readerror = LoadConf(CONFIG_FILE,this->cache);
-00557         if (!this->readerror)
-00558                 this->error = CONF_FILE_NOT_FOUND;
-00559 }
-00560 
-00561 
-00562 ConfigReader::~ConfigReader()
-00563 {
-00564         if (this->cache)
-00565                 delete this->cache;
-00566 }
-00567 
-00568 
-00569 ConfigReader::ConfigReader(std::string filename)
-00570 {
-00571         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00572         this->readerror = LoadConf(filename.c_str(),this->cache);
-00573         if (!this->readerror)
-00574                 this->error = CONF_FILE_NOT_FOUND;
-00575 };
-00576 
-00577 std::string ConfigReader::ReadValue(std::string tag, std::string name, int index)
-00578 {
-00579         char val[MAXBUF];
-00580         char t[MAXBUF];
-00581         char n[MAXBUF];
-00582         strncpy(t,tag.c_str(),MAXBUF);
-00583         strncpy(n,name.c_str(),MAXBUF);
-00584         int res = ReadConf(cache,t,n,index,val);
-00585         if (!res)
-00586         {
-00587                 this->error = CONF_VALUE_NOT_FOUND;
-00588                 return "";
-00589         }
-00590         return std::string(val);
-00591 }
-00592 
-00593 bool ConfigReader::ReadFlag(std::string tag, std::string name, int index)
-00594 {
-00595         char val[MAXBUF];
-00596         char t[MAXBUF];
-00597         char n[MAXBUF];
-00598         strncpy(t,tag.c_str(),MAXBUF);
-00599         strncpy(n,name.c_str(),MAXBUF);
-00600         int res = ReadConf(cache,t,n,index,val);
-00601         if (!res)
-00602         {
-00603                 this->error = CONF_VALUE_NOT_FOUND;
-00604                 return false;
-00605         }
-00606         std::string s = val;
-00607         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00552 bool Server::AddExtendedListMode(char modechar)
+00553 {
+00554         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00555         if (res)
+00556                 ModeMakeList(modechar);
+00557         return res;
+00558 }
+00559 
+00560 int Server::CountUsers(chanrec* c)
+00561 {
+00562         return usercount(c);
+00563 }
+00564 
+00565 
+00566 ConfigReader::ConfigReader()
+00567 {
+00568         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00569         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00570         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00571         if (!this->readerror)
+00572                 this->error = CONF_FILE_NOT_FOUND;
+00573 }
+00574 
+00575 
+00576 ConfigReader::~ConfigReader()
+00577 {
+00578         if (this->cache)
+00579                 delete this->cache;
+00580         if (this->errorlog)
+00581                 delete this->errorlog;
+00582 }
+00583 
+00584 
+00585 ConfigReader::ConfigReader(std::string filename)
+00586 {
+00587         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00588         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00589         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00590         if (!this->readerror)
+00591                 this->error = CONF_FILE_NOT_FOUND;
+00592 };
+00593 
+00594 std::string ConfigReader::ReadValue(std::string tag, std::string name, int index)
+00595 {
+00596         char val[MAXBUF];
+00597         char t[MAXBUF];
+00598         char n[MAXBUF];
+00599         strlcpy(t,tag.c_str(),MAXBUF);
+00600         strlcpy(n,name.c_str(),MAXBUF);
+00601         int res = ReadConf(cache,t,n,index,val);
+00602         if (!res)
+00603         {
+00604                 this->error = CONF_VALUE_NOT_FOUND;
+00605                 return "";
+00606         }
+00607         return std::string(val);
 00608 }
 00609 
-00610 long ConfigReader::ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned)
+00610 bool ConfigReader::ReadFlag(std::string tag, std::string name, int index)
 00611 {
 00612         char val[MAXBUF];
 00613         char t[MAXBUF];
 00614         char n[MAXBUF];
-00615         strncpy(t,tag.c_str(),MAXBUF);
-00616         strncpy(n,name.c_str(),MAXBUF);
-00617         int res = ReadConf(cache,t,n,index,val);
+00615         strlcpy(t,tag.c_str(),MAXBUF);
+00616         strlcpy(n,name.c_str(),MAXBUF);
+00617         int res = ReadConf(cache,t,n,index,val);
 00618         if (!res)
 00619         {
-00620                 this->error = CONF_VALUE_NOT_FOUND;
-00621                 return 0;
+00620                 this->error = CONF_VALUE_NOT_FOUND;
+00621                 return false;
 00622         }
-00623         for (int i = 0; i < strlen(val); i++)
-00624         {
-00625                 if (!isdigit(val[i]))
-00626                 {
-00627                         this->error = CONF_NOT_A_NUMBER;
-00628                         return 0;
-00629                 }
-00630         }
-00631         if ((needs_unsigned) && (atoi(val)<0))
-00632         {
-00633                 this->error = CONF_NOT_UNSIGNED;
-00634                 return 0;
-00635         }
-00636         return atoi(val);
-00637 }
-00638 
-00639 long ConfigReader::GetError()
-00640 {
-00641         long olderr = this->error;
-00642         this->error = 0;
-00643         return olderr;
-00644 }
-00645 
-00646 
-00647 int ConfigReader::Enumerate(std::string tag)
-00648 {
-00649         return EnumConf(cache,tag.c_str());
-00650 }
-00651 
-00652 int ConfigReader::EnumerateValues(std::string tag, int index)
-00653 {
-00654         return EnumValues(cache, tag.c_str(), index);
-00655 }
-00656 
-00657 bool ConfigReader::Verify()
-00658 {
-00659         return this->readerror;
-00660 }
-00661 
+00623         std::string s = val;
+00624         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00625 }
+00626 
+00627 long ConfigReader::ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned)
+00628 {
+00629         char val[MAXBUF];
+00630         char t[MAXBUF];
+00631         char n[MAXBUF];
+00632         strlcpy(t,tag.c_str(),MAXBUF);
+00633         strlcpy(n,name.c_str(),MAXBUF);
+00634         int res = ReadConf(cache,t,n,index,val);
+00635         if (!res)
+00636         {
+00637                 this->error = CONF_VALUE_NOT_FOUND;
+00638                 return 0;
+00639         }
+00640         for (int i = 0; i < strlen(val); i++)
+00641         {
+00642                 if (!isdigit(val[i]))
+00643                 {
+00644                         this->error = CONF_NOT_A_NUMBER;
+00645                         return 0;
+00646                 }
+00647         }
+00648         if ((needs_unsigned) && (atoi(val)<0))
+00649         {
+00650                 this->error = CONF_NOT_UNSIGNED;
+00651                 return 0;
+00652         }
+00653         return atoi(val);
+00654 }
+00655 
+00656 long ConfigReader::GetError()
+00657 {
+00658         long olderr = this->error;
+00659         this->error = 0;
+00660         return olderr;
+00661 }
 00662 
-00663 FileReader::FileReader(std::string filename)
+00663 void ConfigReader::DumpErrors(bool bail, userrec* user)
 00664 {
-00665         file_cache c;
-00666         readfile(c,filename.c_str());
-00667         this->fc = c;
-00668 }
-00669 
-00670 FileReader::FileReader()
-00671 {
-00672 }
-00673 
-00674 void FileReader::LoadFile(std::string filename)
-00675 {
-00676         file_cache c;
-00677         readfile(c,filename.c_str());
-00678         this->fc = c;
-00679 }
-00680 
-00681 
-00682 FileReader::~FileReader()
-00683 {
-00684 }
-00685 
-00686 bool FileReader::Exists()
-00687 {
-00688         if (fc.size() == 0)
-00689         {
-00690                 return(false);
-00691         }
-00692         else
-00693         {
-00694                 return(true);
-00695         }
-00696 }
-00697 
-00698 std::string FileReader::GetLine(int x)
-00699 {
-00700         if ((x<0) || (x>fc.size()))
-00701                 return "";
-00702         return fc[x];
-00703 }
-00704 
-00705 int FileReader::FileSize()
-00706 {
-00707         return fc.size();
-00708 }
-00709 
+00665         if (bail)
+00666         {
+00667                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00668                 exit(0);
+00669         }
+00670         else
+00671         {
+00672                 char dataline[1024];
+00673                 if (user)
+00674                 {
+00675                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00676                         while (!errorlog->eof())
+00677                         {
+00678                                 errorlog->getline(dataline,1024);
+00679                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00680                         }
+00681                 }
+00682                 else
+00683                 {
+00684                         WriteOpers("There were errors in the configuration file:",user->nick);
+00685                         while (!errorlog->eof())
+00686                         {
+00687                                 errorlog->getline(dataline,1024);
+00688                                 WriteOpers(dataline);
+00689                         }
+00690                 }
+00691                 return;
+00692         }
+00693 }
+00694 
+00695 
+00696 int ConfigReader::Enumerate(std::string tag)
+00697 {
+00698         return EnumConf(cache,tag.c_str());
+00699 }
+00700 
+00701 int ConfigReader::EnumerateValues(std::string tag, int index)
+00702 {
+00703         return EnumValues(cache, tag.c_str(), index);
+00704 }
+00705 
+00706 bool ConfigReader::Verify()
+00707 {
+00708         return this->readerror;
+00709 }
 00710 
-00711 std::vector<Module*> modules(255);
-00712 std::vector<ircd_module*> factory(255);
-00713 
-00714 int MODCOUNT  = -1;
-00715 
-00716 
-
            Generated on Sun May 2 00:09:18 2004 for InspIRCd by
+00711 
+00712 FileReader::FileReader(std::string filename)
+00713 {
+00714         file_cache c;
+00715         readfile(c,filename.c_str());
+00716         this->fc = c;
+00717 }
+00718 
+00719 FileReader::FileReader()
+00720 {
+00721 }
+00722 
+00723 void FileReader::LoadFile(std::string filename)
+00724 {
+00725         file_cache c;
+00726         readfile(c,filename.c_str());
+00727         this->fc = c;
+00728 }
+00729 
+00730 
+00731 FileReader::~FileReader()
+00732 {
+00733 }
+00734 
+00735 bool FileReader::Exists()
+00736 {
+00737         if (fc.size() == 0)
+00738         {
+00739                 return(false);
+00740         }
+00741         else
+00742         {
+00743                 return(true);
+00744         }
+00745 }
+00746 
+00747 std::string FileReader::GetLine(int x)
+00748 {
+00749         if ((x<0) || (x>fc.size()))
+00750                 return "";
+00751         return fc[x];
+00752 }
+00753 
+00754 int FileReader::FileSize()
+00755 {
+00756         return fc.size();
+00757 }
+00758 
+00759 
+00760 std::vector<Module*> modules(255);
+00761 std::vector<ircd_module*> factory(255);
+00762 
+00763 int MODCOUNT  = -1;
+00764 
+00765 
+
            Generated on Fri Mar 25 03:49:28 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3 diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html index 7b8e91fc8..c409c582d 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -1,12 +1,11 @@ -modules.cpp File Reference +InspIRCd: modules.cpp File Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            modules.cpp File Reference

            #include "inspircd.h"
            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            modules.cpp File Reference

            #include "inspircd.h"
            #include "inspircd_io.h"
            #include "inspircd_util.h"
            #include "inspircd_config.h"
            @@ -38,106 +37,155 @@ #include "xline.h"
            #include "commands.h"
            -

            -Include dependency graph for modules.cpp:

            Include dependency graph
            - - - - - - - - - - - -

            Go to the source code of this file. - + + - - - + + + + + + - + + - - + + - + + - - - + in_addr >, InAddr_HashComp >  + + + + + + + - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

            Namespaces

            namespace  nspace
            namespace  nspace

            Compounds

            class  ExtMode
            struct  InAddr_HashComp
            struct  StrHashComp
            class  ExtMode
            struct  InAddr_HashComp
            struct  StrHashComp

            Defines

            #define nspace   std
            #define nspace   std

            Typedefs

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

            Functions

            bool ModeDefined (char modechar, int type)
            bool ModeIsListMode (char modechar, int type)
            bool ModeDefinedOper (char modechar, int type)
            int ModeDefinedOn (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)
            void ModeMakeList (char modechar)
            std::vector< Module * > modules (255)
            std::vector< ircd_module * > factory (255)
            bool ModeDefined (char modechar, int type)
            bool ModeIsListMode (char modechar, int type)
            bool ModeDefinedOper (char modechar, int type)
            int ModeDefinedOn (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)
            void ModeMakeList (char modechar)
            std::vector< Module * > modules (255)
            std::vector< ircd_module * > factory (255)

            Variables

            int MODCOUNT = -1
            vector< Module * > modules
            vector< ircd_module * > factory
            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< int > fd_reap
            std::vector< std::string > module_names
            char bannerBuffer [MAXBUF]
            int boundPortCount
            int portCount
            int UDPportCount
            int ports [MAXSOCKS]
            int defaultRoute
            std::vector< long > auth_cookies
            std::stringstream config_f
            serverrec * me [32]
            FILE * log_file
            user_hash clientlist
            chan_hash chanlist
            user_hash whowas
            command_table cmdlist
            file_cache MOTD
            file_cache RULES
            address_cache IP
            ExtModeList EMode
            int MODCOUNT = -1
            vector< Module * > modules
            vector< ircd_module * > factory
            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< int > fd_reap
            std::vector< std::string > module_names
            int boundPortCount
            int portCount
            int UDPportCount
            int ports [MAXSOCKS]
            int defaultRoute
            std::vector< long > auth_cookies
            std::stringstream config_f
            serverrec * me [32]
            FILE * log_file
            user_hash clientlist
            chan_hash chanlist
            user_hash whowas
            command_table cmdlist
            file_cache MOTD
            file_cache RULES
            address_cache IP
            ExtModeList EMode

            Define Documentation

            - +
            -
            + +Definition at line 58 of file modules.cpp.
            #define nspace   std @@ -155,17 +203,17 @@ Include dependency graph for modules.cpp:

            42 of file modules.cpp.

            Typedef Documentation

            -

            - +

            +

            - @@ -180,16 +228,16 @@ Definition at line 42 o

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

            - +

            +

            - @@ -204,16 +252,16 @@ Definition at line 151

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

            - +

            +

            - @@ -228,16 +276,16 @@ Definition at line 150

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

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

            - +

            +

            - @@ -252,16 +300,16 @@ Definition at line 152

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

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

            - +

            +

            - @@ -276,18 +324,18 @@ Definition at line 178

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

            - +

            +

            - @@ -302,44 +350,44 @@ Referenced by ModeDefined()

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

            -

            - +

            +

            -
            + - + - + - + - + - + @@ -361,33 +409,33 @@ Definition at line 149

            -Definition at line 254 of file modules.cpp. +Definition at line 266 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().

            -

            00255 {
-00256         if (ModeDefined(modechar,type)) {
-00257                 return false;
-00258         }
-00259         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
-00260         return true;
-00261 }
+
            00267 {
+00268         if (ModeDefined(modechar,type)) {
+00269                 return false;
+00270         }
+00271         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
+00272         return true;
+00273 }
            bool DoAddExtendedMode (  char   modechar, modechar,
            int   type, type,
            bool   requires_oper, requires_oper,
            int   params_on, params_on,
            int   params_off params_off
            -

            - +

            +

            -
            + - - + + @@ -406,22 +454,22 @@ Referenced by Server::AddEx
            std::vector<ircd_module*> factory (  255   )   ) 
            -

            - +

            +

            -
            + - + - + @@ -443,43 +491,42 @@ Referenced by Server::AddEx

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

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

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

            -

            00186 {
-00187         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00188         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00189         {
-00190                 log(DEBUG,"i->modechar==%c, modechar=%c, i->type=%d, type=%d",i->modechar,modechar,i->type,type);
-00191                 if ((i->modechar == modechar) && (i->type == type))
-00192                 {
-00193                         return true;
-00194                 }
-00195         }
-00196         return false;
-00197 }
+
            00201 {
+00202         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00203         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00204         {
+00205                 if ((i->modechar == modechar) && (i->type == type))
+00206                 {
+00207                         return true;
+00208                 }
+00209         }
+00210         return false;
+00211 }
            bool ModeDefined (  char   modechar, modechar,
            int   type type
            -

            - +

            +

            -
            + - + - + @@ -501,39 +548,39 @@ Referenced by DoAddExtended

            -Definition at line 241 of file modules.cpp. +Definition at line 253 of file modules.cpp.

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

            -

            00242 {
-00243         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00244         {
-00245                 if ((i->modechar == modechar) && (i->type == type))
-00246                 {
-00247                         return i->params_when_off;
-00248                 }
-00249         }
-00250         return 0;
-00251 }
+
            00254 {
+00255         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00256         {
+00257                 if ((i->modechar == modechar) && (i->type == type))
+00258                 {
+00259                         return i->params_when_off;
+00260                 }
+00261         }
+00262         return 0;
+00263 }
            int ModeDefinedOff (  char   modechar, modechar,
            int   type type
            -

            - +

            +

            -
            + - + - + @@ -555,39 +602,39 @@ References EMode, and <

            -Definition at line 228 of file modules.cpp. +Definition at line 240 of file modules.cpp.

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

            -

            00229 {
-00230         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00231         {
-00232                 if ((i->modechar == modechar) && (i->type == type))
-00233                 {
-00234                         return i->params_when_on;
-00235                 }
-00236         }
-00237         return 0;
-00238 }
+
            00241 {
+00242         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00243         {
+00244                 if ((i->modechar == modechar) && (i->type == type))
+00245                 {
+00246                         return i->params_when_on;
+00247                 }
+00248         }
+00249         return 0;
+00250 }
            int ModeDefinedOn (  char   modechar, modechar,
            int   type type
            -

            - +

            +

            -
            + - + - + @@ -609,41 +656,40 @@ References EMode, and <

            -Definition at line 213 of file modules.cpp. +Definition at line 226 of file modules.cpp.

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

            -

            00214 {
-00215         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00216         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00217         {
-00218                 log(DEBUG,"i->modechar==%c, modechar=%c, i->type=%d, type=%d",i->modechar,modechar,i->type,type);
-00219                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
-00220                 {
-00221                         return true;
-00222                 }
-00223         }
-00224         return false;
-00225 }
+
            00227 {
+00228         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00229         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00230         {
+00231                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+00232                 {
+00233                         return true;
+00234                 }
+00235         }
+00236         return false;
+00237 }
            bool ModeDefinedOper (  char   modechar, modechar,
            int   type type
            -

            - +

            +

            -
            + - + - + @@ -665,36 +711,35 @@ References EMode, and <

            -Definition at line 199 of file modules.cpp. +Definition at line 213 of file modules.cpp.

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

            -

            00200 {
-00201         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
-00202         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00203         {
-00204                 log(DEBUG,"i->modechar==%c, modechar=%c, i->type=%d, type=%d",i->modechar,modechar,i->type,type);
-00205                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
-00206                 {
-00207                         return true;
-00208                 }
-00209         }
-00210         return false;
-00211 }
+
            00214 {
+00215         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
+00216         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00217         {
+00218                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00219                 {
+00220                         return true;
+00221                 }
+00222         }
+00223         return false;
+00224 }
            bool ModeIsListMode (  char   modechar, modechar,
            int   type type
            -

            - +

            +

            -
            + - - + + @@ -712,37 +757,37 @@ References EMode, and <

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

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

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

            -

            00265 {
-00266         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
-00267         {
-00268                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
-00269                 {
-00270                         i->list = true;
-00271                         return;
-00272                 }
-00273         }
-00274         return;
-00275 }
+
            00277 {
+00278         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00279         {
+00280                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+00281                 {
+00282                         i->list = true;
+00283                         return;
+00284                 }
+00285         }
+00286         return;
+00287 }
            void ModeMakeList (  char   modechar )  modechar  ) 
            -

            - +

            +

            -
            + - - + + @@ -763,12 +808,12 @@ Referenced by Server::AddEx
            std::vector<Module*> modules (  255   )   ) 

            Variable Documentation

            - +
            - @@ -783,16 +828,16 @@ Referenced by Server::AddEx

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

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

            - +
            - @@ -807,40 +852,16 @@ Definition at line 56 o

            -Definition at line 55 of file modules.cpp. +Definition at line 71 of file modules.cpp.

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

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

            - -

            -Definition at line 57 of file modules.cpp.

            -

            - +
            - @@ -855,16 +876,16 @@ Definition at line 57 o

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

            + -
            std::vector<long> auth_cookies + char AdminNick[MAXBUF]
            -

            - +

            +

            - @@ -879,16 +900,16 @@ Definition at line 85 o

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

            + -
            char bannerBuffer[MAXBUF] + std::vector<long> auth_cookies
            -

            - +

            +

            - @@ -903,16 +924,16 @@ Definition at line 78 o

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

            + -
            int boundPortCount + int boundPortCount
            -

            - +

            +

            - @@ -927,16 +948,16 @@ Definition at line 79 o

            -Definition at line 156 of file modules.cpp. +Definition at line 171 of file modules.cpp.

            + -
            chan_hash chanlist + chan_hash chanlist
            -

            - +

            +

            - @@ -951,18 +972,18 @@ Definition at line 156

            -Definition at line 155 of file modules.cpp. +Definition at line 170 of file modules.cpp.

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

            + -
            user_hash clientlist + user_hash clientlist
            -

            - +

            +

            - @@ -977,16 +998,16 @@ Referenced by Server::GetUs

            -Definition at line 158 of file modules.cpp. +Definition at line 173 of file modules.cpp.

            + -
            command_table cmdlist + command_table cmdlist
            -

            - +

            +

            - @@ -1001,16 +1022,16 @@ Definition at line 158

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

            + -
            std::stringstream config_f + std::stringstream config_f

            - +
            - @@ -1025,16 +1046,16 @@ Definition at line 86 o

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

            + -
            int debugging + int debugging
            -

            - +

            +

            - @@ -1049,16 +1070,16 @@ Definition at line 66 o

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

            + -
            int defaultRoute + int defaultRoute

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

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

            + -
            int DieDelay + int DieDelay

            - +
            - @@ -1097,16 +1118,16 @@ Definition at line 69 o

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

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

            - +
            - @@ -1121,16 +1142,16 @@ Definition at line 58 o

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

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

            - +

            +

            - @@ -1145,15 +1166,15 @@ Definition at line 64 o

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

            - +
            -
            + +Definition at line 65 of file modules.cpp.
            vector<ircd_module*> factory @@ -1171,16 +1192,16 @@ Referenced by DoAddExtended

            -Definition at line 49 of file modules.cpp.

            - +
            - @@ -1195,16 +1216,16 @@ Definition at line 49 o

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

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

            - +

            +

            - @@ -1219,16 +1240,16 @@ Definition at line 75 o

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

            + -
            address_cache IP + address_cache IP

            - +
            - @@ -1243,16 +1264,16 @@ Definition at line 161

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

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

            - +

            +

            - @@ -1267,16 +1288,16 @@ Definition at line 62 o

            -Definition at line 90 of file modules.cpp. +Definition at line 105 of file modules.cpp.

            + -
            FILE* log_file + FILE* log_file

            - +
            - @@ -1291,16 +1312,16 @@ Definition at line 90 o

            -Definition at line 51 of file modules.cpp. +Definition at line 67 of file modules.cpp.

            + -
            int LogLevel + int LogLevel

            - +
            - @@ -1315,16 +1336,16 @@ Definition at line 51 o

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

            + -
            int MaxWhoResults + int MaxWhoResults
            -

            - +

            +

            - @@ -1339,16 +1360,16 @@ Definition at line 72 o

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

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

            - +
            - @@ -1363,16 +1384,16 @@ Definition at line 88 o

            -Definition at line 714 of file modules.cpp. +Definition at line 763 of file modules.cpp.

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

            - +
            - @@ -1387,13 +1408,13 @@ Definition at line 714

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

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

            - +
            -
            + +Definition at line 64 of file modules.cpp.
            vector<Module*> modules @@ -1411,16 +1432,16 @@ Definition at line 76 o

            -Definition at line 48 of file modules.cpp.

            -

            - +

            +

            - @@ -1435,16 +1456,16 @@ Definition at line 48 o

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

            + -
            file_cache MOTD + file_cache MOTD

            - +
            - @@ -1459,16 +1480,16 @@ Definition at line 159

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

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

            - +
            - @@ -1483,16 +1504,16 @@ Definition at line 60 o

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

            + -
            time_t nb_start + time_t nb_start

            - +
            - @@ -1507,16 +1528,16 @@ Definition at line 73 o

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

            + -
            int NetBufferSize + int NetBufferSize

            - +
            - @@ -1531,16 +1552,16 @@ Definition at line 71 o

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

            + -
            char Network[MAXBUF] + char Network[MAXBUF]
            -

            - +

            +

            - @@ -1555,16 +1576,16 @@ Definition at line 53 o

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

            + -
            int portCount + int portCount
            -

            - +

            +

            - @@ -1579,16 +1600,16 @@ Definition at line 80 o

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

            + -
            int ports[MAXSOCKS] + int ports[MAXSOCKS]

            - +
            - @@ -1603,16 +1624,16 @@ Definition at line 82 o

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

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

            - +
            - @@ -1627,16 +1648,16 @@ Definition at line 63 o

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

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

            - +

            +

            - @@ -1651,16 +1672,16 @@ Definition at line 59 o

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

            + -
            file_cache RULES + file_cache RULES

            - +
            - @@ -1675,16 +1696,16 @@ Definition at line 160

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

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

            - +
            - @@ -1699,16 +1720,16 @@ Definition at line 61 o

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

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

            - +
            - @@ -1723,16 +1744,16 @@ Definition at line 54 o

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

            + -
            char ServerName[MAXBUF] + char ServerName[MAXBUF]

            - +
            - @@ -1747,16 +1768,16 @@ Definition at line 52 o

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

            + -
            time_t startup_time + time_t startup_time
            -

            - +

            +

            - @@ -1771,16 +1792,16 @@ Definition at line 70 o

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

            + -
            int UDPportCount + int UDPportCount
            -

            - +

            +

            - @@ -1795,16 +1816,16 @@ Definition at line 81 o

            -Definition at line 157 of file modules.cpp. +Definition at line 172 of file modules.cpp.

            + -
            user_hash whowas + user_hash whowas

            - +
            - @@ -1819,16 +1840,16 @@ Definition at line 157

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

            + -
            int WHOWAS_MAX + int WHOWAS_MAX

            - +
            - @@ -1843,12 +1864,12 @@ Definition at line 68 o

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

            + -
            int WHOWAS_STALE + int WHOWAS_STALE
            -

            Generated on Sun May 2 00:09:25 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index 2ae27ca19..27aa2af8e 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -1,279 +1,293 @@ -modules.h Source File +InspIRCd: modules.h Source File - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            modules.h

            Go to the documentation of this file.
            00001 /*
-00002 
-00003 
-00004 
-00005 */
-00006 
-00007 
-00008 #ifndef __PLUGIN_H
-00009 #define __PLUGIN_H
-00010 
-00011 // log levels
-00012 
-00013 #define DEBUG 10
-00014 #define VERBOSE 20
-00015 #define DEFAULT 30
-00016 #define SPARSE 40
-00017 #define NONE 50
-00018 
-00019 // used with OnExtendedMode() method of modules
-00020 
-00021 #define MT_CHANNEL 1
-00022 #define MT_CLIENT 2
-00023 #define MT_SERVER 3
-00024 
-00025 // used with OnAccessCheck() method of modules
-00026 
-00027 #define ACR_DEFAULT 0           // Do default action (act as if the module isnt even loaded)
-00028 #define ACR_DENY 1              // deny the action
-00029 #define ACR_ALLOW 2             // allow the action
-00030 
-00031 #define AC_KICK 0               // a user is being kicked
-00032 #define AC_DEOP 1               // a user is being deopped
-00033 #define AC_OP 2                 // a user is being opped
-00034 #define AC_VOICE 3              // a user is being voiced
-00035 #define AC_DEVOICE 4            // a user is being devoiced
-00036 #define AC_HALFOP 5             // a user is being halfopped
-00037 #define AC_DEHALFOP 6           // a user is being dehalfopped
-00038 #define AC_INVITE 7             // a user is being invited
-00039 #define AC_GENERAL_MODE 8       // a user channel mode is being changed
+
+
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            
+
            modules.h
            Go to the documentation of this file.
            00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 
+00018 #ifndef __PLUGIN_H
+00019 #define __PLUGIN_H
+00020 
+00021 // log levels
+00022 
+00023 #define DEBUG 10
+00024 #define VERBOSE 20
+00025 #define DEFAULT 30
+00026 #define SPARSE 40
+00027 #define NONE 50
+00028 
+00029 // used with OnExtendedMode() method of modules
+00030 
+00031 #define MT_CHANNEL 1
+00032 #define MT_CLIENT 2
+00033 #define MT_SERVER 3
+00034 
+00035 // used with OnAccessCheck() method of modules
+00036 
+00037 #define ACR_DEFAULT 0           // Do default action (act as if the module isnt even loaded)
+00038 #define ACR_DENY 1              // deny the action
+00039 #define ACR_ALLOW 2             // allow the action
 00040 
-00041 #include "dynamic.h"
-00042 #include "base.h"
-00043 #include "ctables.h"
-00044 #include <string>
-00045 #include <deque>
-00046 #include <sstream>
-00047 
-00050 typedef std::deque<std::string> file_cache;
-00051 typedef file_cache string_list;
-00052 
-00055 typedef std::deque<userrec*> chanuserlist;
-00056 
+00041 #define AC_KICK 0               // a user is being kicked
+00042 #define AC_DEOP 1               // a user is being deopped
+00043 #define AC_OP 2                 // a user is being opped
+00044 #define AC_VOICE 3              // a user is being voiced
+00045 #define AC_DEVOICE 4            // a user is being devoiced
+00046 #define AC_HALFOP 5             // a user is being halfopped
+00047 #define AC_DEHALFOP 6           // a user is being dehalfopped
+00048 #define AC_INVITE 7             // a user is being invited
+00049 #define AC_GENERAL_MODE 8       // a user channel mode is being changed
+00050 
+00051 #include "dynamic.h"
+00052 #include "base.h"
+00053 #include "ctables.h"
+00054 #include <string>
+00055 #include <deque>
+00056 #include <sstream>
 00057 
-00058 // This #define allows us to call a method in all
-00059 // loaded modules in a readable simple way, e.g.:
-00060 // 'FOREACH_MOD OnConnect(user);'
-00061 
-00062 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
-00063 
-00064 // This define is similar to the one above but returns a result in MOD_RESULT.
-00065 // The first module to return a nonzero result is the value to be accepted,
-00066 // and any modules after are ignored.
+00060 typedef std::deque<std::string> file_cache;
+00061 typedef file_cache string_list;
+00062 
+00065 typedef std::deque<userrec*> chanuserlist;
+00066 
 00067 
-00068 // *********************************************************************************************
-00069 
-00070 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
-00071                         for (int i = 0; i <= MODCOUNT; i++) { \
-00072                         int res = modules[i]->x ; \
-00073                         if (res != 0) { \
-00074                                 MOD_RESULT = res; \
-00075                                 break; \
-00076                         } \
-00077                 } \
-00078         } 
-00079    
-00080 // *********************************************************************************************
-00081 
-00082 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
-00083 extern void server_mode(char **parameters, int pcnt, userrec *user);
-00084 
-00085 // class Version holds the version information of a Module, returned
-00086 // by Module::GetVersion (thanks RD)
-00087 
-00092 class Version : public classbase
-00093 {
-00094  public:
-00095          const int Major, Minor, Revision, Build;
-00096          Version(int major, int minor, int revision, int build);
-00097 };
-00098 
-00104 class Admin : public classbase
-00105 {
-00106  public:
-00107          const std::string Name, Email, Nick;
-00108          Admin(std::string name, std::string email, std::string nick);
-00109 };
-00110 
-00116 class Module : public classbase
-00117 {
-00118  public:
-00119 
-00123         Module();
-00124 
-00128         virtual ~Module();
+00068 // This #define allows us to call a method in all
+00069 // loaded modules in a readable simple way, e.g.:
+00070 // 'FOREACH_MOD OnConnect(user);'
+00071 
+00072 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
+00073 
+00074 // This define is similar to the one above but returns a result in MOD_RESULT.
+00075 // The first module to return a nonzero result is the value to be accepted,
+00076 // and any modules after are ignored.
+00077 
+00078 // *********************************************************************************************
+00079 
+00080 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
+00081                         for (int i = 0; i <= MODCOUNT; i++) { \
+00082                         int res = modules[i]->x ; \
+00083                         if (res != 0) { \
+00084                                 MOD_RESULT = res; \
+00085                                 break; \
+00086                         } \
+00087                 } \
+00088         } 
+00089    
+00090 // *********************************************************************************************
+00091 
+00092 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
+00093 extern void server_mode(char **parameters, int pcnt, userrec *user);
+00094 
+00095 // class Version holds the version information of a Module, returned
+00096 // by Module::GetVersion (thanks RD)
+00097 
+00102 class Version : public classbase
+00103 {
+00104  public:
+00105          const int Major, Minor, Revision, Build;
+00106          Version(int major, int minor, int revision, int build);
+00107 };
+00108 
+00114 class Admin : public classbase
+00115 {
+00116  public:
+00117          const std::string Name, Email, Nick;
+00118          Admin(std::string name, std::string email, std::string nick);
+00119 };
+00120 
+00126 class Module : public classbase
+00127 {
+00128  public:
 00129 
-00134         virtual Version GetVersion();
-00135 
-00139         virtual void OnUserConnect(userrec* user);
-00140 
-00144         virtual void OnUserQuit(userrec* user);
+00133         Module();
+00134 
+00138         virtual ~Module();
+00139 
+00144         virtual Version GetVersion();
 00145 
-00150         virtual void OnUserJoin(userrec* user, chanrec* channel);
-00151 
-00156         virtual void OnUserPart(userrec* user, chanrec* channel);
-00157 
-00164         virtual void OnPacketTransmit(char *p);
-00165 
-00173         virtual void OnPacketReceive(char *p);
-00174 
-00180         virtual void OnRehash();
-00181 
-00190         virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
+00149         virtual void OnUserConnect(userrec* user);
+00150 
+00154         virtual void OnUserQuit(userrec* user);
+00155 
+00160         virtual void OnUserJoin(userrec* user, chanrec* channel);
+00161 
+00166         virtual void OnUserPart(userrec* user, chanrec* channel);
+00167 
+00174         virtual void OnPacketTransmit(char *p);
+00175 
+00183         virtual void OnPacketReceive(char *p);
+00184 
+00190         virtual void OnRehash();
 00191 
-00201         virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
-00202         
-00216         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
-00217         
-00218         
-00223         virtual void OnOper(userrec* user);
-00224         
-00233         virtual void OnInfo(userrec* user);
+00200         virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
+00201 
+00211         virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
+00212         
+00226         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
+00227         
+00228         
+00233         virtual void OnOper(userrec* user);
 00234         
-00239         virtual void OnWhois(userrec* source, userrec* dest);
-00240         
-00249         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
-00250 
-00259         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
-00260         
-00268         virtual int OnUserPreNick(userrec* user, std::string newnick);
-00269         
-00292         virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
-00298         virtual string_list OnUserSync(userrec* user);
-00299 
-00305         virtual string_list OnChannelSync(chanrec* chan);
-00306 };
-00307 
-00308 
-00314 class Server : public classbase
-00315 {
-00316  public:
-00320         Server();
-00324         virtual ~Server();
-00325 
-00329         virtual void SendOpers(std::string s);
-00334         virtual void Log(int level, std::string s);
-00339         virtual void Send(int Socket, std::string s);
-00344         virtual void SendServ(int Socket, std::string s);
-00349         virtual void SendFrom(int Socket, userrec* User, std::string s);
-00364         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
-00371         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
-00376         virtual bool CommonChannels(userrec* u1, userrec* u2);
-00384         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
-00389         virtual void SendWallops(userrec* User, std::string text);
-00390 
-00394         virtual bool IsNick(std::string nick);
-00398         virtual int CountUsers(chanrec* c);
-00402         virtual userrec* FindNick(std::string nick);
-00406         virtual chanrec* FindChannel(std::string channel);
-00411         virtual std::string ChanMode(userrec* User, chanrec* Chan);
-00415         virtual bool IsOnChannel(userrec* User, chanrec* Chan);
-00418         virtual std::string GetServerName();
-00421         virtual std::string GetNetworkName();
-00427         virtual Admin GetAdmin();
-00446         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
-00447 
-00469         virtual bool AddExtendedListMode(char modechar);
-00470         
-00485         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
-00486          
-00508         virtual void SendMode(char **parameters, int pcnt, userrec *user);
-00509         
-00522         virtual void SendToModeMask(std::string modes, int flags, std::string text);
-00523 
-00529         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
-00530         
-00536         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
-00537         
-00543         virtual void ChangeUserNick(userrec* user, std::string nickname);
-00544         
-00555         virtual void QuitUser(userrec* user, std::string reason);
-00556         
-00561         virtual bool MatchText(std::string sliteral, std::string spattern);
-00562         
-00574         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
-00575         
-00581         virtual void ChangeHost(userrec* user, std::string host);
-00582         
-00588         virtual void ChangeGECOS(userrec* user, std::string gecos);
-00589         
-00598         virtual bool IsUlined(std::string server);
-00599         
-00603         virtual chanuserlist GetUsers(chanrec* chan);
-00604 
-00605 };
-00606 
-00607 #define CONF_NOT_A_NUMBER       0x000010
-00608 #define CONF_NOT_UNSIGNED       0x000080
-00609 #define CONF_VALUE_NOT_FOUND    0x000100
-00610 #define CONF_FILE_NOT_FOUND     0x000200
-00611 
-00618 class ConfigReader : public classbase
-00619 {
-00620   protected:
-00626         std::stringstream *cache;
-00629         bool readerror;
-00630         long error;
-00631         
-00632   public:
-00637         ConfigReader();                 // default constructor reads ircd.conf
-00641         ConfigReader(std::string filename);     // read a module-specific config
-00645         ~ConfigReader();
-00650         std::string ReadValue(std::string tag, std::string name, int index);
-00656         bool ReadFlag(std::string tag, std::string name, int index);
-00665         long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
-00670         long GetError();
-00677         int Enumerate(std::string tag);
-00682         bool Verify();
-00683 
-00689         int EnumerateValues(std::string tag, int index);
-00690 };
-00691 
-00692 
-00693 
-00699 class FileReader : public classbase
-00700 {
-00701  file_cache fc;
-00702  public:
-00707          FileReader();
-00708 
-00714          FileReader(std::string filename);
-00715 
-00719          ~FileReader();
-00720 
-00726          void LoadFile(std::string filename);
-00727 
-00731          bool Exists();
-00732          
-00737          std::string GetLine(int x);
-00738 
-00744          int FileSize();
-00745 };
+00243         virtual void OnInfo(userrec* user);
+00244         
+00249         virtual void OnWhois(userrec* source, userrec* dest);
+00250         
+00256         virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
+00257         
+00266         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
+00267 
+00279         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
+00280         
+00291         virtual int OnUserPreNick(userrec* user, std::string newnick);
+00292         
+00314         virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
+00315 
+00321         virtual string_list OnUserSync(userrec* user);
+00322 
+00328         virtual string_list OnChannelSync(chanrec* chan);
+00329 };
+00330 
+00331 
+00337 class Server : public classbase
+00338 {
+00339  public:
+00343         Server();
+00347         virtual ~Server();
+00348 
+00352         virtual void SendOpers(std::string s);
+00357         virtual void Log(int level, std::string s);
+00362         virtual void Send(int Socket, std::string s);
+00367         virtual void SendServ(int Socket, std::string s);
+00372         virtual void SendFrom(int Socket, userrec* User, std::string s);
+00387         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
+00394         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
+00399         virtual bool CommonChannels(userrec* u1, userrec* u2);
+00407         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
+00412         virtual void SendWallops(userrec* User, std::string text);
+00413 
+00417         virtual bool IsNick(std::string nick);
+00421         virtual int CountUsers(chanrec* c);
+00425         virtual userrec* FindNick(std::string nick);
+00429         virtual chanrec* FindChannel(std::string channel);
+00434         virtual std::string ChanMode(userrec* User, chanrec* Chan);
+00438         virtual bool IsOnChannel(userrec* User, chanrec* Chan);
+00441         virtual std::string GetServerName();
+00444         virtual std::string GetNetworkName();
+00450         virtual Admin GetAdmin();
+00469         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
+00470 
+00492         virtual bool AddExtendedListMode(char modechar);
+00493         
+00508         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
+00509          
+00531         virtual void SendMode(char **parameters, int pcnt, userrec *user);
+00532         
+00545         virtual void SendToModeMask(std::string modes, int flags, std::string text);
+00546 
+00552         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
+00553         
+00559         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
+00560         
+00566         virtual void ChangeUserNick(userrec* user, std::string nickname);
+00567         
+00578         virtual void QuitUser(userrec* user, std::string reason);
+00579         
+00584         virtual bool MatchText(std::string sliteral, std::string spattern);
+00585         
+00597         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
+00598         
+00604         virtual void ChangeHost(userrec* user, std::string host);
+00605         
+00611         virtual void ChangeGECOS(userrec* user, std::string gecos);
+00612         
+00621         virtual bool IsUlined(std::string server);
+00622         
+00626         virtual chanuserlist GetUsers(chanrec* chan);
+00627 
+00628 };
+00629 
+00630 #define CONF_NOT_A_NUMBER       0x000010
+00631 #define CONF_NOT_UNSIGNED       0x000080
+00632 #define CONF_VALUE_NOT_FOUND    0x000100
+00633 #define CONF_FILE_NOT_FOUND     0x000200
+00634 
+00641 class ConfigReader : public classbase
+00642 {
+00643   protected:
+00649         std::stringstream *cache;
+00650         std::stringstream *errorlog;
+00653         bool readerror;
+00654         long error;
+00655         
+00656   public:
+00661         ConfigReader();                 // default constructor reads ircd.conf
+00665         ConfigReader(std::string filename);     // read a module-specific config
+00669         ~ConfigReader();
+00674         std::string ReadValue(std::string tag, std::string name, int index);
+00680         bool ReadFlag(std::string tag, std::string name, int index);
+00689         long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
+00694         long GetError();
+00701         int Enumerate(std::string tag);
+00706         bool Verify();
+00713         void DumpErrors(bool bail,userrec* user);
+00714 
+00720         int EnumerateValues(std::string tag, int index);
+00721 };
+00722 
+00723 
+00724 
+00730 class FileReader : public classbase
+00731 {
+00732  file_cache fc;
+00733  public:
+00738          FileReader();
+00739 
+00745          FileReader(std::string filename);
 00746 
-00747 
-00754 class ModuleFactory : public classbase
-00755 {
-00756  public:
-00757         ModuleFactory() { }
-00758         virtual ~ModuleFactory() { }
-00763         virtual Module * CreateModule() = 0;
-00764 };
-00765 
-00766 
-00767 typedef DLLFactory<ModuleFactory> ircd_module;
-00768 
-00769 #endif
-
            Generated on Sun May 2 00:09:18 2004 for InspIRCd by
+00750          ~FileReader();
+00751 
+00757          void LoadFile(std::string filename);
+00758 
+00762          bool Exists();
+00763          
+00768          std::string GetLine(int x);
+00769 
+00775          int FileSize();
+00776 };
+00777 
+00778 
+00785 class ModuleFactory : public classbase
+00786 {
+00787  public:
+00788         ModuleFactory() { }
+00789         virtual ~ModuleFactory() { }
+00794         virtual Module * CreateModule() = 0;
+00795 };
+00796 
+00797 
+00798 typedef DLLFactory<ModuleFactory> ircd_module;
+00799 
+00800 #endif
+
            Generated on Fri Mar 25 03:49:28 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3 diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index c022538bb..edd0dbe30 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -1,93 +1,117 @@ -modules.h File Reference +InspIRCd: modules.h File Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            modules.h File Reference

            #include "dynamic.h"
            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            modules.h File Reference

            #include "dynamic.h"
            #include "base.h"
            #include "ctables.h"
            #include <string>
            #include <deque>
            #include <sstream>
            -

            -Include dependency graph for modules.h:

            Include dependency graph
            - - - - - -

            -This graph shows which files directly or indirectly include this file:

            Included by dependency graph
            - - - - -

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

            Compounds

            class  Admin
             Holds /ADMIN data This class contains the admin details of the local server. More...

            class  ConfigReader
             Allows 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. More...

            class  FileReader
             Caches a text file into memory and can be used to retrieve lines from it. More...

            class  Module
             Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...

            class  ModuleFactory
             Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. More...

            class  Server
             Allows 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. More...

            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...

            class  Admin
             Holds /ADMIN data This class contains the admin details of the local server. More...

            class  ConfigReader
             Allows 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. More...

            class  FileReader
             Caches a text file into memory and can be used to retrieve lines from it. More...

            class  Module
             Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...

            class  ModuleFactory
             Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. More...

            class  Server
             Allows 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. More...

            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 DEBUG   10
            #define VERBOSE   20
            #define DEFAULT   30
            #define SPARSE   40
            #define NONE   50
            #define MT_CHANNEL   1
            #define MT_CLIENT   2
            #define MT_SERVER   3
            #define ACR_DEFAULT   0
            #define ACR_DENY   1
            #define ACR_ALLOW   2
            #define AC_KICK   0
            #define AC_DEOP   1
            #define AC_OP   2
            #define AC_VOICE   3
            #define AC_DEVOICE   4
            #define AC_HALFOP   5
            #define AC_DEHALFOP   6
            #define AC_INVITE   7
            #define AC_GENERAL_MODE   8
            #define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->
            #define FOREACH_RESULT(x)
            #define CONF_NOT_A_NUMBER   0x000010
            #define CONF_NOT_UNSIGNED   0x000080
            #define CONF_VALUE_NOT_FOUND   0x000100
            #define CONF_FILE_NOT_FOUND   0x000200
            #define DEBUG   10
            #define VERBOSE   20
            #define DEFAULT   30
            #define SPARSE   40
            #define NONE   50
            #define MT_CHANNEL   1
            #define MT_CLIENT   2
            #define MT_SERVER   3
            #define ACR_DEFAULT   0
            #define ACR_DENY   1
            #define ACR_ALLOW   2
            #define AC_KICK   0
            #define AC_DEOP   1
            #define AC_OP   2
            #define AC_VOICE   3
            #define AC_DEVOICE   4
            #define AC_HALFOP   5
            #define AC_DEHALFOP   6
            #define AC_INVITE   7
            #define AC_GENERAL_MODE   8
            #define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->
            #define FOREACH_RESULT(x)
            #define CONF_NOT_A_NUMBER   0x000010
            #define CONF_NOT_UNSIGNED   0x000080
            #define CONF_VALUE_NOT_FOUND   0x000100
            #define CONF_FILE_NOT_FOUND   0x000200

            Typedefs

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

            typedef file_cache string_list
            typedef std::deque< userrec * > chanuserlist
             Holds a list of users in a channel.

            typedef DLLFactory< ModuleFactory > ircd_module
            typedef std::deque< std::string > file_cache
             Low level definition of a FileReader classes file cache area.

            typedef file_cache string_list
            typedef std::deque< userrec * > chanuserlist
             Holds a list of users in a channel.

            typedef DLLFactory< ModuleFactory > ircd_module

            Functions

            void createcommand (char *cmd, handlerfunc f, char flags, int minparams)
            void server_mode (char **parameters, int pcnt, userrec *user)
            void createcommand (char *cmd, handlerfunc f, char flags, int minparams)
            void server_mode (char **parameters, int pcnt, userrec *user)

            Define Documentation

            - +
            -
            + +Definition at line 47 of file modules.h.
            #define AC_DEHALFOP   6 @@ -105,13 +129,13 @@ This graph shows which files directly or indirectly include this file:

            -Definition at line 37 of file modules.h.

            - +
            -
            + +Definition at line 42 of file modules.h.
            #define AC_DEOP   1 @@ -129,13 +153,13 @@ Definition at line 37 of

            -Definition at line 32 of file modules.h.

            - +
            -
            + +Definition at line 45 of file modules.h.
            #define AC_DEVOICE   4 @@ -153,13 +177,13 @@ Definition at line 32 of

            -Definition at line 35 of file modules.h.

            - +
            -
            + +Definition at line 49 of file modules.h.
            #define AC_GENERAL_MODE   8 @@ -177,13 +201,13 @@ Definition at line 35 of

            -Definition at line 39 of file modules.h.

            - +
            -
            + +Definition at line 46 of file modules.h.
            #define AC_HALFOP   5 @@ -201,13 +225,13 @@ Definition at line 39 of

            -Definition at line 36 of file modules.h.

            - +
            -
            + +Definition at line 48 of file modules.h.
            #define AC_INVITE   7 @@ -225,13 +249,13 @@ Definition at line 36 of

            -Definition at line 38 of file modules.h.

            - +
            -
            + +Definition at line 41 of file modules.h.
            #define AC_KICK   0 @@ -249,13 +273,13 @@ Definition at line 38 of

            -Definition at line 31 of file modules.h.

            - +
            -
            + +Definition at line 43 of file modules.h.
            #define AC_OP   2 @@ -273,13 +297,13 @@ Definition at line 31 of

            -Definition at line 33 of file modules.h.

            - +
            -
            + +Definition at line 44 of file modules.h.
            #define AC_VOICE   3 @@ -297,13 +321,13 @@ Definition at line 33 of

            -Definition at line 34 of file modules.h.

            - +
            -
            + +Definition at line 39 of file modules.h.
            #define ACR_ALLOW   2 @@ -321,13 +345,13 @@ Definition at line 34 of

            -Definition at line 29 of file modules.h.

            - +
            -
            + +Referenced by Module::OnAccessCheck().
            #define ACR_DEFAULT   0 @@ -345,15 +369,15 @@ Definition at line 29 of

            -Definition at line 27 of file modules.h. +Definition at line 37 of file modules.h.

            -Referenced by Module::OnAccessCheck().

            - +
            -
            + +Definition at line 38 of file modules.h.
            #define ACR_DENY   1 @@ -371,13 +395,13 @@ Referenced by Module::OnAcc

            -Definition at line 28 of file modules.h.

            - +
            -
            + +Referenced by ConfigReader::ConfigReader().
            #define CONF_FILE_NOT_FOUND   0x000200 @@ -395,15 +419,15 @@ Definition at line 28 of

            -Definition at line 610 of file modules.h. +Definition at line 633 of file modules.h.

            -Referenced by ConfigReader::ConfigReader().

            - +
            -
            + +Referenced by ConfigReader::ReadInteger().
            #define CONF_NOT_A_NUMBER   0x000010 @@ -421,15 +445,15 @@ Referenced by ConfigReader:

            -Definition at line 607 of file modules.h. +Definition at line 630 of file modules.h.

            -Referenced by ConfigReader::ReadInteger().

            - +
            -
            + +Referenced by ConfigReader::ReadInteger().
            #define CONF_NOT_UNSIGNED   0x000080 @@ -447,15 +471,15 @@ Referenced by ConfigReader:

            -Definition at line 608 of file modules.h. +Definition at line 631 of file modules.h.

            -Referenced by ConfigReader::ReadInteger().

            - +
            -
            + +Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
            #define CONF_VALUE_NOT_FOUND   0x000100 @@ -473,15 +497,15 @@ Referenced by ConfigReader:

            -Definition at line 609 of file modules.h. +Definition at line 632 of file modules.h.

            -Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().

            - +
            -
            + +Definition at line 23 of file modules.h. +

            +Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam().

            #define DEBUG   10 @@ -499,13 +523,15 @@ Referenced by ConfigReader:

            -Definition at line 13 of file modules.h.

            - +
            -
            + +Definition at line 25 of file modules.h.
            #define DEFAULT   30 @@ -523,13 +549,13 @@ Definition at line 13 of

            -Definition at line 15 of file modules.h.

            - +
            -
            + +Definition at line 72 of file modules.h.
            #define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]-> @@ -547,20 +573,20 @@ Definition at line 15 of

            -Definition at line 62 of file modules.h.

            - +
            - @@ -585,13 +611,13 @@ Definition at line 62 of }

            -Definition at line 70 of file modules.h. +Definition at line 80 of file modules.h.

            + - - + +
            #define FOREACH_RESULT (  x   )   ) 

            - +
            -
            + +Referenced by Server::AddExtendedListMode(), and ModeMakeList().
            #define MT_CHANNEL   1 @@ -609,15 +635,15 @@ Definition at line 70 of

            -Definition at line 21 of file modules.h. +Definition at line 31 of file modules.h.

            -Referenced by ModeMakeList().

            - +
            -
            + +Referenced by Server::AddExtendedMode().
            #define MT_CLIENT   2 @@ -635,15 +661,15 @@ Referenced by ModeMakeList(

            -Definition at line 22 of file modules.h. +Definition at line 32 of file modules.h.

            -Referenced by Server::AddExtendedMode().

            - +
            -
            + +Referenced by Server::AddExtendedMode().
            #define MT_SERVER   3 @@ -661,15 +687,15 @@ Referenced by Server::AddEx

            -Definition at line 23 of file modules.h. +Definition at line 33 of file modules.h.

            -Referenced by Server::AddExtendedMode().

            - +
            -
            + +Definition at line 27 of file modules.h.
            #define NONE   50 @@ -687,13 +713,13 @@ Referenced by Server::AddEx

            -Definition at line 17 of file modules.h.

            - +
            -
            + +Definition at line 26 of file modules.h.
            #define SPARSE   40 @@ -711,13 +737,13 @@ Definition at line 17 of

            -Definition at line 16 of file modules.h.

            - +
            -
            + +Definition at line 24 of file modules.h.
            #define VERBOSE   20 @@ -735,17 +761,17 @@ Definition at line 16 of

            -Definition at line 14 of file modules.h.

            Typedef Documentation

            - +
            - @@ -758,22 +784,22 @@ Definition at line 14 of +Referenced by Server::GetUsers().
            + -
            typedef std::deque<userrec*> chanuserlist + typedef std::deque<userrec*> chanuserlist

            -Holds a list of users in a channel. +Holds a list of users in a channel.

            -Definition at line 55 of file modules.h. +Definition at line 65 of file modules.h.

            -Referenced by Server::GetUsers().

            - +
            - @@ -786,22 +812,22 @@ Referenced by Server::GetUs +Referenced by FileReader::FileReader(), and FileReader::LoadFile().
            + -
            typedef std::deque<std::string> file_cache + typedef std::deque<std::string> file_cache

            -Low level definition of a FileReader classes file cache area. +Low level definition of a FileReader classes file cache area.

            -Definition at line 50 of file modules.h. +Definition at line 60 of file modules.h.

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

            - +
            - @@ -816,16 +842,16 @@ Referenced by FileReader::F

            -Definition at line 767 of file modules.h. +Definition at line 798 of file modules.h.

            + -
            typedef DLLFactory<ModuleFactory> ircd_module + typedef DLLFactory<ModuleFactory> ircd_module

            - +
            - @@ -840,40 +866,40 @@ Definition at line 767 of

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

            -Referenced by Module::OnChannelSync(), and Module::OnUserSync(). +Referenced by Module::OnChannelSync(), and Module::OnUserSync().

            + -
            typedef file_cache string_list + typedef file_cache string_list

            Function Documentation

            - +
            -
            + - + - + - + - + @@ -895,31 +921,31 @@ Referenced by Module::OnCha

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

            void createcommand (  char *   cmd, cmd,
            handlerfunc   f, f,
            char   flags, flags,
            int   minparams minparams

            - +
            -
            + - + - + - + @@ -941,12 +967,12 @@ Referenced by Server::AddCo

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

            void server_mode (  char **   parameters, parameters,
            int   pcnt, pcnt,
            userrec *   user user
            -
            Generated on Sun May 2 00:09:26 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/namespacenspace.html b/docs/module-doc/namespacenspace.html index 319f87a2c..b4b1a3a17 100644 --- a/docs/module-doc/namespacenspace.html +++ b/docs/module-doc/namespacenspace.html @@ -1,22 +1,23 @@ -nspace Namespace Reference +InspIRCd: nspace Namespace Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            nspace Namespace Reference

            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            nspace Namespace Reference

            - - + + + +

            Compounds

            struct  hash< in_addr >
            struct  hash< string >
            struct  nspace.hash< in_addr >
            struct  nspace.hash< string >
            -

            Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/namespaces.html b/docs/module-doc/namespaces.html index a0ccee7f8..d1725372f 100644 --- a/docs/module-doc/namespaces.html +++ b/docs/module-doc/namespaces.html @@ -1,18 +1,17 @@ -Namespace Index +InspIRCd: Namespace Index - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            InspIRCd Namespace List

            Here is a list of all namespaces with brief descriptions: + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            InspIRCd Namespace List

            Here is a list of all namespaces with brief descriptions:
            nspace
            std
            -
            Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/namespacestd.html b/docs/module-doc/namespacestd.html index 1d41db21a..0f4d7ffbb 100644 --- a/docs/module-doc/namespacestd.html +++ b/docs/module-doc/namespacestd.html @@ -1,19 +1,18 @@ -std Namespace Reference +InspIRCd: std Namespace Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            std Namespace Reference

            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            std Namespace Reference

            -

            Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/servers_8cpp-source.html b/docs/module-doc/servers_8cpp-source.html index 010f2d50f..703b0bbb2 100644 --- a/docs/module-doc/servers_8cpp-source.html +++ b/docs/module-doc/servers_8cpp-source.html @@ -1,56 +1,68 @@ -servers.cpp Source File +InspIRCd: servers.cpp Source File - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            servers.cpp

            Go to the documentation of this file.
            00001 /*
-00002 
-00003 
-00004 */
-00005 
-00006 #include "inspircd_config.h" 
-00007 #include "servers.h"
-00008 #include "inspircd.h"
-00009 #include <stdio.h>
-00010 #include <map>
-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         sync_soon = false;
-00023 }
-00024 
-00025  
-00026 serverrec::~serverrec()
-00027 {
-00028 }
-00029 
-00030 serverrec::serverrec(char* n, long ver, bool jupe)
-00031 {
-00032         strcpy(name,n);
-00033         lastping = time(NULL);
-00034         usercount_i = usercount = opercount = 0;
-00035         version = ver;
-00036         hops_away = 1;
-00037         signon = time(NULL);
-00038         jupiter = jupe;
-00039         fd = 0;
-00040         sync_soon = false;
-00041 }
-00042 
-
            Generated on Sun May 2 00:09:18 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            servers.cpp

            Go to the documentation of this file.
            00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #include "inspircd_config.h" 
+00018 #include "servers.h"
+00019 #include "inspircd.h"
+00020 #include <stdio.h>
+00021 #include <map>
+00022 
+00023 serverrec::serverrec()
+00024 {
+00025         strlcpy(name,"",256);
+00026         pingtime = 0;
+00027         lastping = time(NULL);
+00028         usercount_i = usercount = opercount = version = 0;
+00029         hops_away = 1;
+00030         signon = time(NULL);
+00031         jupiter = false;
+00032         fd = 0;
+00033         sync_soon = false;
+00034         strlcpy(nickserv,"",NICKMAX);
+00035 }
+00036 
+00037  
+00038 serverrec::~serverrec()
+00039 {
+00040 }
+00041 
+00042 serverrec::serverrec(char* n, long ver, bool jupe)
+00043 {
+00044         strlcpy(name,n,256);
+00045         lastping = time(NULL);
+00046         usercount_i = usercount = opercount = 0;
+00047         version = ver;
+00048         hops_away = 1;
+00049         signon = time(NULL);
+00050         jupiter = jupe;
+00051         fd = 0;
+00052         sync_soon = false;
+00053         strlcpy(nickserv,"",NICKMAX);
+00054 }
+00055 
+
            Generated on Fri Mar 25 03:49:28 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/servers_8cpp.html b/docs/module-doc/servers_8cpp.html index 9c5a128ef..bbcfda75c 100644 --- a/docs/module-doc/servers_8cpp.html +++ b/docs/module-doc/servers_8cpp.html @@ -1,31 +1,23 @@ -servers.cpp File Reference +InspIRCd: servers.cpp File Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            servers.cpp File Reference

            #include "inspircd_config.h"
            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            servers.cpp File Reference

            #include "inspircd_config.h"
            #include "servers.h"
            #include "inspircd.h"
            #include <stdio.h>
            #include <map>
            -

            -Include dependency graph for servers.cpp:

            Include dependency graph
            - - - - -

            Go to the source code of this file.
            -

            Generated on Sun May 2 00:09:26 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/servers_8h-source.html b/docs/module-doc/servers_8h-source.html index b31390763..8579f1b15 100644 --- a/docs/module-doc/servers_8h-source.html +++ b/docs/module-doc/servers_8h-source.html @@ -1,57 +1,69 @@ -servers.h Source File +InspIRCd: servers.h Source File - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            servers.h

            Go to the documentation of this file.
            00001 /*
-00002 
-00003 
-00004 */
-00005 
-00006 #include "inspircd_config.h" 
-00007 #include "connection.h"
-00008 #include <string>
-00009 #include <map>
-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         char description[MAXBUF];
-00051         
-00052         bool sync_soon;
-00053 
-00056         serverrec();
-00059         serverrec(char* n, long ver, bool jupe);
-00062         ~serverrec();
-00063         
-00064 };
-00065 
-00066 
-00067 
-00068 #endif
-00069 
-
            Generated on Sun May 2 00:09:18 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            servers.h

            Go to the documentation of this file.
            00001 /*       +------------------------------------+
+00002  *       | Inspire Internet Relay Chat Daemon |
+00003  *       +------------------------------------+
+00004  *
+00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+00006  *                       E-mail:
+00007  *                <brain@chatspike.net>
+00008  *                <Craig@chatspike.net>
+00009  *     
+00010  * Written by Craig Edwards, Craig McLure, and others.
+00011  * This program is free but copyrighted software; see
+00012  *            the file COPYING for details.
+00013  *
+00014  * ---------------------------------------------------
+00015  */
+00016 
+00017 #include "inspircd_config.h" 
+00018 #include "connection.h"
+00019 #include <string>
+00020 #include <map>
+00021  
+00022 #ifndef __SERVERS_H__ 
+00023 #define __SERVERS_H__ 
+00024  
+00025 #define LINK_ACTIVE     1
+00026 #define LINK_INACTIVE   0
+00027 
+00030 class serverrec : public connection
+00031 {
+00032  private:
+00033  public:
+00036         char name[MAXBUF];
+00039         long pingtime;
+00042         long usercount_i;
+00045         long usercount;
+00048         long opercount;
+00051         int hops_away;
+00054         long version;
+00057         bool jupiter;
+00058         
+00061         char description[MAXBUF];
+00062 
+00065         char nickserv[NICKMAX];
+00066         
+00067         bool sync_soon;
+00068 
+00071         serverrec();
+00074         serverrec(char* n, long ver, bool jupe);
+00077         ~serverrec();
+00078         
+00079 };
+00080 
+00081 
+00082 
+00083 #endif
+00084 
+
            Generated on Fri Mar 25 03:49:28 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/servers_8h.html b/docs/module-doc/servers_8h.html index 7754843ba..8abac3ebd 100644 --- a/docs/module-doc/servers_8h.html +++ b/docs/module-doc/servers_8h.html @@ -1,45 +1,33 @@ -servers.h File Reference +InspIRCd: servers.h File Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            servers.h File Reference

            #include "inspircd_config.h"
            + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            servers.h File Reference

            #include "inspircd_config.h"
            #include "connection.h"
            #include <string>
            #include <map>
            -

            -Include dependency graph for servers.h:

            Include dependency graph
            - - - - -

            -This graph shows which files directly or indirectly include this file:

            Included by dependency graph
            - - - - - -

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

            Compounds

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

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


            Defines

            #define LINK_ACTIVE   1
            #define LINK_INACTIVE   0
            #define LINK_ACTIVE   1
            #define LINK_INACTIVE   0

            Define Documentation

            - +
            -
            + +Definition at line 25 of file servers.h.
            #define LINK_ACTIVE   1 @@ -57,13 +45,13 @@ This graph shows which files directly or indirectly include this file:

            -Definition at line 14 of file servers.h.

            - +
            -
            + +Definition at line 26 of file servers.h.
            #define LINK_INACTIVE   0 @@ -81,12 +69,12 @@ Definition at line 14 of

            -Definition at line 15 of file servers.h.

            -
            Generated on Sun May 2 00:09:27 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structInAddr__HashComp-members.html b/docs/module-doc/structInAddr__HashComp-members.html index 83a400de4..01e6ef7ad 100644 --- a/docs/module-doc/structInAddr__HashComp-members.html +++ b/docs/module-doc/structInAddr__HashComp-members.html @@ -1,16 +1,15 @@ -Member List +InspIRCd: Member List - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            InAddr_HashComp Member List

            This is the complete list of members for InAddr_HashComp, including all inherited members. - -
            operator()(const in_addr &s1, const in_addr &s2) constInAddr_HashComp [inline]
            Generated on Sun May 2 00:09:37 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            InAddr_HashComp Member List

            This is the complete list of members for InAddr_HashComp, including all inherited members. + +
            operator()(const in_addr &s1, const in_addr &s2) constInAddr_HashComp [inline]
            Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structInAddr__HashComp.html b/docs/module-doc/structInAddr__HashComp.html index 1ee9aae21..70da6e105 100644 --- a/docs/module-doc/structInAddr__HashComp.html +++ b/docs/module-doc/structInAddr__HashComp.html @@ -1,33 +1,33 @@ -InAddr_HashComp struct Reference +InspIRCd: InAddr_HashComp struct Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            InAddr_HashComp Struct Reference

            List of all members. + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            InAddr_HashComp Struct Reference

            List of all members.
            - + +

            Public Member Functions

            bool operator() (const in_addr &s1, const in_addr &s2) const
            bool operator() (const in_addr &s1, const in_addr &s2) const

            Member Function Documentation

            - +
            -
            + - + - + @@ -49,25 +49,25 @@

            -Definition at line 135 of file modules.cpp. +Definition at line 150 of file modules.cpp.

            -

            00136         {
-00137                 size_t q;
-00138                 size_t p;
-00139                 
-00140                 memcpy(&q,&s1,sizeof(size_t));
-00141                 memcpy(&p,&s2,sizeof(size_t));
-00142                 
-00143                 return (q == p);
-00144         }
+
            00151         {
+00152                 size_t q;
+00153                 size_t p;
+00154                 
+00155                 memcpy(&q,&s1,sizeof(size_t));
+00156                 memcpy(&p,&s2,sizeof(size_t));
+00157                 
+00158                 return (q == p);
+00159         }
            bool InAddr_HashComp::operator() (  const in_addr &   s1, s1,
            const in_addr &   s2 s2
            The documentation for this struct was generated from the following file: -
            Generated on Sun May 2 00:09:37 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structStrHashComp-members.html b/docs/module-doc/structStrHashComp-members.html index 86ae1ecad..d3c6bb7db 100644 --- a/docs/module-doc/structStrHashComp-members.html +++ b/docs/module-doc/structStrHashComp-members.html @@ -1,16 +1,15 @@ -Member List +InspIRCd: Member List - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            StrHashComp Member List

            This is the complete list of members for StrHashComp, including all inherited members. - -
            operator()(const string &s1, const string &s2) constStrHashComp [inline]
            Generated on Sun May 2 00:09:44 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            StrHashComp Member List

            This is the complete list of members for StrHashComp, including all inherited members. + +
            operator()(const string &s1, const string &s2) constStrHashComp [inline]
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structStrHashComp.html b/docs/module-doc/structStrHashComp.html index 3f68dc4d6..44358220e 100644 --- a/docs/module-doc/structStrHashComp.html +++ b/docs/module-doc/structStrHashComp.html @@ -1,33 +1,33 @@ -StrHashComp struct Reference +InspIRCd: StrHashComp struct Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            StrHashComp Struct Reference

            List of all members. + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            StrHashComp Struct Reference

            List of all members.
            - + +

            Public Member Functions

            bool operator() (const string &s1, const string &s2) const
            bool operator() (const string &s1, const string &s2) const

            Member Function Documentation

            - +
            -
            + - + - + @@ -49,22 +49,22 @@

            -Definition at line 122 of file modules.cpp. +Definition at line 137 of file modules.cpp.

            -

            00123         {
-00124                 char a[MAXBUF],b[MAXBUF];
-00125                 strcpy(a,s1.c_str());
-00126                 strcpy(b,s2.c_str());
-00127                 return (strcasecmp(a,b) == 0);
-00128         }
+
            00138         {
+00139                 char a[MAXBUF],b[MAXBUF];
+00140                 strlcpy(a,s1.c_str(),MAXBUF);
+00141                 strlcpy(b,s2.c_str(),MAXBUF);
+00142                 return (strcasecmp(a,b) == 0);
+00143         }
            bool StrHashComp::operator() (  const string &   s1, s1,
            const string &   s2 s2
            The documentation for this struct was generated from the following file: -
            Generated on Sun May 2 00:09:44 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html index e3abde4ae..01b5891ed 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html @@ -1,16 +1,15 @@ -Member List +InspIRCd: Member List - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            nspace::hash< in_addr > Member List

            This is the complete list of members for nspace::hash< in_addr >, including all inherited members. - -
            operator()(const struct in_addr &a) constnspace::hash< in_addr > [inline]
            Generated on Sun May 2 00:09:47 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            nspace::hash< in_addr > Member List

            This is the complete list of members for nspace::hash< in_addr >, including all inherited members. + +
            operator()(const struct in_addr &a) constnspace::hash< in_addr > [inline]
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html index a0e292654..55fe9db3c 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html @@ -1,31 +1,31 @@ - Templatenspace::hash< in_addr > struct Reference +InspIRCd: Templatenspace::hash< in_addr > struct Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            nspace::hash< in_addr > Struct Template Reference

            List of all members. + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            nspace::hash< in_addr > Struct Template Reference

            List of all members.
            - + +

            Public Member Functions

            size_t operator() (const struct in_addr &a) const
            size_t operator() (const struct in_addr &a) const

            template<>
            struct nspace::hash< in_addr >

            Member Function Documentation

            - +
            -
            + - - + + @@ -43,21 +43,21 @@

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

            -

            00098                 {
-00099                         size_t q;
-00100                         memcpy(&q,&a,sizeof(size_t));
-00101                         return q;
-00102                 }
+
            00113                 {
+00114                         size_t q;
+00115                         memcpy(&q,&a,sizeof(size_t));
+00116                         return q;
+00117                 }
            size_t nspace::hash< in_addr >::operator() (  const struct in_addr &   a )  a  )  const [inline]
            The documentation for this struct was generated from the following file: -
            Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html index 1dffb3cce..3c20fe788 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html @@ -1,16 +1,15 @@ -Member List +InspIRCd: Member List - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            nspace::hash< string > Member List

            This is the complete list of members for nspace::hash< string >, including all inherited members. - -
            operator()(const string &s) constnspace::hash< string > [inline]
            Generated on Sun May 2 00:09:47 2004 for InspIRCd by + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            nspace::hash< string > Member List

            This is the complete list of members for nspace::hash< string >, including all inherited members. + +
            operator()(const string &s) constnspace::hash< string > [inline]
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html index c822791d2..42fa669e9 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html @@ -1,31 +1,31 @@ - Templatenspace::hash< string > struct Reference +InspIRCd: Templatenspace::hash< string > struct Reference - -
            -Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
            -

            nspace::hash< string > Struct Template Reference

            List of all members. + +
            Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
            +

            nspace::hash< string > Struct Template Reference

            List of all members.
            - + +

            Public Member Functions

            size_t operator() (const string &s) const
            size_t operator() (const string &s) const

            template<>
            struct nspace::hash< string >

            Member Function Documentation

            - +
            -
            + - - + + @@ -43,23 +43,23 @@

            -Definition at line 107 of file modules.cpp. +Definition at line 122 of file modules.cpp.

            -

            00108                 {
-00109                         char a[MAXBUF];
-00110                         static struct hash<const char *> strhash;
-00111                         strcpy(a,s.c_str());
-00112                         strlower(a);
-00113                         return strhash(a);
-00114                 }
+
            00123                 {
+00124                         char a[MAXBUF];
+00125                         static struct hash<const char *> strhash;
+00126                         strlcpy(a,s.c_str(),MAXBUF);
+00127                         strlower(a);
+00128                         return strhash(a);
+00129                 }
            size_t nspace::hash< string >::operator() (  const string &   s )  s  )  const [inline]
            The documentation for this struct was generated from the following file: -
            Generated on Sun May 2 00:09:47 2004 for InspIRCd by +
            Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
            +doxygen +1.3.3
            diff --git a/docs/module-doc/tree.html b/docs/module-doc/tree.html index 67ae1fa52..ed5969e5b 100644 --- a/docs/module-doc/tree.html +++ b/docs/module-doc/tree.html @@ -1,10 +1,10 @@ - + - Test + TreeView