From 668df37516e3ee3555aa7085f10d54bda3b4e426 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 16 Apr 2005 18:58:08 +0000 Subject: Added: OnMeshToken MeshSendAll(std::string text); MeshSendCommon(userrec* user, std::string text); MeshSendAllAlive(std::string text); MeshSendUnicast(std::string destination, std::string text); MeshSendAllExcept(std::string target, std::string text); MeshCheckChan(chanrec *c,std::string servername); MeshCheckCommon(userrec* u,std::string servername); git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1112 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 320 ++++++++++++++++----------------- 1 file changed, 160 insertions(+), 160 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 28ac3dcec..d6b6882f7 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -67,7 +67,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 891 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 944 of file modules.h.

Constructor & Destructor Documentation

@@ -97,17 +97,17 @@ Default constructor.

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

-Definition at line 717 of file modules.cpp. +Definition at line 762 of file modules.cpp.

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

-

00718 {
-00719         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00720         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00721         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00722         if (!this->readerror)
-00723                 this->error = CONF_FILE_NOT_FOUND;
-00724 }
+
00763 {
+00764         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00765         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00766         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00767         if (!this->readerror)
+00768                 this->error = CONF_FILE_NOT_FOUND;
+00769 }
@@ -141,17 +141,17 @@ Overloaded constructor.

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

-Definition at line 736 of file modules.cpp. +Definition at line 781 of file modules.cpp.

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

-

00737 {
-00738         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00739         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00740         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00741         if (!this->readerror)
-00742                 this->error = CONF_FILE_NOT_FOUND;
-00743 };
+
00782 {
+00783         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00784         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00785         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00786         if (!this->readerror)
+00787                 this->error = CONF_FILE_NOT_FOUND;
+00788 };
 
    
   
 
@@ -184,16 +184,16 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 727 of file modules.cpp.
+Definition at line 772 of file modules.cpp.
 

-References cache, and errorlog.
+References cache, and errorlog.
 

-
00728 {
-00729         if (this->cache)
-00730                 delete this->cache;
-00731         if (this->errorlog)
-00732                 delete this->errorlog;
-00733 }
+
00773 {
+00774         if (this->cache)
+00775                 delete this->cache;
+00776         if (this->errorlog)
+00777                 delete this->errorlog;
+00778 }
 
    
   
 
@@ -237,40 +237,40 @@ 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 814 of file modules.cpp.
-

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

-
00815 {
-00816         if (bail)
-00817         {
-00818                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00819                 exit(0);
-00820         }
-00821         else
-00822         {
-00823                 char dataline[1024];
-00824                 if (user)
-00825                 {
-00826                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00827                         while (!errorlog->eof())
-00828                         {
-00829                                 errorlog->getline(dataline,1024);
-00830                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00831                         }
-00832                 }
-00833                 else
-00834                 {
-00835                         WriteOpers("There were errors in the configuration file:",user->nick);
-00836                         while (!errorlog->eof())
-00837                         {
-00838                                 errorlog->getline(dataline,1024);
-00839                                 WriteOpers(dataline);
-00840                         }
-00841                 }
-00842                 return;
-00843         }
-00844 }
+Definition at line 859 of file modules.cpp.
+

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

+
00860 {
+00861         if (bail)
+00862         {
+00863                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00864                 exit(0);
+00865         }
+00866         else
+00867         {
+00868                 char dataline[1024];
+00869                 if (user)
+00870                 {
+00871                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00872                         while (!errorlog->eof())
+00873                         {
+00874                                 errorlog->getline(dataline,1024);
+00875                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00876                         }
+00877                 }
+00878                 else
+00879                 {
+00880                         WriteOpers("There were errors in the configuration file:",user->nick);
+00881                         while (!errorlog->eof())
+00882                         {
+00883                                 errorlog->getline(dataline,1024);
+00884                                 WriteOpers(dataline);
+00885                         }
+00886                 }
+00887                 return;
+00888         }
+00889 }
 
    
   
 
@@ -304,13 +304,13 @@ 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 847 of file modules.cpp.
+Definition at line 892 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00848 {
-00849         return EnumConf(cache,tag.c_str());
-00850 }
+
00893 {
+00894         return EnumConf(cache,tag.c_str());
+00895 }
 
    
   
 
@@ -353,13 +353,13 @@ 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 852 of file modules.cpp.
+Definition at line 897 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00853 {
-00854         return EnumValues(cache, tag.c_str(), index);
-00855 }
+
00898 {
+00899         return EnumValues(cache, tag.c_str(), index);
+00900 }
 
    
   
 
@@ -392,15 +392,15 @@ 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 807 of file modules.cpp.
+Definition at line 852 of file modules.cpp.
 

-References error.
+References error.
 

-
00808 {
-00809         long olderr = this->error;
-00810         this->error = 0;
-00811         return olderr;
-00812 }
+
00853 {
+00854         long olderr = this->error;
+00855         this->error = 0;
+00856         return olderr;
+00857 }
 
    
   
 
@@ -449,25 +449,25 @@ 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 761 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
-

-
00762 {
-00763         char val[MAXBUF];
-00764         char t[MAXBUF];
-00765         char n[MAXBUF];
-00766         strlcpy(t,tag.c_str(),MAXBUF);
-00767         strlcpy(n,name.c_str(),MAXBUF);
-00768         int res = ReadConf(cache,t,n,index,val);
-00769         if (!res)
-00770         {
-00771                 this->error = CONF_VALUE_NOT_FOUND;
-00772                 return false;
-00773         }
-00774         std::string s = val;
-00775         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00776 }
+Definition at line 806 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00807 {
+00808         char val[MAXBUF];
+00809         char t[MAXBUF];
+00810         char n[MAXBUF];
+00811         strlcpy(t,tag.c_str(),MAXBUF);
+00812         strlcpy(n,name.c_str(),MAXBUF);
+00813         int res = ReadConf(cache,t,n,index,val);
+00814         if (!res)
+00815         {
+00816                 this->error = CONF_VALUE_NOT_FOUND;
+00817                 return false;
+00818         }
+00819         std::string s = val;
+00820         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00821 }
 
    
   
 
@@ -522,37 +522,37 @@ 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 778 of file modules.cpp.
-

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

-
00779 {
-00780         char val[MAXBUF];
-00781         char t[MAXBUF];
-00782         char n[MAXBUF];
-00783         strlcpy(t,tag.c_str(),MAXBUF);
-00784         strlcpy(n,name.c_str(),MAXBUF);
-00785         int res = ReadConf(cache,t,n,index,val);
-00786         if (!res)
-00787         {
-00788                 this->error = CONF_VALUE_NOT_FOUND;
-00789                 return 0;
-00790         }
-00791         for (int i = 0; i < strlen(val); i++)
-00792         {
-00793                 if (!isdigit(val[i]))
-00794                 {
-00795                         this->error = CONF_NOT_A_NUMBER;
-00796                         return 0;
-00797                 }
-00798         }
-00799         if ((needs_unsigned) && (atoi(val)<0))
-00800         {
-00801                 this->error = CONF_NOT_UNSIGNED;
-00802                 return 0;
-00803         }
-00804         return atoi(val);
-00805 }
+Definition at line 823 of file modules.cpp.
+

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
+

+
00824 {
+00825         char val[MAXBUF];
+00826         char t[MAXBUF];
+00827         char n[MAXBUF];
+00828         strlcpy(t,tag.c_str(),MAXBUF);
+00829         strlcpy(n,name.c_str(),MAXBUF);
+00830         int res = ReadConf(cache,t,n,index,val);
+00831         if (!res)
+00832         {
+00833                 this->error = CONF_VALUE_NOT_FOUND;
+00834                 return 0;
+00835         }
+00836         for (int i = 0; i < strlen(val); i++)
+00837         {
+00838                 if (!isdigit(val[i]))
+00839                 {
+00840                         this->error = CONF_NOT_A_NUMBER;
+00841                         return 0;
+00842                 }
+00843         }
+00844         if ((needs_unsigned) && (atoi(val)<0))
+00845         {
+00846                 this->error = CONF_NOT_UNSIGNED;
+00847                 return 0;
+00848         }
+00849         return atoi(val);
+00850 }
 
    
   
 
@@ -601,24 +601,24 @@ 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 745 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
-

-
00746 {
-00747         char val[MAXBUF];
-00748         char t[MAXBUF];
-00749         char n[MAXBUF];
-00750         strlcpy(t,tag.c_str(),MAXBUF);
-00751         strlcpy(n,name.c_str(),MAXBUF);
-00752         int res = ReadConf(cache,t,n,index,val);
-00753         if (!res)
-00754         {
-00755                 this->error = CONF_VALUE_NOT_FOUND;
-00756                 return "";
-00757         }
-00758         return std::string(val);
-00759 }
+Definition at line 790 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00791 {
+00792         char val[MAXBUF];
+00793         char t[MAXBUF];
+00794         char n[MAXBUF];
+00795         strlcpy(t,tag.c_str(),MAXBUF);
+00796         strlcpy(n,name.c_str(),MAXBUF);
+00797         int res = ReadConf(cache,t,n,index,val);
+00798         if (!res)
+00799         {
+00800                 this->error = CONF_VALUE_NOT_FOUND;
+00801                 return "";
+00802         }
+00803         return std::string(val);
+00804 }
 
    
   
 
@@ -651,13 +651,13 @@ 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 857 of file modules.cpp.
+Definition at line 902 of file modules.cpp.
 

-References readerror.
+References readerror.
 

-
00858 {
-00859         return this->readerror;
-00860 }
+
00903 {
+00904         return this->readerror;
+00905 }
 
    
   
 
@@ -685,9 +685,9 @@ The contents of the configuration file This protected member should never be acc
 

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

-Definition at line 899 of file modules.h.
+Definition at line 952 of file modules.h.
 

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

@@ -711,9 +711,9 @@ Referenced by ConfigReader(
 

 
 

-Definition at line 904 of file modules.h.
+Definition at line 957 of file modules.h.
 

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

@@ -737,9 +737,9 @@ Referenced by ConfigReader(
 

 
 

-Definition at line 900 of file modules.h.
+Definition at line 953 of file modules.h.
 

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

@@ -765,14 +765,14 @@ Used to store errors.
 

 
 

-Definition at line 903 of file modules.h.
+Definition at line 956 of file modules.h.
 

-Referenced by ConfigReader(), and Verify().    
+Referenced by ConfigReader(), and Verify().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Sat Apr 16 14:49:51 2005 for InspIRCd by
+
Generated on Sat Apr 16 18:57:16 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3