From 4d5a17380bc71cabe544b41c7c8a26a292384f3d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 15 May 2005 17:05:15 +0000 Subject: Added docs for hashcomp git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 283 +++++++++++++++++---------------- 1 file changed, 142 insertions(+), 141 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 03cd2a9b7..ec270a4ae 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -4,7 +4,7 @@
-00001 /* +------------------------------------+ 00002 * | Inspire Internet Relay Chat Daemon | 00003 * +------------------------------------+ @@ -309,147 +309,148 @@ 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 -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 -01082 virtual long CalcDuration(std::string duration); -01083 -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(); // default constructor reads ircd.conf -01171 ConfigReader(std::string filename); // read a module-specific config -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 -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; +00812 virtual std::string GetServerDescription(); +00818 virtual Admin GetAdmin(); +00837 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); +00838 +00860 virtual bool AddExtendedListMode(char modechar); +00861 +00879 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source); +00880 +00902 virtual void SendMode(char **parameters, int pcnt, userrec *user); +00903 +00916 virtual void SendToModeMask(std::string modes, int flags, std::string text); +00917 +00923 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); +00924 +00930 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); +00931 +00937 virtual void ChangeUserNick(userrec* user, std::string nickname); +00938 +00949 virtual void QuitUser(userrec* user, std::string reason); +00950 +00955 virtual bool MatchText(std::string sliteral, std::string spattern); +00956 +00968 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); +00969 +00975 virtual void ChangeHost(userrec* user, std::string host); +00976 +00982 virtual void ChangeGECOS(userrec* user, std::string gecos); +00983 +00992 virtual bool IsUlined(std::string server); +00993 +00997 virtual chanuserlist GetUsers(chanrec* chan); +00998 +01005 virtual bool UserToPseudo(userrec* user,std::string message); +01006 +01013 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message); +01014 +01022 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask); +01023 +01031 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname); +01032 +01040 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr); +01041 +01049 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask); +01050 +01058 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask); +01059 +01062 virtual bool DelGLine(std::string hostmask); +01063 +01066 virtual bool DelQLine(std::string nickname); +01067 +01070 virtual bool DelZLine(std::string ipaddr); +01071 +01074 virtual bool DelKLine(std::string hostmask); +01075 +01078 virtual bool DelELine(std::string hostmask); +01079 +01085 virtual long CalcDuration(std::string duration); +01086 +01089 virtual bool IsValidMask(std::string mask); +01090 +01095 virtual void MeshSendAll(std::string text); +01096 +01103 virtual void MeshSendCommon(userrec* user, std::string text); +01104 +01107 virtual void MeshSendAllAlive(std::string text); +01108 +01112 virtual void MeshSendUnicast(std::string destination, std::string text); +01113 +01118 virtual void MeshSendAllExcept(std::string target, std::string text); +01119 +01123 virtual bool MeshCheckChan(chanrec *c,std::string servername); +01124 +01128 virtual bool MeshCheckCommon(userrec* u,std::string servername); +01129 +01134 virtual Module* FindModule(std::string name); +01135 }; +01136 +01137 +01138 #define CONF_NOT_A_NUMBER 0x000010 +01139 #define CONF_NOT_UNSIGNED 0x000080 +01140 #define CONF_VALUE_NOT_FOUND 0x000100 +01141 #define CONF_FILE_NOT_FOUND 0x000200 +01142 +01143 +01150 class ConfigReader : public classbase +01151 { +01152 protected: +01158 std::stringstream *cache; +01159 std::stringstream *errorlog; +01162 bool readerror; +01163 long error; +01164 +01165 public: +01170 ConfigReader(); // default constructor reads ircd.conf +01174 ConfigReader(std::string filename); // read a module-specific config +01178 ~ConfigReader(); +01183 std::string ReadValue(std::string tag, std::string name, int index); +01189 bool ReadFlag(std::string tag, std::string name, int index); +01198 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); +01203 long GetError(); +01210 int Enumerate(std::string tag); +01215 bool Verify(); +01222 void DumpErrors(bool bail,userrec* user); +01223 +01229 int EnumerateValues(std::string tag, int index); +01230 }; +01231 +01232 +01233 +01239 class FileReader : public classbase +01240 { +01241 file_cache fc; +01242 public: +01247 FileReader(); +01248 +01254 FileReader(std::string filename); +01255 +01259 ~FileReader(); +01260 +01266 void LoadFile(std::string filename); +01267 +01271 bool Exists(); +01272 +01277 std::string GetLine(int x); +01278 +01284 int FileSize(); +01285 }; +01286 +01287 +01294 class ModuleFactory : public classbase +01295 { +01296 public: +01297 ModuleFactory() { } +01298 virtual ~ModuleFactory() { } +01303 virtual Module * CreateModule() = 0; +01304 }; 01305 -01306 #endif -
1.3.3
--
cgit v1.3.1-10-gc9f91