From bab9f4b4bc0f6aa0e1377745fd216ef9874b3f27 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 9 Dec 2005 20:21:39 +0000 Subject: Added new module docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 2874 +++++++++++++++++++++++++++++++------- 1 file changed, 2377 insertions(+), 497 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index a97d7c059..deef06e8c 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -21,9 +21,9 @@ Inheritance diagram for Module:

[legend]
List of all members. - + - + @@ -33,9 +33,9 @@ Inheritance diagram for Module:

virtual void 
- + - + @@ -45,15 +45,9 @@ Inheritance diagram for Module:

virtual void 
- + - - - - - - - + @@ -69,9 +63,9 @@ Inheritance diagram for Module:

virtual void 
- + - + @@ -81,6 +75,9 @@ Inheritance diagram for Module:

virtual int 
+ + + @@ -90,24 +87,94 @@ Inheritance diagram for Module:

virtual int 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + @@ -156,6 +223,9 @@ Inheritance diagram for Module:

virtual int 
+ + + @@ -197,8 +267,8 @@ All modules must inherit from this class, its methods will be called when irc se

-Definition at line 238 of file modules.h.

Constructor & Destructor Documentation

-

+Definition at line 239 of file modules.h.

Constructor & Destructor Documentation

+


Public Member Functions

 Module ()
 Module (Server *Me)
 Default constructor creates a module class.
 Default constructor Creates a module class.
virtual ~Module ()
 Default destructor destroys a module class.
OnUserConnect (userrec *user)
 Called when a user connects.
virtual void OnUserQuit (userrec *user)
virtual void OnUserQuit (userrec *user, std::string message)
 Called when a user quits.
 Called when a user quits.
virtual void OnUserDisconnect (userrec *user)
 Called whenever a user's socket is closed.
OnUserPart (userrec *user, chanrec *channel)
 Called when a user parts a channel.
virtual void OnPacketTransmit (std::string &data, std::string serv)
virtual void OnRehash (std::string parameter)
 Called before a packet is transmitted across the irc network between two irc servers.
virtual void OnPacketReceive (std::string &data, std::string serv)
 Called after a packet is received from another irc server.
virtual void OnRehash ()
 Called on rehash.
 Called on rehash.
virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)
 Called when a raw command is transmitted or received.
OnUserKick (userrec *source, userrec *user, chanrec *chan, std::string reason)
 Called whenever a user is kicked.
virtual void OnOper (userrec *user)
virtual void OnOper (userrec *user, std::string opertype)
 Called whenever a user opers locally.
 Called whenever a user opers locally.
virtual void OnInfo (userrec *user)
 Called whenever a user types /INFO.
OnUserPreInvite (userrec *source, userrec *dest, chanrec *channel)
 Called whenever a user is about to invite another user into a channel, before any processing is done.
virtual void OnUserInvite (userrec *source, userrec *dest, chanrec *channel)
 Called after a user has been successfully invited to a channel.
virtual int OnUserPreMessage (userrec *user, void *dest, int target_type, std::string &text)
 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
OnUserPreNick (userrec *user, std::string newnick)
 Called before any nickchange, local or remote.
virtual void OnUserMessage (userrec *user, void *dest, int target_type, std::string text)
 Called after any PRIVMSG sent from a user.
virtual void OnUserNotice (userrec *user, void *dest, int target_type, std::string text)
 Called after any NOTICE sent from a user.
virtual void OnMode (userrec *user, void *dest, int target_type, std::string text)
 Called after every MODE command sent from a user The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.
virtual void OnGetServerDescription (std::string servername, std::string &description)
 Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules.
virtual void OnSyncUser (userrec *user, Module *proto, void *opaque)
 Allows modules to synchronize data which relates to users during a netburst.
virtual void OnSyncChannel (chanrec *chan, Module *proto, void *opaque)
 Allows modules to synchronize data which relates to channels during a netburst.
virtual void OnSyncChannelMetaData (chanrec *chan, Module *proto, void *opaque, std::string extname)
virtual void OnSyncUserMetaData (userrec *user, Module *proto, void *opaque, std::string extname)
virtual void OnDecodeMetaData (int target_type, void *target, std::string extname, std::string extdata)
 Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
virtual void ProtoSendMode (void *opaque, int target_type, void *target, std::string modeline)
 Implemented by modules which provide the ability to link servers.
virtual void ProtoSendMetaData (void *opaque, int target_type, void *target, std::string extname, std::string extdata)
 Implemented by modules which provide the ability to link servers.
virtual void OnWallops (userrec *user, std::string text)
 Called after every WALLOPS command.
virtual void OnChangeHost (userrec *user, std::string newhost)
 Called whenever a user's hostname is changed.
virtual void OnChangeName (userrec *user, std::string gecos)
 Called whenever a user's GECOS (realname) is changed.
virtual void OnAddGLine (long duration, userrec *source, std::string reason, std::string hostmask)
 Called whenever a gline is added by a local user.
virtual void OnAddZLine (long duration, userrec *source, std::string reason, std::string ipmask)
 Called whenever a zline is added by a local user.
virtual void OnAddKLine (long duration, userrec *source, std::string reason, std::string hostmask)
 Called whenever a kline is added by a local user.
virtual void OnAddQLine (long duration, userrec *source, std::string reason, std::string nickmask)
 Called whenever a qline is added by a local user.
virtual void OnAddELine (long duration, userrec *source, std::string reason, std::string hostmask)
 Called whenever a eline is added by a local user.
virtual void OnDelGLine (userrec *source, std::string hostmask)
 Called whenever a gline is deleted.
virtual void OnDelZLine (userrec *source, std::string ipmask)
 Called whenever a zline is deleted.
virtual void OnDelKLine (userrec *source, std::string hostmask)
 Called whenever a kline is deleted.
virtual void OnDelQLine (userrec *source, std::string nickmask)
 Called whenever a qline is deleted.
virtual void OnDelELine (userrec *source, std::string hostmask)
 Called whenever a eline is deleted.
virtual void OnCleanup (int target_type, void *item)
 Called before your module is unloaded to clean up Extensibles.
virtual void OnUserPostNick (userrec *user, std::string oldnick)
 Called after any nickchange, local or remote.
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)
 Called during a netburst to sync user data.
virtual string_list OnChannelSync (chanrec *chan)
 Called during a netburst to sync channel data.
virtual void On005Numeric (std::string &output)
 Called when a 005 numeric is about to be output.
virtual int OnKill (userrec *source, userrec *dest, std::string reason)
 Called when a client is disconnected by KILL.
virtual void OnRemoteKill (userrec *source, userrec *dest, std::string reason)
 Called when an oper wants to disconnect a remote user via KILL.
virtual void OnLoadModule (Module *mod, std::string name)
 Called whenever a module is loaded.
OnLocalTopicChange (userrec *user, chanrec *chan, std::string topic)
 Called whenever a topic is changed by a local user.
virtual void OnPostLocalTopicChange (userrec *user, chanrec *chan, std::string topic)
 Called whenever a local topic has been changed.
virtual void OnEvent (Event *event)
 Called whenever an Event class is sent to all module by another module.
- + + @@ -222,11 +293,16 @@ Definition at line 238 of @@ -260,7 +336,7 @@ Default destructor destroys a module class.

-Definition at line 307 of file modules.cpp.

00307 { }
+Definition at line 308 of file modules.cpp.
00308 { }
 

 

     
@@ -295,9 +371,9 @@ Returns the version number of a Module.
 

 The method should return a Version object with its version information assigned via Version::Version
 

-Definition at line 319 of file modules.cpp.
+Definition at line 321 of file modules.cpp.
 

-References VF_VENDOR.
00319 { return Version(1,0,0,0,VF_VENDOR); }
+References VF_VENDOR.
00321 { return Version(1,0,0,0,VF_VENDOR); }
 

 

     
@@ -330,7 +406,12 @@ References VF_VENDOR.

 Called when a 005 numeric is about to be output. 
 

-The module should modify the 005 numeric if needed to indicate its features.
+The module should modify the 005 numeric if needed to indicate its features. 
Parameters:

+
@@ -206,7 +276,8 @@ Definition at line 238 of
Module::Module (  Server *  Me  ) 

-Default constructor creates a module class. +Default constructor Creates a module class.

+

Parameters:
+ + +
Me An instance of the Server class which can be saved for future use
+

-Definition at line 306 of file modules.cpp.

00306 { }
+Definition at line 307 of file modules.cpp.
00307 { }
+ +
output The 005 string to be modified if neccessary.
+ +

Definition at line 331 of file modules.cpp.

00331 { };
@@ -397,11 +478,19 @@ This function is called before many functions which check a users status on a ch AC_DEHALFOP (6) - a user is being dehalfopped
AC_INVITE (7) - a user is being invited
AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
- Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined). + Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
Parameters:
+ + + + + +
source The source of the access check
dest The destination of the access check
channel The channel which is being checked
access_type See above
+
+

-Definition at line 328 of file modules.cpp. +Definition at line 330 of file modules.cpp.

-References ACR_DEFAULT.

00328 { return ACR_DEFAULT; };
+References ACR_DEFAULT.
00330 { return ACR_DEFAULT; };
 

 

     
@@ -449,7 +538,15 @@ References ACR_DEFAULT.
 Called whenever a ban is added to a channel's list. 
 

-Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
+Return a non-zero value to 'eat' the mode change and prevent the ban from being added. 
Parameters:

+  
+    
+    
+    
+  
source The user adding the ban 
channel The channel the ban is being added to 
banmask The ban mask being added 

+

+
Returns:
1 to block the ban, 0 to continue as normal

+
 

 Definition at line 356 of file modules.cpp.
00356 { return 0; };
 

@@ -457,18 +554,39 @@ Definition at line 356
     
   
 
-

+

 
@@ -482,32 +600,52 @@ Definition at line 356

   

     
       
-          
+          
-          
-          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnBackgroundTimer           void Module::OnAddELine           
           ( time_t  curtime           )  [virtual]long  duration, 
userrec *  source, 
std::string  reason, 
std::string  hostmask
)  [virtual]
         

       

     		
     
 
 

-Called once every five seconds for background processing. 
+Called whenever a eline is added by a local user. 
 

-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.
+This method is triggered after the line is added. 
Parameters:

+  
+    
+    
+    
+    
+  
duration The duration of the line in seconds 
source The sender of the line 
reason The reason text to be displayed 
hostmask The hostmask to add

+

+
 

-Definition at line 335 of file modules.cpp.
00335 { };
+Definition at line 382 of file modules.cpp.
00382 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
-          
+          
+        
+        
+          
+          
+          
+          
@@ -526,32 +664,52 @@ Definition at line 335

         
int Module::OnChangeLocalUserGECOS           void Module::OnAddGLine           
           ( userrec *  user, long  duration, 
userrec *  source, 
         

         

           
           
           std::string  newhost reason, 
std::string  hostmask
         

         

           
     
 
 

-Called whenever a change of a local users GECOS (fullname field) is attempted. 
+Called whenever a gline is added by a local user. 
 

-return 1 to deny the name change, or 0 to allow it.
+This method is triggered after the line is added. 
Parameters:

+  
+    
+    
+    
+    
+  
duration The duration of the line in seconds 
source The sender of the line 
reason The reason text to be displayed 
hostmask The hostmask to add

+

+
 

-Definition at line 349 of file modules.cpp.
00349 { return 0; };
+Definition at line 378 of file modules.cpp.
00378 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
-          
+          
+        
+        
+          
+          
+          
+          
@@ -570,28 +728,57 @@ Definition at line 349

         
int Module::OnChangeLocalUserHost           void Module::OnAddKLine           
           ( userrec *  user, long  duration, 
userrec *  source, 
         

         

           
           
           std::string  newhost reason, 
std::string  hostmask
         

         

           
     
 
 

-Called whenever a change of a local users displayed host is attempted. 
+Called whenever a kline is added by a local user. 
 

-Return 1 to deny the host change, or 0 to allow it.
+This method is triggered after the line is added. 
Parameters:

+  
+    
+    
+    
+    
+  
duration The duration of the line in seconds 
source The sender of the line 
reason The reason text to be displayed 
hostmask The hostmask to add

+

+
 

-Definition at line 348 of file modules.cpp.
00348 { return 0; };
+Definition at line 380 of file modules.cpp.
00380 { };
 

 

     

   

 

-

+

 
@@ -605,32 +792,52 @@ Definition at line 348

   

     
       
-          
+          
-          
-          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
string_list Module::OnChannelSync           void Module::OnAddQLine           
           ( chanrec *  chan           )  [virtual]long  duration, 
userrec *  source, 
std::string  reason, 
std::string  nickmask
)  [virtual]
         

       

     		
     
 
 

-Called during a netburst to sync channel data. 
+Called whenever a qline is added by a local user. 
 

-This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.
+This method is triggered after the line is added. 
Parameters:

+  
+    
+    
+    
+    
+  
duration The duration of the line in seconds 
source The sender of the line 
reason The reason text to be displayed 
nickmask The hostmask to add

+

+
 

-Definition at line 330 of file modules.cpp.
00330 { string_list empty; return empty; }
+Definition at line 381 of file modules.cpp.
00381 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
@@ -649,37 +856,36 @@ Definition at line 330

         
int Module::OnCheckBan           void Module::OnAddZLine           
           ( userrec *  user, long  duration, 
         

         

           
           chanrec *  chanuserrec *  source, 
std::string  reason, 
std::string  ipmask
         

         

           
     
 
 

-Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. 
+Called whenever a zline is added by a local user. 
 

-This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
+This method is triggered after the line is added. 
Parameters:

+  
+    
+    
+    
+    
+  
duration The duration of the line in seconds 
source The sender of the line 
reason The reason text to be displayed 
ipmask The hostmask to add

+

+
 

-Definition at line 346 of file modules.cpp.
00346 { return 0; };
+Definition at line 379 of file modules.cpp.
00379 { };
 

 

     

   

 

-

+

 
@@ -693,38 +899,37 @@ Definition at line 346

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
+          
+          
+          
+          

         
int Module::OnCheckInvite           void Module::OnBackgroundTimer           
           ( userrec *  user, 
chanrec *  chan
)  [virtual]time_t  curtime           )  [virtual]
         

       

     		
     
 
 

-Called whenever a user joins a channel, to determine if invite checks should go ahead or not. 
+Called once every five seconds for background processing. 
 

-This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
+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. 
Parameters:

+  
+    
+  
curtime The current timer derived from time(2)

+

+
 

-Definition at line 343 of file modules.cpp.
00343 { return 0; };
+Definition at line 335 of file modules.cpp.
00335 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-        
-          
-          
-          
-          
-        
-          
+          
@@ -743,23 +948,29 @@ Definition at line 343

         
int Module::OnCheckKey           void Module::OnChangeHost           
           ( 
           userrec * 
            user, 
         
chanrec *  chan, 

         

           
           
           std::string  keygiven newhost
         

         

           
     
 
 

-Called whenever a user joins a channel, to determine if key checks should go ahead or not. 
+Called whenever a user's hostname is changed. 
 

-This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
+This event triggers after the host has been set. 
Parameters:

+  
+    
+    
+  
user The user whos host is being changed 
newhost The new hostname being set

+

+
 

-Definition at line 344 of file modules.cpp.
00344 { return 0; };
+Definition at line 376 of file modules.cpp.
00376 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
@@ -767,8 +978,8 @@ Definition at line 344
-          
-          
+          
+          
@@ -787,28 +998,44 @@ Definition at line 344

         
int Module::OnCheckLimit           int Module::OnChangeLocalUserGECOS           
           ( 
           userrec * 
            user, 
         

           
           chanrec *  chanstd::string  newhost
         

         

           
     
 
 

-Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. 
+Called whenever a change of a local users GECOS (fullname field) is attempted. 
 

-This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
+return 1 to deny the name change, or 0 to allow it. 
Parameters:

+  
+    
+    
+  
user The user whos GECOS will be changed 
newhost The new GECOS 

+

+
Returns:
1 to deny the GECOS change, 0 to allow

+
 

-Definition at line 345 of file modules.cpp.
00345 { return 0; };
+Definition at line 349 of file modules.cpp.
00349 { return 0; };
 

 

     

   

 

-

+

 
@@ -822,38 +1049,39 @@ Definition at line 345

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
bool Module::OnCheckReady           int Module::OnChangeLocalUserHost           
           ( 
           userrec *  user           )  [virtual] user, 
std::string  newhost
)  [virtual]
         

       

     		
     
 
 

-Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. 
+Called whenever a change of a local users displayed host is attempted. 
 

-For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.
+Return 1 to deny the host change, or 0 to allow it. 
Parameters:

+  
+    
+    
+  
user The user whos host will be changed 
newhost The new hostname 

+

+
Returns:
1 to deny the host change, 0 to allow

+
 

-Definition at line 338 of file modules.cpp.
00338 { return true; };
+Definition at line 348 of file modules.cpp.
00348 { return 0; };
 

 

     

   

 

-

+

 
+  

   

     
       
-          
+          
-          
-        
-        
-          
-          
-          
-          
+          
-          
+          
@@ -872,32 +1100,47 @@ Definition at line 338

         
int Module::OnDelBan           void Module::OnChangeName           
           ( 
           userrec *  source, 
chanrec *  channel,  user, 
         

         

           
           
           std::string  banmask gecos
         

         

           
     
 
 

-Called whenever a ban is removed from a channel's list. 
+Called whenever a user's GECOS (realname) is changed. 
 

-Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
+This event triggers after the name has been set. 
Parameters:

+  
+    
+    
+  
user The user who's GECOS is being changed 
gecos The new GECOS being set on the user

+

+
 

-Definition at line 357 of file modules.cpp.
00357 { return 0; };
+Definition at line 377 of file modules.cpp.
00377 { };
 

 

     

   

 

-

+

 
-  
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      

   

     
       
-          
+          
-          
-          
-          
-          
+          
+          
-      

         
void Module::OnEvent           int Module::OnCheckBan           
           ( Event *  event           )  [virtual]userrec *  user, 
         

-    
chanrec *  chan
)  [virtual]

+    

 

 
@@ -907,23 +1150,30 @@ Definition at line 357

   

     
 
 

-Called whenever an Event class is sent to all module by another module. 
+Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. 
 

-Please see the documentation of Event::Send() for further information. The Event sent can always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID() before doing anything to the event data, and you should *not* change the event data in any way!
+This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. 
Parameters:

+  
+    
+    
+  
user The user joining the channel 
chan The channel being joined 

+

+
Returns:
1 to explicitly allow the join, 0 to proceed as normal

+
 

-Definition at line 351 of file modules.cpp.
00351 { return; };
+Definition at line 346 of file modules.cpp.
00346 { return 0; };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
@@ -931,32 +1181,8 @@ Definition at line 351
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
-          
+          
+          
@@ -975,28 +1201,50 @@ Definition at line 351

         
int Module::OnExtendedMode           int Module::OnCheckInvite           
           ( 
           userrec * 
            user, 
         

           
           void *  target, 
char  modechar, 
int  type, 
bool  mode_on, 
string_list &  paramschanrec *  chan
         

         

           
     
 
 

-Called whenever an extended mode is to be processed. 
+Called whenever a user joins a channel, to determine if invite checks should go ahead or not. 
 

-The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with Server::AddExtendedMode If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.
+This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. 
Parameters:

+  
+    
+    
+  
user The user joining the channel 
chan The channel being joined 

+

+
Returns:
1 to explicitly allow the join, 0 to proceed as normal

+
 

-Definition at line 318 of file modules.cpp.
00318 { return false; }
+Definition at line 343 of file modules.cpp.
00343 { return 0; };
 

 

     

   

 

-

+

 
@@ -1010,28 +1258,44 @@ Definition at line 318

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnGlobalConnect           int Module::OnCheckKey           
           ( 
           userrec *  user           )  [virtual] user, 
chanrec *  chan, 
std::string  keygiven
)  [virtual]
         

       

     		
     
 
 

-Called whenever a user connects, anywhere on the network. 
+Called whenever a user joins a channel, to determine if key checks should go ahead or not. 
 

-This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.
+This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. 
Parameters:

+  
+    
+    
+  
user The user joining the channel 
chan The channel being joined 

+

+
Returns:
1 to explicitly allow the join, 0 to proceed as normal

+
 

-Definition at line 355 of file modules.cpp.
00355 { };
+Definition at line 344 of file modules.cpp.
00344 { return 0; };
 

 

     

   

 

-

+

 
@@ -1045,23 +1309,30 @@ Definition at line 355

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnGlobalOper           int Module::OnCheckLimit           
           ( 
           userrec *  user           )  [virtual] user, 
chanrec *  chan
)  [virtual]
         

       

     		
     
 
 

-Called whenever a user is given usermode +o, anywhere on the network. 
+Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. 
 

-You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.
+This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. 
Parameters:

+  
+    
+    
+  
user The user joining the channel 
chan The channel being joined 

+

+
Returns:
1 to explicitly allow the join, 0 to proceed as normal

+
 

-Definition at line 354 of file modules.cpp.
00354 { };
+Definition at line 345 of file modules.cpp.
00345 { return 0; };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
@@ -1080,39 +1351,38 @@ Definition at line 354

         
void Module::OnInfo           bool Module::OnCheckReady           
           ( 
           userrec * 
            user          
     
 
 

-Called whenever a user types /INFO. 
+Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. 
 

-The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:

-<nick> :information here
+For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect. 
Parameters:

+  
+    
+  
user The user to check 

+

+
Returns:
true to indicate readiness, false if otherwise

+
 

-Definition at line 321 of file modules.cpp.
00321 { };
+Definition at line 338 of file modules.cpp.
00338 { return true; };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
+          
+          
-          
-          
+          
+          
@@ -1131,32 +1401,50 @@ Definition at line 321

         
int Module::OnKill           void Module::OnCleanup           
           ( userrec *  source, 
userrec *  dest, int  target_type, 
         

         

           
           std::string  reasonvoid *  item
         

         

           
     
 
 

-Called when a client is disconnected by KILL. 
+Called before your module is unloaded to clean up Extensibles. 
 

-If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!
+This method is called once for every user and channel on the network, so that when your module unloads it may clear up any remaining data in the form of Extensibles added using Extensible::Extend(). If the target_type variable is TYPE_USER, then void* item refers to a userrec*, otherwise it refers to a chanrec*. 
Parameters:

+  
+    
+    
+  
target_type The type of item being cleaned 
item A pointer to the item's class

+

+
 

-Definition at line 332 of file modules.cpp.
00332 { return 0; };
+Definition at line 388 of file modules.cpp.
00388 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
-          
+          
+        
+        
+          
+          
+          
+          
@@ -1175,38 +1463,46 @@ Definition at line 332

         
void Module::OnLoadModule           void Module::OnDecodeMetaData           
           ( Module *  mod, int  target_type, 
void *  target, 
         

         

           
           
           std::string  name extname, 
std::string  extdata
         

         

           
     
 
 

-Called whenever a module is loaded. 
+Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module. 
 

-mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).
+Please see src/modules/m_swhois.cpp for a working example of how to use this method call. 
Parameters:

+  
+    
+    
+    
+    
+  
target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL 
target The chanrec* or userrec* that data should be added to 
extname The extension name which is being sent 
extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData

+

+
 

-Definition at line 333 of file modules.cpp.
00333 { };
+Definition at line 373 of file modules.cpp.
00373 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
+          
-          
+          
-          
+          
@@ -1225,28 +1521,45 @@ Definition at line 333

         
int Module::OnLocalTopicChange           int Module::OnDelBan           
           ( 
           userrec *  user,  source, 
         

         

           
           
           chanrec *  chan,  channel, 
         

         

           
           
           std::string  topic banmask
         

         

           
     
 
 

-Called whenever a topic is changed by a local user. 
+Called whenever a ban is removed from a channel's list. 
 

-Return 1 to deny the topic change, or 0 to allow it.
+Return a non-zero value to 'eat' the mode change and prevent the ban from being removed. 
Parameters:

+  
+    
+    
+    
+  
source The user deleting the ban 
channel The channel the ban is being deleted from 
banmask The ban mask being deleted 

+

+
Returns:
1 to block the unban, 0 to continue as normal

+
 

-Definition at line 350 of file modules.cpp.
00350 { return 0; };
+Definition at line 357 of file modules.cpp.
00357 { return 0; };
 

 

     

   

 

-

+

 
@@ -1260,32 +1573,38 @@ Definition at line 350

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnOper           void Module::OnDelELine           
           ( 
           userrec *  user           )  [virtual] source, 
std::string  hostmask
)  [virtual]
         

       

     		
     
 
 

-Called whenever a user opers locally. 
+Called whenever a eline is deleted. 
 

-The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.
+This method is triggered after the line is deleted. 
Parameters:

+  
+    
+    
+  
source The user removing the line 
hostmask The hostmask to delete

+

+
 

-Definition at line 320 of file modules.cpp.
00320 { };
+Definition at line 387 of file modules.cpp.
00387 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
-          
+          
@@ -1304,32 +1623,38 @@ Definition at line 320

         
int Module::OnOperCompare           void Module::OnDelGLine           
           ( std::string  password, userrec *  source, 
         

         

           
           
           std::string  input hostmask
         

         

           
     
 
 

-Called whenever an oper password is to be compared to what a user has input. 
+Called whenever a gline is deleted. 
 

-The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.
+This method is triggered after the line is deleted. 
Parameters:

+  
+    
+    
+  
source The user removing the line 
hostmask The hostmask to delete

+

+
 

-Definition at line 353 of file modules.cpp.
00353 { return 0; };
+Definition at line 383 of file modules.cpp.
00383 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
-          
+          
@@ -1348,32 +1673,38 @@ Definition at line 353

         
void Module::OnPacketReceive           void Module::OnDelKLine           
           ( std::string &  data, userrec *  source, 
         

         

           
           
           std::string  serv hostmask
         

         

           
     
 
 

-Called after a packet is received from another irc server. 
+Called whenever a kline is deleted. 
 

-This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.
+This method is triggered after the line is deleted. 
Parameters:

+  
+    
+    
+  
source The user removing the line 
hostmask The hostmask to delete

+

+
 

-Definition at line 314 of file modules.cpp.
00314 { }
+Definition at line 385 of file modules.cpp.
00385 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
+          
+          
-          
+          
@@ -1392,44 +1723,38 @@ Definition at line 314

         
void Module::OnPacketTransmit           void Module::OnDelQLine           
           ( std::string &  data, userrec *  source, 
         

         

           
           
           std::string  serv nickmask
         

         

           
     
 
 

-Called before a packet is transmitted across the irc network between two irc servers. 
+Called whenever a qline is deleted. 
 

-This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.
+This method is triggered after the line is deleted. 
Parameters:

+  
+    
+    
+  
source The user removing the line 
hostmask The hostmask to delete

+

+
 

-Definition at line 313 of file modules.cpp.
00313 { }
+Definition at line 386 of file modules.cpp.
00386 { };
 

 

     

   

 

-

+

 
+  
+

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
-          
+          
+          
-          
-          
+          
+          
@@ -1448,56 +1773,1225 @@ Definition at line 313

         
int Module::OnPreCommand           void Module::OnDelZLine           
           ( std::string  command, 
char **  parameters, 
int  pcnt, userrec *  source, 
         

         

           
           userrec *  userstd::string  ipmask
         

         

           
     
 
 

-Called whenever any command is about to be executed. 
+Called whenever a zline is deleted. 
 

-This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using Server::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)
+This method is triggered after the line is deleted. 
Parameters:

+  
+    
+    
+  
source The user removing the line 
hostmask The hostmask to delete

+

+
 

-Definition at line 337 of file modules.cpp.
00337 { return 0; };
+Definition at line 384 of file modules.cpp.
00384 { };
 

 

     

   

 

-

+

 
+  
+

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
-          
+          
+          
+          
+          
-        
+      

         
int Module::OnRawMode           void Module::OnEvent           
           ( userrec *  user, 
chanrec *  chan, 
char  mode, Event *  event           )  [virtual]
         

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever an Event class is sent to all module by another module. 
+

+Please see the documentation of Event::Send() for further information. The Event sent can always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID() before doing anything to the event data, and you should *not* change the event data in any way! 
Parameters:

+  
+    
+  
event The Event class being received

+

+
+

+Definition at line 351 of file modules.cpp.
00351 { return; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnExtendedMode           ( userrec *  user, 
void *  target, 
char  modechar, 
int  type, 
bool  mode_on, 
string_list &  params
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever an extended mode is to be processed. 
+

+The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with Server::AddExtendedMode If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it. 
Parameters:

+  
+    
+    
+    
+    
+    
+    
+  
user The user issuing the mode 
target The user or channel having the mode set on them 
modechar The mode character being set 
type The type of mode (user or channel) being set 
mode_on True if the mode is being set, false if it is being unset 
params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)

+

+
+

+Definition at line 319 of file modules.cpp.
00319 { return false; }
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnGetServerDescription           ( std::string  servername, 
std::string &  description
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules. 
+

+You may change or define the description given in std::string &description. If you do, this description will be shown in the WHOIS fields. 
Parameters:

+  
+    
+    
+  
servername The servername being searched for 
description Alterable server description for this server

+

+
+

+Definition at line 367 of file modules.cpp.
00367 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+      
void Module::OnGlobalConnect           ( userrec *  user           )  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a user connects, anywhere on the network. 
+

+This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users. 
Parameters:

+  
+    
+  
user The user who is connecting

+

+
+

+Definition at line 355 of file modules.cpp.
00355 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+      
void Module::OnGlobalOper           ( userrec *  user           )  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a user is given usermode +o, anywhere on the network. 
+

+You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes. 
Parameters:

+  
+    
+  
user The user who is opering

+

+
+

+Definition at line 354 of file modules.cpp.
00354 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+      
void Module::OnInfo           ( userrec *  user           )  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a user types /INFO. 
+

+The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:

+<nick> :information here

+
Parameters:

+  
+    
+  
user The user issuing /INFO

+

+
+

+Definition at line 323 of file modules.cpp.
00323 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnKill           ( userrec *  source, 
userrec *  dest, 
std::string  reason
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called when a client is disconnected by KILL. 
+

+If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers or remote users. If you do so youre risking race conditions, desyncs and worse! 
Parameters:

+  
+    
+    
+    
+  
source The user sending the KILL 
dest The user being killed 
reason The kill reason 

+

+
Returns:
1 to prevent the kill, 0 to allow

+
+

+Definition at line 332 of file modules.cpp.
00332 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnLoadModule           ( Module *  mod, 
std::string  name
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a module is loaded. 
+

+mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module). 
Parameters:

+  
+    
+    
+  
mod A pointer to the new module 
name The new module's filename

+

+
+

+Definition at line 333 of file modules.cpp.
00333 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnLocalTopicChange           ( userrec *  user, 
chanrec *  chan, 
std::string  topic
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a topic is changed by a local user. 
+

+Return 1 to deny the topic change, or 0 to allow it. 
Parameters:

+  
+    
+    
+    
+    
+  
user The user changing the topic 
chan The channels who's topic is being changed 
topic The actual topic text 
1 to block the topic change, 0 to allow

+

+
+

+Definition at line 350 of file modules.cpp.
00350 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnMode           ( userrec *  user, 
void *  dest, 
int  target_type, 
std::string  text
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called after every MODE command sent from a user The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL. 
+

+The text variable contains the remainder of the mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3". 
Parameters:

+  
+    
+    
+    
+    
+  
user The user sending the MODEs 
dest The target of the modes (userrec* or chanrec*) 
target_type The type of target (TYPE_USER or TYPE_CHANNEL) 
text The actual modes and their parameters if any

+

+
+

+Definition at line 320 of file modules.cpp.
00320 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnOper           ( userrec *  user, 
std::string  opertype
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a user opers locally. 
+

+The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core. 
Parameters:

+  
+    
+    
+  
user The user who is opering up 
opertype The opers type name

+

+
+

+Definition at line 322 of file modules.cpp.
00322 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnOperCompare           ( std::string  password, 
std::string  input
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever an oper password is to be compared to what a user has input. 
+

+The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing. 
Parameters:

+  
+    
+    
+  
password The oper's password 
input The password entered 

+

+
Returns:
1 to match the passwords, 0 to do nothing

+
+

+Definition at line 353 of file modules.cpp.
00353 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnPostLocalTopicChange           ( userrec *  user, 
chanrec *  chan, 
std::string  topic
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a local topic has been changed. 
+

+To block topic changes you must use OnLocalTopicChange instead. 
Parameters:

+  
+    
+    
+    
+  
user The user changing the topic 
chan The channels who's topic is being changed 
topic The actual topic text

+

+
+

+Definition at line 366 of file modules.cpp.
00366 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnPreCommand           ( std::string  command, 
char **  parameters, 
int  pcnt, 
userrec *  user
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever any command is about to be executed. 
+

+This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using Server::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!) 
Parameters:

+  
+    
+    
+    
+    
+  
command The command being executed 
parameters An array of array of characters containing the parameters for the command 
pcnt The nuimber of parameters passed to the command 
user the user issuing the command 

+

+
Returns:
1 to block the command, 0 to allow

+
+

+Definition at line 337 of file modules.cpp.
00337 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnRawMode           ( userrec *  user, 
chanrec *  chan, 
char  mode, 
std::string  param, 
bool  adding, 
int  pcnt
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a mode character is processed. 
+

+Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED! 
Parameters:

+  
+    
+    
+    
+    
+    
+    
+  
user The user who is sending the mode 
chan The channel the mode is being sent to 
mode The mode character being set 
param The parameter for the mode or an empty string 
adding true of the mode is being added, false if it is being removed 
pcnt The parameter count for the mode (0 or 1) 

+

+
Returns:
1 to deny the mode, 0 to allow

+
+

+Definition at line 342 of file modules.cpp.
00342 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnRawSocketAccept           ( int  fd, 
std::string  ip, 
int  localport
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called immediately after any connection is accepted. 
+

+This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection. 
Parameters:

+  
+    
+    
+    
+  
fd The file descriptor returned from accept() 
ip The IP address of the connecting user 
localport The local port number the user connected to

+

+
+

+Definition at line 358 of file modules.cpp.
00358 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+      
void Module::OnRawSocketClose           ( int  fd           )  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called immediately before any socket is closed. 
+

+When this event is called, shutdown() has not yet been called on the socket. 
Parameters:

+  
+    
+  
fd The file descriptor of the socket prior to close()

+

+
+

+Definition at line 360 of file modules.cpp.
00360 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnRawSocketRead           ( int  fd, 
char *  buffer, 
unsigned int  count, 
int &  readresult
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called immediately before any read() operation on a client socket in the core. 
+

+This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult. 
Parameters:

+  
+    
+    
+    
+    
+  
fd The file descriptor of the socket 
buffer A char* buffer being read to 
count The size of the buffer 
readresult The amount of characters read, or 0 

+

+
Returns:
nonzero if the event was handled, in which case readresult must be valid on exit

+
+

+Definition at line 361 of file modules.cpp.
00361 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
int Module::OnRawSocketWrite           ( int  fd, 
char *  buffer, 
int  count
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called immediately before any write() operation on a user's socket in the core. 
+

+Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write(). 
Parameters:

+  
+    
+    
+    
+  
fd The file descriptor of the socket 
buffer A char* buffer being written 
Number of characters to write 

+

+
Returns:
Number of characters actually written or 0 if you didn't handle the operation

+
+

+Definition at line 359 of file modules.cpp.
00359 { return 0; };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+      
void Module::OnRehash           ( std::string  parameter           )  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called on rehash. 
+

+This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application. If a parameter is given, the core has done nothing. The module receiving the event can decide if this parameter has any relevence to it. 
Parameters:

+  
+    
+  
parameter The (optional) parameter given to REHASH from the user.

+

+
+

+Definition at line 316 of file modules.cpp.
00316 { }
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
-          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::OnRemoteKill           ( userrec *  source, 
userrec *  dest, 

           
           
           std::string  param,  reason
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called when an oper wants to disconnect a remote user via KILL. 
+

+
Parameters:

+  
+    
+    
+    
+  
source The user sending the KILL 
dest The user being killed 
reason The kill reason

+

+
+

+Definition at line 364 of file modules.cpp.
00364 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+      
char * Module::OnRequest           ( Request *  request           )  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Called whenever a Request class is sent to your module by another module. 
+

+Please see the documentation of Request::Send() for further information. The Request sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc). 
Parameters:

+  
+    
+  
request The Request class being received

+

+
+

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

+Referenced by Request::Send().
00352 { return NULL; };
+

+

+    

+

+
+  
+    

+      
+        
+          
+          
+          
+          
-          
-          
+          
+          
-          
-          
+          
+          
@@ -1516,38 +3010,45 @@ Definition at line 337
void Module::OnSendList           ( userrec *  user, 
         

         

           
           bool  adding, chanrec *  channel, 
         

         

           
           int  pcntchar  mode
         

         

           
     
 
 

-Called whenever a mode character is processed. 
+Called whenever a list is needed for a listmode. 
 

-Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!
+For example, when a /MODE channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle. 
Parameters:

+  
+    
+    
+    
+  
user The user requesting the list 
channel The channel the list is for 
mode The listmode which a list is being requested on

+

+
 

-Definition at line 342 of file modules.cpp.
00342 { return 0; };
+Definition at line 336 of file modules.cpp.
00336 { };
 

 

     

   

 

-

+

 
@@ -2601,7 +4317,12 @@ Definition at line 309

 Called whenever a user is about to register their connection (e.g. 
 

-before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.
+before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
+          
+          
-          
-          
+          
+          
-          
-          
+          
+          
@@ -1566,26 +3067,33 @@ Definition at line 342

         
void Module::OnRawSocketAccept           void Module::OnServerRaw           
           ( int  fd, std::string &  raw, 
         

         

           
           std::string  ip, bool  inbound, 
         

         

           
           int  localportuserrec *  user
         

         

           
     
 
 

-Called immediately after any connection is accepted. 
+Called when a raw command is transmitted or received. 
 

-This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.
+This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets. 
Parameters:

+  
+    
+    
+    
+  
raw The raw string in RFC1459 format 
inbound A flag to indicate wether the data is coming into the daemon or going out to the user 
user The user record sending the text, when inbound == true.

+

+
 

-Definition at line 358 of file modules.cpp.
00358 { };
+Definition at line 317 of file modules.cpp.
00317 { }
 

 

     

   

 

-

+

 
@@ -2566,9 +4276,15 @@ Definition at line 325

 Called when a user quits. 
 

-The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.
+The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
+          
+          
@@ -1601,44 +3109,43 @@ Definition at line 358

         
void Module::OnRawSocketClose           void Module::OnStats           
           ( int  fd          char  symbol          
            ) 
            [virtual]
         

     

 
 

-Called immediately before any socket is closed. 
+Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. 
 

-When this event is called, shutdown() has not yet been called on the socket.
+
Parameters:

+  
+    
+  
symbol the symbol provided to /STATS

+

+
 

-Definition at line 360 of file modules.cpp.
00360 { };
+Definition at line 347 of file modules.cpp.
00347 { };
 

 

     

   

 

-

+

 

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
+          
+          
-          
-          
+          
+          
-          
-          
+          
+          
@@ -1657,38 +3164,53 @@ Definition at line 360

         
int Module::OnRawSocketRead           void Module::OnSyncChannel           
           ( int  fd, 
char *  buffer, chanrec *  chan, 
         

         

           
           unsigned int  count, Module *  proto, 
         

         

           
           int &  readresultvoid *  opaque
         

         

           
     
 
 

-Called immediately before any read() operation on a client socket in the core. 
-

-This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.
+Allows modules to synchronize data which relates to channels during a netburst. 
+

+When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class Extensible -- There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this!

+For a good example of how to use this function, please see src/modules/m_chanprotect.cpp

+
Parameters:

+  
+    
+    
+    
+  
chan The channel being syncronized 
proto A pointer to the module handling network protocol 
opaque An opaque pointer set by the protocol module, should not be modified!

+

+
 

-Definition at line 361 of file modules.cpp.
00361 { return 0; };
+Definition at line 369 of file modules.cpp.
00369 { };
 

 

     

   

 

-

+

 
@@ -2531,15 +4223,24 @@ Definition at line 326

 Called whenever a user is about to NOTICE A user or a channel, before any processing is done. 
 

-Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.
+Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
+          
+          
-          
-          
+          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
@@ -1707,27 +3229,41 @@ Definition at line 361

         
int Module::OnRawSocketWrite           void Module::OnSyncChannelMetaData           
           ( int  fd, chanrec *  chan, 
         

         

           
           char *  buffer, Module *  proto, 
         

         

           
           int  countvoid *  opaque, 
std::string  extname
         

         

           
     
 
 

-Called immediately before any write() operation on a user's socket in the core. 
-

-Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().
+
 

-Definition at line 359 of file modules.cpp.
00359 { return 0; };
+Definition at line 371 of file modules.cpp.
00371 { };
 

 

     

   

 

-

+

 
@@ -1741,28 +3277,56 @@ Definition at line 359

   

     
       
-          
+          
-          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnRehash           void Module::OnSyncUser           
           (            )  [virtual]userrec *  user, 
Module *  proto, 
void *  opaque
)  [virtual]
         

       

     		
     
 
 

-Called on rehash. 
+Allows modules to synchronize data which relates to users during a netburst. 
 

-This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.
+When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class Extensible -- There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this! 
Parameters:

+  
+    
+    
+    
+  
user The user being syncronized 
proto A pointer to the module handling network protocol 
opaque An opaque pointer set by the protocol module, should not be modified!

+

+
 

-Definition at line 315 of file modules.cpp.
00315 { }
+Definition at line 368 of file modules.cpp.
00368 { };
 

 

     

   

 

-

+

 
@@ -1776,40 +3340,30 @@ Definition at line 315

   

     
       
-          
+          
-          
-          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
char * Module::OnRequest           void Module::OnSyncUserMetaData           
           ( Request *  request           )  [virtual]userrec *  user, 
Module *  proto, 
void *  opaque, 
std::string  extname
)  [virtual]
         

       

     		
     
 
 

-Called whenever a Request class is sent to your module by another module. 
-

-Please see the documentation of Request::Send() for further information. The Request sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
-

-Definition at line 352 of file modules.cpp.
+
 

-Referenced by Request::Send().
00352 { return NULL; };
+Definition at line 372 of file modules.cpp.
00372 { };
 

 

     

   

 

-

+

 
@@ -2475,9 +4160,16 @@ Definition at line 324

 Called before any nickchange, local or remote. 
 

-This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.
+This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
+          
+          
-          
-          
+          
+          
@@ -1828,43 +3382,34 @@ Referenced by Request::Send
     

         
void Module::OnSendList           void Module::OnUnloadModule           
           ( userrec *  user, 
chanrec *  channel, Module *  mod, 
         

         

           
           char  modestd::string  name
         

         

           
 
 

-Called whenever a list is needed for a listmode. 
+Called whenever a module is unloaded. 
 

-For example, when a /MODE channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.
+mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module). 
Parameters:

+  
+    
+    
+  
mod Pointer to the module being unloaded (still valid) 
name The filename of the module being unloaded

+

+
 

-Definition at line 336 of file modules.cpp.
00336 { };
+Definition at line 334 of file modules.cpp.
00334 { };
 

 

     

   

 

-

+

 
@@ -1878,26 +3423,31 @@ Definition at line 336

   

     
       
-          
+          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
-          
-        
-        
-          
-          
-          
+          
+          
+          
+          

         
void Module::OnServerRaw           void Module::OnUserConnect           
           ( std::string &  raw, 
bool  inbound, 
userrec *  user
)  [virtual]userrec *  user           )  [virtual]
         

       

     		
     
 
 

-Called when a raw command is transmitted or received. 
+Called when a user connects. 
 

-This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.
+The details of the connecting user are available to you in the parameter userrec *user 
Parameters:

+  
+    
+  
user The user who is connecting

+

+
 

-Definition at line 316 of file modules.cpp.
00316 { }
+Definition at line 309 of file modules.cpp.
00309 { }
 

 

     

   

 

-

+

 
@@ -2375,7 +4042,16 @@ Definition at line 317

 Called whenever a user is about to be kicked. 
 

-Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc.
+Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
+          
+          
@@ -1913,32 +3463,43 @@ Definition at line 316

         
void Module::OnStats           void Module::OnUserDisconnect           
           ( char  symbol          userrec *  user          
            ) 
            [virtual]
         

     

 
 

-Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. 
+Called whenever a user's socket is closed. 
 

+The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets. 
Parameters:

+  
+    
+  
user The user who is disconnecting

+

 
 

-Definition at line 347 of file modules.cpp.
00347 { };
+Definition at line 311 of file modules.cpp.
00311 { }
 

 

     

   

 

-

+

 
@@ -2319,9 +3979,16 @@ Called whenever a user is about to join a channel, before any processing is done
 

 Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.

 IMPORTANT NOTE!

-If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
+If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
-          
-          
+          
+          
@@ -1957,28 +3518,44 @@ Definition at line 347

         
void Module::OnUnloadModule           void Module::OnUserInvite           
           ( Module *  mod, userrec *  source, 
userrec *  dest, 
         

         

           
           std::string  namechanrec *  channel
         

         

           
     
 
 

-Called whenever a module is unloaded. 
+Called after a user has been successfully invited to a channel. 
 

-mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).
+You cannot prevent the invite from occuring using this function, to do that, use OnUserPreInvite instead. 
Parameters:

+  
+    
+    
+    
+  
source The user who is issuing the INVITE 
dest The user being invited 
channel The channel the user is being invited to

+

+
 

-Definition at line 334 of file modules.cpp.
00334 { };
+Definition at line 365 of file modules.cpp.
00365 { };
 

 

     

   

 

-

+

 
@@ -1992,28 +3569,55 @@ Definition at line 334

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnUserConnect           void Module::OnUserJoin           
           ( 
           userrec *  user           )  [virtual] user, 
chanrec *  channel
)  [virtual]
         

       

     		
     
 
 

-Called when a user connects. 
+Called when a user joins a channel. 
 

-The details of the connecting user are available to you in the parameter userrec *user
+The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel 
Parameters:

+  
+    
+    
+  
user The user who is joining 
channel The channel being joined

+

+
 

-Definition at line 308 of file modules.cpp.
00308 { }
+Definition at line 312 of file modules.cpp.
00312 { }
 

 

     

   

 

-

+

 
@@ -2027,23 +3631,31 @@ Definition at line 308

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
void Module::OnUserDisconnect           void Module::OnUserKick           
           ( 
           userrec *  user           )  [virtual] source, 
userrec *  user, 
chanrec *  chan, 
std::string  reason
)  [virtual]
         

       

     		
     
 
 

-Called whenever a user's socket is closed. 
+Called whenever a user is kicked. 
 

-The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.
+If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use Module::OnUserPreKick instead of this method. 
Parameters:

+  
+    
+    
+    
+    
+  
source The user issuing the kick 
user The user being kicked 
chan The channel the user is being kicked from 
reason The kick reason

+

+
 

-Definition at line 310 of file modules.cpp.
00310 { }
+Definition at line 341 of file modules.cpp.
00341 { };
 

 

     

   

 

-

+

 
@@ -2267,9 +3919,17 @@ Definition at line 327

 Called whenever a user is about to invite another user into a channel, before any processing is done. 
 

-Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.
+Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels. 
Parameters:

+  

   

     
       
-          
+          
@@ -2051,8 +3663,20 @@ Definition at line 310
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
@@ -2071,44 +3695,52 @@ Definition at line 310

         
void Module::OnUserJoin           void Module::OnUserMessage           
           ( 
           userrec * 
            user, 
         

           
           chanrec *  channelvoid *  dest, 
int  target_type, 
std::string  text
         

         

           
     
 
 

-Called when a user joins a channel. 
+Called after any PRIVMSG sent from a user. 
 

-The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel
+The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL. 
Parameters:

+  
+    
+    
+    
+    
+  
user The user sending the message 
dest The target of the message 
target_type The type of target (TYPE_USER or TYPE_CHANNEL) 
text the text being sent by the user

+

+
 

-Definition at line 311 of file modules.cpp.
00311 { }
+Definition at line 362 of file modules.cpp.
00362 { };
 

 

     

   

 

-

+

 
@@ -2217,9 +3863,15 @@ Definition at line 312

 Called after any nickchange, local or remote. 
 

-This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this.
+This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this. 
Parameters:

+  

   

     
       
-          
+          
-          
+          
-          
-          
+          
+          
-          
-          
+          
+          
-          
+          
@@ -2127,11 +3759,19 @@ Definition at line 311
@@ -2173,9 +3813,15 @@ Definition at line 341

 Called when a user parts a channel. 
 

-The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel
+The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel 
Parameters:

+  

         
void Module::OnUserKick           void Module::OnUserNotice           
           ( 
           userrec *  source,  user, 
         

         

           
           userrec *  user, void *  dest, 
         

         

           
           chanrec *  chan, int  target_type, 
         

         

           
           
           std::string  reason text
         

         

           
     
 
 

-Called whenever a user is kicked. 
+Called after any NOTICE sent from a user. 
 

-If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use Module::OnUserPreKick instead of this method.
+The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL. 
Parameters:

+  
+    
+    
+    
+    
+  
user The user sending the message 
dest The target of the message 
target_type The type of target (TYPE_USER or TYPE_CHANNEL) 
text the text being sent by the user

+

+
 

-Definition at line 341 of file modules.cpp.
00341 { };
+Definition at line 363 of file modules.cpp.
00363 { };
 

 

     

 

+    
+    
+  
user The user who is parting 
channel The channel being parted

+
+
 

-Definition at line 312 of file modules.cpp.
00312 { }
+Definition at line 313 of file modules.cpp.
00313 { }
 

 

     

 

+    
+    
+  
user The user changing their nick 
oldnick The old nickname of the user before the nickchange

+
+
 

-Definition at line 327 of file modules.cpp.
00327 { };
+Definition at line 329 of file modules.cpp.
00329 { };
 

 

     

 

+    
+    
+    
+  
source The user who is issuing the INVITE 
dest The user being invited 
channel The channel the user is being invited to 

+
+
Returns:
1 to deny the invite, 0 to allow

+
 

-Definition at line 323 of file modules.cpp.
00323 { return 0; };
+Definition at line 325 of file modules.cpp.
00325 { return 0; };
 

 

     

+    
+    
+  
user The user joining the channel 
cname The channel name being joined 

+
+
Returns:
1 To prevent the join, 0 to allow it.

+
 

-Definition at line 317 of file modules.cpp.
00317 { return 0; }
+Definition at line 318 of file modules.cpp.
00318 { return 0; }
 

 

     

 

+    
+    
+    
+    
+  
source The user issuing the kick 
user The user being kicked 
chan The channel the user is being kicked from 
reason The kick reason 

+
+
Returns:
1 to prevent the kick, 0 to allow it

+
 

 Definition at line 340 of file modules.cpp.
00340 { return 0; };
 

@@ -2431,9 +4107,18 @@ Definition at line 340
 

 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. 
 

-Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.
+Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. 
Parameters:

+  
+    
+    
+    
+    
+  
user The user sending the message 
dest The target of the message (chanrec* or userrec*) 
target_type The type of target (TYPE_USER or TYPE_CHANNEL) 
text Changeable text being sent by the user 

+

+
Returns:
1 to deny the NOTICE, 0 to allow it

+
 

-Definition at line 324 of file modules.cpp.
00324 { return 0; };
+Definition at line 326 of file modules.cpp.
00326 { return 0; };
 

 

     

 

+    
+    
+  
user The username changing their nick 
newnick Their new nickname 

+
+
Returns:
1 to deny the change, 0 to allow

+
 

-Definition at line 326 of file modules.cpp.
00326 { return 0; };
+Definition at line 328 of file modules.cpp.
00328 { return 0; };
 

 

     

 

+    
+    
+    
+    
+  
user The user sending the message 
dest The target of the message (chanrec* or userrec*) 
target_type The type of target (TYPE_USER or TYPE_CHANNEL) 
text Changeable text being sent by the user 

+
+
Returns:
1 to deny the NOTICE, 0 to allow it

+
 

-Definition at line 325 of file modules.cpp.
00325 { return 0; };
+Definition at line 327 of file modules.cpp.
00327 { return 0; };
 

 

     

   

 

-

+

 
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

   

     
@@ -2548,9 +4249,18 @@ Definition at line 325
           void Module::OnUserQuit           
           ( 
           userrec *  user           )  [virtual] user, 
std::string  message
)  [virtual]
         

       

     

 

+    
+    
+  
user The user who is quitting 
message The user's quit message

+
+
 

-Definition at line 309 of file modules.cpp.
00309 { }
+Definition at line 310 of file modules.cpp.
00310 { }
 

 

     

 

+    
+  
user The user registering

+
+
 

 Definition at line 339 of file modules.cpp.
00339 { };
 

@@ -2609,18 +4330,27 @@ Definition at line 339
     		
   

 

-

+

 
@@ -2634,11 +4364,17 @@ Definition at line 339
@@ -2680,9 +4416,153 @@ Definition at line 329

 Called whenever a /WHOIS is performed on a local user. 
 

-The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.
+The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising. 
Parameters:

+  

   

     
       
-          
+          
-          
-          
-          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          

         
string_list Module::OnUserSync           void Module::OnWallops           
           ( 
           userrec *  user           )  [virtual] user, 
std::string  text
)  [virtual]
         

       

     		
     
 
 

-Called during a netburst to sync user data. 
+Called after every WALLOPS command. 
 

-This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.
+
Parameters:

+  
+    
+    
+  
user The user sending the WALLOPS 
text The content of the WALLOPS message

+

+
 

-Definition at line 329 of file modules.cpp.
00329 { string_list empty; return empty; }
+Definition at line 375 of file modules.cpp.
00375 { };
 

 

     

 

+    
+    
+  
source The user issuing the WHOIS command 
dest The user who is being WHOISed

+
+
 

-Definition at line 322 of file modules.cpp.
00322 { };
+Definition at line 324 of file modules.cpp.
00324 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::ProtoSendMetaData           ( void *  opaque, 
int  target_type, 
void *  target, 
std::string  extname, 
std::string  extdata
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Implemented by modules which provide the ability to link servers. 
+

+These modules will implement this method, which allows metadata (extra data added to user and channel records using class Extensible, Extensible::Extend, etc) to be sent to other servers on a netburst and decoded at the other end by the same module on a different server.

+More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of how to use this function. 
Parameters:

+  
+    
+    
+    
+    
+    
+  
opaque An opaque pointer set by the protocol module, should not be modified! 
target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL 
target The chanrec* or userrec* that metadata should be sent for 
extname The extension name to send metadata for 
extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData

+

+
+

+Definition at line 374 of file modules.cpp.
00374 { };
+

+

+    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+      
void Module::ProtoSendMode           ( void *  opaque, 
int  target_type, 
void *  target, 
std::string  modeline
)  [virtual]

+    

+
+  
+    
+    
@@ -2690,7 +4570,7 @@ Definition at line 322

+       
+    
+
+

+Implemented by modules which provide the ability to link servers. 
+

+These modules will implement this method, which allows transparent sending of servermodes down the network link as a broadcast, without a module calling it having to know the format of the MODE command before the actual mode string.

+More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples of how to use this function.

+
Parameters:

+  
+    
+    
+    
+    
+  
opaque An opaque pointer set by the protocol module, should not be modified! 
target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL 
target The chanrec* or userrec* that modes should be sent for 
modeline The modes and parameters to be sent

+

+
+

+Definition at line 370 of file modules.cpp.
00370 { };
 

 

     

 

 
The documentation for this class was generated from the following files:
-
Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by 
+
Generated on Fri Dec 9 20:20:12 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.2.3