From 9c8b44176b47d2186c88743dc1f68023c26d780b Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 4 Apr 2005 18:13:55 +0000 Subject: Added new documentation for ELine class and OnUserPostNick method git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@977 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 274 +++++++++++++++++---------------- 1 file changed, 138 insertions(+), 136 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 bf7b33764..af553f1c7 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -155,143 +155,145 @@ 00267 00279 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text); 00280 -00291 virtual int OnUserPreNick(userrec* user, std::string newnick); -00292 -00314 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type); -00315 -00321 virtual string_list OnUserSync(userrec* user); -00322 -00328 virtual string_list OnChannelSync(chanrec* chan); -00329 -00333 virtual void On005Numeric(std::string &output); -00334 -00344 virtual int OnKill(userrec* source, userrec* dest, std::string reason); -00345 -00356 virtual void OnLoadModule(Module* mod,std::string name); -00357 }; -00358 -00359 -00365 class Server : public classbase -00366 { -00367 public: -00371 Server(); -00375 virtual ~Server(); -00376 -00380 virtual void SendOpers(std::string s); -00385 virtual void Log(int level, std::string s); -00390 virtual void Send(int Socket, std::string s); -00395 virtual void SendServ(int Socket, std::string s); -00400 virtual void SendFrom(int Socket, userrec* User, std::string s); -00415 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); -00422 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); -00427 virtual bool CommonChannels(userrec* u1, userrec* u2); -00435 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); -00440 virtual void SendWallops(userrec* User, std::string text); -00441 -00445 virtual bool IsNick(std::string nick); -00449 virtual int CountUsers(chanrec* c); -00453 virtual userrec* FindNick(std::string nick); -00457 virtual chanrec* FindChannel(std::string channel); -00462 virtual std::string ChanMode(userrec* User, chanrec* Chan); -00466 virtual bool IsOnChannel(userrec* User, chanrec* Chan); -00469 virtual std::string GetServerName(); -00472 virtual std::string GetNetworkName(); -00478 virtual Admin GetAdmin(); -00497 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); -00498 -00520 virtual bool AddExtendedListMode(char modechar); -00521 -00536 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); -00537 -00559 virtual void SendMode(char **parameters, int pcnt, userrec *user); -00560 -00573 virtual void SendToModeMask(std::string modes, int flags, std::string text); -00574 -00580 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); -00581 -00587 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); -00588 -00594 virtual void ChangeUserNick(userrec* user, std::string nickname); -00595 -00606 virtual void QuitUser(userrec* user, std::string reason); -00607 -00612 virtual bool MatchText(std::string sliteral, std::string spattern); +00288 virtual int OnUserPreNick(userrec* user, std::string newnick); +00289 +00297 virtual void OnUserPostNick(userrec* user, std::string oldnick); +00298 +00320 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type); +00321 +00327 virtual string_list OnUserSync(userrec* user); +00328 +00334 virtual string_list OnChannelSync(chanrec* chan); +00335 +00339 virtual void On005Numeric(std::string &output); +00340 +00350 virtual int OnKill(userrec* source, userrec* dest, std::string reason); +00351 +00362 virtual void OnLoadModule(Module* mod,std::string name); +00363 }; +00364 +00365 +00371 class Server : public classbase +00372 { +00373 public: +00377 Server(); +00381 virtual ~Server(); +00382 +00386 virtual void SendOpers(std::string s); +00391 virtual void Log(int level, std::string s); +00396 virtual void Send(int Socket, std::string s); +00401 virtual void SendServ(int Socket, std::string s); +00406 virtual void SendFrom(int Socket, userrec* User, std::string s); +00421 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); +00428 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); +00433 virtual bool CommonChannels(userrec* u1, userrec* u2); +00441 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); +00446 virtual void SendWallops(userrec* User, std::string text); +00447 +00451 virtual bool IsNick(std::string nick); +00455 virtual int CountUsers(chanrec* c); +00459 virtual userrec* FindNick(std::string nick); +00463 virtual chanrec* FindChannel(std::string channel); +00468 virtual std::string ChanMode(userrec* User, chanrec* Chan); +00472 virtual bool IsOnChannel(userrec* User, chanrec* Chan); +00475 virtual std::string GetServerName(); +00478 virtual std::string GetNetworkName(); +00484 virtual Admin GetAdmin(); +00503 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); +00504 +00526 virtual bool AddExtendedListMode(char modechar); +00527 +00542 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); +00543 +00565 virtual void SendMode(char **parameters, int pcnt, userrec *user); +00566 +00579 virtual void SendToModeMask(std::string modes, int flags, std::string text); +00580 +00586 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); +00587 +00593 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); +00594 +00600 virtual void ChangeUserNick(userrec* user, std::string nickname); +00601 +00612 virtual void QuitUser(userrec* user, std::string reason); 00613 -00625 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); -00626 -00632 virtual void ChangeHost(userrec* user, std::string host); -00633 -00639 virtual void ChangeGECOS(userrec* user, std::string gecos); -00640 -00649 virtual bool IsUlined(std::string server); -00650 -00654 virtual chanuserlist GetUsers(chanrec* chan); -00655 -00656 }; -00657 -00658 #define CONF_NOT_A_NUMBER 0x000010 -00659 #define CONF_NOT_UNSIGNED 0x000080 -00660 #define CONF_VALUE_NOT_FOUND 0x000100 -00661 #define CONF_FILE_NOT_FOUND 0x000200 -00662 -00669 class ConfigReader : public classbase -00670 { -00671 protected: -00677 std::stringstream *cache; -00678 std::stringstream *errorlog; -00681 bool readerror; -00682 long error; -00683 -00684 public: -00689 ConfigReader(); // default constructor reads ircd.conf -00693 ConfigReader(std::string filename); // read a module-specific config -00697 ~ConfigReader(); -00702 std::string ReadValue(std::string tag, std::string name, int index); -00708 bool ReadFlag(std::string tag, std::string name, int index); -00717 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); -00722 long GetError(); -00729 int Enumerate(std::string tag); -00734 bool Verify(); -00741 void DumpErrors(bool bail,userrec* user); -00742 -00748 int EnumerateValues(std::string tag, int index); -00749 }; -00750 -00751 -00752 -00758 class FileReader : public classbase -00759 { -00760 file_cache fc; -00761 public: -00766 FileReader(); -00767 -00773 FileReader(std::string filename); -00774 -00778 ~FileReader(); -00779 -00785 void LoadFile(std::string filename); -00786 -00790 bool Exists(); -00791 -00796 std::string GetLine(int x); -00797 -00803 int FileSize(); -00804 }; -00805 -00806 -00813 class ModuleFactory : public classbase -00814 { -00815 public: -00816 ModuleFactory() { } -00817 virtual ~ModuleFactory() { } -00822 virtual Module * CreateModule() = 0; -00823 }; -00824 -00825 -00826 typedef DLLFactory<ModuleFactory> ircd_module; -00827 -00828 #endif -
Generated on Sat Apr 2 19:27:01 2005 for InspIRCd by +00618 virtual bool MatchText(std::string sliteral, std::string spattern); +00619 +00631 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); +00632 +00638 virtual void ChangeHost(userrec* user, std::string host); +00639 +00645 virtual void ChangeGECOS(userrec* user, std::string gecos); +00646 +00655 virtual bool IsUlined(std::string server); +00656 +00660 virtual chanuserlist GetUsers(chanrec* chan); +00661 +00662 }; +00663 +00664 #define CONF_NOT_A_NUMBER 0x000010 +00665 #define CONF_NOT_UNSIGNED 0x000080 +00666 #define CONF_VALUE_NOT_FOUND 0x000100 +00667 #define CONF_FILE_NOT_FOUND 0x000200 +00668 +00675 class ConfigReader : public classbase +00676 { +00677 protected: +00683 std::stringstream *cache; +00684 std::stringstream *errorlog; +00687 bool readerror; +00688 long error; +00689 +00690 public: +00695 ConfigReader(); // default constructor reads ircd.conf +00699 ConfigReader(std::string filename); // read a module-specific config +00703 ~ConfigReader(); +00708 std::string ReadValue(std::string tag, std::string name, int index); +00714 bool ReadFlag(std::string tag, std::string name, int index); +00723 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); +00728 long GetError(); +00735 int Enumerate(std::string tag); +00740 bool Verify(); +00747 void DumpErrors(bool bail,userrec* user); +00748 +00754 int EnumerateValues(std::string tag, int index); +00755 }; +00756 +00757 +00758 +00764 class FileReader : public classbase +00765 { +00766 file_cache fc; +00767 public: +00772 FileReader(); +00773 +00779 FileReader(std::string filename); +00780 +00784 ~FileReader(); +00785 +00791 void LoadFile(std::string filename); +00792 +00796 bool Exists(); +00797 +00802 std::string GetLine(int x); +00803 +00809 int FileSize(); +00810 }; +00811 +00812 +00819 class ModuleFactory : public classbase +00820 { +00821 public: +00822 ModuleFactory() { } +00823 virtual ~ModuleFactory() { } +00828 virtual Module * CreateModule() = 0; +00829 }; +00830 +00831 +00832 typedef DLLFactory<ModuleFactory> ircd_module; +00833 +00834 #endif +
Generated on Mon Apr 4 18:12:48 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.2.3