From bc0d192a35489b8f5c42aa381ab2b120957ef770 Mon Sep 17 00:00:00 2001
From: brain
Date: Sat, 7 May 2005 15:35:21 +0000
Subject: Added final documentation for inspircd Beta 4
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1322 e03df62e-2008-0410-955e-edbf42e46eb7
---
docs/module-doc/modules_8h-source.html | 343 +++++++++++++++++----------------
1 file changed, 178 insertions(+), 165 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 c9a740a95..d402abc90 100644
--- a/docs/module-doc/modules_8h-source.html
+++ b/docs/module-doc/modules_8h-source.html
@@ -268,175 +268,188 @@
00637
00642 virtual void OnGlobalConnect(userrec* user);
00643
-00644 };
-00645
-00646
-00652 class Server : public classbase
-00653 {
-00654 public:
-00658 Server();
-00662 virtual ~Server();
-00663
-00667 virtual void SendOpers(std::string s);
-00672 virtual void Log(int level, std::string s);
-00677 virtual void Send(int Socket, std::string s);
-00682 virtual void SendServ(int Socket, std::string s);
-00687 virtual void SendFrom(int Socket, userrec* User, std::string s);
-00702 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
-00709 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
-00714 virtual bool CommonChannels(userrec* u1, userrec* u2);
-00722 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
-00727 virtual void SendWallops(userrec* User, std::string text);
-00728
-00732 virtual bool IsNick(std::string nick);
-00736 virtual int CountUsers(chanrec* c);
-00740 virtual userrec* FindNick(std::string nick);
-00744 virtual chanrec* FindChannel(std::string channel);
-00749 virtual std::string ChanMode(userrec* User, chanrec* Chan);
-00753 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
-00756 virtual std::string GetServerName();
-00759 virtual std::string GetNetworkName();
-00765 virtual Admin GetAdmin();
-00784 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
-00785
-00807 virtual bool AddExtendedListMode(char modechar);
-00808
-00826 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
-00827
-00849 virtual void SendMode(char **parameters, int pcnt, userrec *user);
-00850
-00863 virtual void SendToModeMask(std::string modes, int flags, std::string text);
-00864
-00870 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
-00871
-00877 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
-00878
-00884 virtual void ChangeUserNick(userrec* user, std::string nickname);
-00885
-00896 virtual void QuitUser(userrec* user, std::string reason);
-00897
-00902 virtual bool MatchText(std::string sliteral, std::string spattern);
-00903
-00915 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
-00916
-00922 virtual void ChangeHost(userrec* user, std::string host);
-00923
-00929 virtual void ChangeGECOS(userrec* user, std::string gecos);
-00930
-00939 virtual bool IsUlined(std::string server);
-00940
-00944 virtual chanuserlist GetUsers(chanrec* chan);
-00945
-00952 virtual bool UserToPseudo(userrec* user,std::string message);
-00953
-00960 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
-00961
-00969 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
-00970
-00978 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
-00979
-00987 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
-00988
-00996 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
-00997
-01005 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
-01006
-01009 virtual bool DelGLine(std::string hostmask);
-01010
-01013 virtual bool DelQLine(std::string nickname);
-01014
-01017 virtual bool DelZLine(std::string ipaddr);
-01018
-01021 virtual bool DelKLine(std::string hostmask);
-01022
-01025 virtual bool DelELine(std::string hostmask);
-01026
-01032 virtual long CalcDuration(std::string duration);
-01033
-01036 virtual bool IsValidMask(std::string mask);
-01037
-01042 virtual void MeshSendAll(std::string text);
-01043
-01050 virtual void MeshSendCommon(userrec* user, std::string text);
-01051
-01054 virtual void MeshSendAllAlive(std::string text);
-01055
-01059 virtual void MeshSendUnicast(std::string destination, std::string text);
+00647 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
+00648
+00652 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
+00653
+00660 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
+00661
+00668 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
+00669
+00673 virtual void OnRawSocketClose(int fd);
+00674
+00685 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
+00686 };
+00687
+00688
+00694 class Server : public classbase
+00695 {
+00696 public:
+00700 Server();
+00704 virtual ~Server();
+00705
+00709 virtual void SendOpers(std::string s);
+00714 virtual void Log(int level, std::string s);
+00719 virtual void Send(int Socket, std::string s);
+00724 virtual void SendServ(int Socket, std::string s);
+00728 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
+00733 virtual void SendFrom(int Socket, userrec* User, std::string s);
+00748 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
+00755 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
+00760 virtual bool CommonChannels(userrec* u1, userrec* u2);
+00768 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
+00773 virtual void SendWallops(userrec* User, std::string text);
+00774
+00778 virtual bool IsNick(std::string nick);
+00782 virtual int CountUsers(chanrec* c);
+00786 virtual userrec* FindNick(std::string nick);
+00790 virtual userrec* FindDescriptor(int socket);
+00794 virtual chanrec* FindChannel(std::string channel);
+00799 virtual std::string ChanMode(userrec* User, chanrec* Chan);
+00803 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
+00806 virtual std::string GetServerName();
+00809 virtual std::string GetNetworkName();
+00815 virtual Admin GetAdmin();
+00834 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
+00835
+00857 virtual bool AddExtendedListMode(char modechar);
+00858
+00876 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
+00877
+00899 virtual void SendMode(char **parameters, int pcnt, userrec *user);
+00900
+00913 virtual void SendToModeMask(std::string modes, int flags, std::string text);
+00914
+00920 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
+00921
+00927 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
+00928
+00934 virtual void ChangeUserNick(userrec* user, std::string nickname);
+00935
+00946 virtual void QuitUser(userrec* user, std::string reason);
+00947
+00952 virtual bool MatchText(std::string sliteral, std::string spattern);
+00953
+00965 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
+00966
+00972 virtual void ChangeHost(userrec* user, std::string host);
+00973
+00979 virtual void ChangeGECOS(userrec* user, std::string gecos);
+00980
+00989 virtual bool IsUlined(std::string server);
+00990
+00994 virtual chanuserlist GetUsers(chanrec* chan);
+00995
+01002 virtual bool UserToPseudo(userrec* user,std::string message);
+01003
+01010 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
+01011
+01019 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
+01020
+01028 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
+01029
+01037 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
+01038
+01046 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
+01047
+01055 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
+01056
+01059 virtual bool DelGLine(std::string hostmask);
01060
-01065 virtual void MeshSendAllExcept(std::string target, std::string text);
-01066
-01070 virtual bool MeshCheckChan(chanrec *c,std::string servername);
-01071
-01075 virtual bool MeshCheckCommon(userrec* u,std::string servername);
+01063 virtual bool DelQLine(std::string nickname);
+01064
+01067 virtual bool DelZLine(std::string ipaddr);
+01068
+01071 virtual bool DelKLine(std::string hostmask);
+01072
+01075 virtual bool DelELine(std::string hostmask);
01076
-01081 virtual Module* FindModule(std::string name);
-01082 };
+01082 virtual long CalcDuration(std::string duration);
01083
-01084
-01085 #define CONF_NOT_A_NUMBER 0x000010
-01086 #define CONF_NOT_UNSIGNED 0x000080
-01087 #define CONF_VALUE_NOT_FOUND 0x000100
-01088 #define CONF_FILE_NOT_FOUND 0x000200
-01089
-01090
-01097 class ConfigReader : public classbase
-01098 {
-01099 protected:
-01105 std::stringstream *cache;
-01106 std::stringstream *errorlog;
-01109 bool readerror;
-01110 long error;
-01111
-01112 public:
-01117 ConfigReader();
-01121 ConfigReader(std::string filename);
-01125 ~ConfigReader();
-01130 std::string ReadValue(std::string tag, std::string name, int index);
-01136 bool ReadFlag(std::string tag, std::string name, int index);
-01145 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
-01150 long GetError();
-01157 int Enumerate(std::string tag);
-01162 bool Verify();
-01169 void DumpErrors(bool bail,userrec* user);
-01170
-01176 int EnumerateValues(std::string tag, int index);
-01177 };
-01178
-01179
-01180
-01186 class FileReader : public classbase
-01187 {
-01188 file_cache fc;
-01189 public:
-01194 FileReader();
-01195
-01201 FileReader(std::string filename);
-01202
-01206 ~FileReader();
-01207
-01213 void LoadFile(std::string filename);
-01214
-01218 bool Exists();
-01219
-01224 std::string GetLine(int x);
-01225
-01231 int FileSize();
-01232 };
-01233
-01234
-01241 class ModuleFactory : public classbase
-01242 {
-01243 public:
-01244 ModuleFactory() { }
-01245 virtual ~ModuleFactory() { }
-01250 virtual Module * CreateModule() = 0;
-01251 };
+01086 virtual bool IsValidMask(std::string mask);
+01087
+01092 virtual void MeshSendAll(std::string text);
+01093
+01100 virtual void MeshSendCommon(userrec* user, std::string text);
+01101
+01104 virtual void MeshSendAllAlive(std::string text);
+01105
+01109 virtual void MeshSendUnicast(std::string destination, std::string text);
+01110
+01115 virtual void MeshSendAllExcept(std::string target, std::string text);
+01116
+01120 virtual bool MeshCheckChan(chanrec *c,std::string servername);
+01121
+01125 virtual bool MeshCheckCommon(userrec* u,std::string servername);
+01126
+01131 virtual Module* FindModule(std::string name);
+01132 };
+01133
+01134
+01135 #define CONF_NOT_A_NUMBER 0x000010
+01136 #define CONF_NOT_UNSIGNED 0x000080
+01137 #define CONF_VALUE_NOT_FOUND 0x000100
+01138 #define CONF_FILE_NOT_FOUND 0x000200
+01139
+01140
+01147 class ConfigReader : public classbase
+01148 {
+01149 protected:
+01155 std::stringstream *cache;
+01156 std::stringstream *errorlog;
+01159 bool readerror;
+01160 long error;
+01161
+01162 public:
+01167 ConfigReader();
+01171 ConfigReader(std::string filename);
+01175 ~ConfigReader();
+01180 std::string ReadValue(std::string tag, std::string name, int index);
+01186 bool ReadFlag(std::string tag, std::string name, int index);
+01195 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
+01200 long GetError();
+01207 int Enumerate(std::string tag);
+01212 bool Verify();
+01219 void DumpErrors(bool bail,userrec* user);
+01220
+01226 int EnumerateValues(std::string tag, int index);
+01227 };
+01228
+01229
+01230
+01236 class FileReader : public classbase
+01237 {
+01238 file_cache fc;
+01239 public:
+01244 FileReader();
+01245
+01251 FileReader(std::string filename);
01252
-01253
-01254 typedef DLLFactory<ModuleFactory> ircd_module;
-01255
-01256 #endif
-
Generated on Tue Apr 26 17:11:44 2005 for InspIRCd by
+01256 ~FileReader();
+01257
+01263 void LoadFile(std::string filename);
+01264
+01268 bool Exists();
+01269
+01274 std::string GetLine(int x);
+01275
+01281 int FileSize();
+01282 };
+01283
+01284
+01291 class ModuleFactory : public classbase
+01292 {
+01293 public:
+01294 ModuleFactory() { }
+01295 virtual ~ModuleFactory() { }
+01300 virtual Module * CreateModule() = 0;
+01301 };
+01302
+01303
+01304 typedef DLLFactory<ModuleFactory> ircd_module;
+01305
+01306 #endif
+
Generated on Sat May 7 15:34:21 2005 for InspIRCd by
1.3.3
--
cgit v1.3.1-10-gc9f91