From 956328e80741c88cdae6d98b07be4171c98f4e26 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 30 May 2005 05:23:22 +0000 Subject: Added docs for base: BoolSet git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1565 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/annotated.html | 3 +- docs/module-doc/base_8h-source.html | 37 +- docs/module-doc/base_8h.html | 59 +- docs/module-doc/channels_8cpp-source.html | 10 +- docs/module-doc/channels_8cpp.html | 92 +- docs/module-doc/channels_8cpp__incl.gif | Bin 37708 -> 37780 bytes docs/module-doc/channels_8h-source.html | 2 +- docs/module-doc/channels_8h.html | 2 +- docs/module-doc/classAdmin-members.html | 2 +- docs/module-doc/classAdmin.html | 6 +- docs/module-doc/classBanItem-members.html | 2 +- docs/module-doc/classBanItem.html | 2 +- docs/module-doc/classBoolSet-members.html | 25 + docs/module-doc/classBoolSet.html | 422 +++++ docs/module-doc/classBoolSet__coll__graph.gif | Bin 0 -> 818 bytes docs/module-doc/classConfigReader-members.html | 2 +- docs/module-doc/classConfigReader.html | 279 +-- docs/module-doc/classConnectClass-members.html | 2 +- docs/module-doc/classConnectClass.html | 2 +- docs/module-doc/classDNS-members.html | 2 +- docs/module-doc/classDNS.html | 2 +- docs/module-doc/classELine-members.html | 2 +- docs/module-doc/classELine.html | 2 +- docs/module-doc/classEvent-members.html | 2 +- docs/module-doc/classEvent.html | 46 +- docs/module-doc/classExemptItem-members.html | 2 +- docs/module-doc/classExemptItem.html | 2 +- docs/module-doc/classExtMode-members.html | 2 +- docs/module-doc/classExtMode.html | 30 +- docs/module-doc/classExtensible-members.html | 2 +- docs/module-doc/classExtensible.html | 2 +- docs/module-doc/classFileReader-members.html | 2 +- docs/module-doc/classFileReader.html | 82 +- docs/module-doc/classGLine-members.html | 2 +- docs/module-doc/classGLine.html | 2 +- docs/module-doc/classHostItem-members.html | 2 +- docs/module-doc/classHostItem.html | 2 +- docs/module-doc/classInviteItem-members.html | 2 +- docs/module-doc/classInviteItem.html | 2 +- docs/module-doc/classInvited-members.html | 2 +- docs/module-doc/classInvited.html | 4 +- docs/module-doc/classKLine-members.html | 2 +- docs/module-doc/classKLine.html | 2 +- docs/module-doc/classModeParameter-members.html | 2 +- docs/module-doc/classModeParameter.html | 2 +- docs/module-doc/classModule-members.html | 2 +- docs/module-doc/classModule.html | 228 +-- docs/module-doc/classModuleFactory-members.html | 2 +- docs/module-doc/classModuleFactory.html | 2 +- docs/module-doc/classModuleMessage-members.html | 2 +- docs/module-doc/classModuleMessage.html | 2 +- docs/module-doc/classQLine-members.html | 2 +- docs/module-doc/classQLine.html | 2 +- docs/module-doc/classRequest-members.html | 2 +- docs/module-doc/classRequest.html | 60 +- docs/module-doc/classServer-members.html | 2 +- docs/module-doc/classServer.html | 812 ++++----- docs/module-doc/classVersion-members.html | 2 +- docs/module-doc/classVersion.html | 6 +- docs/module-doc/classWhoWasUser-members.html | 2 +- docs/module-doc/classWhoWasUser.html | 26 +- docs/module-doc/classXLine-members.html | 2 +- docs/module-doc/classXLine.html | 2 +- docs/module-doc/classZLine-members.html | 2 +- docs/module-doc/classZLine.html | 2 +- docs/module-doc/classchanrec-members.html | 2 +- docs/module-doc/classchanrec.html | 12 +- docs/module-doc/classclassbase-members.html | 2 +- docs/module-doc/classclassbase.html | 2 +- docs/module-doc/classcommand__t-members.html | 2 +- docs/module-doc/classcommand__t.html | 2 +- docs/module-doc/classconnection-members.html | 2 +- docs/module-doc/classconnection.html | 30 +- docs/module-doc/classes.html | 38 +- docs/module-doc/classircd__connector-members.html | 2 +- docs/module-doc/classircd__connector.html | 16 +- docs/module-doc/classserverrec-members.html | 2 +- docs/module-doc/classserverrec.html | 501 +++--- docs/module-doc/classstd_1_1char__traits.html | 2 +- docs/module-doc/classucrec-members.html | 2 +- docs/module-doc/classucrec.html | 6 +- docs/module-doc/classuserrec-members.html | 31 +- docs/module-doc/classuserrec.html | 762 ++++---- docs/module-doc/classuserrec__coll__graph.gif | Bin 12932 -> 13310 bytes docs/module-doc/commands_8h-source.html | 2 +- docs/module-doc/commands_8h.html | 6 +- docs/module-doc/connection_8h-source.html | 2 +- docs/module-doc/connection_8h.html | 8 +- docs/module-doc/ctables_8h-source.html | 2 +- docs/module-doc/ctables_8h.html | 2 +- docs/module-doc/dns_8h-source.html | 2 +- docs/module-doc/dns_8h.html | 2 +- docs/module-doc/files.html | 2 +- docs/module-doc/functions.html | 60 +- docs/module-doc/functions_func.html | 25 +- docs/module-doc/functions_vars.html | 41 +- docs/module-doc/globals.html | 137 +- docs/module-doc/globals_defs.html | 2 +- docs/module-doc/globals_func.html | 32 +- docs/module-doc/globals_type.html | 16 +- docs/module-doc/globals_vars.html | 97 +- docs/module-doc/graph_legend.html | 2 +- docs/module-doc/hashcomp_8h-source.html | 2 +- docs/module-doc/hashcomp_8h.html | 2 +- docs/module-doc/hierarchy.html | 3 +- docs/module-doc/inherit__graph__0.gif | Bin 761 -> 367 bytes docs/module-doc/inherit__graph__1.gif | Bin 12716 -> 761 bytes docs/module-doc/inherit__graph__2.gif | Bin 304 -> 12716 bytes docs/module-doc/inherit__graph__3.gif | Bin 397 -> 304 bytes docs/module-doc/inherit__graph__4.gif | Bin 608 -> 397 bytes docs/module-doc/inherit__graph__5.gif | Bin 531 -> 608 bytes docs/module-doc/inherit__graph__6.gif | Bin 619 -> 531 bytes docs/module-doc/inherit__graph__7.gif | Bin 590 -> 619 bytes docs/module-doc/inherit__graph__8.gif | Bin 513 -> 590 bytes docs/module-doc/inherit__graph__9.gif | Bin 0 -> 513 bytes docs/module-doc/inherits.html | 24 +- docs/module-doc/main.html | 2 +- docs/module-doc/message_8h-source.html | 2 +- docs/module-doc/message_8h.html | 14 +- docs/module-doc/mode_8h-source.html | 2 +- docs/module-doc/mode_8h.html | 2 +- docs/module-doc/modules_8cpp-source.html | 1865 ++++++++++---------- docs/module-doc/modules_8cpp.html | 656 +++---- docs/module-doc/modules_8cpp__incl.gif | Bin 40960 -> 40959 bytes docs/module-doc/modules_8h-source.html | 2 +- docs/module-doc/modules_8h.html | 36 +- docs/module-doc/namespaceirc.html | 2 +- docs/module-doc/namespacemembers.html | 2 +- docs/module-doc/namespacemembers_type.html | 2 +- docs/module-doc/namespacenspace.html | 2 +- docs/module-doc/namespaces.html | 2 +- docs/module-doc/namespacestd.html | 2 +- docs/module-doc/servers_8cpp-source.html | 573 +++--- docs/module-doc/servers_8cpp.html | 84 +- docs/module-doc/servers_8h-source.html | 2 +- docs/module-doc/servers_8h.html | 2 +- docs/module-doc/structdns__ip4list-members.html | 2 +- docs/module-doc/structdns__ip4list.html | 2 +- .../structirc_1_1InAddr__HashComp-members.html | 2 +- docs/module-doc/structirc_1_1InAddr__HashComp.html | 2 +- .../structirc_1_1StrHashComp-members.html | 2 +- docs/module-doc/structirc_1_1StrHashComp.html | 2 +- .../structirc_1_1irc__char__traits-members.html | 2 +- .../module-doc/structirc_1_1irc__char__traits.html | 2 +- ..._1nspace_1_1hash_3_01in__addr_01_4-members.html | 2 +- ...nspace_1_1nspace_1_1hash_3_01in__addr_01_4.html | 2 +- ..._1_1nspace_1_1hash_3_01string_01_4-members.html | 2 +- ...ctnspace_1_1nspace_1_1hash_3_01string_01_4.html | 2 +- docs/module-doc/tree.html | 2 + docs/module-doc/users_8cpp-source.html | 506 +++--- docs/module-doc/users_8cpp.html | 36 +- docs/module-doc/users_8h-source.html | 190 +- docs/module-doc/users_8h.html | 4 +- docs/module-doc/xline_8h-source.html | 2 +- docs/module-doc/xline_8h.html | 22 +- 155 files changed, 4454 insertions(+), 3790 deletions(-) create mode 100644 docs/module-doc/classBoolSet-members.html create mode 100644 docs/module-doc/classBoolSet.html create mode 100644 docs/module-doc/classBoolSet__coll__graph.gif create mode 100644 docs/module-doc/inherit__graph__9.gif (limited to 'docs/module-doc') diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index 2f5f879ec..bb9210bdb 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -8,6 +8,7 @@
| Admin | Holds /ADMIN data This class contains the admin details of the local server |
| BanItem | A subclass of HostItem designed to hold channel bans (+b) |
| BoolSet | BoolSet is a utility class designed to hold eight bools in a bitmask |
| chanrec | Holds all relevent information for a channel |
| char_traits | |
| classbase | The base class for all inspircd classes |
| XLine | XLine is the base class for ban lines such as G lines and K lines |
| ZLine | ZLine class |
1.3.3
diff --git a/docs/module-doc/base_8h-source.html b/docs/module-doc/base_8h-source.html
index 437322d94..9a2058149 100644
--- a/docs/module-doc/base_8h-source.html
+++ b/docs/module-doc/base_8h-source.html
@@ -53,9 +53,40 @@
00088 char* GetExt(std::string key);
00089 };
00090
-00091 #endif
-00092
-
1.3.3
diff --git a/docs/module-doc/base_8h.html b/docs/module-doc/base_8h.html
index d29ee2284..6da6ca04e 100644
--- a/docs/module-doc/base_8h.html
+++ b/docs/module-doc/base_8h.html
@@ -26,6 +26,9 @@ This graph shows which files directly or indirectly include this file:Compounds | |
| class | BoolSet |
| BoolSet is a utility class designed to hold eight bools in a bitmask. More... | |
| class | classbase |
| The base class for all inspircd classes. More... | Typedefs |
| typedef void * | VoidPointer |
Variables | |
| const int | bitfields [] = {1,2,4,8,16,32,64,128} |
| const int | inverted_bitfields [] = {~1,~2,~4,~8,~16,~32,~64,~128} |
@@ -61,7 +69,56 @@ This graph shows which files directly or indirectly include this file:
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
1.3.3
diff --git a/docs/module-doc/channels_8cpp-source.html b/docs/module-doc/channels_8cpp-source.html
index 5c935020a..91c8beca5 100644
--- a/docs/module-doc/channels_8cpp-source.html
+++ b/docs/module-doc/channels_8cpp-source.html
@@ -23,10 +23,10 @@
00016
00017 using namespace std;
00018
-00019 #include "inspircd.h"
-00020 #include "inspircd_io.h"
-00021 #include "inspircd_util.h"
-00022 #include "inspircd_config.h"
+00019 #include "inspircd_config.h"
+00020 #include "inspircd.h"
+00021 #include "inspircd_io.h"
+00022 #include "inspircd_util.h"
00023 #include <unistd.h>
00024 #include <sys/errno.h>
00025 #include <sys/ioctl.h>
@@ -229,7 +229,7 @@
00222 {
00223 return &internal_userlist;
00224 }
-
1.3.3
diff --git a/docs/module-doc/channels_8cpp.html b/docs/module-doc/channels_8cpp.html
index fc9858165..4d76c273f 100644
--- a/docs/module-doc/channels_8cpp.html
+++ b/docs/module-doc/channels_8cpp.html
@@ -5,10 +5,10 @@
#include "inspircd.h"#include "inspircd_config.h"#include "inspircd.h"#include "inspircd_io.h"#include "inspircd_util.h"#include "inspircd_config.h"#include <unistd.h>#include <sys/errno.h>#include <sys/ioctl.h>Include dependency graph for channels.cpp:

| char AdminEmail[MAXBUF] + | char AdminEmail[MAXBUF] |
| char AdminName[MAXBUF] + | char AdminName[MAXBUF] |
| char AdminNick[MAXBUF] + | char AdminNick[MAXBUF] |
| std::vector<long> auth_cookies + | std::vector<long> auth_cookies |
| int boundPortCount + | int boundPortCount |
Definition at line 95 of file channels.cpp.
-Referenced by userrec::HasPermission(). +Referenced by userrec::HasPermission().
@@ -336,7 +336,7 @@ Referenced by chanrec::Get
| int debugging + | int debugging |
| int defaultRoute + | int defaultRoute |
| int DieDelay + | int DieDelay |
| char diepass[MAXBUF] + | char diepass[MAXBUF] |
| char DieValue[MAXBUF] + | char DieValue[MAXBUF] |
| char list[MAXBUF] + | char list[MAXBUF] |
Definition at line 73 of file channels.cpp.
-Referenced by Server::GetUsers(). +Referenced by Server::GetUsers().
@@ -506,7 +506,7 @@ Referenced by Server::GetUs
| FILE* log_file + | FILE* log_file |
| int LogLevel + | int LogLevel |
| int MaxWhoResults + | int MaxWhoResults |
-Definition at line 1016 of file modules.cpp. +Definition at line 1019 of file modules.cpp.
-Referenced by Server::FindModule(). +Referenced by Server::FindModule().
@@ -630,7 +630,7 @@ Referenced by Server::FindM
| std::vector<std::string> module_names + | std::vector<std::string> module_names |
Definition at line 86 of file channels.cpp.
-Referenced by Server::FindModule(). +Referenced by Server::FindModule().
@@ -673,7 +673,7 @@ Referenced by Server::FindM
Definition at line 59 of file channels.cpp.
-Referenced by Server::FindModule().
+Referenced by Server::FindModule().
@@ -682,7 +682,7 @@ Referenced by Server::FindM
| char motd[MAXBUF] + | char motd[MAXBUF] |
| time_t nb_start + | time_t nb_start |
| int NetBufferSize + | int NetBufferSize |
| char Network[MAXBUF] + | char Network[MAXBUF] |
| int portCount + | int portCount |
| int ports[MAXSOCKS] + | int ports[MAXSOCKS] |
| char PrefixQuit[MAXBUF] + | char PrefixQuit[MAXBUF] |
| char restartpass[MAXBUF] + | char restartpass[MAXBUF] |
| char rules[MAXBUF] + | char rules[MAXBUF] |
| char ServerDesc[MAXBUF] + | char ServerDesc[MAXBUF] |
| char ServerName[MAXBUF] + | char ServerName[MAXBUF] |
-Definition at line 63 of file channels.cpp. +Definition at line 63 of file channels.cpp. +
+Referenced by userrec::userrec().
@@ -946,7 +948,7 @@ Definition at line 63
| int SERVERportCount + | int SERVERportCount |
| time_t startup_time + | time_t startup_time |
| time_t TIME + | time_t TIME |
Definition at line 101 of file channels.cpp.
-Referenced by serverrec::FlushWriteBuffers(), serverrec::serverrec(), and userrec::userrec(). +Referenced by serverrec::FlushWriteBuffers(), serverrec::serverrec(), and userrec::userrec().
@@ -1020,7 +1022,7 @@ Referenced by serverrec::Fl
| int WHOWAS_MAX + | int WHOWAS_MAX |
| int WHOWAS_STALE + | int WHOWAS_STALE |
1.3.3
diff --git a/docs/module-doc/channels_8cpp__incl.gif b/docs/module-doc/channels_8cpp__incl.gif
index 73931eed5..34da8c3ad 100644
Binary files a/docs/module-doc/channels_8cpp__incl.gif and b/docs/module-doc/channels_8cpp__incl.gif differ
diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html
index 155b638f8..ed610b7f6 100644
--- a/docs/module-doc/channels_8h-source.html
+++ b/docs/module-doc/channels_8h-source.html
@@ -146,7 +146,7 @@
00257
00258 #endif
00259
-
1.3.3
diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html
index ab68ff5a9..6ecb753de 100644
--- a/docs/module-doc/channels_8h.html
+++ b/docs/module-doc/channels_8h.html
@@ -433,7 +433,7 @@ Holds a complete invite list.
Definition at line 95 of file channels.h.
-
1.3.3
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html
index 826d1605d..f41a63688 100644
--- a/docs/module-doc/classAdmin-members.html
+++ b/docs/module-doc/classAdmin-members.html
@@ -13,7 +13,7 @@
[inline]
1.3.3
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html
index 462bd13e0..e8c844063 100644
--- a/docs/module-doc/classAdmin.html
+++ b/docs/module-doc/classAdmin.html
@@ -82,9 +82,9 @@ Definition at line 123 of
-Definition at line 247 of file modules.cpp. +Definition at line 249 of file modules.cpp.
-
00247 : Name(name), Email(email), Nick(nick) { }; + @@ -163,7 +163,7 @@ Definition at line 126 of-
The documentation for this class was generated from the following files:
1.3.3
diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html
index 7b99d4f01..8a0df5530 100644
--- a/docs/module-doc/classBanItem-members.html
+++ b/docs/module-doc/classBanItem-members.html
@@ -14,7 +14,7 @@
[inline] [inline, virtual]
1.3.3
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html
index 9cd0b9efe..96853c0d3 100644
--- a/docs/module-doc/classBanItem.html
+++ b/docs/module-doc/classBanItem.html
@@ -30,7 +30,7 @@ A subclass of HostItem designed to h
Definition at line 52 of file channels.h.
1.3.3
diff --git a/docs/module-doc/classBoolSet-members.html b/docs/module-doc/classBoolSet-members.html
new file mode 100644
index 000000000..1a61e76c7
--- /dev/null
+++ b/docs/module-doc/classBoolSet-members.html
@@ -0,0 +1,25 @@
+
+
+| bits | BoolSet | [private] |
| BoolSet() | BoolSet | |
| BoolSet(char bitmask) | BoolSet | |
| Get(int number) | BoolSet | |
| Invert(int number) | BoolSet | |
| operator &(BoolSet other) | BoolSet | |
| operator=(BoolSet other) | BoolSet | |
| operator==(BoolSet other) | BoolSet | |
| operator|(BoolSet other) | BoolSet | |
| Set(int number) | BoolSet | |
| Unset(int number) | BoolSet |
+1.3.3
+
+
diff --git a/docs/module-doc/classBoolSet.html b/docs/module-doc/classBoolSet.html
new file mode 100644
index 000000000..bf356dabe
--- /dev/null
+++ b/docs/module-doc/classBoolSet.html
@@ -0,0 +1,422 @@
+
+
+
+#include <base.h>
+
+Collaboration diagram for BoolSet:

Public Member Functions | |
| BoolSet () | |
| The default constructor initializes the BoolSet to all values unset. | |
| BoolSet (char bitmask) | |
| This constructor copies the default bitmask from a char. | |
| void | Set (int number) |
| The Set method sets one bool in the set. | |
| bool | Get (int number) |
| The Get method returns the value of one bool in the set. | |
| void | Unset (int number) |
| The Unset method unsets one value in the set. | |
| void | Invert (int number) |
| The Unset method inverts (flips) one value in the set. | |
| bool | operator== (BoolSet other) |
| Compare two BoolSets. | |
| BoolSet | operator| (BoolSet other) |
| OR two BoolSets together. | |
| BoolSet | operator & (BoolSet other) |
| AND two BoolSets together. | |
| bool | operator= (BoolSet other) |
| Assign one BoolSet to another. | |
Private Attributes | |
| char | bits |
+Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask, and Unset and Invert for special operations upon them. +
+ +
+Definition at line 98 of file base.h.
+
+
|
+
| + + | +
+
+ +The default constructor initializes the BoolSet to all values unset. + + |
+
+
+
|
+
| + + | +
+
+ +This constructor copies the default bitmask from a char. + + |
+
+
+
|
+
| + + | +
+
+ +The Get method returns the value of one bool in the set. + +
|
+
+
+
|
+
| + + | +
+
+ +The Unset method inverts (flips) one value in the set. + +
|
+
+
+
|
+
| + + | +
+
+ +AND two BoolSets together. + + |
+
+
+
|
+
| + + | +
+
+ +Assign one BoolSet to another. + + |
+
+
+
|
+
| + + | +
+
+ +Compare two BoolSets. + + |
+
+
+
|
+
| + + | +
+
+ +OR two BoolSets together. + + |
+
+
+
|
+
| + + | +
+
+ +The Set method sets one bool in the set. + +
|
+
+
+
|
+
| + + | +
+
+ +The Unset method unsets one value in the set. + +
|
+
+
+
|
+
| + + | +
+
+ + + |
+
+1.3.3
+
+
diff --git a/docs/module-doc/classBoolSet__coll__graph.gif b/docs/module-doc/classBoolSet__coll__graph.gif
new file mode 100644
index 000000000..044a9d4a5
Binary files /dev/null and b/docs/module-doc/classBoolSet__coll__graph.gif differ
diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html
index c22caeae3..4b1de8e41 100644
--- a/docs/module-doc/classConfigReader-members.html
+++ b/docs/module-doc/classConfigReader-members.html
@@ -24,7 +24,7 @@
[inline]
1.3.3
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html
index afb91f03a..8c0b0a5f1 100644
--- a/docs/module-doc/classConfigReader.html
+++ b/docs/module-doc/classConfigReader.html
@@ -103,17 +103,18 @@ Default constructor.
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
-Definition at line 819 of file modules.cpp. -
-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. -
-
00820 {
-00821 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00822 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00823 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00824 if (!this->readerror)
-00825 this->error = CONF_FILE_NOT_FOUND;
-00826 }
+Definition at line 821 of file modules.cpp.
+
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
+
+
00822 {
+00823 include_stack.clear();
+00824 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00825 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00826 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00827 if (!this->readerror)
+00828 this->error = CONF_FILE_NOT_FOUND;
+00829 }
@@ -147,17 +148,17 @@ Overloaded constructor.
This constructor initialises the ConfigReader class to read a user-specified config file
-Definition at line 838 of file modules.cpp.
+Definition at line 841 of file modules.cpp.
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
-
00839 {
-00840 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00841 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00842 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00843 if (!this->readerror)
-00844 this->error = CONF_FILE_NOT_FOUND;
-00845 };
+00842 {
+00843 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00844 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00845 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00846 if (!this->readerror)
+00847 this->error = CONF_FILE_NOT_FOUND;
+00848 };
@@ -190,16 +191,16 @@ Default destructor.
This method destroys the ConfigReader class.
-Definition at line 829 of file modules.cpp.
+Definition at line 832 of file modules.cpp.
References cache, and errorlog.
-
00830 {
-00831 if (this->cache)
-00832 delete this->cache;
-00833 if (this->errorlog)
-00834 delete this->errorlog;
-00835 }
+00833 {
+00834 if (this->cache)
+00835 delete this->cache;
+00836 if (this->errorlog)
+00837 delete this->errorlog;
+00838 }
@@ -243,40 +244,40 @@ Dumps the list of errors in a config file to an output location.
If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.
-Definition at line 916 of file modules.cpp.
+Definition at line 919 of file modules.cpp.
References errorlog, connection::fd, and userrec::nick.
-
00917 {
-00918 if (bail)
-00919 {
-00920 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00921 exit(0);
-00922 }
-00923 else
-00924 {
-00925 char dataline[1024];
-00926 if (user)
-00927 {
-00928 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00929 while (!errorlog->eof())
-00930 {
-00931 errorlog->getline(dataline,1024);
-00932 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00933 }
-00934 }
-00935 else
-00936 {
-00937 WriteOpers("There were errors in the configuration file:",user->nick);
-00938 while (!errorlog->eof())
-00939 {
-00940 errorlog->getline(dataline,1024);
-00941 WriteOpers(dataline);
-00942 }
-00943 }
-00944 return;
-00945 }
-00946 }
+00920 {
+00921 if (bail)
+00922 {
+00923 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00924 exit(0);
+00925 }
+00926 else
+00927 {
+00928 char dataline[1024];
+00929 if (user)
+00930 {
+00931 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00932 while (!errorlog->eof())
+00933 {
+00934 errorlog->getline(dataline,1024);
+00935 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00936 }
+00937 }
+00938 else
+00939 {
+00940 WriteOpers("There were errors in the configuration file:",user->nick);
+00941 while (!errorlog->eof())
+00942 {
+00943 errorlog->getline(dataline,1024);
+00944 WriteOpers(dataline);
+00945 }
+00946 }
+00947 return;
+00948 }
+00949 }
@@ -310,13 +311,13 @@ Counts the number of times a given tag appears in the config file.
This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.
-Definition at line 949 of file modules.cpp.
+Definition at line 952 of file modules.cpp.
References cache.
-
00950 {
-00951 return EnumConf(cache,tag.c_str());
-00952 }
+00953 {
+00954 return EnumConf(cache,tag.c_str());
+00955 }
@@ -359,13 +360,13 @@ Returns the number of items within a tag.
For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
-Definition at line 954 of file modules.cpp.
+Definition at line 957 of file modules.cpp.
References cache.
-
00955 {
-00956 return EnumValues(cache, tag.c_str(), index);
-00957 }
+00958 {
+00959 return EnumValues(cache, tag.c_str(), index);
+00960 }
@@ -398,15 +399,15 @@ Returns the last error to occur.
Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.
-Definition at line 909 of file modules.cpp.
+Definition at line 912 of file modules.cpp.
References error.
-
00910 {
-00911 long olderr = this->error;
-00912 this->error = 0;
-00913 return olderr;
-00914 }
+00913 {
+00914 long olderr = this->error;
+00915 this->error = 0;
+00916 return olderr;
+00917 }
@@ -455,25 +456,25 @@ Retrieves a boolean value from the config file.
This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" and "true" in the config file count as true to ReadFlag, and any other value counts as false.
-Definition at line 863 of file modules.cpp.
+Definition at line 866 of file modules.cpp.
References cache, CONF_VALUE_NOT_FOUND, and error.
-
00864 {
-00865 char val[MAXBUF];
-00866 char t[MAXBUF];
-00867 char n[MAXBUF];
-00868 strlcpy(t,tag.c_str(),MAXBUF);
-00869 strlcpy(n,name.c_str(),MAXBUF);
-00870 int res = ReadConf(cache,t,n,index,val);
-00871 if (!res)
-00872 {
-00873 this->error = CONF_VALUE_NOT_FOUND;
-00874 return false;
-00875 }
-00876 std::string s = val;
-00877 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00878 }
+00867 {
+00868 char val[MAXBUF];
+00869 char t[MAXBUF];
+00870 char n[MAXBUF];
+00871 strlcpy(t,tag.c_str(),MAXBUF);
+00872 strlcpy(n,name.c_str(),MAXBUF);
+00873 int res = ReadConf(cache,t,n,index,val);
+00874 if (!res)
+00875 {
+00876 this->error = CONF_VALUE_NOT_FOUND;
+00877 return false;
+00878 }
+00879 std::string s = val;
+00880 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00881 }
@@ -528,37 +529,37 @@ Retrieves an integer value from the config file.
This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED
-Definition at line 880 of file modules.cpp.
+Definition at line 883 of file modules.cpp.
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
-
00881 {
-00882 char val[MAXBUF];
-00883 char t[MAXBUF];
-00884 char n[MAXBUF];
-00885 strlcpy(t,tag.c_str(),MAXBUF);
-00886 strlcpy(n,name.c_str(),MAXBUF);
-00887 int res = ReadConf(cache,t,n,index,val);
-00888 if (!res)
-00889 {
-00890 this->error = CONF_VALUE_NOT_FOUND;
-00891 return 0;
-00892 }
-00893 for (int i = 0; i < strlen(val); i++)
-00894 {
-00895 if (!isdigit(val[i]))
-00896 {
-00897 this->error = CONF_NOT_A_NUMBER;
-00898 return 0;
-00899 }
-00900 }
-00901 if ((needs_unsigned) && (atoi(val)<0))
-00902 {
-00903 this->error = CONF_NOT_UNSIGNED;
-00904 return 0;
-00905 }
-00906 return atoi(val);
-00907 }
+00884 {
+00885 char val[MAXBUF];
+00886 char t[MAXBUF];
+00887 char n[MAXBUF];
+00888 strlcpy(t,tag.c_str(),MAXBUF);
+00889 strlcpy(n,name.c_str(),MAXBUF);
+00890 int res = ReadConf(cache,t,n,index,val);
+00891 if (!res)
+00892 {
+00893 this->error = CONF_VALUE_NOT_FOUND;
+00894 return 0;
+00895 }
+00896 for (int i = 0; i < strlen(val); i++)
+00897 {
+00898 if (!isdigit(val[i]))
+00899 {
+00900 this->error = CONF_NOT_A_NUMBER;
+00901 return 0;
+00902 }
+00903 }
+00904 if ((needs_unsigned) && (atoi(val)<0))
+00905 {
+00906 this->error = CONF_NOT_UNSIGNED;
+00907 return 0;
+00908 }
+00909 return atoi(val);
+00910 }
@@ -607,24 +608,24 @@ Retrieves a value from the config file.
This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
-Definition at line 847 of file modules.cpp.
+Definition at line 850 of file modules.cpp.
References cache, CONF_VALUE_NOT_FOUND, and error.
-
00848 {
-00849 char val[MAXBUF];
-00850 char t[MAXBUF];
-00851 char n[MAXBUF];
-00852 strlcpy(t,tag.c_str(),MAXBUF);
-00853 strlcpy(n,name.c_str(),MAXBUF);
-00854 int res = ReadConf(cache,t,n,index,val);
-00855 if (!res)
-00856 {
-00857 this->error = CONF_VALUE_NOT_FOUND;
-00858 return "";
-00859 }
-00860 return val;
-00861 }
+00851 {
+00852 char val[MAXBUF];
+00853 char t[MAXBUF];
+00854 char n[MAXBUF];
+00855 strlcpy(t,tag.c_str(),MAXBUF);
+00856 strlcpy(n,name.c_str(),MAXBUF);
+00857 int res = ReadConf(cache,t,n,index,val);
+00858 if (!res)
+00859 {
+00860 this->error = CONF_VALUE_NOT_FOUND;
+00861 return "";
+00862 }
+00863 return val;
+00864 }
@@ -657,13 +658,13 @@ Returns true if a config file is valid.
This method is partially implemented and will only return false if the config file does not exist or could not be opened.
-Definition at line 959 of file modules.cpp.
+Definition at line 962 of file modules.cpp.
References readerror.
-
00960 {
-00961 return this->readerror;
-00962 }
+00963 {
+00964 return this->readerror;
+00965 }
@@ -693,7 +694,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc
Definition at line 1158 of file modules.h.
-Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
+Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
@@ -719,7 +720,7 @@ Referenced by ConfigReader(
Definition at line 1163 of file modules.h.
-Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
+Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
@@ -745,7 +746,7 @@ Referenced by ConfigReader(
Definition at line 1159 of file modules.h.
-Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
+Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
@@ -773,12 +774,12 @@ Used to store errors.
Definition at line 1162 of file modules.h.
-Referenced by ConfigReader(), and Verify().
+Referenced by ConfigReader(), and Verify().
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 22:02:53 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:42 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html
index a1be28204..c47a70089 100644
--- a/docs/module-doc/classConnectClass-members.html
+++ b/docs/module-doc/classConnectClass-members.html
@@ -19,7 +19,7 @@
threshold ConnectClass
type ConnectClass
~classbase() classbase [inline]
-
Generated on Wed May 25 22:02:54 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:44 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html
index 02f3ef51e..a429cb11e 100644
--- a/docs/module-doc/classConnectClass.html
+++ b/docs/module-doc/classConnectClass.html
@@ -355,7 +355,7 @@ Definition at line 50 of fi
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:02:54 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:44 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classDNS-members.html b/docs/module-doc/classDNS-members.html
index 5856f173e..7aa9cc2ab 100644
--- a/docs/module-doc/classDNS-members.html
+++ b/docs/module-doc/classDNS-members.html
@@ -33,7 +33,7 @@
SetNS(std::string dnsserver) DNS
t DNS [private]
~DNS() DNS
-
Generated on Wed May 25 22:02:57 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:48 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classDNS.html b/docs/module-doc/classDNS.html
index 91124de7c..13a0af42f 100644
--- a/docs/module-doc/classDNS.html
+++ b/docs/module-doc/classDNS.html
@@ -891,7 +891,7 @@ Definition at line 40 of file
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:02:57 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:48 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classELine-members.html b/docs/module-doc/classELine-members.html
index f52473cc2..2599c52ed 100644
--- a/docs/module-doc/classELine-members.html
+++ b/docs/module-doc/classELine-members.html
@@ -15,7 +15,7 @@
set_time XLine
source XLine
~classbase() classbase [inline]
-
Generated on Wed May 25 22:02:59 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:50 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classELine.html b/docs/module-doc/classELine.html
index 0b8153222..9d654b0fa 100644
--- a/docs/module-doc/classELine.html
+++ b/docs/module-doc/classELine.html
@@ -53,7 +53,7 @@ Definition at line 88 of fi
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:02:59 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:50 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classEvent-members.html b/docs/module-doc/classEvent-members.html
index 5def1e1b8..048949ae5 100644
--- a/docs/module-doc/classEvent-members.html
+++ b/docs/module-doc/classEvent-members.html
@@ -17,7 +17,7 @@
Send() Event [virtual]
source Event [protected]
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:00 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:52 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classEvent.html b/docs/module-doc/classEvent.html
index 79eb1d117..f16ad64ed 100644
--- a/docs/module-doc/classEvent.html
+++ b/docs/module-doc/classEvent.html
@@ -103,9 +103,9 @@ Create a new Event.
-Definition at line 278 of file modules.cpp.
+Definition at line 280 of file modules.cpp.
-
00278 : data(anydata), source(src), id(eventid) { };
+
@@ -139,13 +139,13 @@ Get the Event data.
-Definition at line 280 of file modules.cpp.
+Definition at line 282 of file modules.cpp.
References data.
-
00281 {
-00282 return this->data;
-00283 }
+00283 {
+00284 return this->data;
+00285 }
@@ -178,13 +178,13 @@ Get the event ID.
Use this to determine the event type for safe casting of the data
-Definition at line 296 of file modules.cpp.
+Definition at line 298 of file modules.cpp.
References id.
-
00297 {
-00298 return this->id;
-00299 }
+00299 {
+00300 return this->id;
+00301 }
@@ -217,13 +217,13 @@ Get the event Source.
-Definition at line 285 of file modules.cpp.
+Definition at line 287 of file modules.cpp.
References source.
-
00286 {
-00287 return this->source;
-00288 }
+00288 {
+00289 return this->source;
+00290 }
@@ -258,14 +258,14 @@ The return result of an Event::Send()
Implements ModuleMessage.
-Definition at line 290 of file modules.cpp.
+Definition at line 292 of file modules.cpp.
References FOREACH_MOD.
-
00291 {
-00292 FOREACH_MOD OnEvent(this);
-00293 return NULL;
-00294 }
+00293 {
+00294 FOREACH_MOD OnEvent(this);
+00295 return NULL;
+00296 }
@@ -295,7 +295,7 @@ This member holds a pointer to arbitary data set by the emitter of the message.
Definition at line 199 of file modules.h.
-Referenced by GetData().
+Referenced by GetData().
@@ -323,7 +323,7 @@ This is arbitary text which should be used to distinguish one type of event from
Definition at line 208 of file modules.h.
-Referenced by GetEventID().
+Referenced by GetEventID().
@@ -351,12 +351,12 @@ This is a pointer to the sender of the message, which can be used to directly tr
Definition at line 203 of file modules.h.
-Referenced by GetSource().
+Referenced by GetSource().
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 22:03:00 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:52 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html
index 39d97f34b..5e573def7 100644
--- a/docs/module-doc/classExemptItem-members.html
+++ b/docs/module-doc/classExemptItem-members.html
@@ -14,7 +14,7 @@
set_time HostItem
~classbase() classbase [inline]
~HostItem() HostItem [inline, virtual]
-
Generated on Wed May 25 22:03:01 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:54 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html
index d9347f45d..d5c04bee2 100644
--- a/docs/module-doc/classExemptItem.html
+++ b/docs/module-doc/classExemptItem.html
@@ -30,7 +30,7 @@ A subclass of HostItem designed to h
Definition at line 60 of file channels.h.
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:01 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:54 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classExtMode-members.html b/docs/module-doc/classExtMode-members.html
index 20dbe8f53..5b0dae396 100644
--- a/docs/module-doc/classExtMode-members.html
+++ b/docs/module-doc/classExtMode-members.html
@@ -16,7 +16,7 @@
params_when_on ExtMode
type ExtMode
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:03 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:58 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classExtMode.html b/docs/module-doc/classExtMode.html
index c76a78bb2..07e1602c6 100644
--- a/docs/module-doc/classExtMode.html
+++ b/docs/module-doc/classExtMode.html
@@ -88,11 +88,11 @@
-Definition at line 145 of file modules.cpp.
+Definition at line 147 of file modules.cpp.
-References modechar, needsoper, params_when_off, params_when_on, and type.
+References modechar, needsoper, params_when_off, params_when_on, and type.
-
00145 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
+00147 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
@@ -118,7 +118,7 @@ References modechar,
-Definition at line 144 of file modules.cpp.
+Definition at line 146 of file modules.cpp.
@@ -142,9 +142,9 @@ Definition at line 144
-Definition at line 139 of file modules.cpp.
+Definition at line 141 of file modules.cpp.
-Referenced by ExtMode().
+Referenced by ExtMode().
@@ -168,9 +168,9 @@ Referenced by ExtMode()
-Definition at line 143 of file modules.cpp.
+Definition at line 145 of file modules.cpp.
-Referenced by ExtMode().
+Referenced by ExtMode().
@@ -194,9 +194,9 @@ Referenced by ExtMode()
-Definition at line 142 of file modules.cpp.
+Definition at line 144 of file modules.cpp.
-Referenced by ExtMode().
+Referenced by ExtMode().
@@ -220,9 +220,9 @@ Referenced by ExtMode()
-Definition at line 141 of file modules.cpp.
+Definition at line 143 of file modules.cpp.
-Referenced by ExtMode().
+Referenced by ExtMode().
@@ -246,14 +246,14 @@ Referenced by ExtMode()
-Definition at line 140 of file modules.cpp.
+Definition at line 142 of file modules.cpp.
-Referenced by ExtMode().
+Referenced by ExtMode().
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:03 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:58 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classExtensible-members.html b/docs/module-doc/classExtensible-members.html
index e7a18bf0e..35c799bd6 100644
--- a/docs/module-doc/classExtensible-members.html
+++ b/docs/module-doc/classExtensible-members.html
@@ -13,7 +13,7 @@
GetExt(std::string key) Extensible
Shrink(std::string key) Extensible
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:02 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:57 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html
index c570da923..516f0bf3a 100644
--- a/docs/module-doc/classExtensible.html
+++ b/docs/module-doc/classExtensible.html
@@ -201,7 +201,7 @@ Definition at line 54 of fil
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:02 2005 for InspIRCd by
+
Generated on Mon May 30 05:16:57 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classFileReader-members.html b/docs/module-doc/classFileReader-members.html
index 82c1fd1ac..377da9995 100644
--- a/docs/module-doc/classFileReader-members.html
+++ b/docs/module-doc/classFileReader-members.html
@@ -17,7 +17,7 @@
LoadFile(std::string filename) FileReader
~classbase() classbase [inline]
~FileReader() FileReader
-
Generated on Wed May 25 22:03:05 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:01 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html
index 6637ee208..3e69fe2d0 100644
--- a/docs/module-doc/classFileReader.html
+++ b/docs/module-doc/classFileReader.html
@@ -83,10 +83,10 @@ Default constructor.
This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
-Definition at line 972 of file modules.cpp.
+Definition at line 975 of file modules.cpp.
-
00973 {
-00974 }
+00976 {
+00977 }
@@ -120,15 +120,15 @@ Secondary constructor.
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.
-Definition at line 965 of file modules.cpp.
+Definition at line 968 of file modules.cpp.
References fc, and file_cache.
-
00966 {
-00967 file_cache c;
-00968 readfile(c,filename.c_str());
-00969 this->fc = c;
-00970 }
+00969 {
+00970 file_cache c;
+00971 readfile(c,filename.c_str());
+00972 this->fc = c;
+00973 }
@@ -161,10 +161,10 @@ Default destructor.
This deletes the memory allocated to the file.
-Definition at line 984 of file modules.cpp.
+Definition at line 987 of file modules.cpp.
-
00985 {
-00986 }
+00988 {
+00989 }
@@ -198,20 +198,20 @@ Returns true if the file exists This function will return false if the file coul
-Definition at line 988 of file modules.cpp.
+Definition at line 991 of file modules.cpp.
References fc.
-
00989 {
-00990 if (fc.size() == 0)
-00991 {
-00992 return(false);
-00993 }
-00994 else
-00995 {
-00996 return(true);
-00997 }
-00998 }
+00992 {
+00993 if (fc.size() == 0)
+00994 {
+00995 return(false);
+00996 }
+00997 else
+00998 {
+00999 return(true);
+01000 }
+01001 }
@@ -244,13 +244,13 @@ 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.
-Definition at line 1007 of file modules.cpp.
+Definition at line 1010 of file modules.cpp.
References fc.
-
01008 {
-01009 return fc.size();
-01010 }
+01011 {
+01012 return fc.size();
+01013 }
@@ -284,15 +284,15 @@ 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.
-Definition at line 1000 of file modules.cpp.
+Definition at line 1003 of file modules.cpp.
References fc.
-
01001 {
-01002 if ((x<0) || (x>fc.size()))
-01003 return "";
-01004 return fc[x];
-01005 }
+
@@ -326,15 +326,15 @@ Used to load a file.
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.
-Definition at line 976 of file modules.cpp.
+Definition at line 979 of file modules.cpp.
References fc, and file_cache.
-
00977 {
-00978 file_cache c;
-00979 readfile(c,filename.c_str());
-00980 this->fc = c;
-00981 }
+00980 {
+00981 file_cache c;
+00982 readfile(c,filename.c_str());
+00983 this->fc = c;
+00984 }
@@ -362,12 +362,12 @@ References fc, and
Definition at line 1241 of file modules.h.
-Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().
+Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 22:03:05 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:01 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classGLine-members.html b/docs/module-doc/classGLine-members.html
index 70b191605..2a6dc8ca5 100644
--- a/docs/module-doc/classGLine-members.html
+++ b/docs/module-doc/classGLine-members.html
@@ -15,7 +15,7 @@
set_time XLine
source XLine
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:06 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:03 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classGLine.html b/docs/module-doc/classGLine.html
index a64fb3739..2fc15a0bd 100644
--- a/docs/module-doc/classGLine.html
+++ b/docs/module-doc/classGLine.html
@@ -61,7 +61,7 @@ Definition at line 79 of fi
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:06 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:03 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classHostItem-members.html b/docs/module-doc/classHostItem-members.html
index 54654ce72..dcf02f5bd 100644
--- a/docs/module-doc/classHostItem-members.html
+++ b/docs/module-doc/classHostItem-members.html
@@ -14,7 +14,7 @@
set_time HostItem
~classbase() classbase [inline]
~HostItem() HostItem [inline, virtual]
-
Generated on Wed May 25 22:03:07 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:07 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classHostItem.html b/docs/module-doc/classHostItem.html
index a55562d50..61c4ee368 100644
--- a/docs/module-doc/classHostItem.html
+++ b/docs/module-doc/classHostItem.html
@@ -185,7 +185,7 @@ Definition at line 39 of
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:07 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:07 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classInviteItem-members.html b/docs/module-doc/classInviteItem-members.html
index 508ac308c..5a11ce16f 100644
--- a/docs/module-doc/classInviteItem-members.html
+++ b/docs/module-doc/classInviteItem-members.html
@@ -14,7 +14,7 @@
set_time HostItem
~classbase() classbase [inline]
~HostItem() HostItem [inline, virtual]
-
Generated on Wed May 25 22:03:09 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:12 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classInviteItem.html b/docs/module-doc/classInviteItem.html
index 0238cd82a..36fbb00c2 100644
--- a/docs/module-doc/classInviteItem.html
+++ b/docs/module-doc/classInviteItem.html
@@ -30,7 +30,7 @@ A subclass of HostItem designed to h
Definition at line 68 of file channels.h.
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:09 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:12 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classInvited-members.html b/docs/module-doc/classInvited-members.html
index 786935711..c392fc408 100644
--- a/docs/module-doc/classInvited-members.html
+++ b/docs/module-doc/classInvited-members.html
@@ -10,7 +10,7 @@
channel Invited
classbase() classbase [inline]
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:08 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:09 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classInvited.html b/docs/module-doc/classInvited.html
index daaa94bfe..eebe80fee 100644
--- a/docs/module-doc/classInvited.html
+++ b/docs/module-doc/classInvited.html
@@ -53,12 +53,12 @@ Definition at line 36 of fi
Definition at line 39 of file users.h.
-Referenced by userrec::InviteTo().
+Referenced by userrec::InviteTo().
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:08 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:09 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classKLine-members.html b/docs/module-doc/classKLine-members.html
index 073f87710..9d056eff9 100644
--- a/docs/module-doc/classKLine-members.html
+++ b/docs/module-doc/classKLine-members.html
@@ -15,7 +15,7 @@
set_time XLine
source XLine
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:13 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:20 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classKLine.html b/docs/module-doc/classKLine.html
index 6be07650b..88b799a87 100644
--- a/docs/module-doc/classKLine.html
+++ b/docs/module-doc/classKLine.html
@@ -61,7 +61,7 @@ Definition at line 68 of fi
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:13 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:20 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModeParameter-members.html b/docs/module-doc/classModeParameter-members.html
index c19dd9faa..41ce56aed 100644
--- a/docs/module-doc/classModeParameter-members.html
+++ b/docs/module-doc/classModeParameter-members.html
@@ -12,7 +12,7 @@
mode ModeParameter
parameter ModeParameter
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:14 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:21 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModeParameter.html b/docs/module-doc/classModeParameter.html
index f53c70d11..94e160da6 100644
--- a/docs/module-doc/classModeParameter.html
+++ b/docs/module-doc/classModeParameter.html
@@ -116,7 +116,7 @@ Referenced by chanrec::Set
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:14 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:21 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModule-members.html b/docs/module-doc/classModule-members.html
index 79bf18918..05928e607 100644
--- a/docs/module-doc/classModule-members.html
+++ b/docs/module-doc/classModule-members.html
@@ -65,7 +65,7 @@
OnWhois(userrec *source, userrec *dest) Module [virtual]
~classbase() classbase [inline]
~Module() Module [virtual]
-
Generated on Wed May 25 22:03:16 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:24 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html
index 25df9c3b6..4c034d0d2 100644
--- a/docs/module-doc/classModule.html
+++ b/docs/module-doc/classModule.html
@@ -227,9 +227,9 @@ Default constructor creates a module class.
-Definition at line 303 of file modules.cpp.
+Definition at line 305 of file modules.cpp.
-
00303 { }
+00305 { }
@@ -262,9 +262,9 @@ Default destructor destroys a module class.
-Definition at line 304 of file modules.cpp.
+Definition at line 306 of file modules.cpp.
-
00304 { }
+00306 { }
@@ -298,11 +298,11 @@ Returns the version number of a Module.
The method should return a Version object with its version information assigned via Version::Version
-Definition at line 316 of file modules.cpp.
+Definition at line 318 of file modules.cpp.
References VF_VENDOR.
-
00316 { return Version(1,0,0,0,VF_VENDOR); }
+00318 { return Version(1,0,0,0,VF_VENDOR); }
@@ -336,9 +336,9 @@ Called when a 005 numeric is about to be output.
The module should modify the 005 numeric if needed to indicate its features.
-Definition at line 328 of file modules.cpp.
+Definition at line 330 of file modules.cpp.
-
00328 { };
+00330 { };
@@ -405,11 +405,11 @@ 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).
-Definition at line 325 of file modules.cpp.
+Definition at line 327 of file modules.cpp.
References ACR_DEFAULT.
-
00325 { return ACR_DEFAULT; };
+00327 { return ACR_DEFAULT; };
@@ -458,9 +458,9 @@ Called whenever a ban is added to a channel's list.
Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
-Definition at line 353 of file modules.cpp.
+Definition at line 355 of file modules.cpp.
-
00353 { return 0; };
+00355 { return 0; };
@@ -494,9 +494,9 @@ Called once every five seconds for background processing.
This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.
-Definition at line 331 of file modules.cpp.
+Definition at line 333 of file modules.cpp.
-
00331 { };
+00333 { };
@@ -539,9 +539,9 @@ Called whenever a change of a local users GECOS (fullname field) is attempted.
return 1 to deny the name change, or 0 to allow it.
-Definition at line 345 of file modules.cpp.
+Definition at line 347 of file modules.cpp.
-
00345 { return 0; };
+00347 { return 0; };
@@ -584,9 +584,9 @@ Called whenever a change of a local users displayed host is attempted.
Return 1 to deny the host change, or 0 to allow it.
-Definition at line 344 of file modules.cpp.
+Definition at line 346 of file modules.cpp.
-
00344 { return 0; };
+00346 { return 0; };
@@ -620,11 +620,11 @@ 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.
-Definition at line 327 of file modules.cpp.
+Definition at line 329 of file modules.cpp.
References string_list.
-
00327 { string_list empty; return empty; }
+00329 { string_list empty; return empty; }
@@ -667,9 +667,9 @@ Called whenever a user joins a channel, to determine if banlist checks should go
This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
-Definition at line 342 of file modules.cpp.
+Definition at line 344 of file modules.cpp.
-
00342 { return 0; };
+00344 { return 0; };
@@ -712,9 +712,9 @@ Called whenever a user joins a channel, to determine if invite checks should go
This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
-Definition at line 339 of file modules.cpp.
+Definition at line 341 of file modules.cpp.
-
00339 { return 0; };
+00341 { return 0; };
@@ -763,9 +763,9 @@ Called whenever a user joins a channel, to determine if key checks should go ahe
This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
-Definition at line 340 of file modules.cpp.
+Definition at line 342 of file modules.cpp.
-
00340 { return 0; };
+00342 { return 0; };
@@ -808,9 +808,9 @@ Called whenever a user joins a channel, to determine if channel limit checks sho
This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
-Definition at line 341 of file modules.cpp.
+Definition at line 343 of file modules.cpp.
-
00341 { return 0; };
+00343 { return 0; };
@@ -844,9 +844,9 @@ Called to check if a user who is connecting can now be allowed to register If an
For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.
-Definition at line 334 of file modules.cpp.
+Definition at line 336 of file modules.cpp.
-
00334 { return true; };
+00336 { return true; };
@@ -895,9 +895,9 @@ Called whenever a ban is removed from a channel's list.
Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
-Definition at line 354 of file modules.cpp.
+Definition at line 356 of file modules.cpp.
-
00354 { return 0; };
+00356 { return 0; };
@@ -931,9 +931,9 @@ Called whenever an Event class is sent
Please see the documentation of Event::Send() for further information. The Event sent can always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID() before doing anything to the event data, and you should *not* change the event data in any way!
-Definition at line 348 of file modules.cpp.
+Definition at line 350 of file modules.cpp.
-
00348 { return; };
+00350 { return; };
@@ -1000,9 +1000,9 @@ 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.
-Definition at line 315 of file modules.cpp.
+Definition at line 317 of file modules.cpp.
-
00315 { return false; }
+00317 { return false; }
@@ -1036,9 +1036,9 @@ Called whenever a user connects, anywhere on the network.
This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.
-Definition at line 352 of file modules.cpp.
+Definition at line 354 of file modules.cpp.
-
00352 { };
+00354 { };
@@ -1072,9 +1072,9 @@ Called whenever a user is given usermode +o, anywhere on the network.
You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.
-Definition at line 351 of file modules.cpp.
+Definition at line 353 of file modules.cpp.
-
00351 { };
+00353 { };
@@ -1109,9 +1109,9 @@ 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:
<nick> :information here
-Definition at line 318 of file modules.cpp.
+Definition at line 320 of file modules.cpp.
-
00318 { };
+00320 { };
@@ -1160,9 +1160,9 @@ Called when a client is disconnected by KILL.
If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!
-Definition at line 329 of file modules.cpp.
+Definition at line 331 of file modules.cpp.
-
00329 { return 0; };
+00331 { return 0; };
@@ -1205,9 +1205,9 @@ Called whenever a module is loaded.
mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).
-Definition at line 330 of file modules.cpp.
+Definition at line 332 of file modules.cpp.
-
00330 { };
+00332 { };
@@ -1256,9 +1256,9 @@ Called whenever a topic is changed by a local user.
Return 1 to deny the topic change, or 0 to allow it.
-Definition at line 346 of file modules.cpp.
+Definition at line 348 of file modules.cpp.
-
00346 { return 0; };
+00348 { return 0; };
@@ -1331,9 +1331,9 @@ Called whenever an unknown token is received in a server to server link.
The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using.
-Definition at line 347 of file modules.cpp.
+Definition at line 349 of file modules.cpp.
-
00347 { return 0; };
+00349 { return 0; };
@@ -1367,9 +1367,9 @@ Called whenever a user opers locally.
The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.
-Definition at line 317 of file modules.cpp.
+Definition at line 319 of file modules.cpp.
-
00317 { };
+00319 { };
@@ -1412,9 +1412,9 @@ Called whenever an oper password is to be compared to what a user has input.
The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.
-Definition at line 350 of file modules.cpp.
+Definition at line 352 of file modules.cpp.
-
00350 { return 0; };
+00352 { return 0; };
@@ -1457,9 +1457,9 @@ Called after a packet is received from another irc server.
This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.
-Definition at line 311 of file modules.cpp.
+Definition at line 313 of file modules.cpp.
-
00311 { }
+00313 { }
@@ -1502,9 +1502,9 @@ Called before a packet is transmitted across the irc network between two irc ser
This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.
-Definition at line 310 of file modules.cpp.
+Definition at line 312 of file modules.cpp.
-
00310 { }
+00312 { }
@@ -1559,9 +1559,9 @@ Called whenever any command is about to be executed.
This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using Server::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)
-Definition at line 333 of file modules.cpp.
+Definition at line 335 of file modules.cpp.
-
00333 { return 0; };
+00335 { return 0; };
@@ -1628,9 +1628,9 @@ Called whenever a mode character is processed.
Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!
-Definition at line 338 of file modules.cpp.
+Definition at line 340 of file modules.cpp.
-
00338 { return 0; };
+00340 { return 0; };
@@ -1679,9 +1679,9 @@ Called immediately after any connection is accepted.
This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.
-Definition at line 355 of file modules.cpp.
+Definition at line 357 of file modules.cpp.
-
00355 { };
+00357 { };
@@ -1715,9 +1715,9 @@ Called immediately before any socket is closed.
When this event is called, shutdown() has not yet been called on the socket.
-Definition at line 357 of file modules.cpp.
+Definition at line 359 of file modules.cpp.
-
00357 { };
+00359 { };
@@ -1772,9 +1772,9 @@ Called immediately before any read() operation on a client socket in the core.
This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.
-Definition at line 358 of file modules.cpp.
+Definition at line 360 of file modules.cpp.
-
00358 { return 0; };
+00360 { return 0; };
@@ -1823,9 +1823,9 @@ Called immediately before any write() operation on a user's socket in the core.
Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().
-Definition at line 356 of file modules.cpp.
+Definition at line 358 of file modules.cpp.
-
00356 { return 0; };
+00358 { return 0; };
@@ -1858,9 +1858,9 @@ Called on rehash.
This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.
-Definition at line 312 of file modules.cpp.
+Definition at line 314 of file modules.cpp.
-
00312 { }
+00314 { }
@@ -1894,11 +1894,11 @@ Called whenever a Request class is se
Please see the documentation of Request::Send() for further information. The Request sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
-Definition at line 349 of file modules.cpp.
+Definition at line 351 of file modules.cpp.
-Referenced by Request::Send().
+Referenced by Request::Send().
-
00349 { return NULL; };
+00351 { return NULL; };
@@ -1947,9 +1947,9 @@ Called whenever a list is needed for a listmode.
For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.
-Definition at line 332 of file modules.cpp.
+Definition at line 334 of file modules.cpp.
-
00332 { };
+00334 { };
@@ -1998,9 +1998,9 @@ Called when a raw command is transmitted or received.
This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.
-Definition at line 313 of file modules.cpp.
+Definition at line 315 of file modules.cpp.
-
00313 { }
+00315 { }
@@ -2034,9 +2034,9 @@ Called on all /STATS commands This method is triggered for all /STATS use, inclu
-Definition at line 343 of file modules.cpp.
+Definition at line 345 of file modules.cpp.
-
00343 { };
+00345 { };
@@ -2070,9 +2070,9 @@ Called when a user connects.
The details of the connecting user are available to you in the parameter userrec *user
-Definition at line 305 of file modules.cpp.
+Definition at line 307 of file modules.cpp.
-
00305 { }
+00307 { }
@@ -2106,9 +2106,9 @@ Called whenever a user's socket is closed.
The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.
-Definition at line 307 of file modules.cpp.
+Definition at line 309 of file modules.cpp.
-
00307 { }
+00309 { }
@@ -2151,9 +2151,9 @@ Called when a user joins a channel.
The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel
-Definition at line 308 of file modules.cpp.
+Definition at line 310 of file modules.cpp.
-
00308 { }
+00310 { }
@@ -2208,9 +2208,9 @@ Called whenever a user is kicked.
If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use Module::OnUserPreKick instead of this method.
-Definition at line 337 of file modules.cpp.
+Definition at line 339 of file modules.cpp.
-
00337 { };
+00339 { };
@@ -2253,9 +2253,9 @@ Called when a user parts a channel.
The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel
-Definition at line 309 of file modules.cpp.
+Definition at line 311 of file modules.cpp.
-
00309 { }
+00311 { }
@@ -2298,9 +2298,9 @@ Called after any nickchange, local or remote.
This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this.
-Definition at line 324 of file modules.cpp.
+Definition at line 326 of file modules.cpp.
-
00324 { };
+00326 { };
@@ -2349,9 +2349,9 @@ Called whenever a user is about to invite another user into a channel, before an
Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.
-Definition at line 320 of file modules.cpp.
+Definition at line 322 of file modules.cpp.
-
00320 { return 0; };
+00322 { return 0; };
@@ -2402,9 +2402,9 @@ Returning a value of 1 from this function stops the process immediately, causing
IMPORTANT NOTE!
If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
-Definition at line 314 of file modules.cpp.
+Definition at line 316 of file modules.cpp.
-
00314 { return 0; }
+00316 { return 0; }
@@ -2459,9 +2459,9 @@ Called whenever a user is about to be kicked.
Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc.
-Definition at line 336 of file modules.cpp.
+Definition at line 338 of file modules.cpp.
-
00336 { return 0; };
+00338 { return 0; };
@@ -2516,9 +2516,9 @@ Called whenever a user is about to PRIVMSG A user or a channel, before any proce
Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.
-Definition at line 321 of file modules.cpp.
+Definition at line 323 of file modules.cpp.
-
00321 { return 0; };
+00323 { return 0; };
@@ -2561,9 +2561,9 @@ Called before any nickchange, local or remote.
This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.
-Definition at line 323 of file modules.cpp.
+Definition at line 325 of file modules.cpp.
-
00323 { return 0; };
+00325 { return 0; };
@@ -2618,9 +2618,9 @@ Called whenever a user is about to NOTICE A user or a channel, before any proces
Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.
-Definition at line 322 of file modules.cpp.
+Definition at line 324 of file modules.cpp.
-
00322 { return 0; };
+00324 { return 0; };
@@ -2654,9 +2654,9 @@ Called when a user quits.
The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.
-Definition at line 306 of file modules.cpp.
+Definition at line 308 of file modules.cpp.
-
00306 { }
+00308 { }
@@ -2690,9 +2690,9 @@ Called whenever a user is about to register their connection (e.g.
before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.
-Definition at line 335 of file modules.cpp.
+Definition at line 337 of file modules.cpp.
-
00335 { };
+00337 { };
@@ -2726,11 +2726,11 @@ Called during a netburst to sync user data.
This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.
-Definition at line 326 of file modules.cpp.
+Definition at line 328 of file modules.cpp.
References string_list.
-
00326 { string_list empty; return empty; }
+00328 { string_list empty; return empty; }
@@ -2773,15 +2773,15 @@ Called whenever a /WHOIS is performed on a local user.
The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.
-Definition at line 319 of file modules.cpp.
+Definition at line 321 of file modules.cpp.
-
00319 { };
+00321 { };
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 22:03:16 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:24 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModuleFactory-members.html b/docs/module-doc/classModuleFactory-members.html
index 838f4a443..c9066625b 100644
--- a/docs/module-doc/classModuleFactory-members.html
+++ b/docs/module-doc/classModuleFactory-members.html
@@ -12,7 +12,7 @@
ModuleFactory() ModuleFactory [inline]
~classbase() classbase [inline]
~ModuleFactory() ModuleFactory [inline, virtual]
-
Generated on Wed May 25 22:03:16 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:25 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html
index 4f0d5ba4f..5696482fb 100644
--- a/docs/module-doc/classModuleFactory.html
+++ b/docs/module-doc/classModuleFactory.html
@@ -136,7 +136,7 @@ Your inherited class of ModuleFactory must return a pointer to your modules.h
-
Generated on Wed May 25 22:03:16 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:25 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModuleMessage-members.html b/docs/module-doc/classModuleMessage-members.html
index fd297c619..4249074f2 100644
--- a/docs/module-doc/classModuleMessage-members.html
+++ b/docs/module-doc/classModuleMessage-members.html
@@ -10,7 +10,7 @@
classbase() classbase [inline]
Send()=0 ModuleMessage [pure virtual]
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:17 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:27 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classModuleMessage.html b/docs/module-doc/classModuleMessage.html
index 05f108e79..d194e7af9 100644
--- a/docs/module-doc/classModuleMessage.html
+++ b/docs/module-doc/classModuleMessage.html
@@ -67,7 +67,7 @@ Implemented in Request, and
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:17 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:27 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classQLine-members.html b/docs/module-doc/classQLine-members.html
index 868bbbdce..a03e71840 100644
--- a/docs/module-doc/classQLine-members.html
+++ b/docs/module-doc/classQLine-members.html
@@ -16,7 +16,7 @@
set_time XLine
source XLine
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:19 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:28 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classQLine.html b/docs/module-doc/classQLine.html
index bcd2d68b3..a6cf3b6fa 100644
--- a/docs/module-doc/classQLine.html
+++ b/docs/module-doc/classQLine.html
@@ -90,7 +90,7 @@ Definition at line 114 of f
The documentation for this class was generated from the following file:
-
Generated on Wed May 25 22:03:19 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:28 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classRequest-members.html b/docs/module-doc/classRequest-members.html
index e65b772a6..bad7f7120 100644
--- a/docs/module-doc/classRequest-members.html
+++ b/docs/module-doc/classRequest-members.html
@@ -17,7 +17,7 @@
Send() Request [virtual]
source Request [protected]
~classbase() classbase [inline]
-
Generated on Wed May 25 22:03:20 2005 for InspIRCd by
+
Generated on Mon May 30 05:17:30 2005 for InspIRCd by
1.3.3
diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html
index 17f49f7cc..be396252c 100644
--- a/docs/module-doc/classRequest.html
+++ b/docs/module-doc/classRequest.html
@@ -103,9 +103,9 @@ Create a new Request.
-Definition at line 249 of file modules.cpp.
+Definition at line 251 of file modules.cpp.
-
00249 : data(anydata), source(src), dest(dst) { };
+
@@ -139,13 +139,13 @@ Fetch the Request data.
-Definition at line 251 of file modules.cpp.
+Definition at line 253 of file modules.cpp.
References data.
-
00252 {
-00253 return this->data;
-00254 }
+00254 {
+00255 return this->data;
+00256 }
@@ -178,13 +178,13 @@ Fetch the request destination (should be 'this' in the receiving module).
-Definition at line 261 of file modules.cpp.
+Definition at line 263 of file modules.cpp.
References dest.
-
00262 {
-00263 return this->dest;
-00264 }
+00264 {
+00265