From f326e475e311bf0fa211ccd052ba38d8235efa12 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 1 Apr 2005 17:07:42 +0000 Subject: Updated documentation (html) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@937 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 248 +++++++++++++++++---------------- 1 file changed, 127 insertions(+), 121 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 27aa2af8e..85ac91a38 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -162,130 +162,136 @@ 00321 virtual string_list OnUserSync(userrec* user); 00322 00328 virtual string_list OnChannelSync(chanrec* chan); -00329 }; -00330 -00331 -00337 class Server : public classbase -00338 { -00339 public: -00343 Server(); -00347 virtual ~Server(); -00348 -00352 virtual void SendOpers(std::string s); -00357 virtual void Log(int level, std::string s); -00362 virtual void Send(int Socket, std::string s); -00367 virtual void SendServ(int Socket, std::string s); -00372 virtual void SendFrom(int Socket, userrec* User, std::string s); -00387 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); -00394 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); -00399 virtual bool CommonChannels(userrec* u1, userrec* u2); -00407 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); -00412 virtual void SendWallops(userrec* User, std::string text); -00413 -00417 virtual bool IsNick(std::string nick); -00421 virtual int CountUsers(chanrec* c); -00425 virtual userrec* FindNick(std::string nick); -00429 virtual chanrec* FindChannel(std::string channel); -00434 virtual std::string ChanMode(userrec* User, chanrec* Chan); -00438 virtual bool IsOnChannel(userrec* User, chanrec* Chan); -00441 virtual std::string GetServerName(); -00444 virtual std::string GetNetworkName(); -00450 virtual Admin GetAdmin(); -00469 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); -00470 -00492 virtual bool AddExtendedListMode(char modechar); -00493 -00508 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); -00509 -00531 virtual void SendMode(char **parameters, int pcnt, userrec *user); -00532 -00545 virtual void SendToModeMask(std::string modes, int flags, std::string text); -00546 -00552 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); -00553 -00559 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); +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 -00566 virtual void ChangeUserNick(userrec* user, std::string nickname); -00567 -00578 virtual void QuitUser(userrec* user, std::string reason); -00579 -00584 virtual bool MatchText(std::string sliteral, std::string spattern); -00585 -00597 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); -00598 -00604 virtual void ChangeHost(userrec* user, std::string host); -00605 -00611 virtual void ChangeGECOS(userrec* user, std::string gecos); -00612 -00621 virtual bool IsUlined(std::string server); -00622 -00626 virtual chanuserlist GetUsers(chanrec* chan); -00627 -00628 }; -00629 -00630 #define CONF_NOT_A_NUMBER 0x000010 -00631 #define CONF_NOT_UNSIGNED 0x000080 -00632 #define CONF_VALUE_NOT_FOUND 0x000100 -00633 #define CONF_FILE_NOT_FOUND 0x000200 -00634 -00641 class ConfigReader : public classbase -00642 { -00643 protected: -00649 std::stringstream *cache; -00650 std::stringstream *errorlog; -00653 bool readerror; -00654 long error; -00655 -00656 public: -00661 ConfigReader(); // default constructor reads ircd.conf -00665 ConfigReader(std::string filename); // read a module-specific config -00669 ~ConfigReader(); -00674 std::string ReadValue(std::string tag, std::string name, int index); -00680 bool ReadFlag(std::string tag, std::string name, int index); -00689 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); -00694 long GetError(); -00701 int Enumerate(std::string tag); -00706 bool Verify(); -00713 void DumpErrors(bool bail,userrec* user); -00714 -00720 int EnumerateValues(std::string tag, int index); -00721 }; -00722 -00723 -00724 -00730 class FileReader : public classbase -00731 { -00732 file_cache fc; -00733 public: -00738 FileReader(); -00739 -00745 FileReader(std::string filename); -00746 -00750 ~FileReader(); +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); +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 -00757 void LoadFile(std::string filename); -00758 -00762 bool Exists(); -00763 -00768 std::string GetLine(int x); -00769 -00775 int FileSize(); -00776 }; -00777 -00778 -00785 class ModuleFactory : public classbase -00786 { -00787 public: -00788 ModuleFactory() { } -00789 virtual ~ModuleFactory() { } -00794 virtual Module * CreateModule() = 0; -00795 }; -00796 +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 -00798 typedef DLLFactory<ModuleFactory> ircd_module; -00799 -00800 #endif -
1.3.3
--
cgit v1.3.1-10-gc9f91