From c0f731e19d61a971af5cf26d073ccd25bfc5c91c Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 13 Apr 2005 12:41:46 +0000 Subject: Added Server::AddGLine Added Server::AddKLine Added Server::AddZLine Added Server::AddQLine Added Server::AddELine Added Server::DelGLine Added Server::DelKLine Added Server::DelZLine Added Server::DelQLine Added Server::DelELine Added Server::Duration git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1071 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 59 +++++++++++++++++++++++++++++++++------- 1 file changed, 49 insertions(+), 10 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 37ab96846..a0e01fb1e 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -48,7 +48,7 @@ Inherits classbase. virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)  Called when a raw command is transmitted or received.

-virtual int OnExtendedMode (userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params) +virtual int OnExtendedMode (userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)  Called whenever an extended mode is to be processed.

virtual int OnUserPreJoin (userrec *user, chanrec *chan, const char *cname) @@ -81,10 +81,10 @@ Inherits classbase. virtual int OnAccessCheck (userrec *source, userrec *dest, chanrec *channel, int access_type)  Called before an action which requires a channel privilage check.

-virtual string_list OnUserSync (userrec *user) +virtual string_list OnUserSync (userrec *user)  Called during a netburst to sync user data.

-virtual string_list OnChannelSync (chanrec *chan) +virtual string_list OnChannelSync (chanrec *chan)  Called during a netburst to sync channel data.

virtual void On005Numeric (std::string &output) @@ -96,6 +96,9 @@ Inherits classbase. virtual void OnLoadModule (Module *mod, std::string name)  Called whenever a module is loaded.

+virtual void OnBackgroundTimer (time_t curtime) + + Called once every five seconds for background processing.

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -104,7 +107,7 @@ All modules must inherit from this class, its methods will be called when irc se

-Definition at line 133 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 135 of file modules.h.

Constructor & Destructor Documentation

@@ -320,13 +323,49 @@ References ACR_DEFAULT.
+

+ + + + +
+ + + + + + + + + + +
void Module::OnBackgroundTimer ( time_t  curtime  )  [virtual]
+
+ + + + + +
+   + + +

+Called once every five seconds for background processing. +

+This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server. +

+Definition at line 333 of file modules.cpp. +

+

00333 { };
+

- + @@ -1248,7 +1287,7 @@ Definition at line 309
- + @@ -354,7 +393,7 @@ Definition at line 329

References string_list.

-

00329 { string_list empty; return empty; }
+
00329 { string_list empty; return empty; }
string_list Module::OnChannelSync string_list Module::OnChannelSync (  chanrec *  chan
@@ -396,7 +435,7 @@ References string_list.
string_list & string_list &  params
- + @@ -1276,7 +1315,7 @@ Definition at line 328

References string_list.

-

00328 { string_list empty; return empty; }
+
00328 { string_list empty; return empty; }
string_list Module::OnUserSync string_list Module::OnUserSync (  userrec *  user
@@ -1327,7 +1366,7 @@ Definition at line 321

The documentation for this class was generated from the following files: -
Generated on Sat Apr 9 14:38:29 2005 for InspIRCd by +
Generated on Wed Apr 13 12:32:26 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91