From 71e6de4b88c3d51bfa59fed44049a4d1ea6d26a1 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 29 Apr 2004 15:23:02 +0000 Subject: Documentation update for class 'Extensible' git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@749 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 246 ++++++++++++++++----------------- 1 file changed, 123 insertions(+), 123 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 ce661ed2d..a80c9a53b 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -105,131 +105,131 @@ 00150 00156 virtual void OnRehash(); 00157 -00164 virtual void OnServerRaw(std::string &raw, bool inbound); -00165 -00175 virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms); -00176 -00189 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname); -00190 -00191 -00196 virtual void OnOper(userrec* user); -00197 -00206 virtual void OnInfo(userrec* user); -00207 -00212 virtual void OnWhois(userrec* source, userrec* dest); -00213 -00222 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text); -00223 -00232 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text); -00233 -00241 virtual int OnUserPreNick(userrec* user, std::string newnick); -00242 }; -00243 -00244 -00250 class Server : public classbase -00251 { -00252 public: -00256 Server(); -00260 virtual ~Server(); -00261 -00265 virtual void SendOpers(std::string s); -00270 virtual void Log(int level, std::string s); -00275 virtual void Send(int Socket, std::string s); -00280 virtual void SendServ(int Socket, std::string s); -00285 virtual void SendFrom(int Socket, userrec* User, std::string s); -00300 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); -00307 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); -00312 virtual bool CommonChannels(userrec* u1, userrec* u2); -00320 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); -00325 virtual void SendWallops(userrec* User, std::string text); -00326 -00330 virtual bool IsNick(std::string nick); -00334 virtual int CountUsers(chanrec* c); -00338 virtual userrec* FindNick(std::string nick); -00342 virtual chanrec* FindChannel(std::string channel); -00347 virtual std::string ChanMode(userrec* User, chanrec* Chan); -00350 virtual std::string GetServerName(); -00353 virtual std::string GetNetworkName(); -00359 virtual Admin GetAdmin(); -00378 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); -00379 -00394 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); -00395 -00417 virtual void SendMode(char **parameters, int pcnt, userrec *user); -00418 -00431 virtual void SendToModeMask(std::string modes, int flags, std::string text); -00432 -00438 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); -00439 -00445 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); -00446 -00452 virtual void ChangeUserNick(userrec* user, std::string nickname); -00453 -00464 virtual void QuitUser(userrec* user, std::string reason); -00465 -00470 virtual bool MatchText(std::string sliteral, std::string spattern); -00471 -00483 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); -00484 -00490 virtual void ChangeHost(userrec* user, std::string host); -00491 -00497 virtual void ChangeGECOS(userrec* user, std::string gecos); -00498 -00507 virtual bool IsUlined(std::string server); -00508 }; -00509 -00516 class ConfigReader : public classbase -00517 { -00518 protected: -00524 std::stringstream *cache; -00527 bool error; -00528 -00529 public: -00534 ConfigReader(); // default constructor reads ircd.conf -00538 ConfigReader(std::string filename); // read a module-specific config -00542 ~ConfigReader(); -00547 std::string ReadValue(std::string tag, std::string name, int index); -00554 int Enumerate(std::string tag); -00559 bool Verify(); -00560 -00566 int EnumerateValues(std::string tag, int index); -00567 }; -00568 -00569 +00166 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user); +00167 +00177 virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms); +00178 +00191 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname); +00192 +00193 +00198 virtual void OnOper(userrec* user); +00199 +00208 virtual void OnInfo(userrec* user); +00209 +00214 virtual void OnWhois(userrec* source, userrec* dest); +00215 +00224 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text); +00225 +00234 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text); +00235 +00243 virtual int OnUserPreNick(userrec* user, std::string newnick); +00244 }; +00245 +00246 +00252 class Server : public classbase +00253 { +00254 public: +00258 Server(); +00262 virtual ~Server(); +00263 +00267 virtual void SendOpers(std::string s); +00272 virtual void Log(int level, std::string s); +00277 virtual void Send(int Socket, std::string s); +00282 virtual void SendServ(int Socket, std::string s); +00287 virtual void SendFrom(int Socket, userrec* User, std::string s); +00302 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); +00309 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); +00314 virtual bool CommonChannels(userrec* u1, userrec* u2); +00322 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); +00327 virtual void SendWallops(userrec* User, std::string text); +00328 +00332 virtual bool IsNick(std::string nick); +00336 virtual int CountUsers(chanrec* c); +00340 virtual userrec* FindNick(std::string nick); +00344 virtual chanrec* FindChannel(std::string channel); +00349 virtual std::string ChanMode(userrec* User, chanrec* Chan); +00352 virtual std::string GetServerName(); +00355 virtual std::string GetNetworkName(); +00361 virtual Admin GetAdmin(); +00380 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); +00381 +00396 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); +00397 +00419 virtual void SendMode(char **parameters, int pcnt, userrec *user); +00420 +00433 virtual void SendToModeMask(std::string modes, int flags, std::string text); +00434 +00440 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); +00441 +00447 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); +00448 +00454 virtual void ChangeUserNick(userrec* user, std::string nickname); +00455 +00466 virtual void QuitUser(userrec* user, std::string reason); +00467 +00472 virtual bool MatchText(std::string sliteral, std::string spattern); +00473 +00485 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); +00486 +00492 virtual void ChangeHost(userrec* user, std::string host); +00493 +00499 virtual void ChangeGECOS(userrec* user, std::string gecos); +00500 +00509 virtual bool IsUlined(std::string server); +00510 }; +00511 +00518 class ConfigReader : public classbase +00519 { +00520 protected: +00526 std::stringstream *cache; +00529 bool error; +00530 +00531 public: +00536 ConfigReader(); // default constructor reads ircd.conf +00540 ConfigReader(std::string filename); // read a module-specific config +00544 ~ConfigReader(); +00549 std::string ReadValue(std::string tag, std::string name, int index); +00556 int Enumerate(std::string tag); +00561 bool Verify(); +00562 +00568 int EnumerateValues(std::string tag, int index); +00569 }; 00570 -00576 class FileReader : public classbase -00577 { -00578 file_cache fc; -00579 public: -00584 FileReader(); -00585 -00591 FileReader(std::string filename); -00592 -00596 ~FileReader(); -00597 -00603 void LoadFile(std::string filename); -00604 -00608 bool Exists(); -00609 -00614 std::string GetLine(int x); -00615 -00621 int FileSize(); -00622 }; -00623 -00624 -00631 class ModuleFactory : public classbase -00632 { -00633 public: -00634 ModuleFactory() { } -00635 virtual ~ModuleFactory() { } -00640 virtual Module * CreateModule() = 0; -00641 }; -00642 -00643 -00644 typedef DLLFactory<ModuleFactory> ircd_module; +00571 +00572 +00578 class FileReader : public classbase +00579 { +00580 file_cache fc; +00581 public: +00586 FileReader(); +00587 +00593 FileReader(std::string filename); +00594 +00598 ~FileReader(); +00599 +00605 void LoadFile(std::string filename); +00606 +00610 bool Exists(); +00611 +00616 std::string GetLine(int x); +00617 +00623 int FileSize(); +00624 }; +00625 +00626 +00633 class ModuleFactory : public classbase +00634 { +00635 public: +00636 ModuleFactory() { } +00637 virtual ~ModuleFactory() { } +00642 virtual Module * CreateModule() = 0; +00643 }; +00644 00645 -00646 #endif -
1.3-rc3
--
cgit v1.3.1-10-gc9f91