From 3f4b15c2cfe51a654b5167273f5a95b29e757cf1 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 14 Apr 2005 21:13:24 +0000 Subject: New documentation on today's new methods etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1096 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 365 +++++++++++++++++---------------- 1 file changed, 187 insertions(+), 178 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 f2e507304..51290f271 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -151,189 +151,198 @@ 00219 00233 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname); 00234 -00235 -00240 virtual void OnOper(userrec* user); -00241 -00250 virtual void OnInfo(userrec* user); -00251 -00256 virtual void OnWhois(userrec* source, userrec* dest); -00257 -00263 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel); -00264 -00273 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text); -00274 -00286 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text); -00287 -00295 virtual int OnUserPreNick(userrec* user, std::string newnick); -00296 -00304 virtual void OnUserPostNick(userrec* user, std::string oldnick); -00305 -00327 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type); -00328 -00334 virtual string_list OnUserSync(userrec* user); -00335 -00341 virtual string_list OnChannelSync(chanrec* chan); -00342 -00346 virtual void On005Numeric(std::string &output); +00240 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason); +00241 +00246 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason); +00247 +00252 virtual void OnOper(userrec* user); +00253 +00262 virtual void OnInfo(userrec* user); +00263 +00268 virtual void OnWhois(userrec* source, userrec* dest); +00269 +00275 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel); +00276 +00285 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text); +00286 +00298 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text); +00299 +00307 virtual int OnUserPreNick(userrec* user, std::string newnick); +00308 +00316 virtual void OnUserPostNick(userrec* user, std::string oldnick); +00317 +00339 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type); +00340 +00346 virtual string_list OnUserSync(userrec* user); 00347 -00357 virtual int OnKill(userrec* source, userrec* dest, std::string reason); -00358 -00369 virtual void OnLoadModule(Module* mod,std::string name); +00353 virtual string_list OnChannelSync(chanrec* chan); +00354 +00358 virtual void On005Numeric(std::string &output); +00359 +00369 virtual int OnKill(userrec* source, userrec* dest, std::string reason); 00370 -00376 virtual void OnBackgroundTimer(time_t curtime); -00377 -00385 virtual void OnSendList(userrec* user, chanrec* channel, char mode); -00386 -00387 }; -00388 +00381 virtual void OnLoadModule(Module* mod,std::string name); +00382 +00388 virtual void OnBackgroundTimer(time_t curtime); 00389 -00395 class Server : public classbase -00396 { -00397 public: -00401 Server(); -00405 virtual ~Server(); -00406 -00410 virtual void SendOpers(std::string s); -00415 virtual void Log(int level, std::string s); -00420 virtual void Send(int Socket, std::string s); -00425 virtual void SendServ(int Socket, std::string s); -00430 virtual void SendFrom(int Socket, userrec* User, std::string s); -00445 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); -00452 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); -00457 virtual bool CommonChannels(userrec* u1, userrec* u2); -00465 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); -00470 virtual void SendWallops(userrec* User, std::string text); -00471 -00475 virtual bool IsNick(std::string nick); -00479 virtual int CountUsers(chanrec* c); -00483 virtual userrec* FindNick(std::string nick); -00487 virtual chanrec* FindChannel(std::string channel); -00492 virtual std::string ChanMode(userrec* User, chanrec* Chan); -00496 virtual bool IsOnChannel(userrec* User, chanrec* Chan); -00499 virtual std::string GetServerName(); -00502 virtual std::string GetNetworkName(); -00508 virtual Admin GetAdmin(); -00527 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); -00528 -00550 virtual bool AddExtendedListMode(char modechar); -00551 -00569 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source); -00570 -00592 virtual void SendMode(char **parameters, int pcnt, userrec *user); -00593 -00606 virtual void SendToModeMask(std::string modes, int flags, std::string text); -00607 -00613 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); -00614 -00620 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); -00621 -00627 virtual void ChangeUserNick(userrec* user, std::string nickname); -00628 -00639 virtual void QuitUser(userrec* user, std::string reason); -00640 -00645 virtual bool MatchText(std::string sliteral, std::string spattern); -00646 -00658 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); -00659 -00665 virtual void ChangeHost(userrec* user, std::string host); -00666 -00672 virtual void ChangeGECOS(userrec* user, std::string gecos); -00673 -00682 virtual bool IsUlined(std::string server); -00683 -00687 virtual chanuserlist GetUsers(chanrec* chan); -00688 -00695 virtual bool UserToPseudo(userrec* user,std::string message); -00696 -00703 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message); -00704 -00712 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask); -00713 -00721 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname); -00722 -00730 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr); -00731 -00739 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask); -00740 -00748 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask); -00749 -00752 virtual bool DelGLine(std::string hostmask); -00753 -00756 virtual bool DelQLine(std::string nickname); -00757 -00760 virtual bool DelZLine(std::string ipaddr); -00761 -00764 virtual bool DelKLine(std::string hostmask); -00765 -00768 virtual bool DelELine(std::string hostmask); -00769 -00775 virtual long CalcDuration(std::string duration); -00776 -00777 }; -00778 -00779 #define CONF_NOT_A_NUMBER 0x000010 -00780 #define CONF_NOT_UNSIGNED 0x000080 -00781 #define CONF_VALUE_NOT_FOUND 0x000100 -00782 #define CONF_FILE_NOT_FOUND 0x000200 -00783 -00790 class ConfigReader : public classbase -00791 { -00792 protected: -00798 std::stringstream *cache; -00799 std::stringstream *errorlog; -00802 bool readerror; -00803 long error; -00804 -00805 public: -00810 ConfigReader(); // default constructor reads ircd.conf -00814 ConfigReader(std::string filename); // read a module-specific config -00818 ~ConfigReader(); -00823 std::string ReadValue(std::string tag, std::string name, int index); -00829 bool ReadFlag(std::string tag, std::string name, int index); -00838 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); -00843 long GetError(); -00850 int Enumerate(std::string tag); -00855 bool Verify(); -00862 void DumpErrors(bool bail,userrec* user); -00863 -00869 int EnumerateValues(std::string tag, int index); -00870 }; -00871 -00872 -00873 -00879 class FileReader : public classbase -00880 { -00881 file_cache fc; -00882 public: -00887 FileReader(); -00888 -00894 FileReader(std::string filename); -00895 -00899 ~FileReader(); -00900 -00906 void LoadFile(std::string filename); -00907 -00911 bool Exists(); -00912 -00917 std::string GetLine(int x); +00397 virtual void OnSendList(userrec* user, chanrec* channel, char mode); +00398 +00409 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user); +00410 +00419 virtual bool OnCheckReady(userrec* user); +00420 +00428 virtual void OnUserRegister(userrec* user); +00429 }; +00430 +00431 +00437 class Server : public classbase +00438 { +00439 public: +00443 Server(); +00447 virtual ~Server(); +00448 +00452 virtual void SendOpers(std::string s); +00457 virtual void Log(int level, std::string s); +00462 virtual void Send(int Socket, std::string s); +00467 virtual void SendServ(int Socket, std::string s); +00472 virtual void SendFrom(int Socket, userrec* User, std::string s); +00487 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); +00494 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); +00499 virtual bool CommonChannels(userrec* u1, userrec* u2); +00507 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); +00512 virtual void SendWallops(userrec* User, std::string text); +00513 +00517 virtual bool IsNick(std::string nick); +00521 virtual int CountUsers(chanrec* c); +00525 virtual userrec* FindNick(std::string nick); +00529 virtual chanrec* FindChannel(std::string channel); +00534 virtual std::string ChanMode(userrec* User, chanrec* Chan); +00538 virtual bool IsOnChannel(userrec* User, chanrec* Chan); +00541 virtual std::string GetServerName(); +00544 virtual std::string GetNetworkName(); +00550 virtual Admin GetAdmin(); +00569 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); +00570 +00592 virtual bool AddExtendedListMode(char modechar); +00593 +00611 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source); +00612 +00634 virtual void SendMode(char **parameters, int pcnt, userrec *user); +00635 +00648 virtual void SendToModeMask(std::string modes, int flags, std::string text); +00649 +00655 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); +00656 +00662 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); +00663 +00669 virtual void ChangeUserNick(userrec* user, std::string nickname); +00670 +00681 virtual void QuitUser(userrec* user, std::string reason); +00682 +00687 virtual bool MatchText(std::string sliteral, std::string spattern); +00688 +00700 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); +00701 +00707 virtual void ChangeHost(userrec* user, std::string host); +00708 +00714 virtual void ChangeGECOS(userrec* user, std::string gecos); +00715 +00724 virtual bool IsUlined(std::string server); +00725 +00729 virtual chanuserlist GetUsers(chanrec* chan); +00730 +00737 virtual bool UserToPseudo(userrec* user,std::string message); +00738 +00745 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message); +00746 +00754 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask); +00755 +00763 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname); +00764 +00772 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr); +00773 +00781 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask); +00782 +00790 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask); +00791 +00794 virtual bool DelGLine(std::string hostmask); +00795 +00798 virtual bool DelQLine(std::string nickname); +00799 +00802 virtual bool DelZLine(std::string ipaddr); +00803 +00806 virtual bool DelKLine(std::string hostmask); +00807 +00810 virtual bool DelELine(std::string hostmask); +00811 +00817 virtual long CalcDuration(std::string duration); +00818 +00821 virtual bool IsValidMask(std::string mask); +00822 }; +00823 +00824 #define CONF_NOT_A_NUMBER 0x000010 +00825 #define CONF_NOT_UNSIGNED 0x000080 +00826 #define CONF_VALUE_NOT_FOUND 0x000100 +00827 #define CONF_FILE_NOT_FOUND 0x000200 +00828 +00835 class ConfigReader : public classbase +00836 { +00837 protected: +00843 std::stringstream *cache; +00844 std::stringstream *errorlog; +00847 bool readerror; +00848 long error; +00849 +00850 public: +00855 ConfigReader(); // default constructor reads ircd.conf +00859 ConfigReader(std::string filename); // read a module-specific config +00863 ~ConfigReader(); +00868 std::string ReadValue(std::string tag, std::string name, int index); +00874 bool ReadFlag(std::string tag, std::string name, int index); +00883 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); +00888 long GetError(); +00895 int Enumerate(std::string tag); +00900 bool Verify(); +00907 void DumpErrors(bool bail,userrec* user); +00908 +00914 int EnumerateValues(std::string tag, int index); +00915 }; +00916 +00917 00918 -00924 int FileSize(); -00925 }; -00926 -00927 -00934 class ModuleFactory : public classbase -00935 { -00936 public: -00937 ModuleFactory() { } -00938 virtual ~ModuleFactory() { } -00943 virtual Module * CreateModule() = 0; -00944 }; +00924 class FileReader : public classbase +00925 { +00926 file_cache fc; +00927 public: +00932 FileReader(); +00933 +00939 FileReader(std::string filename); +00940 +00944 ~FileReader(); 00945 -00946 -00947 typedef DLLFactory<ModuleFactory> ircd_module; -00948 -00949 #endif -
Generated on Wed Apr 13 13:06:54 2005 for InspIRCd by +00951 void LoadFile(std::string filename); +00952 +00956 bool Exists(); +00957 +00962 std::string GetLine(int x); +00963 +00969 int FileSize(); +00970 }; +00971 +00972 +00979 class ModuleFactory : public classbase +00980 { +00981 public: +00982 ModuleFactory() { } +00983 virtual ~ModuleFactory() { } +00988 virtual Module * CreateModule() = 0; +00989 }; +00990 +00991 +00992 typedef DLLFactory<ModuleFactory> ircd_module; +00993 +00994 #endif +
Generated on Thu Apr 14 21:12:05 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.2.3