From 097b2479d0393d8a8bada4a50708d7a2404045ca Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 12 Dec 2005 13:32:15 +0000 Subject: Added new docs for class SocketEngine git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 284 ++++++++++++++++----------------- 1 file changed, 142 insertions(+), 142 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 6a8a95db9..fee5b1e48 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -102,16 +102,16 @@ Default constructor.

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

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

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

00835 {
-00836         include_stack.clear();
-00837         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00838         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00839         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00840         if (!this->readerror)
-00841                 this->error = CONF_FILE_NOT_FOUND;
-00842 }
+Definition at line 807 of file modules.cpp.
+

+References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
00808 {
+00809         include_stack.clear();
+00810         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00811         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00812         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00813         if (!this->readerror)
+00814                 this->error = CONF_FILE_NOT_FOUND;
+00815 }
 

 

     
@@ -146,15 +146,15 @@ Overloaded constructor.
 

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

-Definition at line 854 of file modules.cpp.
+Definition at line 827 of file modules.cpp.
 

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
00855 {
-00856         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00857         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00858         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00859         if (!this->readerror)
-00860                 this->error = CONF_FILE_NOT_FOUND;
-00861 };
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
00828 {
+00829         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00830         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00831         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00832         if (!this->readerror)
+00833                 this->error = CONF_FILE_NOT_FOUND;
+00834 };
 

 

     
@@ -188,14 +188,14 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 845 of file modules.cpp.
+Definition at line 818 of file modules.cpp.
 

-References cache, and errorlog.
00846 {
-00847         if (this->cache)
-00848                 delete this->cache;
-00849         if (this->errorlog)
-00850                 delete this->errorlog;
-00851 }
+References cache, and errorlog.
00819 {
+00820         if (this->cache)
+00821                 delete this->cache;
+00822         if (this->errorlog)
+00823                 delete this->errorlog;
+00824 }
 

 

     
@@ -240,38 +240,38 @@ 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 932 of file modules.cpp.
-

-References errorlog, connection::fd, and userrec::nick.
00933 {
-00934         if (bail)
-00935         {
-00936                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00937                 exit(0);
-00938         }
-00939         else
-00940         {
-00941                 char dataline[1024];
-00942                 if (user)
-00943                 {
-00944                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00945                         while (!errorlog->eof())
-00946                         {
-00947                                 errorlog->getline(dataline,1024);
-00948                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00949                         }
-00950                 }
-00951                 else
-00952                 {
-00953                         WriteOpers("There were errors in the configuration file:",user->nick);
-00954                         while (!errorlog->eof())
-00955                         {
-00956                                 errorlog->getline(dataline,1024);
-00957                                 WriteOpers(dataline);
-00958                         }
-00959                 }
-00960                 return;
-00961         }
-00962 }
+Definition at line 905 of file modules.cpp.
+

+References errorlog, connection::fd, and userrec::nick.
00906 {
+00907         if (bail)
+00908         {
+00909                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00910                 exit(0);
+00911         }
+00912         else
+00913         {
+00914                 char dataline[1024];
+00915                 if (user)
+00916                 {
+00917                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00918                         while (!errorlog->eof())
+00919                         {
+00920                                 errorlog->getline(dataline,1024);
+00921                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00922                         }
+00923                 }
+00924                 else
+00925                 {
+00926                         WriteOpers("There were errors in the configuration file:",user->nick);
+00927                         while (!errorlog->eof())
+00928                         {
+00929                                 errorlog->getline(dataline,1024);
+00930                                 WriteOpers(dataline);
+00931                         }
+00932                 }
+00933                 return;
+00934         }
+00935 }
 

 

     
@@ -306,11 +306,11 @@ 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 965 of file modules.cpp.
+Definition at line 938 of file modules.cpp.
 

-References cache.
00966 {
-00967         return EnumConf(cache,tag.c_str());
-00968 }
+References cache.
00939 {
+00940         return EnumConf(cache,tag.c_str());
+00941 }
 

 

     
@@ -354,11 +354,11 @@ 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 970 of file modules.cpp.
+Definition at line 943 of file modules.cpp.
 

-References cache.
00971 {
-00972         return EnumValues(cache, tag.c_str(), index);
-00973 }
+References cache.
00944 {
+00945         return EnumValues(cache, tag.c_str(), index);
+00946 }
 

 

     
@@ -392,13 +392,13 @@ 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 925 of file modules.cpp.
+Definition at line 898 of file modules.cpp.
 

-References error.
00926 {
-00927         long olderr = this->error;
-00928         this->error = 0;
-00929         return olderr;
-00930 }
+References error.
00899 {
+00900         long olderr = this->error;
+00901         this->error = 0;
+00902         return olderr;
+00903 }
 

 

     
@@ -448,23 +448,23 @@ 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 879 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
00880 {
-00881         char val[MAXBUF];
-00882         char t[MAXBUF];
-00883         char n[MAXBUF];
-00884         strlcpy(t,tag.c_str(),MAXBUF);
-00885         strlcpy(n,name.c_str(),MAXBUF);
-00886         int res = ReadConf(cache,t,n,index,val);
-00887         if (!res)
-00888         {
-00889                 this->error = CONF_VALUE_NOT_FOUND;
-00890                 return false;
-00891         }
-00892         std::string s = val;
-00893         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00894 }
+Definition at line 852 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
00853 {
+00854         char val[MAXBUF];
+00855         char t[MAXBUF];
+00856         char n[MAXBUF];
+00857         strlcpy(t,tag.c_str(),MAXBUF);
+00858         strlcpy(n,name.c_str(),MAXBUF);
+00859         int res = ReadConf(cache,t,n,index,val);
+00860         if (!res)
+00861         {
+00862                 this->error = CONF_VALUE_NOT_FOUND;
+00863                 return false;
+00864         }
+00865         std::string s = val;
+00866         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00867 }
 

 

     
@@ -520,35 +520,35 @@ 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 896 of file modules.cpp.
-

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
00897 {
-00898         char val[MAXBUF];
-00899         char t[MAXBUF];
-00900         char n[MAXBUF];
-00901         strlcpy(t,tag.c_str(),MAXBUF);
-00902         strlcpy(n,name.c_str(),MAXBUF);
-00903         int res = ReadConf(cache,t,n,index,val);
-00904         if (!res)
-00905         {
-00906                 this->error = CONF_VALUE_NOT_FOUND;
-00907                 return 0;
-00908         }
-00909         for (unsigned int i = 0; i < strlen(val); i++)
-00910         {
-00911                 if (!isdigit(val[i]))
-00912                 {
-00913                         this->error = CONF_NOT_A_NUMBER;
-00914                         return 0;
-00915                 }
-00916         }
-00917         if ((needs_unsigned) && (atoi(val)<0))
-00918         {
-00919                 this->error = CONF_NOT_UNSIGNED;
-00920                 return 0;
-00921         }
-00922         return atoi(val);
-00923 }
+Definition at line 869 of file modules.cpp.
+

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
00870 {
+00871         char val[MAXBUF];
+00872         char t[MAXBUF];
+00873         char n[MAXBUF];
+00874         strlcpy(t,tag.c_str(),MAXBUF);
+00875         strlcpy(n,name.c_str(),MAXBUF);
+00876         int res = ReadConf(cache,t,n,index,val);
+00877         if (!res)
+00878         {
+00879                 this->error = CONF_VALUE_NOT_FOUND;
+00880                 return 0;
+00881         }
+00882         for (unsigned int i = 0; i < strlen(val); i++)
+00883         {
+00884                 if (!isdigit(val[i]))
+00885                 {
+00886                         this->error = CONF_NOT_A_NUMBER;
+00887                         return 0;
+00888                 }
+00889         }
+00890         if ((needs_unsigned) && (atoi(val)<0))
+00891         {
+00892                 this->error = CONF_NOT_UNSIGNED;
+00893                 return 0;
+00894         }
+00895         return atoi(val);
+00896 }
 

 

     
@@ -598,22 +598,22 @@ 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 863 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
00864 {
-00865         char val[MAXBUF];
-00866         char t[MAXBUF];
-00867         char n[MAXBUF];
-00868         strlcpy(t,tag.c_str(),MAXBUF);
-00869         strlcpy(n,name.c_str(),MAXBUF);
-00870         int res = ReadConf(cache,t,n,index,val);
-00871         if (!res)
-00872         {
-00873                 this->error = CONF_VALUE_NOT_FOUND;
-00874                 return "";
-00875         }
-00876         return val;
-00877 }
+Definition at line 836 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
00837 {
+00838         char val[MAXBUF];
+00839         char t[MAXBUF];
+00840         char n[MAXBUF];
+00841         strlcpy(t,tag.c_str(),MAXBUF);
+00842         strlcpy(n,name.c_str(),MAXBUF);
+00843         int res = ReadConf(cache,t,n,index,val);
+00844         if (!res)
+00845         {
+00846                 this->error = CONF_VALUE_NOT_FOUND;
+00847                 return "";
+00848         }
+00849         return val;
+00850 }
 

 

     
@@ -647,11 +647,11 @@ 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 975 of file modules.cpp.
+Definition at line 948 of file modules.cpp.
 

-References readerror.
00976 {
-00977         return this->readerror;
-00978 }
+References readerror.
00949 {
+00950         return this->readerror;
+00951 }
 

 

     
@@ -684,7 +684,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc
 

 Definition at line 1518 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,7 +711,7 @@ Referenced by ConfigReader(
 

 Definition at line 1523 of file modules.h.
 

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

@@ -738,7 +738,7 @@ Referenced by ConfigReader(
 

 Definition at line 1519 of file modules.h.
 

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

@@ -767,12 +767,12 @@ Used to store errors.
 

 Definition at line 1522 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 Fri Dec 9 20:20:11 2005 for InspIRCd by 
+
Generated on Mon Dec 12 13:31:11 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.3.1-10-gc9f91