From 08e384bb24398224856c44baa51b51977644de9d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 9 Feb 2003 12:49:00 +0000 Subject: Documentation update, 09/02/03 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 271 +++++++++++++++------------------ 1 file changed, 126 insertions(+), 145 deletions(-) (limited to 'docs/module-doc/modules_8h-source.html') diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index d773cf20f..03ecb7fab 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -8,158 +8,139 @@ Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

modules.h

Go to the documentation of this file.
00001 /*
 00002 
-00003 $Log$
-00003 Revision 1.5  2003/01/27 00:28:57  brain
-00003 ...
 00003 
-00004 Revision 1.2  2003/01/26 23:52:59  brain
-00005 Modified documentation for base classes
-00006 Added base classes
-00007 
-00008 Revision 1.1.1.1  2003/01/23 19:45:58  brain
-00009 InspIRCd second source tree
-00010 
-00011 Revision 1.12  2003/01/22 20:59:10  brain
-00012 Added FileReader class documentation
-00013 
-00014 Revision 1.11  2003/01/22 20:49:16  brain
-00015 Added FileReader file-caching class
-00016 Changed m_randquote to use FileReader class
-00017 
-00018 Revision 1.10  2003/01/22 00:57:27  brain
-00019 Changes to documentation
-00020 
-00021 Revision 1.9  2003/01/22 00:44:26  brain
-00022 Added documentation comments
-00023 
-00024 Revision 1.8  2003/01/21 20:31:24  brain
-00025 Modified to add documentation
-00026 Added ConfigReader class for modules
-00027 
-00028 Revision 1.7  2003/01/15 22:47:44  brain
-00029 Changed user and channel structs to classes (finally)
-00030 
-00031 Revision 1.6  2003/01/13 22:30:50  brain
-00032 Added Admin class (holds /admin info for modules)
-00033 Added methods to Server class
-00034 
-00035 
-00036 */
-00037 
-00038 
-00039 #ifndef __PLUGIN_H
-00040 #define __PLUGIN_H
-00041 
-00042 #include "dynamic.h"
-00043 #include "base.h"
-00044 #include <string>
-00045 #include <deque>
+00004 
+00005 */
+00006 
+00007 
+00008 #ifndef __PLUGIN_H
+00009 #define __PLUGIN_H
+00010 
+00011 #define DEBUG 10
+00012 #define VERBOSE 20
+00013 #define DEFAULT 30
+00014 #define SPARSE 40
+00015 #define NONE 50
+00016 
+00017 #include "dynamic.h"
+00018 #include "base.h"
+00019 #include <string>
+00020 #include <deque>
+00021 
+00024 typedef deque<string> file_cache;
+00025 
+00026 
+00027 // This #define allows us to call a method in all
+00028 // loaded modules in a readable simple way, e.g.:
+00029 // 'FOREACH_MOD OnConnect(user);'
+00030 
+00031 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
+00032 
+00033 // class Version holds the version information of a Module, returned
+00034 // by Module::GetVersion (thanks RD)
+00035 
+00040 class Version : public classbase
+00041 {
+00042  public:
+00043          const int Major, Minor, Revision, Build;
+00044          Version(int major, int minor, int revision, int build);
+00045 };
 00046 
-00049 typedef deque<string> file_cache;
-00050 
-00051 
-00052 // This #define allows us to call a method in all
-00053 // loaded modules in a readable simple way, e.g.:
-00054 // 'FOREACH_MOD OnConnect(user);'
-00055 
-00056 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
-00057 
-00058 // class Version holds the version information of a Module, returned
-00059 // by Module::GetVersion (thanks RD)
-00060 
-00065 class Version : public classbase
+00047 
+00053 class Admin : public classbase
+00054 {
+00055  public:
+00056          const string Name, Email, Nick;
+00057          Admin(string name,string email,string nick);
+00058 };
+00059 
+00065 class Module : public classbase
 00066 {
 00067  public:
-00068          const int Major, Minor, Revision, Build;
-00069          Version(int major, int minor, int revision, int build);
-00070 };
-00071 
-00072 
-00078 class Admin : public classbase
-00079 {
-00080  public:
-00081          const string Name, Email, Nick;
-00082          Admin(string name,string email,string nick);
-00083 };
-00084 
-00090 class Module : public classbase
-00091 {
-00092  public:
-00096         Module();
-00100         virtual ~Module();
-00105         virtual Version GetVersion();
-00109         virtual void OnUserConnect(userrec* user);
-00113         virtual void OnUserQuit(userrec* user);
-00118         virtual void OnUserJoin(userrec* user, chanrec* channel);
-00123         virtual void OnUserPart(userrec* user, chanrec* channel);
-00124 };
-00125 
-00126 
-00132 class Server : public classbase
-00133 {
-00134  public:
-00138         Server();
-00142         virtual ~Server();
-00143 
-00147         virtual void SendOpers(string s);
-00152         virtual void Debug(string s);
-00157         virtual void Send(int Socket, string s);
-00162         virtual void SendServ(int Socket, string s);
-00167         virtual void SendFrom(int Socket, userrec* User, string s);
-00172         virtual void SendTo(userrec* Source, userrec* Dest, string s);
-00179         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
-00184         virtual bool CommonChannels(userrec* u1, userrec* u2);
-00192         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
-00197         virtual void SendWallops(userrec* User, string text);
-00198 
-00202         virtual bool IsNick(string nick);
-00206         virtual userrec* FindNick(string nick);
-00210         virtual chanrec* FindChannel(string channel);
-00215         virtual string ChanMode(userrec* User, chanrec* Chan);
-00218         virtual string GetServerName();
-00221         virtual string GetNetworkName();
-00227         virtual Admin GetAdmin();
-00228          
-00229 };
-00230 
-00237 class ConfigReader : public classbase
-00238 {
-00239   protected:
-00242         string fname;
-00243   public:
-00248         ConfigReader();                 // default constructor reads ircd.conf
-00252         ConfigReader(string filename);  // read a module-specific config
-00256         ~ConfigReader();
-00261         string ReadValue(string tag, string name, int index);
-00268         int Enumerate(string tag);
-00272         bool Verify();
-00273 };
-00274 
-00275 
-00276 
-00282 class FileReader : public classbase
-00283 {
-00284  file_cache fc;
-00285  public:
-00290          FileReader();
-00296          FileReader(string filename);
-00300          ~FileReader();
-00306          void LoadFile(string filename);
-00311          string GetLine(int x);
-00317          int FileSize();
+00071         Module();
+00075         virtual ~Module();
+00080         virtual Version GetVersion();
+00084         virtual void OnUserConnect(userrec* user);
+00088         virtual void OnUserQuit(userrec* user);
+00093         virtual void OnUserJoin(userrec* user, chanrec* channel);
+00098         virtual void OnUserPart(userrec* user, chanrec* channel);
+00099 
+00100 
+00101         virtual void Module::OnPacketTransmit(char *p);
+00102         virtual void Module::OnPacketReceive(char *p);
+00103         virtual void OnRehash();
+00104 
+00105 };
+00106 
+00107 
+00113 class Server : public classbase
+00114 {
+00115  public:
+00119         Server();
+00123         virtual ~Server();
+00124 
+00128         virtual void SendOpers(string s);
+00133         virtual void Log(int level, string s);
+00138         virtual void Send(int Socket, string s);
+00143         virtual void SendServ(int Socket, string s);
+00148         virtual void SendFrom(int Socket, userrec* User, string s);
+00153         virtual void SendTo(userrec* Source, userrec* Dest, string s);
+00160         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
+00165         virtual bool CommonChannels(userrec* u1, userrec* u2);
+00173         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
+00178         virtual void SendWallops(userrec* User, string text);
+00179 
+00183         virtual bool IsNick(string nick);
+00187         virtual userrec* FindNick(string nick);
+00191         virtual chanrec* FindChannel(string channel);
+00196         virtual string ChanMode(userrec* User, chanrec* Chan);
+00199         virtual string GetServerName();
+00202         virtual string GetNetworkName();
+00208         virtual Admin GetAdmin();
+00209          
+00210 };
+00211 
+00218 class ConfigReader : public classbase
+00219 {
+00220   protected:
+00223         string fname;
+00224   public:
+00229         ConfigReader();                 // default constructor reads ircd.conf
+00233         ConfigReader(string filename);  // read a module-specific config
+00237         ~ConfigReader();
+00242         string ReadValue(string tag, string name, int index);
+00249         int Enumerate(string tag);
+00253         bool Verify();
+00254 };
+00255 
+00256 
+00257 
+00263 class FileReader : public classbase
+00264 {
+00265  file_cache fc;
+00266  public:
+00271          FileReader();
+00277          FileReader(string filename);
+00281          ~FileReader();
+00287          void LoadFile(string filename);
+00292          string GetLine(int x);
+00298          int FileSize();
+00299 };
+00300 
+00301 
+00308 class ModuleFactory : public classbase
+00309 {
+00310  public:
+00311         ModuleFactory() { }
+00312         virtual ~ModuleFactory() { }
+00317         virtual Module * CreateModule() = 0;
 00318 };
 00319 
 00320 
-00327 class ModuleFactory : public classbase
-00328 {
-00329  public:
-00330         ModuleFactory() { }
-00331         virtual ~ModuleFactory() { }
-00336         virtual Module * CreateModule() = 0;
-00337 };
-00338 
-00339 #endif
-
Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by +00321 typedef DLLFactory<ModuleFactory> ircd_module; +00322 +00323 #endif +
Generated on Sun Feb 9 12:48:16 2003 for InspIRCd by doxygen1.3-rc2
-- cgit v1.2.3