Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file
Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file
Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers
Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers
Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class
Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class
-Generated on Sun May 2 00:09:29 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/base_8h-source.html b/docs/module-doc/base_8h-source.html
index 3de7c4079..8adefdfe8 100644
--- a/docs/module-doc/base_8h-source.html
+++ b/docs/module-doc/base_8h-source.html
@@ -1,52 +1,63 @@
-base.h Source File
+InspIRCd: base.h Source File
-
-
@@ -56,12 +46,12 @@ This graph shows which files directly or indirectly include this file:
-Definition at line 13 of file base.h.
+Definition at line 25 of file base.h.
-Generated on Sun May 2 00:09:19 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:29 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/channels_8cpp-source.html b/docs/module-doc/channels_8cpp-source.html
index 51d99f553..2e474e22d 100644
--- a/docs/module-doc/channels_8cpp-source.html
+++ b/docs/module-doc/channels_8cpp-source.html
@@ -1,199 +1,210 @@
-channels.cpp Source File
+InspIRCd: channels.cpp Source File
-
-
-Generated on Sun May 2 00:09:20 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:29 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html
index fc7d4a5ec..d768a44a0 100644
--- a/docs/module-doc/channels_8h-source.html
+++ b/docs/module-doc/channels_8h-source.html
@@ -1,137 +1,147 @@
-channels.h Source File
+InspIRCd: channels.h Source File
-
-
Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class.More...
Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class. More...
-Generated on Sun May 2 00:09:21 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:29 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html
index 36b2e3e8c..1149be0ac 100644
--- a/docs/module-doc/classAdmin-members.html
+++ b/docs/module-doc/classAdmin-members.html
@@ -1,22 +1,21 @@
-Member List
+InspIRCd: Member List
-
-
-Holds /ADMIN data This class contains the admin details of the local server.
+Holds /ADMIN data This class contains the admin details of the local server.
It is constructed by class Server, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running.
-Generated on Sun May 2 00:09:29 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html
index 7baeb71f6..76ea1821b 100644
--- a/docs/module-doc/classBanItem-members.html
+++ b/docs/module-doc/classBanItem-members.html
@@ -1,23 +1,22 @@
-Member List
+InspIRCd: Member List
-
-
Generated on Sun May 2 00:09:30 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html
index 0cb5f4742..5487f9e86 100644
--- a/docs/module-doc/classConfigReader-members.html
+++ b/docs/module-doc/classConfigReader-members.html
@@ -1,31 +1,32 @@
-Member List
+InspIRCd: Member List
-
-
Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
+
+
Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
More...
-Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
+Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.
+Dumps the list of errors in a config file to an output location.
+
+If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.
+
-Counts the number of times a given tag appears in the config file.
+Counts the number of times a given tag appears in the config file.
This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.
-Returns the number of items within a tag.
+Returns the number of items within a tag.
For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
-Returns the last error to occur.
+Returns the last error to occur.
Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.
-Retrieves a boolean value from the config file.
+Retrieves a boolean value from the config file.
This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" and "true" in the config file count as true to ReadFlag, and any other value counts as false.
-Retrieves an integer value from the config file.
+Retrieves an integer value from the config file.
This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED
-Retrieves a value from the config file.
+Retrieves a value from the config file.
This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
-The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).
+The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).
It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
-Generated on Sun May 2 00:09:32 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html
index 19b112718..4cf3b8c8c 100644
--- a/docs/module-doc/classConnectClass-members.html
+++ b/docs/module-doc/classConnectClass-members.html
@@ -1,24 +1,23 @@
-Member List
+InspIRCd: Member List
-
-
-Holds information relevent to <connect allow> and <connect deny> tags in the config file.
+Holds information relevent to <connect allow> and <connect deny> tags in the config file.
-Generated on Sun May 2 00:09:33 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html
index 94e61a4b6..46a3151d2 100644
--- a/docs/module-doc/classExemptItem-members.html
+++ b/docs/module-doc/classExemptItem-members.html
@@ -1,23 +1,22 @@
-Member List
+InspIRCd: Member List
-
-
Generated on Sun May 2 00:09:34 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classExtMode-members.html b/docs/module-doc/classExtMode-members.html
index 4f3b8f47a..357214dfb 100644
--- a/docs/module-doc/classExtMode-members.html
+++ b/docs/module-doc/classExtMode-members.html
@@ -1,25 +1,24 @@
-Member List
+InspIRCd: Member List
-
-
-Generated on Sun May 2 00:09:36 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classExtensible-members.html b/docs/module-doc/classExtensible-members.html
index 2c4871fca..7c83ec3ac 100644
--- a/docs/module-doc/classExtensible-members.html
+++ b/docs/module-doc/classExtensible-members.html
@@ -1,22 +1,21 @@
-Member List
+InspIRCd: Member List
-
-
-class Extensible is the parent class of many classes such as userrec and chanrec.
+class Extensible is the parent class of many classes such as userrec and chanrec.
class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage).
-Extend an Extensible class.
+Extend an Extensible class.
You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, Extensible::Extend will return false in this case. On successful extension, Extend returns true.
-
+
-
+
char* Extensible::GetExt
(
std::string
-
key
-
)
+
key
+
)
@@ -112,22 +105,22 @@ You must provide a key to store the data as, and a void* to the data (typedef Vo
-Get an extension item.
+Get an extension item.
You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.
-
+
-
+
bool Extensible::Shrink
(
std::string
-
key
-
)
+
key
+
)
@@ -143,19 +136,19 @@ You must provide a key name, which is case sensitive. If you provide a non-exist
-Shrink an Extensible class.
+Shrink an Extensible class.
You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success.
-Generated on Sun May 2 00:09:35 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classFileReader-members.html b/docs/module-doc/classFileReader-members.html
index e2e10b1bf..cb8bb55cb 100644
--- a/docs/module-doc/classFileReader-members.html
+++ b/docs/module-doc/classFileReader-members.html
@@ -1,26 +1,25 @@
-Member List
+InspIRCd: Member List
-
-
-Caches a text file into memory and can be used to retrieve lines from it.
+Caches a text file into memory and can be used to retrieve lines from it.
This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file.
This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.
-Returns true if the file exists This function will return false if the file could not be opened.
+Returns true if the file exists This function will return false if the file could not be opened.
-Returns the size of the file in lines.
+Returns the size of the file in lines.
This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.
-Retrieve one line from the file.
+Retrieve one line from the file.
This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.
-Generated on Sun May 2 00:09:36 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classGLine-members.html b/docs/module-doc/classGLine-members.html
index e0ce7b030..10f04a3b2 100644
--- a/docs/module-doc/classGLine-members.html
+++ b/docs/module-doc/classGLine-members.html
@@ -1,24 +1,23 @@
-Member List
+InspIRCd: Member List
-
-
-Generated on Sun May 2 00:09:37 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classHostItem-members.html b/docs/module-doc/classHostItem-members.html
index 4e4ac6d51..61a0e1b7e 100644
--- a/docs/module-doc/classHostItem-members.html
+++ b/docs/module-doc/classHostItem-members.html
@@ -1,23 +1,22 @@
-Member List
+InspIRCd: Member List
-
-
-Generated on Sun May 2 00:09:37 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classInviteItem-members.html b/docs/module-doc/classInviteItem-members.html
index 8f37a3ab3..49a5d25c7 100644
--- a/docs/module-doc/classInviteItem-members.html
+++ b/docs/module-doc/classInviteItem-members.html
@@ -1,23 +1,22 @@
-Member List
+InspIRCd: Member List
-
-
Generated on Sun May 2 00:09:38 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classInvited-members.html b/docs/module-doc/classInvited-members.html
index d355eb806..44fcd5d19 100644
--- a/docs/module-doc/classInvited-members.html
+++ b/docs/module-doc/classInvited-members.html
@@ -1,19 +1,18 @@
-Member List
+InspIRCd: Member List
-
-
-Generated on Sun May 2 00:09:38 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classKLine-members.html b/docs/module-doc/classKLine-members.html
index 4fe3facfa..9cc27d5ff 100644
--- a/docs/module-doc/classKLine-members.html
+++ b/docs/module-doc/classKLine-members.html
@@ -1,24 +1,23 @@
-Member List
+InspIRCd: Member List
-
-
-Generated on Sun May 2 00:09:40 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classModeParameter-members.html b/docs/module-doc/classModeParameter-members.html
index 900a001d5..8ab7a86cb 100644
--- a/docs/module-doc/classModeParameter-members.html
+++ b/docs/module-doc/classModeParameter-members.html
@@ -1,21 +1,20 @@
-Member List
+InspIRCd: Member List
-
-
-Generated on Sun May 2 00:09:40 2004 for InspIRCd by
+Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by
-1.3-rc3
+
+1.3.3
diff --git a/docs/module-doc/classModule-members.html b/docs/module-doc/classModule-members.html
index ad9926e5b..b015aa959 100644
--- a/docs/module-doc/classModule-members.html
+++ b/docs/module-doc/classModule-members.html
@@ -1,40 +1,40 @@
-Member List
+InspIRCd: Member List
-
-
-Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
+Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
-Called before an action which requires a channel privilage check.
+Called before an action which requires a channel privilage check.
This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are:
@@ -244,25 +262,25 @@ This function is called before many functions which check a users status on a ch
Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
-Called during a netburst to sync channel data.
+Called during a netburst to sync channel data.
This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.
-Called whenever an extended mode is to be processed.
+Called whenever an extended mode is to be processed.
The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with Server::AddExtendedMode If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.
-Called whenever a user types /INFO.
+Called whenever a user types /INFO.
The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:
1.3-rc3
+
