ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 02:59:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added new module docs

Browse Source 
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7
This commit is contained in:
brain 2005-12-09 20:21:39 +00:00
parent a96341b150
commit bab9f4b4bc
325 changed files with 8824 additions and 4952 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/man/man3/Admin.3
View File

@ -1,4 +1,4 @@
.TH "Admin" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "Admin" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -38,7 +38,7 @@ 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 124 of file modules.h.
Definition at line 125 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Admin::Admin (\fBstd::string\fP name, \fBstd::string\fP email, \fBstd::string\fP nick)"
@ -53,13 +53,13 @@ Definition at line 250 of file modules.cpp.
.PP
.SS "const \fBstd::string\fP \fBAdmin::Email\fP"
.PP
Definition at line 127 of file modules.h.
Definition at line 128 of file modules.h.
.SS "const \fBstd::string\fP \fBAdmin::Name\fP"
.PP
Definition at line 127 of file modules.h.
Definition at line 128 of file modules.h.
.SS "const \fBstd::string\fP \fBAdmin::Nick\fP"
.PP
Definition at line 127 of file modules.h.
Definition at line 128 of file modules.h.
.SH "Author"
.PP

2
docs/man/man3/BanItem.3
View File

@ -1,4 +1,4 @@
.TH "BanItem" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "BanItem" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

6
docs/man/man3/BoolSet.3
View File

@ -1,4 +1,4 @@
.TH "BoolSet" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "BoolSet" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -67,7 +67,7 @@ BoolSet is a utility class designed to hold eight bools in a bitmask.
Use \fBBoolSet::Set\fP and \fBBoolSet::Get\fP to set and get bools in the bitmask, and Unset and Invert for special operations upon them.
.PP
Definition at line 95 of file base.h.
Definition at line 104 of file base.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "BoolSet::BoolSet ()"
@ -145,7 +145,7 @@ The Unset method unsets one value in the set.
.PP
.SS "char \fBBoolSet::bits\fP\fC [private]\fP"
.PP
Definition at line 97 of file base.h.
Definition at line 106 of file base.h.
.SH "Author"
.PP

276
docs/man/man3/ConfigReader.3
View File

@ -1,4 +1,4 @@
.TH "ConfigReader" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ConfigReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -84,7 +84,7 @@ Allows reading of values from configuration files This class allows a module to
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 1121 of file modules.h.
Definition at line 1510 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "ConfigReader::ConfigReader ()"
@ -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 796 of file modules.cpp.
Definition at line 834 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
.PP
.nf
797 {
798 include_stack.clear();
799 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
800 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
801 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
802 if (!this->readerror)
803 this->error = CONF_FILE_NOT_FOUND;
804 }
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 }
.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 816 of file modules.cpp.
Definition at line 854 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
817 {
818 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
819 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
820 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
821 if (!this->readerror)
822 this->error = CONF_FILE_NOT_FOUND;
823 };
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 };
.fi
.PP
.SS "ConfigReader::~ConfigReader ()"
@ -134,17 +134,17 @@ Default destructor.
.PP
This method destroys the ConfigReader class.
.PP
Definition at line 807 of file modules.cpp.
Definition at line 845 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
808 {
809 if (this->cache)
810 delete this->cache;
811 if (this->errorlog)
812 delete this->errorlog;
813 }
846 {
847 if (this->cache)
848 delete this->cache;
849 if (this->errorlog)
850 delete this->errorlog;
851 }
.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 894 of file modules.cpp.
Definition at line 932 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
895 {
896 if (bail)
897 {
898 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
899 exit(0);
900 }
901 else
902 {
903 char dataline[1024];
904 if (user)
905 {
906 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
907 while (!errorlog->eof())
908 {
909 errorlog->getline(dataline,1024);
910 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
911 }
912 }
913 else
914 {
915 WriteOpers('There were errors in the configuration file:',user->nick);
916 while (!errorlog->eof())
917 {
918 errorlog->getline(dataline,1024);
919 WriteOpers(dataline);
920 }
921 }
922 return;
923 }
924 }
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 }
.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 927 of file modules.cpp.
Definition at line 965 of file modules.cpp.
.PP
References cache.
.PP
.nf
928 {
929 return EnumConf(cache,tag.c_str());
930 }
966 {
967 return EnumConf(cache,tag.c_str());
968 }
.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 932 of file modules.cpp.
Definition at line 970 of file modules.cpp.
.PP
References cache.
.PP
.nf
933 {
934 return EnumValues(cache, tag.c_str(), index);
935 }
971 {
972 return EnumValues(cache, tag.c_str(), index);
973 }
.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 887 of file modules.cpp.
Definition at line 925 of file modules.cpp.
.PP
References error.
.PP
.nf
888 {
889 long olderr = this->error;
890 this->error = 0;
891 return olderr;
892 }
926 {
927 long olderr = this->error;
928 this->error = 0;
929 return olderr;
930 }
.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 841 of file modules.cpp.
Definition at line 879 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
842 {
843 char val[MAXBUF];
844 char t[MAXBUF];
845 char n[MAXBUF];
846 strlcpy(t,tag.c_str(),MAXBUF);
847 strlcpy(n,name.c_str(),MAXBUF);
848 int res = ReadConf(cache,t,n,index,val);
849 if (!res)
850 {
851 this->error = CONF_VALUE_NOT_FOUND;
852 return false;
853 }
854 std::string s = val;
855 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
856 }
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 }
.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 858 of file modules.cpp.
Definition at line 896 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
859 {
860 char val[MAXBUF];
861 char t[MAXBUF];
862 char n[MAXBUF];
863 strlcpy(t,tag.c_str(),MAXBUF);
864 strlcpy(n,name.c_str(),MAXBUF);
865 int res = ReadConf(cache,t,n,index,val);
866 if (!res)
867 {
868 this->error = CONF_VALUE_NOT_FOUND;
869 return 0;
870 }
871 for (unsigned int i = 0; i < strlen(val); i++)
872 {
873 if (!isdigit(val[i]))
874 {
875 this->error = CONF_NOT_A_NUMBER;
876 return 0;
877 }
878 }
879 if ((needs_unsigned) && (atoi(val)<0))
880 {
881 this->error = CONF_NOT_UNSIGNED;
882 return 0;
883 }
884 return atoi(val);
885 }
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 }
.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 825 of file modules.cpp.
Definition at line 863 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
826 {
827 char val[MAXBUF];
828 char t[MAXBUF];
829 char n[MAXBUF];
830 strlcpy(t,tag.c_str(),MAXBUF);
831 strlcpy(n,name.c_str(),MAXBUF);
832 int res = ReadConf(cache,t,n,index,val);
833 if (!res)
834 {
835 this->error = CONF_VALUE_NOT_FOUND;
836 return '';
837 }
838 return val;
839 }
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 }
.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 937 of file modules.cpp.
Definition at line 975 of file modules.cpp.
.PP
References readerror.
.PP
.nf
938 {
939 return this->readerror;
940 }
976 {
977 return this->readerror;
978 }
.fi
.PP
.SH "Member Data Documentation"
@ -361,24 +361,24 @@ The contents of the configuration file This protected member should never be acc
.PP
It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
.PP
Definition at line 1129 of file modules.h.
Definition at line 1518 of file modules.h.
.PP
Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
.SS "long \fBConfigReader::error\fP\fC [protected]\fP"
.PP
Definition at line 1134 of file modules.h.
Definition at line 1523 of file modules.h.
.PP
Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
.SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP"
.PP
Definition at line 1130 of file modules.h.
Definition at line 1519 of file modules.h.
.PP
Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
.SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
.PP
Used to store errors.
.PP
Definition at line 1133 of file modules.h.
Definition at line 1522 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().

44
docs/man/man3/ConnectClass.3
View File

@ -1,4 +1,4 @@
.TH "ConnectClass" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ConnectClass" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -63,26 +63,26 @@ Inherits \fBclassbase\fP.
.PP
Holds information relevent to <connect allow> and <connect deny> tags in the config file.
.PP
Definition at line 45 of file users.h.
Definition at line 48 of file users.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "ConnectClass::ConnectClass ()\fC [inline]\fP"
.PP
Definition at line 79 of file users.h.
Definition at line 82 of file users.h.
.PP
References flood, host, pass, pingtime, recvqmax, registration_timeout, sendqmax, and threshold.
.PP
.nf
80 {
81 registration_timeout = 0;
82 flood = 0;
83 pingtime = 0;
84 threshold = 0;
85 sendqmax = 0;
86 recvqmax = 0;
87 strlcpy(host,'',MAXBUF);
88 strlcpy(pass,'',MAXBUF);
89 }
83 {
84 registration_timeout = 0;
85 flood = 0;
86 pingtime = 0;
87 threshold = 0;
88 sendqmax = 0;
89 recvqmax = 0;
90 strlcpy(host,'',MAXBUF);
91 strlcpy(pass,'',MAXBUF);
92 }
.fi
.PP
.SH "Member Data Documentation"
@ -91,63 +91,63 @@ References flood, host, pass, pingtime, recvqmax, registration_timeout, sendqmax
.PP
Number of lines in buffer before excess flood is triggered.
.PP
Definition at line 56 of file users.h.
Definition at line 59 of file users.h.
.PP
Referenced by ConnectClass().
.SS "char \fBConnectClass::host\fP[MAXBUF]"
.PP
Host mask for this line.
.PP
Definition at line 59 of file users.h.
Definition at line 62 of file users.h.
.PP
Referenced by ConnectClass().
.SS "char \fBConnectClass::pass\fP[MAXBUF]"
.PP
(Optional) Password for this line
.PP
Definition at line 65 of file users.h.
Definition at line 68 of file users.h.
.PP
Referenced by ConnectClass().
.SS "int \fBConnectClass::pingtime\fP"
.PP
Number of seconds between pings for this line.
.PP
Definition at line 62 of file users.h.
Definition at line 65 of file users.h.
.PP
Referenced by ConnectClass().
.SS "long \fBConnectClass::recvqmax\fP"
.PP
Maximum size of recvq for users in this class (bytes).
.PP
Definition at line 77 of file users.h.
Definition at line 80 of file users.h.
.PP
Referenced by ConnectClass().
.SS "int \fBConnectClass::registration_timeout\fP"
.PP
Max time to register the connection in seconds.
.PP
Definition at line 53 of file users.h.
Definition at line 56 of file users.h.
.PP
Referenced by ConnectClass().
.SS "long \fBConnectClass::sendqmax\fP"
.PP
Maximum size of sendq for users in this class (bytes).
.PP
Definition at line 73 of file users.h.
Definition at line 76 of file users.h.
.PP
Referenced by ConnectClass().
.SS "int \fBConnectClass::threshold\fP"
.PP
Threshold value for flood disconnect.
.PP
Definition at line 69 of file users.h.
Definition at line 72 of file users.h.
.PP
Referenced by ConnectClass().
.SS "char \fBConnectClass::type\fP"
.PP
Type of line, either CC_ALLOW or CC_DENY.
.PP
Definition at line 50 of file users.h.
Definition at line 53 of file users.h.
.SH "Author"
.PP

27
docs/man/man3/DNS.3
View File

@ -1,4 +1,4 @@
.TH "DNS" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "DNS" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -42,6 +42,9 @@ DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addr
.br
.RI "\fIThis method returns the result of your query as a string, depending upon wether you called \fBDNS::ReverseLookup()\fP or \fBDNS::ForwardLookup\fP. \fP"
.ti -1c
.RI "\fBstd::string\fP \fBGetResultIP\fP ()"
.br
.ti -1c
.RI "int \fBGetFD\fP ()"
.br
.RI "\fIThis method returns the file handle used by the dns query socket or zero if the query is invalid for some reason, e.g. \fP"
@ -74,7 +77,7 @@ DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addr
.RI "int \fBdns_getname4\fP (const in_addr *const ip)"
.br
.ti -1c
.RI "char * \fBdns_getresult\fP (const int \fBfd\fP)"
.RI "char * \fBdns_getresult\fP (const int fd)"
.br
.ti -1c
.RI "in_addr * \fBdns_aton4_s\fP (const char *const ipstring, in_addr *const ip)"
@ -83,7 +86,7 @@ DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addr
.RI "char * \fBdns_ntoa4_s\fP (const in_addr *const ip, char *const \fBresult\fP)"
.br
.ti -1c
.RI "char * \fBdns_getresult_s\fP (const int \fBfd\fP, char *const \fBresult\fP)"
.RI "char * \fBdns_getresult_s\fP (const int fd, char *const \fBresult\fP)"
.br
.ti -1c
.RI "in_addr * \fBdns_aton4_r\fP (const char *const ipstring)"
@ -92,7 +95,7 @@ DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addr
.RI "char * \fBdns_ntoa4_r\fP (const in_addr *const ip)"
.br
.ti -1c
.RI "char * \fBdns_getresult_r\fP (const int \fBfd\fP)"
.RI "char * \fBdns_getresult_r\fP (const int fd)"
.br
.in -1c
.SS "Private Attributes"
@ -105,10 +108,13 @@ DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addr
.RI "char * \fBresult\fP"
.br
.ti -1c
.RI "char \fBlocalbuf\fP [1024]"
.br
.ti -1c
.RI "int \fBt\fP"
.br
.ti -1c
.RI "int \fBfd\fP"
.RI "int \fBmyfd\fP"
.br
.in -1c
.SH "Detailed Description"
@ -178,6 +184,8 @@ the dns server not responding.
.PP
This method returns the result of your query as a string, depending upon wether you called \fBDNS::ReverseLookup()\fP or \fBDNS::ForwardLookup\fP.
.PP
.SS "\fBstd::string\fP DNS::GetResultIP ()"
.PP
.SS "bool DNS::HasResult ()"
.PP
This method will return true when the lookup is completed.
@ -195,15 +203,18 @@ This method will start the reverse lookup of an ip given in dotted decimal forma
.SS "in_addr* \fBDNS::binip\fP\fC [private]\fP"
.PP
Definition at line 38 of file dns.h.
.SS "int \fBDNS::fd\fP\fC [private]\fP"
.SS "char \fBDNS::localbuf\fP[1024]\fC [private]\fP"
.PP
Definition at line 42 of file dns.h.
Definition at line 40 of file dns.h.
.SS "int \fBDNS::myfd\fP\fC [private]\fP"
.PP
Definition at line 43 of file dns.h.
.SS "char* \fBDNS::result\fP\fC [private]\fP"
.PP
Definition at line 39 of file dns.h.
.SS "int \fBDNS::t\fP\fC [private]\fP"
.PP
Definition at line 40 of file dns.h.
Definition at line 41 of file dns.h.
.SH "Author"
.PP

2
docs/man/man3/ELine.3
View File

@ -1,4 +1,4 @@
.TH "ELine" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ELine" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

10
docs/man/man3/Event.3
View File

@ -1,4 +1,4 @@
.TH "Event" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "Event" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -58,7 +58,7 @@ The Event class is a unicast message directed at all modules.
When the class is properly instantiated it may be sent to all modules using the \fBSend()\fP method, which will trigger the OnEvent method in all modules passing the object as its parameter.
.PP
Definition at line 196 of file modules.h.
Definition at line 197 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Event::Event (char * anydata, \fBModule\fP * src, \fBstd::string\fP eventid)"
@ -142,7 +142,7 @@ References FOREACH_MOD.
.PP
This member holds a pointer to arbitary data set by the emitter of the message.
.PP
Definition at line 201 of file modules.h.
Definition at line 202 of file modules.h.
.PP
Referenced by GetData().
.SS "\fBstd::string\fP \fBEvent::id\fP\fC [protected]\fP"
@ -151,14 +151,14 @@ The event identifier.
.PP
This is arbitary text which should be used to distinguish one type of event from another.
.PP
Definition at line 210 of file modules.h.
Definition at line 211 of file modules.h.
.PP
Referenced by GetEventID().
.SS "\fBModule\fP* \fBEvent::source\fP\fC [protected]\fP"
.PP
This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply.
.PP
Definition at line 205 of file modules.h.
Definition at line 206 of file modules.h.
.PP
Referenced by GetSource().

2
docs/man/man3/ExemptItem.3
View File

@ -1,4 +1,4 @@
.TH "ExemptItem" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ExemptItem" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/ExtMode.3
View File

@ -1,4 +1,4 @@
.TH "ExtMode" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ExtMode" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

25
docs/man/man3/Extensible.3
View File

@ -1,4 +1,4 @@
.TH "Extensible" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "Extensible" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -29,6 +29,10 @@ Inherited by \fBchanrec\fP, \fBcommand_t\fP, and \fBconnection\fP.
.RI "char * \fBGetExt\fP (\fBstd::string\fP key)"
.br
.RI "\fIGet an extension item. \fP"
.ti -1c
.RI "void \fBGetExtList\fP (std::deque< \fBstd::string\fP > &\fBlist\fP)"
.br
.RI "\fIGet a list of all extension items names. \fP"
.in -1c
.SS "Private Attributes"
@ -44,7 +48,7 @@ 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 50 of file base.h.
Definition at line 51 of file base.h.
.SH "Member Function Documentation"
.PP
.SS "bool Extensible::Extend (\fBstd::string\fP key, char * p)"
@ -81,6 +85,21 @@ If you provide a non-existent key name, the function returns NULL, otherwise a p
.RE
.PP
.SS "void Extensible::GetExtList (std::deque< \fBstd::string\fP > & list)"
.PP
Get a list of all extension items names.
.PP
\fBParameters:\fP
.RS 4
\fIlist\fP A deque of strings to receive the list
.RE
.PP
\fBReturns:\fP
.RS 4
This function writes a list of all extension items stored in this object by name into the given deque and returns void.
.RE
.PP
.SS "bool Extensible::Shrink (\fBstd::string\fP key)"
.PP
Shrink an Extensible class.
@ -104,7 +123,7 @@ Returns true on success.
.PP
Private data store.
.PP
Definition at line 54 of file base.h.
Definition at line 55 of file base.h.
.SH "Author"
.PP

84
docs/man/man3/FileReader.3
View File

@ -1,4 +1,4 @@
.TH "FileReader" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "FileReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -57,7 +57,7 @@ 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 1210 of file modules.h.
Definition at line 1599 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "FileReader::FileReader ()"
@ -66,11 +66,11 @@ Default constructor.
.PP
This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
.PP
Definition at line 950 of file modules.cpp.
Definition at line 988 of file modules.cpp.
.PP
.nf
951 {
952 }
989 {
990 }
.fi
.PP
.SS "FileReader::FileReader (\fBstd::string\fP filename)"
@ -79,16 +79,16 @@ Secondary constructor.
.PP
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.
.PP
Definition at line 943 of file modules.cpp.
Definition at line 981 of file modules.cpp.
.PP
References fc.
.PP
.nf
944 {
945 file_cache c;
946 readfile(c,filename.c_str());
947 this->fc = c;
948 }
982 {
983 file_cache c;
984 readfile(c,filename.c_str());
985 this->fc = c;
986 }
.fi
.PP
.SS "FileReader::~FileReader ()"
@ -97,11 +97,11 @@ Default destructor.
.PP
This deletes the memory allocated to the file.
.PP
Definition at line 962 of file modules.cpp.
Definition at line 1000 of file modules.cpp.
.PP
.nf
963 {
964 }
1001 {
1002 }
.fi
.PP
.SH "Member Function Documentation"
@ -110,21 +110,21 @@ Definition at line 962 of file modules.cpp.
.PP
Returns true if the file exists This function will return false if the file could not be opened.
.PP
Definition at line 966 of file modules.cpp.
Definition at line 1004 of file modules.cpp.
.PP
References fc.
.PP
.nf
967 {
968 if (fc.size() == 0)
969 {
970 return(false);
971 }
972 else
973 {
974 return(true);
975 }
976 }
1005 {
1006 if (fc.size() == 0)
1007 {
1008 return(false);
1009 }
1010 else
1011 {
1012 return(true);
1013 }
1014 }
.fi
.PP
.SS "int FileReader::FileSize ()"
@ -133,14 +133,14 @@ Returns the size of the file in lines.
.PP
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.
.PP
Definition at line 985 of file modules.cpp.
Definition at line 1023 of file modules.cpp.
.PP
References fc.
.PP
.nf
986 {
987 return fc.size();
988 }
1024 {
1025 return fc.size();
1026 }
.fi
.PP
.SS "\fBstd::string\fP FileReader::GetLine (int x)"
@ -149,16 +149,16 @@ Retrieve one line from the file.
.PP
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.
.PP
Definition at line 978 of file modules.cpp.
Definition at line 1016 of file modules.cpp.
.PP
References fc.
.PP
.nf
979 {
980 if ((x<0) || ((unsigned)x>fc.size()))
981 return '';
982 return fc[x];
983 }
1017 {
1018 if ((x<0) || ((unsigned)x>fc.size()))
1019 return '';
1020 return fc[x];
1021 }
.fi
.PP
.SS "void FileReader::LoadFile (\fBstd::string\fP filename)"
@ -167,23 +167,23 @@ Used to load a file.
.PP
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.
.PP
Definition at line 954 of file modules.cpp.
Definition at line 992 of file modules.cpp.
.PP
References fc.
.PP
.nf
955 {
956 file_cache c;
957 readfile(c,filename.c_str());
958 this->fc = c;
959 }
993 {
994 file_cache c;
995 readfile(c,filename.c_str());
996 this->fc = c;
997 }
.fi
.PP
.SH "Member Data Documentation"
.PP
.SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
.PP
Definition at line 1212 of file modules.h.
Definition at line 1601 of file modules.h.
.PP
Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().

2
docs/man/man3/GLine.3
View File

@ -1,4 +1,4 @@
.TH "GLine" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "GLine" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/HostItem.3
View File

@ -1,4 +1,4 @@
.TH "HostItem" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "HostItem" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

424
docs/man/man3/InspSocket.3
View File

@ -1,4 +1,4 @@
.TH "InspSocket" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "InspSocket" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -15,7 +15,7 @@ InspSocket \-
.RI "\fBInspSocket\fP ()"
.br
.ti -1c
.RI "\fBInspSocket\fP (int newfd)"
.RI "\fBInspSocket\fP (int newfd, char *ip)"
.br
.ti -1c
.RI "\fBInspSocket\fP (\fBstd::string\fP \fBhost\fP, int \fBport\fP, bool listening, unsigned long maxtime)"
@ -42,6 +42,9 @@ InspSocket \-
.RI "virtual char * \fBRead\fP ()"
.br
.ti -1c
.RI "\fBstd::string\fP \fBGetIP\fP ()"
.br
.ti -1c
.RI "virtual int \fBWrite\fP (\fBstd::string\fP data)"
.br
.ti -1c
@ -94,7 +97,10 @@ InspSocket \-
.RI "pollfd \fBpolls\fP"
.br
.ti -1c
.RI "char \fBibuf\fP [1024]"
.RI "char \fBibuf\fP [16384]"
.br
.ti -1c
.RI "\fBstd::string\fP \fBIP\fP"
.br
.ti -1c
.RI "sockaddr_in \fBclient\fP"
@ -123,327 +129,342 @@ References I_DISCONNECTED, and state.
49 }
.fi
.PP
.SS "InspSocket::InspSocket (int newfd)"
.SS "InspSocket::InspSocket (int newfd, char * ip)"
.PP
Definition at line 51 of file socket.cpp.
.PP
References fd, I_CONNECTED, and state.
References fd, I_CONNECTED, IP, and state.
.PP
.nf
52 {
53 this->fd = newfd;
54 this->state = I_CONNECTED;
55 }
55 this->IP = ip;
56 }
.fi
.PP
.SS "InspSocket::InspSocket (\fBstd::string\fP host, int port, bool listening, unsigned long maxtime)"
.PP
Definition at line 57 of file socket.cpp.
Definition at line 58 of file socket.cpp.
.PP
References addr, addy, Close(), DEBUG, fd, I_CONNECTING, I_ERR_BIND, I_ERR_CONNECT, I_ERR_SOCKET, I_ERROR, I_LISTENING, OnError(), state, timeout, and timeout_end.
References addr, addy, Close(), DEBUG, fd, I_CONNECTING, I_ERR_BIND, I_ERR_CONNECT, I_ERR_SOCKET, I_ERROR, I_LISTENING, IP, OnError(), state, timeout, and timeout_end.
.PP
.nf
58 {
59 if (listening) {
60 if ((this->fd = OpenTCPSocket()) == ERROR)
61 {
62 this->fd = -1;
63 this->state = I_ERROR;
64 this->OnError(I_ERR_SOCKET);
65 log(DEBUG,'OpenTCPSocket() error');
66 return;
67 }
68 else
69 {
70 if (BindSocket(this->fd,this->client,this->server,port,(char*)host.c_str()) == ERROR)
71 {
72 this->Close();
73 this->fd = -1;
74 this->state = I_ERROR;
75 this->OnError(I_ERR_BIND);
76 log(DEBUG,'BindSocket() error %s',strerror(errno));
77 return;
78 }
79 else
80 {
81 this->state = I_LISTENING;
82 log(DEBUG,'New socket now in I_LISTENING state');
83 return;
84 }
85 }
86 } else {
87 char* ip;
88 this->host = host;
89 hostent* hoste = gethostbyname(host.c_str());
90 if (!hoste) {
91 ip = (char*)host.c_str();
92 } else {
93 struct in_addr* ia = (in_addr*)hoste->h_addr;
94 ip = inet_ntoa(*ia);
95 }
96
97 timeout_end = time(NULL)+maxtime;
98 timeout = false;
99 if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
100 {
101 this->state = I_ERROR;
102 this->OnError(I_ERR_SOCKET);
103 return;
104 }
105 this->port = port;
106 inet_aton(ip,&addy);
107 addr.sin_family = AF_INET;
108 addr.sin_addr = addy;
109 addr.sin_port = htons(this->port);
110
111 int flags;
112 flags = fcntl(this->fd, F_GETFL, 0);
113 fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
114
115 if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
116 {
117 if (errno != EINPROGRESS)
118 {
119 this->Close();
120 this->OnError(I_ERR_CONNECT);
121 this->state = I_ERROR;
122 return;
123 }
124 }
125 this->state = I_CONNECTING;
126 return;
127 }
128 }
59 {
60 if (listening) {
61 if ((this->fd = OpenTCPSocket()) == ERROR)
62 {
63 this->fd = -1;
64 this->state = I_ERROR;
65 this->OnError(I_ERR_SOCKET);
66 log(DEBUG,'OpenTCPSocket() error');
67 return;
68 }
69 else
70 {
71 if (BindSocket(this->fd,this->client,this->server,port,(char*)host.c_str()) == ERROR)
72 {
73 this->Close();
74 this->fd = -1;
75 this->state = I_ERROR;
76 this->OnError(I_ERR_BIND);
77 log(DEBUG,'BindSocket() error %s',strerror(errno));
78 return;
79 }
80 else
81 {
82 this->state = I_LISTENING;
83 log(DEBUG,'New socket now in I_LISTENING state');
84 return;
85 }
86 }
87 } else {
88 char* ip;
89 this->host = host;
90 hostent* hoste = gethostbyname(host.c_str());
91 if (!hoste) {
92 ip = (char*)host.c_str();
93 } else {
94 struct in_addr* ia = (in_addr*)hoste->h_addr;
95 ip = inet_ntoa(*ia);
96 }
97
98 this->IP = ip;
99
100 timeout_end = time(NULL)+maxtime;
101 timeout = false;
102 if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
103 {
104 this->state = I_ERROR;
105 this->OnError(I_ERR_SOCKET);
106 return;
107 }
108 this->port = port;
109 inet_aton(ip,&addy);
110 addr.sin_family = AF_INET;
111 addr.sin_addr = addy;
112 addr.sin_port = htons(this->port);
113
114 int flags;
115 flags = fcntl(this->fd, F_GETFL, 0);
116 fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
117
118 if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
119 {
120 if (errno != EINPROGRESS)
121 {
122 this->Close();
123 this->OnError(I_ERR_CONNECT);
124 this->state = I_ERROR;
125 return;
126 }
127 }
128 this->state = I_CONNECTING;
129 return;
130 }
131 }
.fi
.PP
.SS "InspSocket::~InspSocket ()\fC [virtual]\fP"
.PP
Definition at line 246 of file socket.cpp.
Definition at line 254 of file socket.cpp.
.PP
References Close().
.PP
.nf
247 {
248 this->Close();
249 }
255 {
256 this->Close();
257 }
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "void InspSocket::Close ()\fC [virtual]\fP"
.PP
Definition at line 130 of file socket.cpp.
Definition at line 133 of file socket.cpp.
.PP
References fd, and OnClose().
.PP
Referenced by InspSocket(), and ~InspSocket().
.PP
.nf
131 {
132 if (this->fd != -1)
133 {
134 this->OnClose();
135 shutdown(this->fd,2);
136 close(this->fd);
137 this->fd = -1;
138 }
139 }
134 {
135 if (this->fd != -1)
136 {
137 this->OnClose();
138 shutdown(this->fd,2);
139 close(this->fd);
140 this->fd = -1;
141 }
142 }
.fi
.PP
.SS "\fBstd::string\fP InspSocket::GetIP ()"
.PP
Definition at line 144 of file socket.cpp.
.PP
References IP.
.PP
.nf
145 {
146 return this->IP;
147 }
.fi
.PP
.SS "\fBInspSocketState\fP InspSocket::GetState ()"
.PP
Definition at line 233 of file socket.cpp.
Definition at line 241 of file socket.cpp.
.PP
References state.
.PP
.nf
234 {
235 return this->state;
236 }
242 {
243 return this->state;
244 }
.fi
.PP
.SS "void InspSocket::OnClose ()\fC [virtual]\fP"
.PP
Definition at line 244 of file socket.cpp.
Definition at line 252 of file socket.cpp.
.PP
Referenced by Close().
.PP
.nf
244 { return; }
252 { return; }
.fi
.PP
.SS "bool InspSocket::OnConnected ()\fC [virtual]\fP"
.PP
Definition at line 238 of file socket.cpp.
Definition at line 246 of file socket.cpp.
.PP
Referenced by Poll().
.PP
.nf
238 { return true; }
246 { return true; }
.fi
.PP
.SS "bool InspSocket::OnDataReady ()\fC [virtual]\fP"
.PP
Definition at line 242 of file socket.cpp.
Definition at line 250 of file socket.cpp.
.PP
Referenced by Poll().
.PP
.nf
242 { return true; }
250 { return true; }
.fi
.PP
.SS "int InspSocket::OnDisconnect ()\fC [virtual]\fP"
.PP
Definition at line 240 of file socket.cpp.
Definition at line 248 of file socket.cpp.
.PP
.nf
240 { return 0; }
248 { return 0; }
.fi
.PP
.SS "void InspSocket::OnError (\fBInspSocketError\fP e)\fC [virtual]\fP"
.PP
Definition at line 239 of file socket.cpp.
Definition at line 247 of file socket.cpp.
.PP
Referenced by InspSocket(), and Poll().
.PP
.nf
239 { return; }
247 { return; }
.fi
.PP
.SS "int InspSocket::OnIncomingConnection (int newfd, char * ip)\fC [virtual]\fP"
.PP
Definition at line 241 of file socket.cpp.
Definition at line 249 of file socket.cpp.
.PP
Referenced by Poll().
.PP
.nf
241 { return 0; }
249 { return 0; }
.fi
.PP
.SS "void InspSocket::OnTimeout ()\fC [virtual]\fP"
.PP
Definition at line 243 of file socket.cpp.
Definition at line 251 of file socket.cpp.
.PP
Referenced by Poll().
.PP
.nf
243 { return; }
251 { return; }
.fi
.PP
.SS "bool InspSocket::Poll ()"
.PP
Definition at line 183 of file socket.cpp.
Definition at line 191 of file socket.cpp.
.PP
References client, fd, I_CONNECTED, I_CONNECTING, I_ERR_TIMEOUT, I_ERROR, I_LISTENING, length, OnConnected(), OnDataReady(), OnError(), OnIncomingConnection(), OnTimeout(), polls, SetState(), state, timeout, and timeout_end.
.PP
.nf
184 {
185 if ((time(NULL) > timeout_end) && (this->state == I_CONNECTING))
186 {
187 // for non-listening sockets, the timeout can occur
188 // which causes termination of the connection after
189 // the given number of seconds without a successful
190 // connection.
191 this->OnTimeout();
192 this->OnError(I_ERR_TIMEOUT);
193 timeout = true;
194 this->state = I_ERROR;
195 return false;
196 }
197 polls.fd = this->fd;
198 state == I_CONNECTING ? polls.events = POLLOUT : polls.events = POLLIN;
199 int ret = poll(&polls,1,1);
200
201 if (ret > 0)
202 {
203 int incoming = -1;
204
205 switch (this->state)
206 {
207 case I_CONNECTING:
208 this->SetState(I_CONNECTED);
209 return this->OnConnected();
210 break;
211 case I_LISTENING:
212 length = sizeof (client);
213 incoming = accept (this->fd, (sockaddr*)&client,&length);
214 this->OnIncomingConnection(incoming,inet_ntoa(client.sin_addr));
215 return true;
216 break;
217 case I_CONNECTED:
218 return this->OnDataReady();
219 break;
220 default:
221 break;
222 }
223 }
224 return true;
225 }
192 {
193 if ((time(NULL) > timeout_end) && (this->state == I_CONNECTING))
194 {
195 // for non-listening sockets, the timeout can occur
196 // which causes termination of the connection after
197 // the given number of seconds without a successful
198 // connection.
199 this->OnTimeout();
200 this->OnError(I_ERR_TIMEOUT);
201 timeout = true;
202 this->state = I_ERROR;
203 return false;
204 }
205 polls.fd = this->fd;
206 state == I_CONNECTING ? polls.events = POLLOUT : polls.events = POLLIN;
207 int ret = poll(&polls,1,1);
208
209 if (ret > 0)
210 {
211 int incoming = -1;
212
213 switch (this->state)
214 {
215 case I_CONNECTING:
216 this->SetState(I_CONNECTED);
217 return this->OnConnected();
218 break;
219 case I_LISTENING:
220 length = sizeof (client);
221 incoming = accept (this->fd, (sockaddr*)&client,&length);
222 this->OnIncomingConnection(incoming,inet_ntoa(client.sin_addr));
223 return true;
224 break;
225 case I_CONNECTED:
226 return this->OnDataReady();
227 break;
228 default:
229 break;
230 }
231 }
232 return true;
233 }
.fi
.PP
.SS "char * InspSocket::Read ()\fC [virtual]\fP"
.PP
Definition at line 141 of file socket.cpp.
Definition at line 149 of file socket.cpp.
.PP
References DEBUG, and ibuf.
.PP
.nf
142 {
143 int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
144 if (n > 0)
145 {
146 ibuf[n] = 0;
147 return ibuf;
148 }
149 else
150 {
151 log(DEBUG,'EOF or error on socket');
152 return NULL;
153 }
154 }
150 {
151 int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
152 if (n > 0)
153 {
154 ibuf[n] = 0;
155 return ibuf;
156 }
157 else
158 {
159 log(DEBUG,'EOF or error on socket');
160 return NULL;
161 }
162 }
.fi
.PP
.SS "void InspSocket::SetState (\fBInspSocketState\fP s)"
.PP
Definition at line 227 of file socket.cpp.
Definition at line 235 of file socket.cpp.
.PP
References DEBUG, and state.
.PP
Referenced by Poll().
.PP
.nf
228 {
229 log(DEBUG,'Socket state change');
230 this->state = s;
231 }
236 {
237 log(DEBUG,'Socket state change');
238 this->state = s;
239 }
.fi
.PP
.SS "int InspSocket::Write (\fBstd::string\fP data)\fC [virtual]\fP"
.PP
Definition at line 160 of file socket.cpp.
Definition at line 168 of file socket.cpp.
.PP
.nf
161 {
162 char* d = (char*)data.c_str();
163 unsigned int written = 0;
164 int n = 0;
165 int s = data.length();
166 while ((written < data.length()) && (n >= 0))
167 {
168 n = send(this->fd,d,s,0);
169 if (n > 0)
170 {
171 // If we didnt write everything, advance
172 // the pointers so that when we retry
173 // the next time around the loop, we try
174 // to write what we failed to write before.
175 written += n;
176 s -= n;
177 d += n;
178 }
179 }
180 return written;
181 }
169 {
170 char* d = (char*)data.c_str();
171 unsigned int written = 0;
172 int n = 0;
173 int s = data.length();
174 while ((written < data.length()) && (n >= 0))
175 {
176 n = send(this->fd,d,s,0);
177 if (n > 0)
178 {
179 // If we didnt write everything, advance
180 // the pointers so that when we retry
181 // the next time around the loop, we try
182 // to write what we failed to write before.
183 written += n;
184 s -= n;
185 d += n;
186 }
187 }
188 return written;
189 }
.fi
.PP
.SH "Member Data Documentation"
@ -460,7 +481,7 @@ Definition at line 38 of file socket.h.
Referenced by InspSocket().
.SS "sockaddr_in \fBInspSocket::client\fP\fC [private]\fP"
.PP
Definition at line 43 of file socket.h.
Definition at line 44 of file socket.h.
.PP
Referenced by Poll().
.SS "int \fBInspSocket::fd\fP\fC [private]\fP"
@ -471,14 +492,19 @@ Referenced by Close(), InspSocket(), and Poll().
.SS "\fBstd::string\fP \fBInspSocket::host\fP\fC [private]\fP"
.PP
Definition at line 34 of file socket.h.
.SS "char \fBInspSocket::ibuf\fP[1024]\fC [private]\fP"
.SS "char \fBInspSocket::ibuf\fP[16384]\fC [private]\fP"
.PP
Definition at line 42 of file socket.h.
.PP
Referenced by Read().
.SS "\fBstd::string\fP \fBInspSocket::IP\fP\fC [private]\fP"
.PP
Definition at line 43 of file socket.h.
.PP
Referenced by GetIP(), and InspSocket().
.SS "socklen_t \fBInspSocket::length\fP\fC [private]\fP"
.PP
Definition at line 45 of file socket.h.
Definition at line 46 of file socket.h.
.PP
Referenced by Poll().
.SS "pollfd \fBInspSocket::polls\fP\fC [private]\fP"
@ -491,7 +517,7 @@ Referenced by Poll().
Definition at line 35 of file socket.h.
.SS "sockaddr_in \fBInspSocket::server\fP\fC [private]\fP"
.PP
Definition at line 44 of file socket.h.
Definition at line 45 of file socket.h.
.SS "\fBInspSocketState\fP \fBInspSocket::state\fP\fC [private]\fP"
.PP
Definition at line 36 of file socket.h.

2
docs/man/man3/InviteItem.3
View File

@ -1,4 +1,4 @@
.TH "InviteItem" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "InviteItem" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

6
docs/man/man3/Invited.3
View File

@ -1,4 +1,4 @@
.TH "Invited" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "Invited" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -23,12 +23,12 @@ Inherits \fBclassbase\fP.
.PP
Holds a channel name to which a user has been invited.
.PP
Definition at line 36 of file users.h.
Definition at line 39 of file users.h.
.SH "Member Data Documentation"
.PP
.SS "char \fBInvited::channel\fP[CHANMAX]"
.PP
Definition at line 39 of file users.h.
Definition at line 42 of file users.h.
.PP
Referenced by userrec::InviteTo().

2
docs/man/man3/KLine.3
View File

@ -1,4 +1,4 @@
.TH "KLine" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "KLine" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/ModeParameter.3
View File

@ -1,4 +1,4 @@
.TH "ModeParameter" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ModeParameter" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

1567
docs/man/man3/Module.3
View File

File diff suppressed because it is too large Load Diff

16
docs/man/man3/ModuleFactory.3
View File

@ -1,4 +1,4 @@
.TH "ModuleFactory" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ModuleFactory" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -22,7 +22,7 @@ Inherits \fBclassbase\fP.
.RI "virtual \fB~ModuleFactory\fP ()"
.br
.ti -1c
.RI "virtual \fBModule\fP * \fBCreateModule\fP ()=0"
.RI "virtual \fBModule\fP * \fBCreateModule\fP (\fBServer\fP *Me)=0"
.br
.RI "\fICreates a new module. \fP"
.in -1c
@ -32,28 +32,28 @@ Instantiates classes inherited from \fBModule\fP This class creates a class inhe
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 1265 of file modules.h.
Definition at line 1654 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP"
.PP
Definition at line 1268 of file modules.h.
Definition at line 1657 of file modules.h.
.PP
.nf
1268 { }
1657 { }
.fi
.PP
.SS "virtual ModuleFactory::~ModuleFactory ()\fC [inline, virtual]\fP"
.PP
Definition at line 1269 of file modules.h.
Definition at line 1658 of file modules.h.
.PP
.nf
1269 { }
1658 { }
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "virtual \fBModule\fP* ModuleFactory::CreateModule ()\fC [pure virtual]\fP"
.SS "virtual \fBModule\fP* ModuleFactory::CreateModule (\fBServer\fP * Me)\fC [pure virtual]\fP"
.PP
Creates a new module.
.PP

8
docs/man/man3/ModuleMessage.3
View File

@ -1,4 +1,4 @@
.TH "ModuleMessage" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ModuleMessage" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -29,15 +29,15 @@ Inherited by \fBEvent\fP, and \fBRequest\fP.
.PP
The ModuleMessage class is the base class of \fBRequest\fP and \fBEvent\fP This class is used to represent a basic data structure which is passed between modules for safe inter-module communications.
.PP
Definition at line 142 of file modules.h.
Definition at line 143 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "virtual ModuleMessage::~ModuleMessage ()\fC [inline, virtual]\fP"
.PP
Definition at line 148 of file modules.h.
Definition at line 149 of file modules.h.
.PP
.nf
148 {};
149 {};
.fi
.PP
.SH "Member Function Documentation"

2
docs/man/man3/QLine.3
View File

@ -1,4 +1,4 @@
.TH "QLine" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "QLine" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

10
docs/man/man3/Request.3
View File

@ -1,4 +1,4 @@
.TH "Request" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "Request" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -58,7 +58,7 @@ The Request class is a unicast message directed at a given module.
When this class is properly instantiated it may be sent to a module using the \fBSend()\fP method, which will call the given module's OnRequest method with this class as its parameter.
.PP
Definition at line 156 of file modules.h.
Definition at line 157 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Request::Request (char * anydata, \fBModule\fP * src, \fBModule\fP * dst)"
@ -146,21 +146,21 @@ References dest, and Module::OnRequest().
.PP
This member holds a pointer to arbitary data set by the emitter of the message.
.PP
Definition at line 161 of file modules.h.
Definition at line 162 of file modules.h.
.PP
Referenced by GetData().
.SS "\fBModule\fP* \fBRequest::dest\fP\fC [protected]\fP"
.PP
The single destination of the Request.
.PP
Definition at line 168 of file modules.h.
Definition at line 169 of file modules.h.
.PP
Referenced by GetDest(), and Send().
.SS "\fBModule\fP* \fBRequest::source\fP\fC [protected]\fP"
.PP
This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply.
.PP
Definition at line 165 of file modules.h.
Definition at line 166 of file modules.h.
.PP
Referenced by GetSource().

773
docs/man/man3/Server.3
View File

File diff suppressed because it is too large Load Diff

14
docs/man/man3/Version.3
View File

@ -1,4 +1,4 @@
.TH "Version" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "Version" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -44,7 +44,7 @@ Holds a module's Version information The four members (set by the constructor on
A class of type Version is returned by the GetVersion method of the \fBModule\fP class.
.PP
Definition at line 112 of file modules.h.
Definition at line 113 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Version::Version (int major, int minor, int revision, int build, int flags)"
@ -59,19 +59,19 @@ Definition at line 246 of file modules.cpp.
.PP
.SS "const int \fBVersion::Build\fP"
.PP
Definition at line 115 of file modules.h.
Definition at line 116 of file modules.h.
.SS "const int \fBVersion::Flags\fP"
.PP
Definition at line 115 of file modules.h.
Definition at line 116 of file modules.h.
.SS "const int \fBVersion::Major\fP"
.PP
Definition at line 115 of file modules.h.
Definition at line 116 of file modules.h.
.SS "const int \fBVersion::Minor\fP"
.PP
Definition at line 115 of file modules.h.
Definition at line 116 of file modules.h.
.SS "const int \fBVersion::Revision\fP"
.PP
Definition at line 115 of file modules.h.
Definition at line 116 of file modules.h.
.SH "Author"
.PP

18
docs/man/man3/WhoWasUser.3
View File

@ -1,4 +1,4 @@
.TH "WhoWasUser" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "WhoWasUser" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -39,30 +39,30 @@ WhoWasUser \- A lightweight userrec used by WHOWAS.
.PP
A lightweight userrec used by WHOWAS.
.PP
Definition at line 325 of file users.h.
Definition at line 332 of file users.h.
.SH "Member Data Documentation"
.PP
.SS "char \fBWhoWasUser::dhost\fP[160]"
.PP
Definition at line 330 of file users.h.
Definition at line 337 of file users.h.
.SS "char \fBWhoWasUser::fullname\fP[MAXGECOS+1]"
.PP
Definition at line 332 of file users.h.
Definition at line 339 of file users.h.
.SS "char \fBWhoWasUser::host\fP[160]"
.PP
Definition at line 331 of file users.h.
Definition at line 338 of file users.h.
.SS "char \fBWhoWasUser::ident\fP[IDENTMAX+1]"
.PP
Definition at line 329 of file users.h.
Definition at line 336 of file users.h.
.SS "char \fBWhoWasUser::nick\fP[NICKMAX]"
.PP
Definition at line 328 of file users.h.
Definition at line 335 of file users.h.
.SS "char \fBWhoWasUser::server\fP[256]"
.PP
Definition at line 333 of file users.h.
Definition at line 340 of file users.h.
.SS "time_t \fBWhoWasUser::signon\fP"
.PP
Definition at line 334 of file users.h.
Definition at line 341 of file users.h.
.SH "Author"
.PP

2
docs/man/man3/XLine.3
View File

@ -1,4 +1,4 @@
.TH "XLine" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "XLine" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/ZLine.3
View File

@ -1,4 +1,4 @@
.TH "ZLine" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ZLine" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/_home_.3
View File

@ -1,4 +1,4 @@
.TH "/home/ Directory Reference" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "/home/ Directory Reference" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/_home_brain_.3
View File

@ -1,4 +1,4 @@
.TH "/home/brain/ Directory Reference" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "/home/brain/ Directory Reference" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/_home_brain_inspircd-cvs_.3
View File

@ -1,4 +1,4 @@
.TH "/home/brain/inspircd-cvs/ Directory Reference" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "/home/brain/inspircd-cvs/ Directory Reference" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/_home_brain_inspircd-cvs_inspircd_.3
View File

@ -1,4 +1,4 @@
.TH "/home/brain/inspircd-cvs/inspircd/ Directory Reference" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "/home/brain/inspircd-cvs/inspircd/ Directory Reference" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/_home_brain_inspircd-cvs_inspircd_include_.3
View File

@ -1,4 +1,4 @@
.TH "/home/brain/inspircd-cvs/inspircd/include/ Directory Reference" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "/home/brain/inspircd-cvs/inspircd/include/ Directory Reference" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/_home_brain_inspircd-cvs_inspircd_src_.3
View File

@ -1,4 +1,4 @@
.TH "/home/brain/inspircd-cvs/inspircd/src/ Directory Reference" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "/home/brain/inspircd-cvs/inspircd/src/ Directory Reference" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

6
docs/man/man3/base.h.3
View File

@ -1,4 +1,4 @@
.TH "base.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "base.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -12,6 +12,8 @@ base.h \-
.br
\fC#include <map>\fP
.br
\fC#include <deque>\fP
.br
\fC#include <string>\fP
.br
@ -42,7 +44,7 @@ base.h \-
.PP
.SS "typedef void* \fBVoidPointer\fP"
.PP
Definition at line 25 of file base.h.
Definition at line 26 of file base.h.
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.

4
docs/man/man3/channels.cpp.3
View File

@ -1,4 +1,4 @@
.TH "channels.cpp" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "channels.cpp" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -221,7 +221,7 @@ Referenced by Server::GetUsers().
Definition at line 81 of file channels.cpp.
.SS "int \fBMODCOUNT\fP = -1"
.PP
Definition at line 994 of file modules.cpp.
Definition at line 1032 of file modules.cpp.
.PP
Referenced by Server::FindModule().
.SS "std::vector<\fBstd::string\fP> \fBmodule_names\fP"

2
docs/man/man3/channels.h.3
View File

@ -1,4 +1,4 @@
.TH "channels.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "channels.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/chanrec.3
View File

@ -1,4 +1,4 @@
.TH "chanrec" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "chanrec" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

14
docs/man/man3/classbase.3
View File

@ -1,4 +1,4 @@
.TH "classbase" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "classbase" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -35,27 +35,27 @@ Inherited by \fBAdmin\fP, \fBConfigReader\fP, \fBConnectClass\fP, \fBExtensible\
.PP
The base class for all inspircd classes.
.PP
Definition at line 29 of file base.h.
Definition at line 30 of file base.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "classbase::classbase ()\fC [inline]\fP"
.PP
Constructor, Sets the object's time.
.PP
Definition at line 39 of file base.h.
Definition at line 40 of file base.h.
.PP
References age.
.PP
.nf
39 { age = time(NULL); }
40 { age = time(NULL); }
.fi
.PP
.SS "classbase::~classbase ()\fC [inline]\fP"
.PP
Definition at line 40 of file base.h.
Definition at line 41 of file base.h.
.PP
.nf
40 { }
41 { }
.fi
.PP
.SH "Member Data Documentation"
@ -64,7 +64,7 @@ Definition at line 40 of file base.h.
.PP
Time that the object was instantiated (used for TS calculation etc).
.PP
Definition at line 34 of file base.h.
Definition at line 35 of file base.h.
.PP
Referenced by classbase().

2
docs/man/man3/command_t.3
View File

@ -1,4 +1,4 @@
.TH "command_t" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "command_t" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

9
docs/man/man3/commands.h.3
View File

@ -1,4 +1,4 @@
.TH "commands.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "commands.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -188,9 +188,14 @@ commands.h \-
.RI "long \fBduration\fP (const char *str)"
.br
.RI "\fIOther useful functions. \fP"
.ti -1c
.RI "void \fBdo_whois\fP (\fBuserrec\fP *user, \fBuserrec\fP *dest, unsigned long signon, unsigned long idle, char *nick)"
.br
.in -1c
.SH "Function Documentation"
.PP
.SS "void do_whois (\fBuserrec\fP * user, \fBuserrec\fP * dest, unsigned long signon, unsigned long idle, char * nick)"
.PP
.SS "long duration (const char * str)"
.PP
Other useful functions.
@ -304,7 +309,7 @@ These are the handlers for user commands.
.PP
Functions for u:lined servers.
.PP
Referenced by Server::IsUlined().
Referenced by userrec::HasPermission(), and Server::IsUlined().
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.

2
docs/man/man3/connection.3
View File

@ -1,4 +1,4 @@
.TH "connection" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "connection" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/connection.h.3
View File

@ -1,4 +1,4 @@
.TH "connection.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "connection.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/ctables.h.3
View File

@ -1,4 +1,4 @@
.TH "ctables.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ctables.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/dns.h.3
View File

@ -1,4 +1,4 @@
.TH "dns.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "dns.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/dns_ip4list.3
View File

@ -1,4 +1,4 @@
.TH "dns_ip4list" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "dns_ip4list" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/hashcomp.h.3
View File

@ -1,4 +1,4 @@
.TH "hashcomp.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "hashcomp.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/irc.3
View File

@ -1,4 +1,4 @@
.TH "irc" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "irc" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/irc_InAddr_HashComp.3
View File

@ -1,4 +1,4 @@
.TH "irc::InAddr_HashComp" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "irc::InAddr_HashComp" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/irc_StrHashComp.3
View File

@ -1,4 +1,4 @@
.TH "irc::StrHashComp" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "irc::StrHashComp" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/irc_irc_char_traits.3
View File

@ -1,4 +1,4 @@
.TH "irc::irc_char_traits" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "irc::irc_char_traits" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/message.h.3
View File

@ -1,4 +1,4 @@
.TH "message.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "message.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/mode.h.3
View File

@ -1,4 +1,4 @@
.TH "mode.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "mode.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

4
docs/man/man3/modules.cpp.3
View File

@ -1,4 +1,4 @@
.TH "modules.cpp" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "modules.cpp" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -474,7 +474,7 @@ Referenced by ConfigReader::ConfigReader().
Definition at line 81 of file channels.cpp.
.SS "int \fBMODCOUNT\fP = -1"
.PP
Definition at line 994 of file modules.cpp.
Definition at line 1032 of file modules.cpp.
.SS "std::vector<\fBstd::string\fP> \fBmodule_names\fP"
.PP
.SS "std::vector<\fBInspSocket\fP*> \fBmodule_sockets\fP"

64
docs/man/man3/modules.h.3
View File

@ -1,4 +1,4 @@
.TH "modules.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "modules.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -71,6 +71,7 @@ modules.h \-
.ti -1c
.RI "#define \fBDEBUG\fP 10"
.br
.RI "\fIlog levels \fP"
.ti -1c
.RI "#define \fBVERBOSE\fP 20"
.br
@ -86,6 +87,7 @@ modules.h \-
.ti -1c
.RI "#define \fBMT_CHANNEL\fP 1"
.br
.RI "\fIUsed with OnExtendedMode() method of modules. \fP"
.ti -1c
.RI "#define \fBMT_CLIENT\fP 2"
.br
@ -95,6 +97,7 @@ modules.h \-
.ti -1c
.RI "#define \fBACR_DEFAULT\fP 0"
.br
.RI "\fIUsed with OnAccessCheck() method of modules. \fP"
.ti -1c
.RI "#define \fBACR_DENY\fP 1"
.br
@ -131,6 +134,7 @@ modules.h \-
.ti -1c
.RI "#define \fBVF_STATIC\fP 1"
.br
.RI "\fIUsed to define a set of behavior bits for a module. \fP"
.ti -1c
.RI "#define \fBVF_VENDOR\fP 2"
.br
@ -194,36 +198,38 @@ modules.h \-
.PP
.SS "#define AC_DEHALFOP 6"
.PP
Definition at line 47 of file modules.h.
Definition at line 46 of file modules.h.
.SS "#define AC_DEOP 1"
.PP
Definition at line 42 of file modules.h.
Definition at line 41 of file modules.h.
.SS "#define AC_DEVOICE 4"
.PP
Definition at line 45 of file modules.h.
Definition at line 44 of file modules.h.
.SS "#define AC_GENERAL_MODE 8"
.PP
Definition at line 49 of file modules.h.
Definition at line 48 of file modules.h.
.SS "#define AC_HALFOP 5"
.PP
Definition at line 46 of file modules.h.
Definition at line 45 of file modules.h.
.SS "#define AC_INVITE 7"
.PP
Definition at line 48 of file modules.h.
Definition at line 47 of file modules.h.
.SS "#define AC_KICK 0"
.PP
Definition at line 41 of file modules.h.
Definition at line 40 of file modules.h.
.SS "#define AC_OP 2"
.PP
Definition at line 43 of file modules.h.
Definition at line 42 of file modules.h.
.SS "#define AC_VOICE 3"
.PP
Definition at line 44 of file modules.h.
Definition at line 43 of file modules.h.
.SS "#define ACR_ALLOW 2"
.PP
Definition at line 39 of file modules.h.
.SS "#define ACR_DEFAULT 0"
.PP
Used with OnAccessCheck() method of modules.
.PP
Definition at line 37 of file modules.h.
.PP
Referenced by Module::OnAccessCheck().
@ -232,40 +238,42 @@ Referenced by Module::OnAccessCheck().
Definition at line 38 of file modules.h.
.SS "#define CONF_FILE_NOT_FOUND 0x000200"
.PP
Definition at line 1112 of file modules.h.
Definition at line 1501 of file modules.h.
.PP
Referenced by ConfigReader::ConfigReader().
.SS "#define CONF_NOT_A_NUMBER 0x000010"
.PP
Definition at line 1109 of file modules.h.
Definition at line 1498 of file modules.h.
.PP
Referenced by ConfigReader::ReadInteger().
.SS "#define CONF_NOT_UNSIGNED 0x000080"
.PP
Definition at line 1110 of file modules.h.
Definition at line 1499 of file modules.h.
.PP
Referenced by ConfigReader::ReadInteger().
.SS "#define CONF_VALUE_NOT_FOUND 0x000100"
.PP
Definition at line 1111 of file modules.h.
Definition at line 1500 of file modules.h.
.PP
Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
.SS "#define DEBUG 10"
.PP
log levels
.PP
Definition at line 23 of file modules.h.
.PP
Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DelUser(), userrec::HasPermission(), InspSocket::InspSocket(), chanrec::IsCustomModeSet(), InspSocket::Read(), userrec::ReadData(), userrec::RemoveInvite(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), InspSocket::SetState(), userrec::SetWriteError(), and Server::UserToPseudo().
Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DelUser(), InspSocket::InspSocket(), chanrec::IsCustomModeSet(), InspSocket::Read(), userrec::ReadData(), userrec::RemoveInvite(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), InspSocket::SetState(), userrec::SetWriteError(), and Server::UserToPseudo().
.SS "#define DEFAULT 30"
.PP
Definition at line 25 of file modules.h.
.SS "#define FD_MAGIC_NUMBER -42"
.PP
Definition at line 100 of file modules.h.
Definition at line 101 of file modules.h.
.PP
Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
.SS "#define FOREACH_MOD for (int _i = 0; _i <= \fBMODCOUNT\fP; _i++) modules[_i]->"
.PP
Definition at line 80 of file modules.h.
Definition at line 81 of file modules.h.
.PP
Referenced by Event::Send().
.SS "#define FOREACH_RESULT(x)"
@ -284,9 +292,11 @@ Referenced by Event::Send().
}
.fi
.PP
Definition at line 88 of file modules.h.
Definition at line 89 of file modules.h.
.SS "#define MT_CHANNEL 1"
.PP
Used with OnExtendedMode() method of modules.
.PP
Definition at line 31 of file modules.h.
.PP
Referenced by Server::AddExtendedListMode(), and ModeMakeList().
@ -311,16 +321,18 @@ Definition at line 26 of file modules.h.
Definition at line 24 of file modules.h.
.SS "#define VF_COMMON 8"
.PP
Definition at line 56 of file modules.h.
Definition at line 55 of file modules.h.
.SS "#define VF_SERVICEPROVIDER 4"
.PP
Definition at line 55 of file modules.h.
Definition at line 54 of file modules.h.
.SS "#define VF_STATIC 1"
.PP
Definition at line 53 of file modules.h.
Used to define a set of behavior bits for a module.
.PP
Definition at line 52 of file modules.h.
.SS "#define VF_VENDOR 2"
.PP
Definition at line 54 of file modules.h.
Definition at line 53 of file modules.h.
.PP
Referenced by Module::GetVersion().
.SH "Typedef Documentation"
@ -329,18 +341,18 @@ Referenced by Module::GetVersion().
.PP
Holds a list of users in a channel.
.PP
Definition at line 73 of file modules.h.
Definition at line 74 of file modules.h.
.SS "typedef std::deque<\fBstd::string\fP> \fBfile_cache\fP"
.PP
Low level definition of a \fBFileReader\fP classes file cache area.
.PP
Definition at line 68 of file modules.h.
Definition at line 65 of file modules.h.
.SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP"
.PP
Definition at line 1278 of file modules.h.
Definition at line 1667 of file modules.h.
.SS "typedef \fBfile_cache\fP \fBstring_list\fP"
.PP
Definition at line 69 of file modules.h.
Definition at line 70 of file modules.h.
.SH "Function Documentation"
.PP
.SS "void createcommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)"

2
docs/man/man3/nspace.3
View File

@ -1,4 +1,4 @@
.TH "nspace" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "nspace" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/nspace_hash_ in_addr _.3
View File

@ -1,4 +1,4 @@
.TH "nspace::hash< in_addr >" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "nspace::hash< in_addr >" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/nspace_hash_ string _.3
View File

@ -1,4 +1,4 @@
.TH "nspace::hash< string >" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "nspace::hash< string >" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/socket.cpp.3
View File

@ -1,4 +1,4 @@
.TH "socket.cpp" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "socket.cpp" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/socket.h.3
View File

@ -1,4 +1,4 @@
.TH "socket.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "socket.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/std.3
View File

@ -1,4 +1,4 @@
.TH "std" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "std" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/std_char_traits.3
View File

@ -1,4 +1,4 @@
.TH "std::char_traits" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "std::char_traits" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

2
docs/man/man3/ucrec.3
View File

@ -1,4 +1,4 @@
.TH "ucrec" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "ucrec" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME

561
docs/man/man3/userrec.3
View File

@ -1,4 +1,4 @@
.TH "userrec" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "userrec" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -19,9 +19,6 @@ Inherits \fBconnection\fP.
.RI "\fBuserrec\fP ()"
.br
.ti -1c
.RI "virtual \fB~userrec\fP ()"
.br
.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"
@ -89,6 +86,9 @@ Inherits \fBconnection\fP.
.RI "void \fBCloseSocket\fP ()"
.br
.RI "\fIShuts down and closes the user's socket. \fP"
.ti -1c
.RI "virtual \fB~userrec\fP ()"
.br
.in -1c
.SS "Public Attributes"
@ -192,52 +192,53 @@ Holds all information about a user This class stores all information about a use
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 108 of file users.h.
Definition at line 111 of file users.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "userrec::userrec ()"
.PP
Definition at line 33 of file users.cpp.
Definition at line 38 of file users.cpp.
.PP
References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, sendq, server, ServerName, connection::signon, TIME, timeout, and ucrec::uc_modes.
.PP
.nf
34 {
35 // the PROPER way to do it, AVOID bzero at *ALL* costs
36 strcpy(nick,'');
37 strcpy(ip,'127.0.0.1');
38 timeout = 0;
39 strcpy(ident,'');
40 strcpy(host,'');
41 strcpy(dhost,'');
42 strcpy(fullname,'');
43 strcpy(modes,'');
44 server = (char*)FindServerNamePtr(ServerName);
45 strcpy(awaymsg,'');
46 strcpy(oper,'');
47 reset_due = TIME;
48 lines_in = 0;
49 fd = lastping = signon = idle_lastmsg = nping = registered = 0;
50 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
51 haspassed = false;
52 dns_done = false;
53 recvq = '';
54 sendq = '';
55 for (int i = 0; i < MAXCHANS; i++)
56 {
57 this->chans[i].channel = NULL;
58 this->chans[i].uc_modes = 0;
59 }
60 invites.clear();
61 }
39 {
40 // the PROPER way to do it, AVOID bzero at *ALL* costs
41 strcpy(nick,'');
42 strcpy(ip,'127.0.0.1');
43 timeout = 0;
44 strcpy(ident,'');
45 strcpy(host,'');
46 strcpy(dhost,'');
47 strcpy(fullname,'');
48 strcpy(modes,'');
49 server = (char*)FindServerNamePtr(ServerName);
50 strcpy(awaymsg,'');
51 strcpy(oper,'');
52 reset_due = TIME;
53 lines_in = 0;
54 fd = lastping = signon = idle_lastmsg = nping = registered = 0;
55 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
56 haspassed = false;
57 dns_done = false;
58 recvq = '';
59 sendq = '';
60 for (int i = 0; i < MAXCHANS; i++)
61 {
62 this->chans[i].channel = NULL;
63 this->chans[i].uc_modes = 0;
64 }
65 invites.clear();
66 }
.fi
.PP
.SS "virtual userrec::~userrec ()\fC [inline, virtual]\fP"
.SS "userrec::~userrec ()\fC [virtual]\fP"
.PP
Definition at line 221 of file users.h.
Definition at line 68 of file users.cpp.
.PP
.nf
221 { }
69 {
70 }
.fi
.PP
.SH "Member Function Documentation"
@ -248,35 +249,35 @@ This method adds data to the buffer of the user.
.PP
The buffer can grow to any size within limits of the available memory, managed by the size of a \fBstd::string\fP, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.
.PP
Definition at line 194 of file users.cpp.
Definition at line 205 of file users.cpp.
.PP
References recvq, recvqmax, and SetWriteError().
.PP
.nf
195 {
196 std::string b = '';
197 for (unsigned int i = 0; i < a.length(); i++)
198 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
199 b = b + a[i];
200 std::stringstream stream(recvq);
201 stream << b;
202 recvq = stream.str();
203 unsigned int i = 0;
204 // count the size of the first line in the buffer.
205 while (i < recvq.length())
206 {
207 if (recvq[i++] == '\n')
208 break;
209 }
210 if (recvq.length() > (unsigned)this->recvqmax)
211 {
212 this->SetWriteError('RecvQ exceeded');
213 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax);
214 }
215 // return false if we've had more than 600 characters WITHOUT
216 // a carriage return (this is BAD, drop the socket)
217 return (i < 600);
218 }
206 {
207 std::string b = '';
208 for (unsigned int i = 0; i < a.length(); i++)
209 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
210 b = b + a[i];
211 std::stringstream stream(recvq);
212 stream << b;
213 recvq = stream.str();
214 unsigned int i = 0;
215 // count the size of the first line in the buffer.
216 while (i < recvq.length())
217 {
218 if (recvq[i++] == '\n')
219 break;
220 }
221 if (recvq.length() > (unsigned)this->recvqmax)
222 {
223 this->SetWriteError('RecvQ exceeded');
224 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax);
225 }
226 // return false if we've had more than 600 characters WITHOUT
227 // a carriage return (this is BAD, drop the socket)
228 return (i < 600);
229 }
.fi
.PP
.SS "void userrec::AddWriteBuf (\fBstd::string\fP data)"
@ -285,24 +286,24 @@ Adds to the user's write buffer.
.PP
You may add any amount of text up to this users sendq value, if you exceed the sendq value, \fBSetWriteError()\fP will be called to set the users error string to 'SendQ exceeded', and further buffer adds will be dropped.
.PP
Definition at line 250 of file users.cpp.
Definition at line 261 of file users.cpp.
.PP
References sendq, sendqmax, and SetWriteError().
.PP
.nf
251 {
252 if (this->GetWriteError() != '')
253 return;
254 if (sendq.length() + data.length() > (unsigned)this->sendqmax)
255 {
256 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax);
257 this->SetWriteError('SendQ exceeded');
258 return;
259 }
260 std::stringstream stream;
261 stream << sendq << data;
262 sendq = stream.str();
263 }
262 {
263 if (this->GetWriteError() != '')
264 return;
265 if (sendq.length() + data.length() > (unsigned)this->sendqmax)
266 {
267 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax);
268 this->SetWriteError('SendQ exceeded');
269 return;
270 }
271 std::stringstream stream;
272 stream << sendq << data;
273 sendq = stream.str();
274 }
.fi
.PP
.SS "bool userrec::BufferIsReady ()"
@ -311,46 +312,46 @@ This method returns true if the buffer contains at least one carriage return cha
.PP
one complete line may be read)
.PP
Definition at line 220 of file users.cpp.
Definition at line 231 of file users.cpp.
.PP
References recvq.
.PP
.nf
221 {
222 for (unsigned int i = 0; i < recvq.length(); i++)
223 if (recvq[i] == '\n')
224 return true;
225 return false;
226 }
232 {
233 for (unsigned int i = 0; i < recvq.length(); i++)
234 if (recvq[i] == '\n')
235 return true;
236 return false;
237 }
.fi
.PP
.SS "void userrec::ClearBuffer ()"
.PP
This function clears the entire buffer by setting it to an empty string.
.PP
Definition at line 228 of file users.cpp.
Definition at line 239 of file users.cpp.
.PP
References recvq.
.PP
Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
.PP
.nf
229 {
230 recvq = '';
231 }
240 {
241 recvq = '';
242 }
.fi
.PP
.SS "void userrec::CloseSocket ()"
.PP
Shuts down and closes the user's socket.
.PP
Definition at line 63 of file users.cpp.
Definition at line 72 of file users.cpp.
.PP
.nf
64 {
65 shutdown(this->fd,2);
66 close(this->fd);
67 }
73 {
74 shutdown(this->fd,2);
75 close(this->fd);
76 }
.fi
.PP
.SS "void userrec::FlushWriteBuf ()"
@ -359,31 +360,31 @@ Flushes as much of the user's buffer to the file descriptor as possible.
.PP
This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.
.PP
Definition at line 266 of file users.cpp.
Definition at line 277 of file users.cpp.
.PP
References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError().
.PP
.nf
267 {
268 if (sendq.length())
269 {
270 char* tb = (char*)this->sendq.c_str();
271 int n_sent = write(this->fd,tb,this->sendq.length());
272 if (n_sent == -1)
273 {
274 this->SetWriteError(strerror(errno));
275 }
276 else
277 {
278 // advance the queue
279 tb += n_sent;
280 this->sendq = tb;
281 // update the user's stats counters
282 this->bytes_out += n_sent;
283 this->cmds_out++;
284 }
285 }
286 }
278 {
279 if (sendq.length())
280 {
281 char* tb = (char*)this->sendq.c_str();
282 int n_sent = write(this->fd,tb,this->sendq.length());
283 if (n_sent == -1)
284 {
285 this->SetWriteError(strerror(errno));
286 }
287 else
288 {
289 // advance the queue
290 tb += n_sent;
291 this->sendq = tb;
292 // update the user's stats counters
293 this->bytes_out += n_sent;
294 this->cmds_out++;
295 }
296 }
297 }
.fi
.PP
.SS "\fBstd::string\fP userrec::GetBuffer ()"
@ -392,42 +393,42 @@ This method returns the first available string at the tail end of the buffer and
.PP
This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.
.PP
Definition at line 233 of file users.cpp.
Definition at line 244 of file users.cpp.
.PP
References recvq.
.PP
.nf
234 {
235 if (recvq == '')
236 return '';
237 char* line = (char*)recvq.c_str();
238 std::string ret = '';
239 while ((*line != '\n') && (strlen(line)))
240 {
241 ret = ret + *line;
242 line++;
243 }
244 if ((*line == '\n') || (*line == '\r'))
245 line++;
246 recvq = line;
247 return ret;
248 }
245 {
246 if (recvq == '')
247 return '';
248 char* line = (char*)recvq.c_str();
249 std::string ret = '';
250 while ((*line != '\n') && (strlen(line)))
251 {
252 ret = ret + *line;
253 line++;
254 }
255 if ((*line == '\n') || (*line == '\r'))
256 line++;
257 recvq = line;
258 return ret;
259 }
.fi
.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.
.PP
Definition at line 69 of file users.cpp.
Definition at line 78 of file users.cpp.
.PP
References dhost, ident, and nick.
.PP
.nf
70 {
71 static char result[MAXBUF];
72 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost);
73 return result;
74 }
79 {
80 static char result[MAXBUF];
81 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost);
82 return result;
83 }
.fi
.PP
.SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP"
@ -436,44 +437,44 @@ Returns the full real host of the user This member function returns the hostname
.PP
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.
.PP
Definition at line 87 of file users.cpp.
Definition at line 96 of file users.cpp.
.PP
References connection::host, ident, and nick.
.PP
.nf
88 {
89 static char fresult[MAXBUF];
90 snprintf(fresult,MAXBUF,'%s!%s@%s',nick,ident,host);
91 return fresult;
92 }
97 {
98 static char fresult[MAXBUF];
99 snprintf(fresult,MAXBUF,'%s!%s@%s',nick,ident,host);
100 return fresult;
101 }
.fi
.PP
.SS "\fBInvitedList\fP * userrec::GetInviteList ()"
.PP
Returns the list of channels this user has been invited to but has not yet joined.
.PP
Definition at line 108 of file users.cpp.
Definition at line 117 of file users.cpp.
.PP
References invites.
.PP
.nf
109 {
110 return &invites;
111 }
118 {
119 return &invites;
120 }
.fi
.PP
.SS "\fBstd::string\fP userrec::GetWriteError ()"
.PP
Returns the write error which last occured on this connection or an empty string if none occured.
.PP
Definition at line 296 of file users.cpp.
Definition at line 307 of file users.cpp.
.PP
References WriteError.
.PP
.nf
297 {
298 return this->WriteError;
299 }
308 {
309 return this->WriteError;
310 }
.fi
.PP
.SS "bool userrec::HasPermission (char * command)"
@ -482,118 +483,120 @@ Returns true or false for if a user can execute a privilaged oper command.
.PP
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.
.PP
Definition at line 142 of file users.cpp.
Definition at line 151 of file users.cpp.
.PP
References config_f, and DEBUG.
References config_f, and is_uline().
.PP
.nf
143 {
144 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
145 char* mycmd;
146 char* savept;
147 char* savept2;
148
149 // are they even an oper at all?
150 if (strchr(this->modes,'o'))
151 {
152 log(DEBUG,'*** HasPermission: %s is an oper',this->nick);
153 for (int j =0; j < ConfValueEnum('type',&config_f); j++)
154 {
155 ConfValue('type','name',j,TypeName,&config_f);
156 if (!strcmp(TypeName,this->oper))
157 {
158 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper);
159 ConfValue('type','classes',j,Classes,&config_f);
160 char* myclass = strtok_r(Classes,' ',&savept);
161 while (myclass)
162 {
163 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass);
164 for (int k =0; k < ConfValueEnum('class',&config_f); k++)
165 {
166 ConfValue('class','name',k,ClassName,&config_f);
167 if (!strcmp(ClassName,myclass))
168 {
169 ConfValue('class','commands',k,CommandList,&config_f);
170 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList);
171
172
173 mycmd = strtok_r(CommandList,' ',&savept2);
174 while (mycmd)
175 {
176 if (!strcasecmp(mycmd,command))
177 {
178 log(DEBUG,'*** Command %s found, returning true',command);
179 return true;
180 }
181 mycmd = strtok_r(NULL,' ',&savept2);
182 }
183 }
184 }
185 myclass = strtok_r(NULL,' ',&savept);
186 }
187 }
188 }
189 }
190 return false;
191 }
152 {
153 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
154 char* mycmd;
155 char* savept;
156 char* savept2;
157
158 // users on u-lined servers can completely bypass
159 // all permissions based checks.
160 //
161 // of course, if this is sent to a remote server and this
162 // server is not ulined there, then that other server
163 // silently drops the command.
164 if (is_uline(this->server))
165 return true;
166
167 // are they even an oper at all?
168 if (strchr(this->modes,'o'))
169 {
170 for (int j =0; j < ConfValueEnum('type',&config_f); j++)
171 {
172 ConfValue('type','name',j,TypeName,&config_f);
173 if (!strcmp(TypeName,this->oper))
174 {
175 ConfValue('type','classes',j,Classes,&config_f);
176 char* myclass = strtok_r(Classes,' ',&savept);
177 while (myclass)
178 {
179 for (int k =0; k < ConfValueEnum('class',&config_f); k++)
180 {
181 ConfValue('class','name',k,ClassName,&config_f);
182 if (!strcmp(ClassName,myclass))
183 {
184 ConfValue('class','commands',k,CommandList,&config_f);
185 mycmd = strtok_r(CommandList,' ',&savept2);
186 while (mycmd)
187 {
188 if ((!strcasecmp(mycmd,command)) || (*mycmd == '*'))
189 {
190 return true;
191 }
192 mycmd = strtok_r(NULL,' ',&savept2);
193 }
194 }
195 }
196 myclass = strtok_r(NULL,' ',&savept);
197 }
198 }
199 }
200 }
201 return false;
202 }
.fi
.PP
.SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP"
.PP
Adds a channel to a users invite list (invites them to a channel).
.PP
Definition at line 113 of file users.cpp.
Definition at line 122 of file users.cpp.
.PP
References Invited::channel, and invites.
.PP
.nf
114 {
115 Invited i;
116 strlcpy(i.channel,channel,CHANMAX);
117 invites.push_back(i);
118 }
123 {
124 Invited i;
125 strlcpy(i.channel,channel,CHANMAX);
126 invites.push_back(i);
127 }
.fi
.PP
.SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP"
.PP
Returns true if a user is invited to a channel.
.PP
Definition at line 94 of file users.cpp.
Definition at line 103 of file users.cpp.
.PP
References invites.
.PP
.nf
95 {
96 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
97 {
98 if (i->channel) {
99 if (!strcasecmp(i->channel,channel))
100 {
101 return true;
102 }
103 }
104 }
105 return false;
106 }
104 {
105 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
106 {
107 if (i->channel) {
108 if (!strcasecmp(i->channel,channel))
109 {
110 return true;
111 }
112 }
113 }
114 return false;
115 }
.fi
.PP
.SS "int userrec::ReadData (void * buffer, size_t size)"
.PP
Calls read() to read some data for this user using their fd.
.PP
Definition at line 76 of file users.cpp.
Definition at line 85 of file users.cpp.
.PP
References DEBUG.
.PP
.nf
77 {
78 if (this->fd > -1)
79 {
80 log(DEBUG,'userrec::ReadData on fd %d',this->fd);
81 return read(this->fd, buffer, size);
82 }
83 else return 0;
84 }
86 {
87 if (this->fd > -1)
88 {
89 log(DEBUG,'userrec::ReadData on fd %d',this->fd);
90 return read(this->fd, buffer, size);
91 }
92 else return 0;
93 }
.fi
.PP
.SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP"
@ -602,31 +605,31 @@ Removes a channel from a users invite list.
.PP
This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
.PP
Definition at line 120 of file users.cpp.
Definition at line 129 of file users.cpp.
.PP
References DEBUG, and invites.
.PP
.nf
121 {
122 log(DEBUG,'Removing invites');
123 if (channel)
124 {
125 if (invites.size())
126 {
127 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
128 {
129 if (i->channel)
130 {
131 if (!strcasecmp(i->channel,channel))
132 {
133 invites.erase(i);
134 return;
135 }
136 }
137 }
138 }
139 }
140 }
130 {
131 log(DEBUG,'Removing invites');
132 if (channel)
133 {
134 if (invites.size())
135 {
136 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
137 {
138 if (i->channel)
139 {
140 if (!strcasecmp(i->channel,channel))
141 {
142 invites.erase(i);
143 return;
144 }
145 }
146 }
147 }
148 }
149 }
.fi
.PP
.SS "void userrec::SetWriteError (\fBstd::string\fP error)"
@ -635,19 +638,19 @@ Sets the write error for a connection.
.PP
This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged.
.PP
Definition at line 288 of file users.cpp.
Definition at line 299 of file users.cpp.
.PP
References DEBUG, and WriteError.
.PP
Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf().
.PP
.nf
289 {
290 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str());
291 // don't try to set the error twice, its already set take the first string.
292 if (this->WriteError == '')
293 this->WriteError = error;
294 }
300 {
301 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str());
302 // don't try to set the error twice, its already set take the first string.
303 if (this->WriteError == '')
304 this->WriteError = error;
305 }
.fi
.PP
.SH "Member Data Documentation"
@ -658,12 +661,12 @@ The user's away message.
.PP
If this string is empty, the user is not marked as away.
.PP
Definition at line 155 of file users.h.
Definition at line 158 of file users.h.
.PP
Referenced by userrec().
.SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]"
.PP
Definition at line 146 of file users.h.
Definition at line 149 of file users.h.
.PP
Referenced by Server::PseudoToUser(), and userrec().
.SS "char \fBuserrec::dhost\fP[160]"
@ -672,28 +675,28 @@ The host displayed to non-opers (used for cloaking etc).
.PP
This usually matches the value of \fBuserrec::host\fP.
.PP
Definition at line 131 of file users.h.
Definition at line 134 of file users.h.
.PP
Referenced by GetFullHost(), and userrec().
.SS "bool \fBuserrec::dns_done\fP"
.PP
True when \fBDNS\fP lookups are completed.
.PP
Definition at line 178 of file users.h.
Definition at line 181 of file users.h.
.PP
Referenced by userrec().
.SS "int \fBuserrec::flood\fP"
.PP
Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
.PP
Definition at line 161 of file users.h.
Definition at line 164 of file users.h.
.PP
Referenced by userrec().
.SS "char \fBuserrec::fullname\fP[MAXGECOS+1]"
.PP
The users full name.
.PP
Definition at line 135 of file users.h.
Definition at line 138 of file users.h.
.PP
Referenced by userrec().
.SS "char \fBuserrec::ident\fP[IDENTMAX+2]"
@ -702,21 +705,21 @@ The users ident reply.
.PP
Two characters are added to the user-defined limit to compensate for the tilde etc.
.PP
Definition at line 126 of file users.h.
Definition at line 129 of file users.h.
.PP
Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().
.SS "\fBInvitedList\fP \fBuserrec::invites\fP\fC [private]\fP"
.PP
A list of channels the user has a pending invite to.
.PP
Definition at line 114 of file users.h.
Definition at line 117 of file users.h.
.PP
Referenced by GetInviteList(), InviteTo(), IsInvited(), RemoveInvite(), and userrec().
.SS "int \fBuserrec::lines_in\fP"
.PP
Flood counters.
.PP
Definition at line 203 of file users.h.
Definition at line 206 of file users.h.
.PP
Referenced by userrec().
.SS "char \fBuserrec::modes\fP[54]"
@ -725,7 +728,7 @@ The user's mode string.
.PP
This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. it is limited to length 54, as there can only be a maximum of 52 user modes (26 upper, 26 lower case) a null terminating char, and an optional + character.
.PP
Definition at line 144 of file users.h.
Definition at line 147 of file users.h.
.PP
Referenced by userrec().
.SS "char \fBuserrec::nick\fP[NICKMAX]"
@ -734,7 +737,7 @@ The users nickname.
.PP
An invalid nickname indicates an unregistered connection prior to the NICK command.
.PP
Definition at line 121 of file users.h.
Definition at line 124 of file users.h.
.PP
Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec().
.SS "char \fBuserrec::oper\fP[NICKMAX]"
@ -743,7 +746,7 @@ The oper type they logged in as, if they are an oper.
.PP
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.
.PP
Definition at line 174 of file users.h.
Definition at line 177 of file users.h.
.PP
Referenced by userrec().
.SS "char \fBuserrec::password\fP[MAXBUF]"
@ -752,31 +755,31 @@ Password specified by the user when they registered.
.PP
This is stored even if the <connect> block doesnt need a password, so that modules may check it.
.PP
Definition at line 188 of file users.h.
Definition at line 191 of file users.h.
.SS "unsigned int \fBuserrec::pingmax\fP"
.PP
Number of seconds between PINGs for this user (set from <connect:allow> tag.
.PP
Definition at line 182 of file users.h.
Definition at line 185 of file users.h.
.SS "\fBstd::string\fP \fBuserrec::recvq\fP"
.PP
User's receive queue.
.PP
Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.
.PP
Definition at line 194 of file users.h.
Definition at line 197 of file users.h.
.PP
Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec().
.SS "long \fBuserrec::recvqmax\fP"
.PP
Maximum size this user's recvq can become.
.PP
Definition at line 217 of file users.h.
Definition at line 220 of file users.h.
.PP
Referenced by AddBuffer().
.SS "time_t \fBuserrec::reset_due\fP"
.PP
Definition at line 204 of file users.h.
Definition at line 207 of file users.h.
.PP
Referenced by userrec().
.SS "\fBstd::string\fP \fBuserrec::sendq\fP"
@ -785,36 +788,36 @@ User's send queue.
.PP
Lines waiting to be sent are stored here until their buffer is flushed.
.PP
Definition at line 199 of file users.h.
Definition at line 202 of file users.h.
.PP
Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec().
.SS "long \fBuserrec::sendqmax\fP"
.PP
Maximum size this user's sendq can become.
.PP
Definition at line 213 of file users.h.
Definition at line 216 of file users.h.
.PP
Referenced by AddWriteBuf().
.SS "char* \fBuserrec::server\fP"
.PP
The server the user is connected to.
.PP
Definition at line 150 of file users.h.
Definition at line 153 of file users.h.
.PP
Referenced by userrec().
.SS "long \fBuserrec::threshold\fP"
.PP
Definition at line 205 of file users.h.
Definition at line 208 of file users.h.
.SS "unsigned int \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.
.PP
Definition at line 167 of file users.h.
Definition at line 170 of file users.h.
.PP
Referenced by userrec().
.SS "\fBstd::string\fP \fBuserrec::WriteError\fP"
.PP
Definition at line 209 of file users.h.
Definition at line 212 of file users.h.
.PP
Referenced by GetWriteError(), and SetWriteError().

4
docs/man/man3/users.cpp.3
View File

@ -1,4 +1,4 @@
.TH "users.cpp" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "users.cpp" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -20,6 +20,8 @@ users.cpp \-
.br
\fC#include 'inspstring.h'\fP
.br
\fC#include 'commands.h'\fP
.br
\fC#include 'helperfuncs.h'\fP
.br

18
docs/man/man3/users.h.3
View File

@ -1,4 +1,4 @@
.TH "users.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "users.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -75,34 +75,34 @@ users.h \-
.PP
.SS "#define CC_ALLOW 0"
.PP
Definition at line 31 of file users.h.
Definition at line 34 of file users.h.
.SS "#define CC_DENY 1"
.PP
Definition at line 32 of file users.h.
Definition at line 35 of file users.h.
.SS "#define STATUS_HOP 2"
.PP
Definition at line 27 of file users.h.
Definition at line 30 of file users.h.
.SS "#define STATUS_NORMAL 0"
.PP
Definition at line 29 of file users.h.
Definition at line 32 of file users.h.
.SS "#define STATUS_OP 4"
.PP
Definition at line 26 of file users.h.
Definition at line 29 of file users.h.
.SS "#define STATUS_VOICE 1"
.PP
Definition at line 28 of file users.h.
Definition at line 31 of file users.h.
.SH "Typedef Documentation"
.PP
.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).
.PP
Definition at line 100 of file users.h.
Definition at line 103 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.
.PP
Definition at line 94 of file users.h.
Definition at line 97 of file users.h.
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.

7
docs/man/man3/xline.h.3
View File

@ -1,4 +1,4 @@
.TH "xline.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.TH "xline.h" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -132,6 +132,9 @@ xline.h \-
.RI "void \fBzline_set_creation_time\fP (char *ip, time_t create_time)"
.br
.ti -1c
.RI "void \fBeline_set_creation_time\fP (char *host, time_t create_time)"
.br
.ti -1c
.RI "bool \fBzline_make_global\fP (const char *ipaddr)"
.br
.ti -1c
@ -172,6 +175,8 @@ Referenced by Server::DelQLine().
.SS "bool del_zline (const char * ipaddr)"
.PP
Referenced by Server::DelZLine().
.SS "void eline_set_creation_time (char * host, time_t create_time)"
.PP
.SS "void expire_lines ()"
.PP
.SS "void gline_set_creation_time (char * host, time_t create_time)"

2
docs/module-doc/annotated.html
View File

@ -49,7 +49,7 @@
<tr><td class="indexkey"><a class="el" href="classXLine.html">XLine</a></td><td class="indexvalue">XLine is the base class for ban lines such as G lines and K lines </td></tr>
<tr><td class="indexkey"><a class="el" href="classZLine.html">ZLine</a></td><td class="indexvalue">ZLine class </td></tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:10 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

115
docs/module-doc/base_8h-source.html
View File

@ -29,63 +29,66 @@
<a name="l00020"></a>00020 <span class="preprocessor">#include "inspircd_config.h"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;time.h&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;map&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00024"></a>00024
<a name="l00025"></a><a class="code" href="base_8h.html#VoidPointer">00025</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span>* <a class="code" href="base_8h.html#VoidPointer">VoidPointer</a>;
<a name="l00026"></a>00026
<a name="l00029"></a><a class="code" href="classclassbase.html">00029</a> <span class="keyword">class </span><a class="code" href="classclassbase.html">classbase</a>
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00034"></a><a class="code" href="classclassbase.html#age">00034</a> time_t <a class="code" href="classclassbase.html#age">age</a>;
<a name="l00035"></a>00035
<a name="l00039"></a><a class="code" href="classclassbase.html#classbase_28_29">00039</a> <a class="code" href="classclassbase.html#classbase_28_29">classbase</a>() { <a class="code" href="classclassbase.html#age">age</a> = time(NULL); }
<a name="l00040"></a><a class="code" href="classclassbase.html#_7Eclassbase_28_29">00040</a> <a class="code" href="classclassbase.html#_7Eclassbase_28_29">~classbase</a>() { }
<a name="l00041"></a>00041 };
<a name="l00042"></a>00042
<a name="l00050"></a><a class="code" href="classExtensible.html">00050</a> <span class="keyword">class </span><a class="code" href="classExtensible.html">Extensible</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
<a name="l00051"></a>00051 {
<a name="l00054"></a><a class="code" href="classExtensible.html#Extension_5FItems">00054</a> std::map&lt;std::string,char*&gt; <a class="code" href="classExtensible.html#Extension_5FItems">Extension_Items</a>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00057"></a>00057
<a name="l00069"></a>00069 <span class="keywordtype">bool</span> <a class="code" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extend</a>(<a class="code" href="namespaceirc.html#string">std::string</a> key, <span class="keywordtype">char</span>* p);
<a name="l00070"></a>00070
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> <a class="code" href="classExtensible.html#Shrink_28std_3A_3Astring_20key_29">Shrink</a>(<a class="code" href="namespaceirc.html#string">std::string</a> key);
<a name="l00081"></a>00081
<a name="l00088"></a>00088 <span class="keywordtype">char</span>* <a class="code" href="classExtensible.html#GetExt_28std_3A_3Astring_20key_29">GetExt</a>(<a class="code" href="namespaceirc.html#string">std::string</a> key);
<a name="l00089"></a>00089 };
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;deque&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a><a class="code" href="base_8h.html#VoidPointer">00026</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span>* <a class="code" href="base_8h.html#VoidPointer">VoidPointer</a>;
<a name="l00027"></a>00027
<a name="l00030"></a><a class="code" href="classclassbase.html">00030</a> <span class="keyword">class </span><a class="code" href="classclassbase.html">classbase</a>
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <span class="keyword">public</span>:
<a name="l00035"></a><a class="code" href="classclassbase.html#age">00035</a> time_t <a class="code" href="classclassbase.html#age">age</a>;
<a name="l00036"></a>00036
<a name="l00040"></a><a class="code" href="classclassbase.html#classbase_28_29">00040</a> <a class="code" href="classclassbase.html#classbase_28_29">classbase</a>() { <a class="code" href="classclassbase.html#age">age</a> = time(NULL); }
<a name="l00041"></a><a class="code" href="classclassbase.html#_7Eclassbase_28_29">00041</a> <a class="code" href="classclassbase.html#_7Eclassbase_28_29">~classbase</a>() { }
<a name="l00042"></a>00042 };
<a name="l00043"></a>00043
<a name="l00051"></a><a class="code" href="classExtensible.html">00051</a> <span class="keyword">class </span><a class="code" href="classExtensible.html">Extensible</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
<a name="l00052"></a>00052 {
<a name="l00055"></a><a class="code" href="classExtensible.html#Extension_5FItems">00055</a> std::map&lt;std::string,char*&gt; <a class="code" href="classExtensible.html#Extension_5FItems">Extension_Items</a>;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">public</span>:
<a name="l00058"></a>00058
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> <a class="code" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extend</a>(<a class="code" href="namespaceirc.html#string">std::string</a> key, <span class="keywordtype">char</span>* p);
<a name="l00071"></a>00071
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> <a class="code" href="classExtensible.html#Shrink_28std_3A_3Astring_20key_29">Shrink</a>(<a class="code" href="namespaceirc.html#string">std::string</a> key);
<a name="l00082"></a>00082
<a name="l00089"></a>00089 <span class="keywordtype">char</span>* <a class="code" href="classExtensible.html#GetExt_28std_3A_3Astring_20key_29">GetExt</a>(<a class="code" href="namespaceirc.html#string">std::string</a> key);
<a name="l00090"></a>00090
<a name="l00095"></a><a class="code" href="classBoolSet.html">00095</a> <span class="keyword">class </span><a class="code" href="classBoolSet.html">BoolSet</a>
<a name="l00096"></a>00096 {
<a name="l00097"></a><a class="code" href="classBoolSet.html#bits">00097</a> <span class="keywordtype">char</span> <a class="code" href="classBoolSet.html#bits">bits</a>;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">public</span>:
<a name="l00100"></a>00100
<a name="l00103"></a>00103 <a class="code" href="classBoolSet.html#BoolSet_28_29">BoolSet</a>();
<a name="l00104"></a>00104
<a name="l00107"></a>00107 <a class="code" href="classBoolSet.html#BoolSet_28_29">BoolSet</a>(<span class="keywordtype">char</span> bitmask);
<a name="l00108"></a>00108
<a name="l00113"></a>00113 <span class="keywordtype">void</span> <a class="code" href="classBoolSet.html#Set_28int_20number_29">Set</a>(<span class="keywordtype">int</span> number);
<a name="l00114"></a>00114
<a name="l00121"></a>00121 <span class="keywordtype">bool</span> <a class="code" href="classBoolSet.html#Get_28int_20number_29">Get</a>(<span class="keywordtype">int</span> number);
<a name="l00122"></a>00122
<a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="classBoolSet.html#Unset_28int_20number_29">Unset</a>(<span class="keywordtype">int</span> number);
<a name="l00128"></a>00128
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="classBoolSet.html#Invert_28int_20number_29">Invert</a>(<span class="keywordtype">int</span> number);
<a name="l00134"></a>00134
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> <a class="code" href="classBoolSet.html#operator_3D_3D_28BoolSet_20other_29">operator==</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00138"></a>00138
<a name="l00141"></a>00141 <a class="code" href="classBoolSet.html">BoolSet</a> <a class="code" href="classBoolSet.html#operator_7C_28BoolSet_20other_29">operator|</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00142"></a>00142
<a name="l00145"></a>00145 <a class="code" href="classBoolSet.html">BoolSet</a> <a class="code" href="classBoolSet.html#operator_20_26_28BoolSet_20other_29">operator&amp;</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00146"></a>00146
<a name="l00149"></a>00149 <span class="keywordtype">bool</span> <a class="code" href="classBoolSet.html#operator_3D_28BoolSet_20other_29">operator=</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00150"></a>00150 };
<a name="l00151"></a>00151
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="preprocessor">#endif</span>
<a name="l00154"></a>00154 <span class="preprocessor"></span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="classExtensible.html#GetExtList_28std_3A_3Adeque_3C_20std_3A_3Astring_20_3E_20_26list_29">GetExtList</a>(std::deque&lt;std::string&gt; &amp;list);
<a name="l00098"></a>00098 };
<a name="l00099"></a>00099
<a name="l00104"></a><a class="code" href="classBoolSet.html">00104</a> <span class="keyword">class </span><a class="code" href="classBoolSet.html">BoolSet</a>
<a name="l00105"></a>00105 {
<a name="l00106"></a><a class="code" href="classBoolSet.html#bits">00106</a> <span class="keywordtype">char</span> <a class="code" href="classBoolSet.html#bits">bits</a>;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">public</span>:
<a name="l00109"></a>00109
<a name="l00112"></a>00112 <a class="code" href="classBoolSet.html#BoolSet_28_29">BoolSet</a>();
<a name="l00113"></a>00113
<a name="l00116"></a>00116 <a class="code" href="classBoolSet.html#BoolSet_28_29">BoolSet</a>(<span class="keywordtype">char</span> bitmask);
<a name="l00117"></a>00117
<a name="l00122"></a>00122 <span class="keywordtype">void</span> <a class="code" href="classBoolSet.html#Set_28int_20number_29">Set</a>(<span class="keywordtype">int</span> number);
<a name="l00123"></a>00123
<a name="l00130"></a>00130 <span class="keywordtype">bool</span> <a class="code" href="classBoolSet.html#Get_28int_20number_29">Get</a>(<span class="keywordtype">int</span> number);
<a name="l00131"></a>00131
<a name="l00136"></a>00136 <span class="keywordtype">void</span> <a class="code" href="classBoolSet.html#Unset_28int_20number_29">Unset</a>(<span class="keywordtype">int</span> number);
<a name="l00137"></a>00137
<a name="l00142"></a>00142 <span class="keywordtype">void</span> <a class="code" href="classBoolSet.html#Invert_28int_20number_29">Invert</a>(<span class="keywordtype">int</span> number);
<a name="l00143"></a>00143
<a name="l00146"></a>00146 <span class="keywordtype">bool</span> <a class="code" href="classBoolSet.html#operator_3D_3D_28BoolSet_20other_29">operator==</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00147"></a>00147
<a name="l00150"></a>00150 <a class="code" href="classBoolSet.html">BoolSet</a> <a class="code" href="classBoolSet.html#operator_7C_28BoolSet_20other_29">operator|</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00151"></a>00151
<a name="l00154"></a>00154 <a class="code" href="classBoolSet.html">BoolSet</a> <a class="code" href="classBoolSet.html#operator_20_26_28BoolSet_20other_29">operator&amp;</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00155"></a>00155
<a name="l00158"></a>00158 <span class="keywordtype">bool</span> <a class="code" href="classBoolSet.html#operator_3D_28BoolSet_20other_29">operator=</a>(<a class="code" href="classBoolSet.html">BoolSet</a> other);
<a name="l00159"></a>00159 };
<a name="l00160"></a>00160
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="preprocessor">#endif</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:03 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

29
docs/module-doc/base_8h.html
View File

@ -10,6 +10,7 @@
<h1>base.h File Reference</h1><code>#include &quot;inspircd_config.h&quot;</code><br>
<code>#include &lt;time.h&gt;</code><br>
<code>#include &lt;map&gt;</code><br>
<code>#include &lt;deque&gt;</code><br>
<code>#include &lt;string&gt;</code><br>
<p>
@ -18,18 +19,18 @@ Include dependency graph for base.h:<p><center><img src="base_8h__incl.gif" bord
<p>
This graph shows which files directly or indirectly include this file:<p><center><img src="base_8h__dep__incl.gif" border="0" usemap="#base.hdep_map" alt=""></center>
<map name="base.hdep_map">
<area href="channels_8h-source.html" shape="rect" coords="123,260,208,287" alt="">
<area href="connection_8h-source.html" shape="rect" coords="116,108,215,135" alt="">
<area href="ctables_8h-source.html" shape="rect" coords="264,7,339,33" alt="">
<area href="modules_8h-source.html" shape="rect" coords="396,57,479,84" alt="">
<area href="users_8cpp-source.html" shape="rect" coords="398,159,478,185" alt="">
<area href="users_8h-source.html" shape="rect" coords="270,260,334,287" alt="">
<area href="commands_8h-source.html" shape="rect" coords="388,463,487,489" alt="">
<area href="message_8h-source.html" shape="rect" coords="395,209,480,236" alt="">
<area href="mode_8h-source.html" shape="rect" coords="404,311,471,337" alt="">
<area href="xline_8h-source.html" shape="rect" coords="407,361,468,388" alt="">
<area href="channels_8cpp-source.html" shape="rect" coords="536,235,635,261" alt="">
<area href="modules_8cpp-source.html" shape="rect" coords="536,311,635,337" alt="">
<area href="channels_8h-source.html" shape="rect" coords="123,327,208,353" alt="">
<area href="connection_8h-source.html" shape="rect" coords="116,276,215,303" alt="">
<area href="ctables_8h-source.html" shape="rect" coords="264,529,339,556" alt="">
<area href="modules_8h-source.html" shape="rect" coords="396,479,479,505" alt="">
<area href="users_8cpp-source.html" shape="rect" coords="546,99,626,125" alt="">
<area href="users_8h-source.html" shape="rect" coords="270,276,334,303" alt="">
<area href="commands_8h-source.html" shape="rect" coords="388,124,487,151" alt="">
<area href="message_8h-source.html" shape="rect" coords="395,428,480,455" alt="">
<area href="mode_8h-source.html" shape="rect" coords="404,327,471,353" alt="">
<area href="xline_8h-source.html" shape="rect" coords="407,377,468,404" alt="">
<area href="channels_8cpp-source.html" shape="rect" coords="536,428,635,455" alt="">
<area href="modules_8cpp-source.html" shape="rect" coords="536,377,635,404" alt="">
</map>
<p>
@ -72,10 +73,10 @@ This graph shows which files directly or indirectly include this file:<p><center
<p>
<p>
Definition at line <a class="el" href="base_8h-source.html#l00025">25</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td>
Definition at line <a class="el" href="base_8h-source.html#l00026">26</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:04 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

BIN
docs/module-doc/base_8h__dep__incl.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.4 KiB

After

Width:  |  Height:  |  Size: 8.9 KiB

24
docs/module-doc/base_8h__dep__incl.map
View File

@ -1,13 +1,13 @@
base referer
rect $channels_8h-source.html 123,260 208,287
rect $connection_8h-source.html 116,108 215,135
rect $ctables_8h-source.html 264,7 339,33
rect $modules_8h-source.html 396,57 479,84
rect $users_8cpp-source.html 398,159 478,185
rect $users_8h-source.html 270,260 334,287
rect $commands_8h-source.html 388,463 487,489
rect $message_8h-source.html 395,209 480,236
rect $mode_8h-source.html 404,311 471,337
rect $xline_8h-source.html 407,361 468,388
rect $channels_8cpp-source.html 536,235 635,261
rect $modules_8cpp-source.html 536,311 635,337
rect $channels_8h-source.html 123,327 208,353
rect $connection_8h-source.html 116,276 215,303
rect $ctables_8h-source.html 264,529 339,556
rect $modules_8h-source.html 396,479 479,505
rect $users_8cpp-source.html 546,99 626,125
rect $users_8h-source.html 270,276 334,303
rect $commands_8h-source.html 388,124 487,151
rect $message_8h-source.html 395,428 480,455
rect $mode_8h-source.html 404,327 471,353
rect $xline_8h-source.html 407,377 468,404
rect $channels_8cpp-source.html 536,428 635,455
rect $modules_8cpp-source.html 536,377 635,404

2
docs/module-doc/base_8h__dep__incl.md5
View File

@ -1 +1 @@
f6b12bb178ea9037bef41c096843593c
e28f78b35c4f957a36c51e1bcb09e76a

BIN
docs/module-doc/base_8h__incl.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.8 KiB

After

Width:  |  Height:  |  Size: 2.1 KiB

2
docs/module-doc/base_8h__incl.md5
View File

@ -1 +1 @@
67c328a54e3df328858803d816336df4
6c8bdf0cad8e094c4c6082bc5e0b8386

2
docs/module-doc/channels_8cpp-source.html
View File

@ -225,7 +225,7 @@
<a name="l00216"></a>00216 {
<a name="l00217"></a>00217 <span class="keywordflow">return</span> &amp;<a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>;
<a name="l00218"></a>00218 }
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:03 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

18
docs/module-doc/channels_8cpp.html
View File

@ -263,7 +263,7 @@ Definition at line <a class="el" href="channels_8cpp-source.html#l00053">53</a>
<p>
<p>
Referenced by <a class="el" href="users_8cpp-source.html#l00142">userrec::HasPermission()</a>. </td>
Referenced by <a class="el" href="users_8cpp-source.html#l00151">userrec::HasPermission()</a>. </td>
</tr>
</table>
<a class="anchor" name="custom_5Fmode_5Fparams"></a><!-- doxytag: member="channels.cpp::custom_mode_params" ref="custom_5Fmode_5Fparams" args="" --><p>
@ -430,7 +430,7 @@ Referenced by <a class="el" href="channels_8cpp-source.html#l00175">chanrec::Get
<p>
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00420">Server::GetUsers()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00453">Server::GetUsers()</a>. </td>
</tr>
</table>
<a class="anchor" name="log_5Ffile"></a><!-- doxytag: member="channels.cpp::log_file" ref="log_5Ffile" args="" --><p>
@ -526,9 +526,9 @@ Definition at line <a class="el" href="channels_8cpp-source.html#l00081">81</a>
<p>
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00994">994</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l01032">1032</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00784">Server::FindModule()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00822">Server::FindModule()</a>. </td>
</tr>
</table>
<a class="anchor" name="module_5Fnames"></a><!-- doxytag: member="channels.cpp::module_names" ref="module_5Fnames" args="" --><p>
@ -553,7 +553,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00784">Server::FindM
<p>
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00784">Server::FindModule()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00822">Server::FindModule()</a>. </td>
</tr>
</table>
<a class="anchor" name="modules"></a><!-- doxytag: member="channels.cpp::modules" ref="modules" args="" --><p>
@ -578,7 +578,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00784">Server::FindM
<p>
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00784">Server::FindModule()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00822">Server::FindModule()</a>. </td>
</tr>
</table>
<a class="anchor" name="motd_5BMAXBUF_5D"></a><!-- doxytag: member="channels.cpp::motd" ref="motd_5BMAXBUF_5D" args="[MAXBUF]" --><p>
@ -833,7 +833,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00784">Server::FindM
<p>
<p>
Referenced by <a class="el" href="users_8cpp-source.html#l00033">userrec::userrec()</a>. </td>
Referenced by <a class="el" href="users_8cpp-source.html#l00038">userrec::userrec()</a>. </td>
</tr>
</table>
<a class="anchor" name="startup_5Ftime"></a><!-- doxytag: member="channels.cpp::startup_time" ref="startup_5Ftime" args="" --><p>
@ -881,7 +881,7 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00033">userrec::userre
<p>
<p>
Referenced by <a class="el" href="users_8cpp-source.html#l00033">userrec::userrec()</a>. </td>
Referenced by <a class="el" href="users_8cpp-source.html#l00038">userrec::userrec()</a>. </td>
</tr>
</table>
<a class="anchor" name="WHOWAS_5FMAX"></a><!-- doxytag: member="channels.cpp::WHOWAS_MAX" ref="WHOWAS_5FMAX" args="" --><p>
@ -930,7 +930,7 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00033">userrec::userre
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:05 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

2
docs/module-doc/channels_8cpp__incl.md5
View File

@ -1 +1 @@
b9467ee45a5cd937945c9c8802f0376d
00cd09e5fafd85fb588d65342322aed6

2
docs/module-doc/channels_8h-source.html
View File

@ -148,7 +148,7 @@
<a name="l00257"></a>00257
<a name="l00258"></a>00258 <span class="preprocessor">#endif</span>
<a name="l00259"></a>00259 <span class="preprocessor"></span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:03 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

18
docs/module-doc/channels_8h.html
View File

@ -22,14 +22,14 @@ Include dependency graph for channels.h:<p><center><img src="channels_8h__incl.g
<p>
This graph shows which files directly or indirectly include this file:<p><center><img src="channels_8h__dep__incl.gif" border="0" usemap="#channels.hdep_map" alt=""></center>
<map name="channels.hdep_map">
<area href="users_8cpp-source.html" shape="rect" coords="267,7,347,33" alt="">
<area href="users_8h-source.html" shape="rect" coords="144,199,208,225" alt="">
<area href="commands_8h-source.html" shape="rect" coords="257,311,356,337" alt="">
<area href="message_8h-source.html" shape="rect" coords="264,57,349,84" alt="">
<area href="mode_8h-source.html" shape="rect" coords="273,159,340,185" alt="">
<area href="xline_8h-source.html" shape="rect" coords="276,260,337,287" alt="">
<area href="channels_8cpp-source.html" shape="rect" coords="405,133,504,160" alt="">
<area href="modules_8cpp-source.html" shape="rect" coords="405,209,504,236" alt="">
<area href="users_8cpp-source.html" shape="rect" coords="415,58,495,84" alt="">
<area href="users_8h-source.html" shape="rect" coords="144,210,208,236" alt="">
<area href="commands_8h-source.html" shape="rect" coords="257,58,356,84" alt="">
<area href="message_8h-source.html" shape="rect" coords="264,362,349,388" alt="">
<area href="mode_8h-source.html" shape="rect" coords="273,159,340,186" alt="">
<area href="xline_8h-source.html" shape="rect" coords="276,311,337,338" alt="">
<area href="channels_8cpp-source.html" shape="rect" coords="405,286,504,312" alt="">
<area href="modules_8cpp-source.html" shape="rect" coords="405,210,504,236" alt="">
</map>
<p>
@ -449,7 +449,7 @@ Holds a complete invite list.
Definition at line <a class="el" href="channels_8h-source.html#l00095">95</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:06 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

BIN
docs/module-doc/channels_8h__dep__incl.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.1 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

16
docs/module-doc/channels_8h__dep__incl.map
View File

@ -1,9 +1,9 @@
base referer
rect $users_8cpp-source.html 267,7 347,33
rect $users_8h-source.html 144,199 208,225
rect $commands_8h-source.html 257,311 356,337
rect $message_8h-source.html 264,57 349,84
rect $mode_8h-source.html 273,159 340,185
rect $xline_8h-source.html 276,260 337,287
rect $channels_8cpp-source.html 405,133 504,160
rect $modules_8cpp-source.html 405,209 504,236
rect $users_8cpp-source.html 415,58 495,84
rect $users_8h-source.html 144,210 208,236
rect $commands_8h-source.html 257,58 356,84
rect $message_8h-source.html 264,362 349,388
rect $mode_8h-source.html 273,159 340,186
rect $xline_8h-source.html 276,311 337,338
rect $channels_8cpp-source.html 405,286 504,312
rect $modules_8cpp-source.html 405,210 504,236

2
docs/module-doc/channels_8h__dep__incl.md5
View File

@ -1 +1 @@
3803f94897b7a90d54a987bd74d935ae
dae3fe0b8a33c3f04852556c65af182e

BIN
docs/module-doc/channels_8h__incl.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

2
docs/module-doc/channels_8h__incl.md5
View File

@ -1 +1 @@
bff3dff79fdca44ef00db5b6a6df4411
2faa87cc7e26d0d2ae6d67b690f5412a

2
docs/module-doc/classAdmin-members.html
View File

@ -13,7 +13,7 @@
<tr class="memlist"><td><a class="el" href="classAdmin.html#Name">Name</a></td><td><a class="el" href="classAdmin.html">Admin</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classAdmin.html#Nick">Nick</a></td><td><a class="el" href="classAdmin.html">Admin</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classclassbase.html#_7Eclassbase_28_29">~classbase</a>()</td><td><a class="el" href="classclassbase.html">classbase</a></td><td><code> [inline]</code></td></tr>
</table><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
</table><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

10
docs/module-doc/classAdmin.html
View File

@ -38,7 +38,7 @@ It is constructed by class <a class="el" href="classServer.html">Server</a>, and
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l00124">124</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
Definition at line <a class="el" href="modules_8h-source.html#l00125">125</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="Admin_28std_3A_3Astring_20name_2C_20std_3A_3Astring_20email_2C_20std_3A_3Astring_20nick_29"></a><!-- doxytag: member="Admin::Admin" ref="Admin_28std_3A_3Astring_20name_2C_20std_3A_3Astring_20email_2C_20std_3A_3Astring_20nick_29" args="(std::string name, std::string email, std::string nick)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
@ -110,7 +110,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00250">250</a>
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
Definition at line <a class="el" href="modules_8h-source.html#l00128">128</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Name"></a><!-- doxytag: member="Admin::Name" ref="Name" args="" --><p>
@ -135,7 +135,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
Definition at line <a class="el" href="modules_8h-source.html#l00128">128</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Nick"></a><!-- doxytag: member="Admin::Nick" ref="Nick" args="" --><p>
@ -160,12 +160,12 @@ Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
Definition at line <a class="el" href="modules_8h-source.html#l00128">128</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

2
docs/module-doc/classBanItem-members.html
View File

@ -14,7 +14,7 @@
<tr class="memlist"><td><a class="el" href="classHostItem.html#set_5Ftime">set_time</a></td><td><a class="el" href="classHostItem.html">HostItem</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classclassbase.html#_7Eclassbase_28_29">~classbase</a>()</td><td><a class="el" href="classclassbase.html">classbase</a></td><td><code> [inline]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classHostItem.html#_7EHostItem_28_29">~HostItem</a>()</td><td><a class="el" href="classHostItem.html">HostItem</a></td><td><code> [inline, virtual]</code></td></tr>
</table><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
</table><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

2
docs/module-doc/classBanItem.html
View File

@ -30,7 +30,7 @@ A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to h
<p>
Definition at line <a class="el" href="channels_8h-source.html#l00052">52</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

2
docs/module-doc/classBoolSet-members.html
View File

@ -17,7 +17,7 @@
<tr class="memlist"><td><a class="el" href="classBoolSet.html#operator_7C_28BoolSet_20other_29">operator|</a>(BoolSet other)</td><td><a class="el" href="classBoolSet.html">BoolSet</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classBoolSet.html#Set_28int_20number_29">Set</a>(int number)</td><td><a class="el" href="classBoolSet.html">BoolSet</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classBoolSet.html#Unset_28int_20number_29">Unset</a>(int number)</td><td><a class="el" href="classBoolSet.html">BoolSet</a></td><td></td></tr>
</table><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
</table><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

6
docs/module-doc/classBoolSet.html
View File

@ -55,7 +55,7 @@ Use <a class="el" href="classBoolSet.html#Set_28int_20number_29">BoolSet::Set</a
<p>
<p>
Definition at line <a class="el" href="base_8h-source.html#l00095">95</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
Definition at line <a class="el" href="base_8h-source.html#l00104">104</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="BoolSet_28_29"></a><!-- doxytag: member="BoolSet::BoolSet" ref="BoolSet_28_29" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
@ -400,12 +400,12 @@ The Unset method unsets one value in the set.
<p>
<p>
Definition at line <a class="el" href="base_8h-source.html#l00097">97</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td>
Definition at line <a class="el" href="base_8h-source.html#l00106">106</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="base_8h-source.html">base.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

2
docs/module-doc/classConfigReader-members.html
View File

@ -24,7 +24,7 @@
<tr class="memlist"><td><a class="el" href="classConfigReader.html#Verify_28_29">Verify</a>()</td><td><a class="el" href="classConfigReader.html">ConfigReader</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classclassbase.html#_7Eclassbase_28_29">~classbase</a>()</td><td><a class="el" href="classclassbase.html">classbase</a></td><td><code> [inline]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classConfigReader.html#_7EConfigReader_28_29">~ConfigReader</a>()</td><td><a class="el" href="classConfigReader.html">ConfigReader</a></td><td></td></tr>
</table><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
</table><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

284
docs/module-doc/classConfigReader.html
View File

@ -73,7 +73,7 @@ It may either be instantiated with one parameter or none. Constructing the class
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l01121">1121</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
Definition at line <a class="el" href="modules_8h-source.html#l01510">1510</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ConfigReader_28_29"></a><!-- doxytag: member="ConfigReader::ConfigReader" ref="ConfigReader_28_29" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
@ -102,16 +102,16 @@ Default constructor.
<p>
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00796">796</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00834">834</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01112">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01134">error</a>, <a class="el" href="modules_8h-source.html#l01130">errorlog</a>, <a class="el" href="modules_8cpp.html#include_5Fstack">include_stack</a>, and <a class="el" href="modules_8h-source.html#l01133">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00797"></a>00797 {
<a name="l00798"></a>00798 <a class="code" href="modules_8cpp.html#include_5Fstack">include_stack</a>.clear();
<a name="l00799"></a>00799 this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00800"></a>00800 this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00801"></a>00801 this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(CONFIG_FILE,this-&gt;cache,this-&gt;errorlog);
<a name="l00802"></a>00802 <span class="keywordflow">if</span> (!this-&gt;readerror)
<a name="l00803"></a>00803 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>;
<a name="l00804"></a>00804 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01501">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01523">error</a>, <a class="el" href="modules_8h-source.html#l01519">errorlog</a>, <a class="el" href="modules_8cpp.html#include_5Fstack">include_stack</a>, and <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00835"></a>00835 {
<a name="l00836"></a>00836 <a class="code" href="modules_8cpp.html#include_5Fstack">include_stack</a>.clear();
<a name="l00837"></a>00837 this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00838"></a>00838 this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00839"></a>00839 this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(CONFIG_FILE,this-&gt;cache,this-&gt;errorlog);
<a name="l00840"></a>00840 <span class="keywordflow">if</span> (!this-&gt;readerror)
<a name="l00841"></a>00841 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>;
<a name="l00842"></a>00842 }
</pre></div>
<p>
</td>
@ -146,15 +146,15 @@ Overloaded constructor.
<p>
This constructor initialises the ConfigReader class to read a user-specified config file
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00816">816</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00854">854</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01112">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01134">error</a>, <a class="el" href="modules_8h-source.html#l01130">errorlog</a>, and <a class="el" href="modules_8h-source.html#l01133">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00817"></a>00817 {
<a name="l00818"></a>00818 this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00819"></a>00819 this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00820"></a>00820 this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(filename.c_str(),this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a>,this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a>);
<a name="l00821"></a>00821 <span class="keywordflow">if</span> (!this-&gt;readerror)
<a name="l00822"></a>00822 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>;
<a name="l00823"></a>00823 };
References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01501">CONF_FILE_NOT_FOUND</a>, <a class="el" href="modules_8h-source.html#l01523">error</a>, <a class="el" href="modules_8h-source.html#l01519">errorlog</a>, and <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00855"></a>00855 {
<a name="l00856"></a>00856 this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00857"></a>00857 this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a> = <span class="keyword">new</span> std::stringstream(std::stringstream::in | std::stringstream::out);
<a name="l00858"></a>00858 this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a> = LoadConf(filename.c_str(),this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a>,this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a>);
<a name="l00859"></a>00859 <span class="keywordflow">if</span> (!this-&gt;readerror)
<a name="l00860"></a>00860 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FFILE_5FNOT_5FFOUND">CONF_FILE_NOT_FOUND</a>;
<a name="l00861"></a>00861 };
</pre></div>
<p>
</td>
@ -188,14 +188,14 @@ Default destructor.
<p>
This method destroys the ConfigReader class.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00807">807</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00845">845</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>, and <a class="el" href="modules_8h-source.html#l01130">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00808"></a>00808 {
<a name="l00809"></a>00809 <span class="keywordflow">if</span> (this-&gt;cache)
<a name="l00810"></a>00810 <span class="keyword">delete</span> this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a>;
<a name="l00811"></a>00811 <span class="keywordflow">if</span> (this-&gt;errorlog)
<a name="l00812"></a>00812 <span class="keyword">delete</span> this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a>;
<a name="l00813"></a>00813 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>, and <a class="el" href="modules_8h-source.html#l01519">errorlog</a>.<div class="fragment"><pre class="fragment"><a name="l00846"></a>00846 {
<a name="l00847"></a>00847 <span class="keywordflow">if</span> (this-&gt;cache)
<a name="l00848"></a>00848 <span class="keyword">delete</span> this-&gt;<a class="code" href="classConfigReader.html#cache">cache</a>;
<a name="l00849"></a>00849 <span class="keywordflow">if</span> (this-&gt;errorlog)
<a name="l00850"></a>00850 <span class="keyword">delete</span> this-&gt;<a class="code" href="classConfigReader.html#errorlog">errorlog</a>;
<a name="l00851"></a>00851 }
</pre></div>
<p>
</td>
@ -240,38 +240,38 @@ Dumps the list of errors in a config file to an output location.
<p>
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.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00894">894</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00932">932</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01130">errorlog</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00121">userrec::nick</a>.<div class="fragment"><pre class="fragment"><a name="l00895"></a>00895 {
<a name="l00896"></a>00896 <span class="keywordflow">if</span> (bail)
<a name="l00897"></a>00897 {
<a name="l00898"></a>00898 printf(<span class="stringliteral">"There were errors in your configuration:\n%s"</span>,<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;str().c_str());
<a name="l00899"></a>00899 exit(0);
<a name="l00900"></a>00900 }
<a name="l00901"></a>00901 <span class="keywordflow">else</span>
<a name="l00902"></a>00902 {
<a name="l00903"></a>00903 <span class="keywordtype">char</span> dataline[1024];
<a name="l00904"></a>00904 <span class="keywordflow">if</span> (user)
<a name="l00905"></a>00905 {
<a name="l00906"></a>00906 WriteServ(user-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :There were errors in the configuration file:"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
<a name="l00907"></a>00907 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;eof())
<a name="l00908"></a>00908 {
<a name="l00909"></a>00909 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;getline(dataline,1024);
<a name="l00910"></a>00910 WriteServ(user-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :%s"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,dataline);
<a name="l00911"></a>00911 }
<a name="l00912"></a>00912 }
<a name="l00913"></a>00913 <span class="keywordflow">else</span>
<a name="l00914"></a>00914 {
<a name="l00915"></a>00915 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
<a name="l00916"></a>00916 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;eof())
<a name="l00917"></a>00917 {
<a name="l00918"></a>00918 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;getline(dataline,1024);
<a name="l00919"></a>00919 WriteOpers(dataline);
<a name="l00920"></a>00920 }
<a name="l00921"></a>00921 }
<a name="l00922"></a>00922 <span class="keywordflow">return</span>;
<a name="l00923"></a>00923 }
<a name="l00924"></a>00924 }
References <a class="el" href="modules_8h-source.html#l01519">errorlog</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, and <a class="el" href="users_8h-source.html#l00124">userrec::nick</a>.<div class="fragment"><pre class="fragment"><a name="l00933"></a>00933 {
<a name="l00934"></a>00934 <span class="keywordflow">if</span> (bail)
<a name="l00935"></a>00935 {
<a name="l00936"></a>00936 printf(<span class="stringliteral">"There were errors in your configuration:\n%s"</span>,<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;str().c_str());
<a name="l00937"></a>00937 exit(0);
<a name="l00938"></a>00938 }
<a name="l00939"></a>00939 <span class="keywordflow">else</span>
<a name="l00940"></a>00940 {
<a name="l00941"></a>00941 <span class="keywordtype">char</span> dataline[1024];
<a name="l00942"></a>00942 <span class="keywordflow">if</span> (user)
<a name="l00943"></a>00943 {
<a name="l00944"></a>00944 WriteServ(user-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :There were errors in the configuration file:"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
<a name="l00945"></a>00945 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;eof())
<a name="l00946"></a>00946 {
<a name="l00947"></a>00947 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;getline(dataline,1024);
<a name="l00948"></a>00948 WriteServ(user-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"NOTICE %s :%s"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,dataline);
<a name="l00949"></a>00949 }
<a name="l00950"></a>00950 }
<a name="l00951"></a>00951 <span class="keywordflow">else</span>
<a name="l00952"></a>00952 {
<a name="l00953"></a>00953 WriteOpers(<span class="stringliteral">"There were errors in the configuration file:"</span>,user-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
<a name="l00954"></a>00954 <span class="keywordflow">while</span> (!<a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;eof())
<a name="l00955"></a>00955 {
<a name="l00956"></a>00956 <a class="code" href="classConfigReader.html#errorlog">errorlog</a>-&gt;getline(dataline,1024);
<a name="l00957"></a>00957 WriteOpers(dataline);
<a name="l00958"></a>00958 }
<a name="l00959"></a>00959 }
<a name="l00960"></a>00960 <span class="keywordflow">return</span>;
<a name="l00961"></a>00961 }
<a name="l00962"></a>00962 }
</pre></div>
<p>
</td>
@ -306,11 +306,11 @@ Counts the number of times a given tag appears in the config file.
<p>
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 <a class="el" href="classConfigReader.html#ReadValue_28std_3A_3Astring_20tag_2C_20std_3A_3Astring_20name_2C_20int_20index_29">ConfigReader::ReadValue</a> to loop through all copies of a multiple instance tag.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00927">927</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00965">965</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00928"></a>00928 {
<a name="l00929"></a>00929 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str());
<a name="l00930"></a>00930 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00966"></a>00966 {
<a name="l00967"></a>00967 <span class="keywordflow">return</span> EnumConf(<a class="code" href="classConfigReader.html#cache">cache</a>,tag.c_str());
<a name="l00968"></a>00968 }
</pre></div>
<p>
</td>
@ -354,11 +354,11 @@ Returns the number of items within a tag.
<p>
For example if the tag was &lt;test tag="blah" data="foo"&gt; then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00932">932</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00970">970</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00933"></a>00933 {
<a name="l00934"></a>00934 <span class="keywordflow">return</span> EnumValues(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index);
<a name="l00935"></a>00935 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>.<div class="fragment"><pre class="fragment"><a name="l00971"></a>00971 {
<a name="l00972"></a>00972 <span class="keywordflow">return</span> EnumValues(<a class="code" href="classConfigReader.html#cache">cache</a>, tag.c_str(), index);
<a name="l00973"></a>00973 }
</pre></div>
<p>
</td>
@ -392,13 +392,13 @@ Returns the last error to occur.
<p>
Valid errors can be found by looking in <a class="el" href="modules_8h.html">modules.h</a>. Any nonzero value indicates an error condition. A call to <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> resets the error flag back to 0.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00887">887</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00925">925</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00888"></a>00888 {
<a name="l00889"></a>00889 <span class="keywordtype">long</span> olderr = this-&gt;<a class="code" href="classConfigReader.html#error">error</a>;
<a name="l00890"></a>00890 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = 0;
<a name="l00891"></a>00891 <span class="keywordflow">return</span> olderr;
<a name="l00892"></a>00892 }
References <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00926"></a>00926 {
<a name="l00927"></a>00927 <span class="keywordtype">long</span> olderr = this-&gt;<a class="code" href="classConfigReader.html#error">error</a>;
<a name="l00928"></a>00928 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = 0;
<a name="l00929"></a>00929 <span class="keywordflow">return</span> olderr;
<a name="l00930"></a>00930 }
</pre></div>
<p>
</td>
@ -448,23 +448,23 @@ Retrieves a boolean value from the config file.
<p>
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.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00841">841</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00879">879</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01111">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00842"></a>00842 {
<a name="l00843"></a>00843 <span class="keywordtype">char</span> val[MAXBUF];
<a name="l00844"></a>00844 <span class="keywordtype">char</span> t[MAXBUF];
<a name="l00845"></a>00845 <span class="keywordtype">char</span> n[MAXBUF];
<a name="l00846"></a>00846 strlcpy(t,tag.c_str(),MAXBUF);
<a name="l00847"></a>00847 strlcpy(n,name.c_str(),MAXBUF);
<a name="l00848"></a>00848 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
<a name="l00849"></a>00849 <span class="keywordflow">if</span> (!res)
<a name="l00850"></a>00850 {
<a name="l00851"></a>00851 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
<a name="l00852"></a>00852 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00853"></a>00853 }
<a name="l00854"></a>00854 <a class="code" href="namespaceirc.html#string">std::string</a> s = val;
<a name="l00855"></a>00855 <span class="keywordflow">return</span> ((s == <span class="stringliteral">"yes"</span>) || (s == <span class="stringliteral">"YES"</span>) || (s == <span class="stringliteral">"true"</span>) || (s == <span class="stringliteral">"TRUE"</span>) || (s == <span class="stringliteral">"1"</span>));
<a name="l00856"></a>00856 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01500">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00880"></a>00880 {
<a name="l00881"></a>00881 <span class="keywordtype">char</span> val[MAXBUF];
<a name="l00882"></a>00882 <span class="keywordtype">char</span> t[MAXBUF];
<a name="l00883"></a>00883 <span class="keywordtype">char</span> n[MAXBUF];
<a name="l00884"></a>00884 strlcpy(t,tag.c_str(),MAXBUF);
<a name="l00885"></a>00885 strlcpy(n,name.c_str(),MAXBUF);
<a name="l00886"></a>00886 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
<a name="l00887"></a>00887 <span class="keywordflow">if</span> (!res)
<a name="l00888"></a>00888 {
<a name="l00889"></a>00889 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
<a name="l00890"></a>00890 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00891"></a>00891 }
<a name="l00892"></a>00892 <a class="code" href="namespaceirc.html#string">std::string</a> s = val;
<a name="l00893"></a>00893 <span class="keywordflow">return</span> ((s == <span class="stringliteral">"yes"</span>) || (s == <span class="stringliteral">"YES"</span>) || (s == <span class="stringliteral">"true"</span>) || (s == <span class="stringliteral">"TRUE"</span>) || (s == <span class="stringliteral">"1"</span>));
<a name="l00894"></a>00894 }
</pre></div>
<p>
</td>
@ -520,35 +520,35 @@ Retrieves an integer value from the config file.
<p>
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 <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> 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 <a class="el" href="classConfigReader.html#GetError_28_29">GetError()</a> will return CONF_NOT_UNSIGNED
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00858">858</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00896">896</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01109">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01110">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01111">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00859"></a>00859 {
<a name="l00860"></a>00860 <span class="keywordtype">char</span> val[MAXBUF];
<a name="l00861"></a>00861 <span class="keywordtype">char</span> t[MAXBUF];
<a name="l00862"></a>00862 <span class="keywordtype">char</span> n[MAXBUF];
<a name="l00863"></a>00863 strlcpy(t,tag.c_str(),MAXBUF);
<a name="l00864"></a>00864 strlcpy(n,name.c_str(),MAXBUF);
<a name="l00865"></a>00865 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
<a name="l00866"></a>00866 <span class="keywordflow">if</span> (!res)
<a name="l00867"></a>00867 {
<a name="l00868"></a>00868 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
<a name="l00869"></a>00869 <span class="keywordflow">return</span> 0;
<a name="l00870"></a>00870 }
<a name="l00871"></a>00871 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(val); i++)
<a name="l00872"></a>00872 {
<a name="l00873"></a>00873 <span class="keywordflow">if</span> (!isdigit(val[i]))
<a name="l00874"></a>00874 {
<a name="l00875"></a>00875 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FA_5FNUMBER">CONF_NOT_A_NUMBER</a>;
<a name="l00876"></a>00876 <span class="keywordflow">return</span> 0;
<a name="l00877"></a>00877 }
<a name="l00878"></a>00878 }
<a name="l00879"></a>00879 <span class="keywordflow">if</span> ((needs_unsigned) &amp;&amp; (atoi(val)&lt;0))
<a name="l00880"></a>00880 {
<a name="l00881"></a>00881 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FUNSIGNED">CONF_NOT_UNSIGNED</a>;
<a name="l00882"></a>00882 <span class="keywordflow">return</span> 0;
<a name="l00883"></a>00883 }
<a name="l00884"></a>00884 <span class="keywordflow">return</span> atoi(val);
<a name="l00885"></a>00885 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01498">CONF_NOT_A_NUMBER</a>, <a class="el" href="modules_8h-source.html#l01499">CONF_NOT_UNSIGNED</a>, <a class="el" href="modules_8h-source.html#l01500">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00897"></a>00897 {
<a name="l00898"></a>00898 <span class="keywordtype">char</span> val[MAXBUF];
<a name="l00899"></a>00899 <span class="keywordtype">char</span> t[MAXBUF];
<a name="l00900"></a>00900 <span class="keywordtype">char</span> n[MAXBUF];
<a name="l00901"></a>00901 strlcpy(t,tag.c_str(),MAXBUF);
<a name="l00902"></a>00902 strlcpy(n,name.c_str(),MAXBUF);
<a name="l00903"></a>00903 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
<a name="l00904"></a>00904 <span class="keywordflow">if</span> (!res)
<a name="l00905"></a>00905 {
<a name="l00906"></a>00906 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
<a name="l00907"></a>00907 <span class="keywordflow">return</span> 0;
<a name="l00908"></a>00908 }
<a name="l00909"></a>00909 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(val); i++)
<a name="l00910"></a>00910 {
<a name="l00911"></a>00911 <span class="keywordflow">if</span> (!isdigit(val[i]))
<a name="l00912"></a>00912 {
<a name="l00913"></a>00913 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FA_5FNUMBER">CONF_NOT_A_NUMBER</a>;
<a name="l00914"></a>00914 <span class="keywordflow">return</span> 0;
<a name="l00915"></a>00915 }
<a name="l00916"></a>00916 }
<a name="l00917"></a>00917 <span class="keywordflow">if</span> ((needs_unsigned) &amp;&amp; (atoi(val)&lt;0))
<a name="l00918"></a>00918 {
<a name="l00919"></a>00919 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FNOT_5FUNSIGNED">CONF_NOT_UNSIGNED</a>;
<a name="l00920"></a>00920 <span class="keywordflow">return</span> 0;
<a name="l00921"></a>00921 }
<a name="l00922"></a>00922 <span class="keywordflow">return</span> atoi(val);
<a name="l00923"></a>00923 }
</pre></div>
<p>
</td>
@ -598,22 +598,22 @@ Retrieves a value from the config file.
<p>
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.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00825">825</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00863">863</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01129">cache</a>, <a class="el" href="modules_8h-source.html#l01111">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01134">error</a>.<div class="fragment"><pre class="fragment"><a name="l00826"></a>00826 {
<a name="l00827"></a>00827 <span class="keywordtype">char</span> val[MAXBUF];
<a name="l00828"></a>00828 <span class="keywordtype">char</span> t[MAXBUF];
<a name="l00829"></a>00829 <span class="keywordtype">char</span> n[MAXBUF];
<a name="l00830"></a>00830 strlcpy(t,tag.c_str(),MAXBUF);
<a name="l00831"></a>00831 strlcpy(n,name.c_str(),MAXBUF);
<a name="l00832"></a>00832 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
<a name="l00833"></a>00833 <span class="keywordflow">if</span> (!res)
<a name="l00834"></a>00834 {
<a name="l00835"></a>00835 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
<a name="l00836"></a>00836 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
<a name="l00837"></a>00837 }
<a name="l00838"></a>00838 <span class="keywordflow">return</span> val;
<a name="l00839"></a>00839 }
References <a class="el" href="modules_8h-source.html#l01518">cache</a>, <a class="el" href="modules_8h-source.html#l01500">CONF_VALUE_NOT_FOUND</a>, and <a class="el" href="modules_8h-source.html#l01523">error</a>.<div class="fragment"><pre class="fragment"><a name="l00864"></a>00864 {
<a name="l00865"></a>00865 <span class="keywordtype">char</span> val[MAXBUF];
<a name="l00866"></a>00866 <span class="keywordtype">char</span> t[MAXBUF];
<a name="l00867"></a>00867 <span class="keywordtype">char</span> n[MAXBUF];
<a name="l00868"></a>00868 strlcpy(t,tag.c_str(),MAXBUF);
<a name="l00869"></a>00869 strlcpy(n,name.c_str(),MAXBUF);
<a name="l00870"></a>00870 <span class="keywordtype">int</span> res = ReadConf(<a class="code" href="classConfigReader.html#cache">cache</a>,t,n,index,val);
<a name="l00871"></a>00871 <span class="keywordflow">if</span> (!res)
<a name="l00872"></a>00872 {
<a name="l00873"></a>00873 this-&gt;<a class="code" href="classConfigReader.html#error">error</a> = <a class="code" href="modules_8h.html#CONF_5FVALUE_5FNOT_5FFOUND">CONF_VALUE_NOT_FOUND</a>;
<a name="l00874"></a>00874 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
<a name="l00875"></a>00875 }
<a name="l00876"></a>00876 <span class="keywordflow">return</span> val;
<a name="l00877"></a>00877 }
</pre></div>
<p>
</td>
@ -647,11 +647,11 @@ Returns true if a config file is valid.
<p>
This method is partially implemented and will only return false if the config file does not exist or could not be opened.
<p>
Definition at line <a class="el" href="modules_8cpp-source.html#l00937">937</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
Definition at line <a class="el" href="modules_8cpp-source.html#l00975">975</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
References <a class="el" href="modules_8h-source.html#l01133">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00938"></a>00938 {
<a name="l00939"></a>00939 <span class="keywordflow">return</span> this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a>;
<a name="l00940"></a>00940 }
References <a class="el" href="modules_8h-source.html#l01522">readerror</a>.<div class="fragment"><pre class="fragment"><a name="l00976"></a>00976 {
<a name="l00977"></a>00977 <span class="keywordflow">return</span> this-&gt;<a class="code" href="classConfigReader.html#readerror">readerror</a>;
<a name="l00978"></a>00978 }
</pre></div>
<p>
</td>
@ -682,9 +682,9 @@ The contents of the configuration file This protected member should never be acc
<p>
It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
<p>
Definition at line <a class="el" href="modules_8h-source.html#l01129">1129</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
Definition at line <a class="el" href="modules_8h-source.html#l01518">1518</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00927">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00932">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00841">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00858">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00825">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00807">~ConfigReader()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00965">Enumerate()</a>, <a class="el" href="modules_8cpp-source.html#l00970">EnumerateValues()</a>, <a class="el" href="modules_8cpp-source.html#l00879">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00896">ReadInteger()</a>, <a class="el" href="modules_8cpp-source.html#l00863">ReadValue()</a>, and <a class="el" href="modules_8cpp-source.html#l00845">~ConfigReader()</a>. </td>
</tr>
</table>
<a class="anchor" name="error"></a><!-- doxytag: member="ConfigReader::error" ref="error" args="" --><p>
@ -709,9 +709,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader(
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l01134">1134</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
Definition at line <a class="el" href="modules_8h-source.html#l01523">1523</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00887">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00841">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00858">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00825">ReadValue()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00925">GetError()</a>, <a class="el" href="modules_8cpp-source.html#l00879">ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00896">ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00863">ReadValue()</a>. </td>
</tr>
</table>
<a class="anchor" name="errorlog"></a><!-- doxytag: member="ConfigReader::errorlog" ref="errorlog" args="" --><p>
@ -736,9 +736,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader(
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l01130">1130</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
Definition at line <a class="el" href="modules_8h-source.html#l01519">1519</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00894">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00807">~ConfigReader()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, <a class="el" href="modules_8cpp-source.html#l00932">DumpErrors()</a>, and <a class="el" href="modules_8cpp-source.html#l00845">~ConfigReader()</a>. </td>
</tr>
</table>
<a class="anchor" name="readerror"></a><!-- doxytag: member="ConfigReader::readerror" ref="readerror" args="" --><p>
@ -765,14 +765,14 @@ Used to store errors.
<p>
<p>
Definition at line <a class="el" href="modules_8h-source.html#l01133">1133</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
Definition at line <a class="el" href="modules_8h-source.html#l01522">1522</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
Referenced by <a class="el" href="modules_8cpp-source.html#l00796">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00937">Verify()</a>. </td>
Referenced by <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00975">Verify()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

2
docs/module-doc/classConnectClass-members.html
View File

@ -19,7 +19,7 @@
<tr class="memlist"><td><a class="el" href="classConnectClass.html#threshold">threshold</a></td><td><a class="el" href="classConnectClass.html">ConnectClass</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classConnectClass.html#type">type</a></td><td><a class="el" href="classConnectClass.html">ConnectClass</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classclassbase.html#_7Eclassbase_28_29">~classbase</a>()</td><td><a class="el" href="classclassbase.html">classbase</a></td><td><code> [inline]</code></td></tr>
</table><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
</table><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

60
docs/module-doc/classConnectClass.html
View File

@ -57,7 +57,7 @@ Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tag
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00045">45</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
Definition at line <a class="el" href="users_8h-source.html#l00048">48</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ConnectClass_28_29"></a><!-- doxytag: member="ConnectClass::ConnectClass" ref="ConnectClass_28_29" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
@ -84,18 +84,18 @@ Definition at line <a class="el" href="users_8h-source.html#l00045">45</a> of fi
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00079">79</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00082">82</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
References <a class="el" href="users_8h-source.html#l00056">flood</a>, <a class="el" href="users_8h-source.html#l00059">host</a>, <a class="el" href="users_8h-source.html#l00065">pass</a>, <a class="el" href="users_8h-source.html#l00062">pingtime</a>, <a class="el" href="users_8h-source.html#l00077">recvqmax</a>, <a class="el" href="users_8h-source.html#l00053">registration_timeout</a>, <a class="el" href="users_8h-source.html#l00073">sendqmax</a>, and <a class="el" href="users_8h-source.html#l00069">threshold</a>.<div class="fragment"><pre class="fragment"><a name="l00080"></a>00080 {
<a name="l00081"></a>00081 <a class="code" href="classConnectClass.html#registration_5Ftimeout">registration_timeout</a> = 0;
<a name="l00082"></a>00082 <a class="code" href="classConnectClass.html#flood">flood</a> = 0;
<a name="l00083"></a>00083 <a class="code" href="classConnectClass.html#pingtime">pingtime</a> = 0;
<a name="l00084"></a>00084 <a class="code" href="classConnectClass.html#threshold">threshold</a> = 0;
<a name="l00085"></a>00085 <a class="code" href="classConnectClass.html#sendqmax">sendqmax</a> = 0;
<a name="l00086"></a>00086 <a class="code" href="classConnectClass.html#recvqmax">recvqmax</a> = 0;
<a name="l00087"></a>00087 strlcpy(<a class="code" href="classConnectClass.html#host_5BMAXBUF_5D">host</a>,<span class="stringliteral">""</span>,MAXBUF);
<a name="l00088"></a>00088 strlcpy(<a class="code" href="classConnectClass.html#pass_5BMAXBUF_5D">pass</a>,<span class="stringliteral">""</span>,MAXBUF);
<a name="l00089"></a>00089 }
References <a class="el" href="users_8h-source.html#l00059">flood</a>, <a class="el" href="users_8h-source.html#l00062">host</a>, <a class="el" href="users_8h-source.html#l00068">pass</a>, <a class="el" href="users_8h-source.html#l00065">pingtime</a>, <a class="el" href="users_8h-source.html#l00080">recvqmax</a>, <a class="el" href="users_8h-source.html#l00056">registration_timeout</a>, <a class="el" href="users_8h-source.html#l00076">sendqmax</a>, and <a class="el" href="users_8h-source.html#l00072">threshold</a>.<div class="fragment"><pre class="fragment"><a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <a class="code" href="classConnectClass.html#registration_5Ftimeout">registration_timeout</a> = 0;
<a name="l00085"></a>00085 <a class="code" href="classConnectClass.html#flood">flood</a> = 0;
<a name="l00086"></a>00086 <a class="code" href="classConnectClass.html#pingtime">pingtime</a> = 0;
<a name="l00087"></a>00087 <a class="code" href="classConnectClass.html#threshold">threshold</a> = 0;
<a name="l00088"></a>00088 <a class="code" href="classConnectClass.html#sendqmax">sendqmax</a> = 0;
<a name="l00089"></a>00089 <a class="code" href="classConnectClass.html#recvqmax">recvqmax</a> = 0;
<a name="l00090"></a>00090 strlcpy(<a class="code" href="classConnectClass.html#host_5BMAXBUF_5D">host</a>,<span class="stringliteral">""</span>,MAXBUF);
<a name="l00091"></a>00091 strlcpy(<a class="code" href="classConnectClass.html#pass_5BMAXBUF_5D">pass</a>,<span class="stringliteral">""</span>,MAXBUF);
<a name="l00092"></a>00092 }
</pre></div>
<p>
</td>
@ -126,9 +126,9 @@ Number of lines in buffer before excess flood is triggered.
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00056">56</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00059">59</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="host_5BMAXBUF_5D"></a><!-- doxytag: member="ConnectClass::host" ref="host_5BMAXBUF_5D" args="[MAXBUF]" --><p>
@ -155,9 +155,9 @@ Host mask for this line.
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00059">59</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00062">62</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="pass_5BMAXBUF_5D"></a><!-- doxytag: member="ConnectClass::pass" ref="pass_5BMAXBUF_5D" args="[MAXBUF]" --><p>
@ -184,9 +184,9 @@ Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00065">65</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00068">68</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="pingtime"></a><!-- doxytag: member="ConnectClass::pingtime" ref="pingtime" args="" --><p>
@ -213,9 +213,9 @@ Number of seconds between pings for this line.
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00062">62</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00065">65</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="recvqmax"></a><!-- doxytag: member="ConnectClass::recvqmax" ref="recvqmax" args="" --><p>
@ -242,9 +242,9 @@ Maximum size of recvq for users in this class (bytes).
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00077">77</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00080">80</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="registration_5Ftimeout"></a><!-- doxytag: member="ConnectClass::registration_timeout" ref="registration_5Ftimeout" args="" --><p>
@ -271,9 +271,9 @@ Max time to register the connection in seconds.
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00053">53</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00056">56</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="sendqmax"></a><!-- doxytag: member="ConnectClass::sendqmax" ref="sendqmax" args="" --><p>
@ -300,9 +300,9 @@ Maximum size of sendq for users in this class (bytes).
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00073">73</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00076">76</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="threshold"></a><!-- doxytag: member="ConnectClass::threshold" ref="threshold" args="" --><p>
@ -329,9 +329,9 @@ Threshold value for flood disconnect.
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00069">69</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
Definition at line <a class="el" href="users_8h-source.html#l00072">72</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
<p>
Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>. </td>
Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>. </td>
</tr>
</table>
<a class="anchor" name="type"></a><!-- doxytag: member="ConnectClass::type" ref="type" args="" --><p>
@ -358,12 +358,12 @@ Type of line, either CC_ALLOW or CC_DENY.
<p>
<p>
Definition at line <a class="el" href="users_8h-source.html#l00050">50</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
Definition at line <a class="el" href="users_8h-source.html#l00053">53</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="users_8h-source.html">users.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

6
docs/module-doc/classDNS-members.html
View File

@ -23,17 +23,19 @@
<tr class="memlist"><td><a class="el" href="classDNS.html#dns_5Fntoa_34_28const_20in_5Faddr_20_2Aconst_20ip_29">dns_ntoa4</a>(const in_addr *const ip)</td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#dns_5Fntoa_34_5Fr_28const_20in_5Faddr_20_2Aconst_20ip_29">dns_ntoa4_r</a>(const in_addr *const ip)</td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#dns_5Fntoa_34_5Fs_28const_20in_5Faddr_20_2Aconst_20ip_2C_20char_20_2Aconst_20result_29">dns_ntoa4_s</a>(const in_addr *const ip, char *const result)</td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#fd">fd</a></td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#ForwardLookup_28std_3A_3Astring_20host_29">ForwardLookup</a>(std::string host)</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#GetFD_28_29">GetFD</a>()</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#GetResult_28_29">GetResult</a>()</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#GetResultIP_28_29">GetResultIP</a>()</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#HasResult_28_29">HasResult</a>()</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#localbuf_5B_31_30_32_34_5D">localbuf</a></td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#myfd">myfd</a></td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#result">result</a></td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#ReverseLookup_28std_3A_3Astring_20ip_29">ReverseLookup</a>(std::string ip)</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#SetNS_28std_3A_3Astring_20dnsserver_29">SetNS</a>(std::string dnsserver)</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#t">t</a></td><td><a class="el" href="classDNS.html">DNS</a></td><td><code> [private]</code></td></tr>
<tr class="memlist"><td><a class="el" href="classDNS.html#_7EDNS_28_29">~DNS</a>()</td><td><a class="el" href="classDNS.html">DNS</a></td><td></td></tr>
</table><hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
</table><hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

74
docs/module-doc/classDNS.html
View File

@ -35,6 +35,8 @@ Collaboration diagram for DNS:<p><center><img src="classDNS__coll__graph.gif" bo
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#GetResult_28_29">GetResult</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the result of your query as a string, depending upon wether you called <a class="el" href="classDNS.html#ReverseLookup_28std_3A_3Astring_20ip_29">DNS::ReverseLookup()</a> or <a class="el" href="classDNS.html#ForwardLookup_28std_3A_3Astring_20host_29">DNS::ForwardLookup</a>. <a href="#GetResult_28_29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#GetResultIP_28_29">GetResultIP</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#GetFD_28_29">GetFD</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the file handle used by the dns query socket or zero if the query is invalid for some reason, e.g. <a href="#GetFD_28_29"></a><br></td></tr>
@ -55,28 +57,30 @@ Collaboration diagram for DNS:<p><center><img src="classDNS__coll__graph.gif" bo
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetname_34_28const_20in_5Faddr_20_2Aconst_20ip_29">dns_getname4</a> (const in_addr *const ip)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetresult_28const_20int_20fd_29">dns_getresult</a> (const int <a class="el" href="classDNS.html#fd">fd</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetresult_28const_20int_20fd_29">dns_getresult</a> (const int fd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Faton_34_5Fs_28const_20char_20_2Aconst_20ipstring_2C_20in_5Faddr_20_2Aconst_20ip_29">dns_aton4_s</a> (const char *const ipstring, in_addr *const ip)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fntoa_34_5Fs_28const_20in_5Faddr_20_2Aconst_20ip_2C_20char_20_2Aconst_20result_29">dns_ntoa4_s</a> (const in_addr *const ip, char *const <a class="el" href="classDNS.html#result">result</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetresult_5Fs_28const_20int_20fd_2C_20char_20_2Aconst_20result_29">dns_getresult_s</a> (const int <a class="el" href="classDNS.html#fd">fd</a>, char *const <a class="el" href="classDNS.html#result">result</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetresult_5Fs_28const_20int_20fd_2C_20char_20_2Aconst_20result_29">dns_getresult_s</a> (const int fd, char *const <a class="el" href="classDNS.html#result">result</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Faton_34_5Fr_28const_20char_20_2Aconst_20ipstring_29">dns_aton4_r</a> (const char *const ipstring)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fntoa_34_5Fr_28const_20in_5Faddr_20_2Aconst_20ip_29">dns_ntoa4_r</a> (const in_addr *const ip)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetresult_5Fr_28const_20int_20fd_29">dns_getresult_r</a> (const int <a class="el" href="classDNS.html#fd">fd</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#dns_5Fgetresult_5Fr_28const_20int_20fd_29">dns_getresult_r</a> (const int fd)</td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#binip">binip</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#result">result</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#localbuf_5B_31_30_32_34_5D">localbuf</a> [1024]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#t">t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#fd">fd</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDNS.html#myfd">myfd</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
@ -678,6 +682,33 @@ the dns server not responding. </td>
<p>
This method returns the result of your query as a string, depending upon wether you called <a class="el" href="classDNS.html#ReverseLookup_28std_3A_3Astring_20ip_29">DNS::ReverseLookup()</a> or <a class="el" href="classDNS.html#ForwardLookup_28std_3A_3Astring_20host_29">DNS::ForwardLookup</a>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="GetResultIP_28_29"></a><!-- doxytag: member="DNS::GetResultIP" ref="GetResultIP_28_29" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> DNS::GetResultIP </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
@ -795,13 +826,13 @@ This method will start the reverse lookup of an ip given in dotted decimal forma
Definition at line <a class="el" href="dns_8h-source.html#l00038">38</a> of file <a class="el" href="dns_8h-source.html">dns.h</a>. </td>
</tr>
</table>
<a class="anchor" name="fd"></a><!-- doxytag: member="DNS::fd" ref="fd" args="" --><p>
<a class="anchor" name="localbuf_5B_31_30_32_34_5D"></a><!-- doxytag: member="DNS::localbuf" ref="localbuf_5B_31_30_32_34_5D" args="[1024]" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="classDNS.html#fd">DNS::fd</a><code> [private]</code> </td>
<td class="md" nowrap valign="top">char <a class="el" href="classDNS.html#localbuf_5B_31_30_32_34_5D">DNS::localbuf</a>[1024]<code> [private]</code> </td>
</tr>
</table>
</td>
@ -817,7 +848,32 @@ Definition at line <a class="el" href="dns_8h-source.html#l00038">38</a> of file
<p>
<p>
Definition at line <a class="el" href="dns_8h-source.html#l00042">42</a> of file <a class="el" href="dns_8h-source.html">dns.h</a>. </td>
Definition at line <a class="el" href="dns_8h-source.html#l00040">40</a> of file <a class="el" href="dns_8h-source.html">dns.h</a>. </td>
</tr>
</table>
<a class="anchor" name="myfd"></a><!-- doxytag: member="DNS::myfd" ref="myfd" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="classDNS.html#myfd">DNS::myfd</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="dns_8h-source.html#l00043">43</a> of file <a class="el" href="dns_8h-source.html">dns.h</a>. </td>
</tr>
</table>
<a class="anchor" name="result"></a><!-- doxytag: member="DNS::result" ref="result" args="" --><p>
@ -867,12 +923,12 @@ Definition at line <a class="el" href="dns_8h-source.html#l00039">39</a> of file
<p>
<p>
Definition at line <a class="el" href="dns_8h-source.html#l00040">40</a> of file <a class="el" href="dns_8h-source.html">dns.h</a>. </td>
Definition at line <a class="el" href="dns_8h-source.html#l00041">41</a> of file <a class="el" href="dns_8h-source.html">dns.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dns_8h-source.html">dns.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>

BIN
docs/module-doc/classDNS__coll__graph.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.7 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

2
docs/module-doc/classDNS__coll__graph.md5
View File

@ -1 +1 @@
30aee4bdc7bc1791511ab48a46f93734
0840238510d3cd2b1f0c40a4d86dbdbe

Some files were not shown because too many files have changed in this diff Show More