From 1ea860b5708d065f9ed51234fc031969215fd806 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 2 Apr 2004 13:47:31 +0000 Subject: Updated documentation to document Server::SendMode git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@356 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 243 +++++++++++++++++---------------- 1 file changed, 123 insertions(+), 120 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 577ffd62a..f872917ec 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -42,127 +42,130 @@ 00036 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-> 00037 00038 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams); -00039 -00040 // class Version holds the version information of a Module, returned -00041 // by Module::GetVersion (thanks RD) -00042 -00047 class Version : public classbase -00048 { -00049 public: -00050 const int Major, Minor, Revision, Build; -00051 Version(int major, int minor, int revision, int build); -00052 }; -00053 -00059 class Admin : public classbase -00060 { -00061 public: -00062 const std::string Name, Email, Nick; -00063 Admin(std::string name, std::string email, std::string nick); -00064 }; -00065 -00071 class Module : public classbase -00072 { -00073 public: -00074 -00078 Module(); -00079 -00083 virtual ~Module(); -00084 -00089 virtual Version GetVersion(); -00090 -00094 virtual void OnUserConnect(userrec* user); -00095 -00099 virtual void OnUserQuit(userrec* user); -00100 -00105 virtual void OnUserJoin(userrec* user, chanrec* channel); -00106 -00111 virtual void OnUserPart(userrec* user, chanrec* channel); -00112 -00119 virtual void Module::OnPacketTransmit(char *p); -00120 -00128 virtual void Module::OnPacketReceive(char *p); -00129 -00135 virtual void OnRehash(); -00136 -00143 virtual void OnServerRaw(std::string &raw, bool inbound); -00144 -00153 virtual bool OnExtendedMode(userrec* user, chanrec* chan, char modechar, int type, bool mode_on, string_list &params); -00154 -00155 }; -00156 -00157 -00163 class Server : public classbase -00164 { -00165 public: -00169 Server(); -00173 virtual ~Server(); -00174 -00178 virtual void SendOpers(std::string s); -00183 virtual void Log(int level, std::string s); -00188 virtual void Send(int Socket, std::string s); -00193 virtual void SendServ(int Socket, std::string s); -00198 virtual void SendFrom(int Socket, userrec* User, std::string s); -00203 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); -00210 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); -00215 virtual bool CommonChannels(userrec* u1, userrec* u2); -00223 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); -00228 virtual void SendWallops(userrec* User, std::string text); -00229 -00233 virtual bool IsNick(std::string nick); -00237 virtual userrec* FindNick(std::string nick); -00241 virtual chanrec* FindChannel(std::string channel); -00246 virtual std::string ChanMode(userrec* User, chanrec* Chan); -00249 virtual std::string GetServerName(); -00252 virtual std::string GetNetworkName(); -00258 virtual Admin GetAdmin(); -00276 virtual bool AddExtendedMode(char modechar, int type, bool default_on, int params_when_on, int params_when_off); -00277 -00292 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); -00293 -00294 }; -00295 -00302 class ConfigReader : public classbase -00303 { -00304 protected: -00307 std::string fname; -00308 public: -00313 ConfigReader(); // default constructor reads ircd.conf -00317 ConfigReader(std::string filename); // read a module-specific config -00321 ~ConfigReader(); -00326 std::string ReadValue(std::string tag, std::string name, int index); -00333 int Enumerate(std::string tag); -00337 bool Verify(); -00338 }; -00339 -00340 -00341 -00347 class FileReader : public classbase -00348 { -00349 file_cache fc; -00350 public: -00355 FileReader(); -00361 FileReader(std::string filename); -00365 ~FileReader(); -00371 void LoadFile(std::string filename); -00376 bool Exists(); -00377 std::string GetLine(int x); -00383 int FileSize(); -00384 }; -00385 -00386 -00393 class ModuleFactory : public classbase -00394 { -00395 public: -00396 ModuleFactory() { } -00397 virtual ~ModuleFactory() { } -00402 virtual Module * CreateModule() = 0; -00403 }; -00404 +00039 extern void server_mode(char **parameters, int pcnt, userrec *user); +00040 +00041 // class Version holds the version information of a Module, returned +00042 // by Module::GetVersion (thanks RD) +00043 +00048 class Version : public classbase +00049 { +00050 public: +00051 const int Major, Minor, Revision, Build; +00052 Version(int major, int minor, int revision, int build); +00053 }; +00054 +00060 class Admin : public classbase +00061 { +00062 public: +00063 const std::string Name, Email, Nick; +00064 Admin(std::string name, std::string email, std::string nick); +00065 }; +00066 +00072 class Module : public classbase +00073 { +00074 public: +00075 +00079 Module(); +00080 +00084 virtual ~Module(); +00085 +00090 virtual Version GetVersion(); +00091 +00095 virtual void OnUserConnect(userrec* user); +00096 +00100 virtual void OnUserQuit(userrec* user); +00101 +00106 virtual void OnUserJoin(userrec* user, chanrec* channel); +00107 +00112 virtual void OnUserPart(userrec* user, chanrec* channel); +00113 +00120 virtual void Module::OnPacketTransmit(char *p); +00121 +00129 virtual void Module::OnPacketReceive(char *p); +00130 +00136 virtual void OnRehash(); +00137 +00144 virtual void OnServerRaw(std::string &raw, bool inbound); +00145 +00154 virtual bool OnExtendedMode(userrec* user, chanrec* chan, char modechar, int type, bool mode_on, string_list &params); +00155 +00156 +00157 }; +00158 +00159 +00165 class Server : public classbase +00166 { +00167 public: +00171 Server(); +00175 virtual ~Server(); +00176 +00180 virtual void SendOpers(std::string s); +00185 virtual void Log(int level, std::string s); +00190 virtual void Send(int Socket, std::string s); +00195 virtual void SendServ(int Socket, std::string s); +00200 virtual void SendFrom(int Socket, userrec* User, std::string s); +00205 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); +00212 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); +00217 virtual bool CommonChannels(userrec* u1, userrec* u2); +00225 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); +00230 virtual void SendWallops(userrec* User, std::string text); +00231 +00235 virtual bool IsNick(std::string nick); +00239 virtual userrec* FindNick(std::string nick); +00243 virtual chanrec* FindChannel(std::string channel); +00248 virtual std::string ChanMode(userrec* User, chanrec* Chan); +00251 virtual std::string GetServerName(); +00254 virtual std::string GetNetworkName(); +00260 virtual Admin GetAdmin(); +00278 virtual bool AddExtendedMode(char modechar, int type, bool default_on, int params_when_on, int params_when_off); +00279 +00294 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams); +00295 +00313 virtual void SendMode(char **parameters, int pcnt, userrec *user); +00314 }; +00315 +00322 class ConfigReader : public classbase +00323 { +00324 protected: +00327 std::string fname; +00328 public: +00333 ConfigReader(); // default constructor reads ircd.conf +00337 ConfigReader(std::string filename); // read a module-specific config +00341 ~ConfigReader(); +00346 std::string ReadValue(std::string tag, std::string name, int index); +00353 int Enumerate(std::string tag); +00357 bool Verify(); +00358 }; +00359 +00360 +00361 +00367 class FileReader : public classbase +00368 { +00369 file_cache fc; +00370 public: +00375 FileReader(); +00381 FileReader(std::string filename); +00385 ~FileReader(); +00391 void LoadFile(std::string filename); +00396 bool Exists(); +00397 std::string GetLine(int x); +00403 int FileSize(); +00404 }; 00405 -00406 typedef DLLFactory<ModuleFactory> ircd_module; -00407 -00408 #endif -
Generated on Fri Apr 2 13:37:27 2004 for InspIRCd by +00406 +00413 class ModuleFactory : public classbase +00414 { +00415 public: +00416 ModuleFactory() { } +00417 virtual ~ModuleFactory() { } +00422 virtual Module * CreateModule() = 0; +00423 }; +00424 +00425 +00426 typedef DLLFactory<ModuleFactory> ircd_module; +00427 +00428 #endif +
Generated on Fri Apr 2 14:46:05 2004 for InspIRCd by doxygen1.3-rc3
-- cgit v1.2.3