Added new docs for class SocketEngine

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 133 insertions, 133 deletions

diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index 6edd9f6fa..bc4f7caa3 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -1,4 +1,4 @@
-.TH "ConfigReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
+.TH "ConfigReader" 3 "12 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -93,19 +93,19 @@ Default constructor.
 .PP
 This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
 .PP
-Definition at line 834 of file modules.cpp.
+Definition at line 807 of file modules.cpp.
 .PP
 References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
 .PP
 .nf
-835 {
-836         include_stack.clear();
-837         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-838         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-839         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-840         if (!this->readerror)
-841                 this->error = CONF_FILE_NOT_FOUND;
-842 }
+808 {
+809         include_stack.clear();
+810         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+811         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+812         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+813         if (!this->readerror)
+814                 this->error = CONF_FILE_NOT_FOUND;
+815 }
 .fi
 .PP
 .SS "ConfigReader::ConfigReader (\fBstd::string\fP filename)"
@@ -114,18 +114,18 @@ Overloaded constructor.
 .PP
 This constructor initialises the ConfigReader class to read a user-specified config file
 .PP
-Definition at line 854 of file modules.cpp.
+Definition at line 827 of file modules.cpp.
 .PP
 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
 .PP
 .nf
-855 {
-856         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-857         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-858         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-859         if (!this->readerror)
-860                 this->error = CONF_FILE_NOT_FOUND;
-861 };
+828 {
+829         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+830         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+831         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+832         if (!this->readerror)
+833                 this->error = CONF_FILE_NOT_FOUND;
+834 };
 .fi
 .PP
 .SS "ConfigReader::~ConfigReader ()"
@@ -134,17 +134,17 @@ Default destructor.
 .PP
 This method destroys the ConfigReader class.
 .PP
-Definition at line 845 of file modules.cpp.
+Definition at line 818 of file modules.cpp.
 .PP
 References cache, and errorlog.
 .PP
 .nf
-846 {
-847         if (this->cache)
-848                 delete this->cache;
-849         if (this->errorlog)
-850                 delete this->errorlog;
-851 }
+819 {
+820         if (this->cache)
+821                 delete this->cache;
+822         if (this->errorlog)
+823                 delete this->errorlog;
+824 }
 .fi
 .PP
 .SH "Member Function Documentation"
@@ -155,41 +155,41 @@ Dumps the list of errors in a config file to an output location.
 .PP
 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.
 .PP
-Definition at line 932 of file modules.cpp.
+Definition at line 905 of file modules.cpp.
 .PP
 References errorlog, connection::fd, and userrec::nick.
 .PP
 .nf
-933 {
-934         if (bail)
-935         {
-936                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-937                 exit(0);
-938         }
-939         else
-940         {
-941                 char dataline[1024];
-942                 if (user)
-943                 {
-944                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-945                         while (!errorlog->eof())
-946                         {
-947                                 errorlog->getline(dataline,1024);
-948                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-949                         }
-950                 }
-951                 else
-952                 {
-953                         WriteOpers('There were errors in the configuration file:',user->nick);
-954                         while (!errorlog->eof())
-955                         {
-956                                 errorlog->getline(dataline,1024);
-957                                 WriteOpers(dataline);
-958                         }
-959                 }
-960                 return;
-961         }
-962 }
+906 {
+907         if (bail)
+908         {
+909                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+910                 exit(0);
+911         }
+912         else
+913         {
+914                 char dataline[1024];
+915                 if (user)
+916                 {
+917                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
+918                         while (!errorlog->eof())
+919                         {
+920                                 errorlog->getline(dataline,1024);
+921                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
+922                         }
+923                 }
+924                 else
+925                 {
+926                         WriteOpers('There were errors in the configuration file:',user->nick);
+927                         while (!errorlog->eof())
+928                         {
+929                                 errorlog->getline(dataline,1024);
+930                                 WriteOpers(dataline);
+931                         }
+932                 }
+933                 return;
+934         }
+935 }
 .fi
 .PP
 .SS "int ConfigReader::Enumerate (\fBstd::string\fP tag)"
@@ -198,14 +198,14 @@ Counts the number of times a given tag appears in the config file.
 .PP
 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.
 .PP
-Definition at line 965 of file modules.cpp.
+Definition at line 938 of file modules.cpp.
 .PP
 References cache.
 .PP
 .nf
-966 {
-967         return EnumConf(cache,tag.c_str());
-968 }
+939 {
+940         return EnumConf(cache,tag.c_str());
+941 }
 .fi
 .PP
 .SS "int ConfigReader::EnumerateValues (\fBstd::string\fP tag, int index)"
@@ -214,14 +214,14 @@ Returns the number of items within a tag.
 .PP
 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.
 .PP
-Definition at line 970 of file modules.cpp.
+Definition at line 943 of file modules.cpp.
 .PP
 References cache.
 .PP
 .nf
-971 {
-972         return EnumValues(cache, tag.c_str(), index);
-973 }
+944 {
+945         return EnumValues(cache, tag.c_str(), index);
+946 }
 .fi
 .PP
 .SS "long ConfigReader::GetError ()"
@@ -230,16 +230,16 @@ Returns the last error to occur.
 .PP
 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.
 .PP
-Definition at line 925 of file modules.cpp.
+Definition at line 898 of file modules.cpp.
 .PP
 References error.
 .PP
 .nf
-926 {
-927         long olderr = this->error;
-928         this->error = 0;
-929         return olderr;
-930 }
+899 {
+900         long olderr = this->error;
+901         this->error = 0;
+902         return olderr;
+903 }
 .fi
 .PP
 .SS "bool ConfigReader::ReadFlag (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
@@ -248,26 +248,26 @@ Retrieves a boolean value from the config file.
 .PP
 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.
 .PP
-Definition at line 879 of file modules.cpp.
+Definition at line 852 of file modules.cpp.
 .PP
 References cache, CONF_VALUE_NOT_FOUND, and error.
 .PP
 .nf
-880 {
-881         char val[MAXBUF];
-882         char t[MAXBUF];
-883         char n[MAXBUF];
-884         strlcpy(t,tag.c_str(),MAXBUF);
-885         strlcpy(n,name.c_str(),MAXBUF);
-886         int res = ReadConf(cache,t,n,index,val);
-887         if (!res)
-888         {
-889                 this->error = CONF_VALUE_NOT_FOUND;
-890                 return false;
-891         }
-892         std::string s = val;
-893         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-894 }
+853 {
+854         char val[MAXBUF];
+855         char t[MAXBUF];
+856         char n[MAXBUF];
+857         strlcpy(t,tag.c_str(),MAXBUF);
+858         strlcpy(n,name.c_str(),MAXBUF);
+859         int res = ReadConf(cache,t,n,index,val);
+860         if (!res)
+861         {
+862                 this->error = CONF_VALUE_NOT_FOUND;
+863                 return false;
+864         }
+865         std::string s = val;
+866         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+867 }
 .fi
 .PP
 .SS "long ConfigReader::ReadInteger (\fBstd::string\fP tag, \fBstd::string\fP name, int index, bool needs_unsigned)"
@@ -276,38 +276,38 @@ Retrieves an integer value from the config file.
 .PP
 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_UNSIGNED
 .PP
-Definition at line 896 of file modules.cpp.
+Definition at line 869 of file modules.cpp.
 .PP
 References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
 .PP
 .nf
-897 {
-898         char val[MAXBUF];
-899         char t[MAXBUF];
-900         char n[MAXBUF];
-901         strlcpy(t,tag.c_str(),MAXBUF);
-902         strlcpy(n,name.c_str(),MAXBUF);
-903         int res = ReadConf(cache,t,n,index,val);
-904         if (!res)
-905         {
-906                 this->error = CONF_VALUE_NOT_FOUND;
-907                 return 0;
-908         }
-909         for (unsigned int i = 0; i < strlen(val); i++)
-910         {
-911                 if (!isdigit(val[i]))
-912                 {
-913                         this->error = CONF_NOT_A_NUMBER;
-914                         return 0;
-915                 }
-916         }
-917         if ((needs_unsigned) && (atoi(val)<0))
-918         {
-919                 this->error = CONF_NOT_UNSIGNED;
-920                 return 0;
-921         }
-922         return atoi(val);
-923 }
+870 {
+871         char val[MAXBUF];
+872         char t[MAXBUF];
+873         char n[MAXBUF];
+874         strlcpy(t,tag.c_str(),MAXBUF);
+875         strlcpy(n,name.c_str(),MAXBUF);
+876         int res = ReadConf(cache,t,n,index,val);
+877         if (!res)
+878         {
+879                 this->error = CONF_VALUE_NOT_FOUND;
+880                 return 0;
+881         }
+882         for (unsigned int i = 0; i < strlen(val); i++)
+883         {
+884                 if (!isdigit(val[i]))
+885                 {
+886                         this->error = CONF_NOT_A_NUMBER;
+887                         return 0;
+888                 }
+889         }
+890         if ((needs_unsigned) && (atoi(val)<0))
+891         {
+892                 this->error = CONF_NOT_UNSIGNED;
+893                 return 0;
+894         }
+895         return atoi(val);
+896 }
 .fi
 .PP
 .SS "\fBstd::string\fP ConfigReader::ReadValue (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
@@ -316,25 +316,25 @@ Retrieves a value from the config file.
 .PP
 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.
 .PP
-Definition at line 863 of file modules.cpp.
+Definition at line 836 of file modules.cpp.
 .PP
 References cache, CONF_VALUE_NOT_FOUND, and error.
 .PP
 .nf
-864 {
-865         char val[MAXBUF];
-866         char t[MAXBUF];
-867         char n[MAXBUF];
-868         strlcpy(t,tag.c_str(),MAXBUF);
-869         strlcpy(n,name.c_str(),MAXBUF);
-870         int res = ReadConf(cache,t,n,index,val);
-871         if (!res)
-872         {
-873                 this->error = CONF_VALUE_NOT_FOUND;
-874                 return '';
-875         }
-876         return val;
-877 }
+837 {
+838         char val[MAXBUF];
+839         char t[MAXBUF];
+840         char n[MAXBUF];
+841         strlcpy(t,tag.c_str(),MAXBUF);
+842         strlcpy(n,name.c_str(),MAXBUF);
+843         int res = ReadConf(cache,t,n,index,val);
+844         if (!res)
+845         {
+846                 this->error = CONF_VALUE_NOT_FOUND;
+847                 return '';
+848         }
+849         return val;
+850 }
 .fi
 .PP
 .SS "bool ConfigReader::Verify ()"
@@ -343,14 +343,14 @@ Returns true if a config file is valid.
 .PP
 This method is partially implemented and will only return false if the config file does not exist or could not be opened.
 .PP
-Definition at line 975 of file modules.cpp.
+Definition at line 948 of file modules.cpp.
 .PP
 References readerror.
 .PP
 .nf
-976 {
-977         return this->readerror;
-978 }
+949 {
+950         return this->readerror;
+951 }
 .fi
 .PP
 .SH "Member Data Documentation"