From a96514c284514116300794696f062c7fa6b1f79f Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 19:17:41 +0000 Subject: Added new docs for class InspIRCd and globals.h etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 172 +++++++++++++++++++-------------------- 1 file changed, 86 insertions(+), 86 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index da8947364..07293e12f 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -5,7 +5,7 @@
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
-

Module Class Reference

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +

Module Class Reference

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...

#include <modules.h> @@ -261,7 +261,7 @@ Inheritance diagram for Module:

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

Detailed Description

-Base class for all InspIRCd modules This class is the base class for InspIRCd modules. +Base class for all InspIRCd modules This class is the base class for InspIRCd modules.

All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.

@@ -302,7 +302,7 @@ Default constructor Creates a module class.

-Definition at line 228 of file modules.cpp.

00228 { }
+Definition at line 220 of file modules.cpp.
00220 { }
 

 

     
@@ -336,7 +336,7 @@ Default destructor destroys a module class.
 

 
 

-Definition at line 229 of file modules.cpp.
00229 { }
+Definition at line 221 of file modules.cpp.
00221 { }
 

 

     
@@ -371,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 240 of file modules.cpp.
+Definition at line 232 of file modules.cpp.
 

-References VF_VENDOR.
00240 { return Version(1,0,0,0,VF_VENDOR); }
+References VF_VENDOR.
00232 { return Version(1,0,0,0,VF_VENDOR); }
 

 

     
@@ -413,7 +413,7 @@ The module should modify the 005 numeric if needed to indicate its features. 

 
 

-Definition at line 250 of file modules.cpp.
00250 { };
+Definition at line 242 of file modules.cpp.
00242 { };
 

 

     
@@ -488,9 +488,9 @@ This function is called before many functions which check a users status on a ch
 

 
 

-Definition at line 249 of file modules.cpp.
+Definition at line 241 of file modules.cpp.
 

-References ACR_DEFAULT.
00249 { return ACR_DEFAULT; };
+References ACR_DEFAULT.
00241 { return ACR_DEFAULT; };
 

 

     
@@ -548,7 +548,7 @@ Return a non-zero value to 'eat' the mode change and prevent the ban from being
 
Returns:
1 to block the ban, 0 to continue as normal

 
 

-Definition at line 275 of file modules.cpp.
00275 { return 0; };
+Definition at line 267 of file modules.cpp.
00267 { return 0; };
 

 

     
@@ -612,7 +612,7 @@ This method is triggered after the line is added. 
Parameters:
 

 
 

-Definition at line 301 of file modules.cpp.
00301 { };
+Definition at line 293 of file modules.cpp.
00293 { };
 

 

     
@@ -676,7 +676,7 @@ This method is triggered after the line is added. 
Parameters:
 

 
 

-Definition at line 297 of file modules.cpp.
00297 { };
+Definition at line 289 of file modules.cpp.
00289 { };
 

 

     
@@ -740,7 +740,7 @@ This method is triggered after the line is added. 
Parameters:
 

 
 

-Definition at line 299 of file modules.cpp.
00299 { };
+Definition at line 291 of file modules.cpp.
00291 { };
 

 

     
@@ -804,7 +804,7 @@ This method is triggered after the line is added. 
Parameters:
 

 
 

-Definition at line 300 of file modules.cpp.
00300 { };
+Definition at line 292 of file modules.cpp.
00292 { };
 

 

     
@@ -868,7 +868,7 @@ This method is triggered after the line is added. 
Parameters:
 

 
 

-Definition at line 298 of file modules.cpp.
00298 { };
+Definition at line 290 of file modules.cpp.
00290 { };
 

 

     
@@ -908,7 +908,7 @@ This timer can be used to control timed features. Its period is not accurate eno
 
 
 

-Definition at line 254 of file modules.cpp.
00254 { };
+Definition at line 246 of file modules.cpp.
00246 { };
 

 

     
@@ -958,7 +958,7 @@ This event triggers after the host has been set. 
Parameters:<
 

 
 

-Definition at line 295 of file modules.cpp.
00295 { };
+Definition at line 287 of file modules.cpp.
00287 { };
 

 

     
@@ -1009,7 +1009,7 @@ return 1 to deny the name change, or 0 to allow it. 
Parameter
 
Returns:
1 to deny the GECOS change, 0 to allow

 
 

-Definition at line 268 of file modules.cpp.
00268 { return 0; };
+Definition at line 260 of file modules.cpp.
00260 { return 0; };
 

 

     
@@ -1060,7 +1060,7 @@ Return 1 to deny the host change, or 0 to allow it. 
Parameter
 
Returns:
1 to deny the host change, 0 to allow

 
 

-Definition at line 267 of file modules.cpp.
00267 { return 0; };
+Definition at line 259 of file modules.cpp.
00259 { return 0; };
 

 

     
@@ -1110,7 +1110,7 @@ This event triggers after the name has been set. 
Parameters:<
 

 
 

-Definition at line 296 of file modules.cpp.
00296 { };
+Definition at line 288 of file modules.cpp.
00288 { };
 

 

     
@@ -1161,7 +1161,7 @@ This method will always be called for each join, wether or not the user actually
 
Returns:
1 to explicitly allow the join, 0 to proceed as normal

 
 

-Definition at line 265 of file modules.cpp.
00265 { return 0; };
+Definition at line 257 of file modules.cpp.
00257 { return 0; };
 

 

     
@@ -1212,7 +1212,7 @@ This method will always be called for each join, wether or not the channel is ac
 
Returns:
1 to explicitly allow the join, 0 to proceed as normal

 
 

-Definition at line 262 of file modules.cpp.
00262 { return 0; };
+Definition at line 254 of file modules.cpp.
00254 { return 0; };
 

 

     
@@ -1269,7 +1269,7 @@ This method will always be called for each join, wether or not the channel is ac
 
Returns:
1 to explicitly allow the join, 0 to proceed as normal

 
 

-Definition at line 263 of file modules.cpp.
00263 { return 0; };
+Definition at line 255 of file modules.cpp.
00255 { return 0; };
 

 

     
@@ -1320,7 +1320,7 @@ This method will always be called for each join, wether or not the channel is ac
 
Returns:
1 to explicitly allow the join, 0 to proceed as normal

 
 

-Definition at line 264 of file modules.cpp.
00264 { return 0; };
+Definition at line 256 of file modules.cpp.
00256 { return 0; };
 

 

     
@@ -1361,7 +1361,7 @@ For example a module which implements ident lookups will continue to return fals
 
Returns:
true to indicate readiness, false if otherwise

 
 

-Definition at line 257 of file modules.cpp.
00257 { return true; };
+Definition at line 249 of file modules.cpp.
00249 { return true; };
 

 

     
@@ -1411,7 +1411,7 @@ This method is called once for every user and channel on the network, so that wh
 

 
 

-Definition at line 307 of file modules.cpp.
00307 { };
+Definition at line 299 of file modules.cpp.
00299 { };
 

 

     
@@ -1475,7 +1475,7 @@ Please see src/modules/m_swhois.cpp for a working example of how to use this met
 

 
 

-Definition at line 292 of file modules.cpp.
00292 { };
+Definition at line 284 of file modules.cpp.
00284 { };
 

 

     
@@ -1533,7 +1533,7 @@ Return a non-zero value to 'eat' the mode change and prevent the ban from being
 
Returns:
1 to block the unban, 0 to continue as normal

 
 

-Definition at line 276 of file modules.cpp.
00276 { return 0; };
+Definition at line 268 of file modules.cpp.
00268 { return 0; };
 

 

     
@@ -1583,7 +1583,7 @@ This method is triggered after the line is deleted. 
Parameter
 

 
 

-Definition at line 306 of file modules.cpp.
00306 { };
+Definition at line 298 of file modules.cpp.
00298 { };
 

 

     
@@ -1633,7 +1633,7 @@ This method is triggered after the line is deleted. 
Parameter
 

 
 

-Definition at line 302 of file modules.cpp.
00302 { };
+Definition at line 294 of file modules.cpp.
00294 { };
 

 

     
@@ -1683,7 +1683,7 @@ This method is triggered after the line is deleted. 
Parameter
 

 
 

-Definition at line 304 of file modules.cpp.
00304 { };
+Definition at line 296 of file modules.cpp.
00296 { };
 

 

     
@@ -1733,7 +1733,7 @@ This method is triggered after the line is deleted. 
Parameter
 

 
 

-Definition at line 305 of file modules.cpp.
00305 { };
+Definition at line 297 of file modules.cpp.
00297 { };
 

 

     
@@ -1783,7 +1783,7 @@ This method is triggered after the line is deleted. 
Parameter
 

 
 

-Definition at line 303 of file modules.cpp.
00303 { };
+Definition at line 295 of file modules.cpp.
00295 { };
 

 

     
@@ -1823,7 +1823,7 @@ Please see the documentation of 
 
 
 

-Definition at line 270 of file modules.cpp.
00270 { return; };
+Definition at line 262 of file modules.cpp.
00262 { return; };
 

 

     
@@ -1901,7 +1901,7 @@ The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the
 
 
 

-Definition at line 238 of file modules.cpp.
00238 { return false; }
+Definition at line 230 of file modules.cpp.
00230 { return false; }
 

 

     
@@ -1951,7 +1951,7 @@ You may change or define the description given in 286 of file modules.cpp.
00286 { };
+Definition at line 278 of file modules.cpp.
00278 { };
 

 

     
@@ -1991,7 +1991,7 @@ This event is informational only. You should not change any user information in
 
 
 

-Definition at line 274 of file modules.cpp.
00274 { };
+Definition at line 266 of file modules.cpp.
00266 { };
 

 

     
@@ -2031,7 +2031,7 @@ You cannot override this and prevent it from happening as it is already happened
 
 
 

-Definition at line 273 of file modules.cpp.
00273 { };
+Definition at line 265 of file modules.cpp.
00265 { };
 

 

     
@@ -2073,7 +2073,7 @@ The userrec will contain the information of the user who typed the command. Modu
 
 
 

-Definition at line 242 of file modules.cpp.
00242 { };
+Definition at line 234 of file modules.cpp.
00234 { };
 

 

     
@@ -2131,7 +2131,7 @@ If a client is killed by a server, e.g. a nickname collision or protocol error,
 
Returns:
1 to prevent the kill, 0 to allow

 
 

-Definition at line 251 of file modules.cpp.
00251 { return 0; };
+Definition at line 243 of file modules.cpp.
00243 { return 0; };
 

 

     
@@ -2181,7 +2181,7 @@ mod will contain a pointer to the module, and string will contain its name, for
 
 
 

-Definition at line 252 of file modules.cpp.
00252 { };
+Definition at line 244 of file modules.cpp.
00244 { };
 

 

     
@@ -2239,7 +2239,7 @@ Return 1 to deny the topic change, or 0 to allow it. 
Paramete
 

 
 

-Definition at line 269 of file modules.cpp.
00269 { return 0; };
+Definition at line 261 of file modules.cpp.
00261 { return 0; };
 

 

     
@@ -2303,7 +2303,7 @@ The text variable contains the remainder of the mode string after the target, e.
 
 
 

-Definition at line 239 of file modules.cpp.
00239 { };
+Definition at line 231 of file modules.cpp.
00231 { };
 

 

     
@@ -2353,7 +2353,7 @@ The userrec will contain the oper mode 'o' as this function is called after any
 
 
 

-Definition at line 241 of file modules.cpp.
00241 { };
+Definition at line 233 of file modules.cpp.
00233 { };
 

 

     
@@ -2404,7 +2404,7 @@ The password field (from the config file) is in 'password' and is to be compared
 
Returns:
1 to match the passwords, 0 to do nothing

 
 

-Definition at line 272 of file modules.cpp.
00272 { return 0; };
+Definition at line 264 of file modules.cpp.
00264 { return 0; };
 

 

     
@@ -2461,7 +2461,7 @@ To block topic changes you must use OnLocalTopicChange instead. 

 

 
 

-Definition at line 285 of file modules.cpp.
00285 { };
+Definition at line 277 of file modules.cpp.
00277 { };
 

 

     
@@ -2526,7 +2526,7 @@ This event occurs for all registered commands, wether they are registered in the
 
Returns:
1 to block the command, 0 to allow

 
 

-Definition at line 256 of file modules.cpp.
00256 { return 0; };
+Definition at line 248 of file modules.cpp.
00248 { return 0; };
 

 

     
@@ -2605,7 +2605,7 @@ Return 1 from this function to block the mode character from being processed ent
 
Returns:
1 to deny the mode, 0 to allow

 
 

-Definition at line 261 of file modules.cpp.
00261 { return 0; };
+Definition at line 253 of file modules.cpp.
00253 { return 0; };
 

 

     
@@ -2662,7 +2662,7 @@ This is intended for raw socket processing (e.g. modules which wrap the tcp conn
 
 
 

-Definition at line 277 of file modules.cpp.
00277 { };
+Definition at line 269 of file modules.cpp.
00269 { };
 

 

     
@@ -2702,7 +2702,7 @@ When this event is called, shutdown() has not yet been called on the socket. 

 
 

-Definition at line 279 of file modules.cpp.
00279 { };
+Definition at line 271 of file modules.cpp.
00271 { };
 

 

     
@@ -2767,7 +2767,7 @@ This occurs AFTER the select() or poll() so there is always data waiting to be r
 
Returns:
nonzero if the event was handled, in which case readresult must be valid on exit

 
 

-Definition at line 280 of file modules.cpp.
00280 { return 0; };
+Definition at line 272 of file modules.cpp.
00272 { return 0; };
 

 

     
@@ -2825,7 +2825,7 @@ Because this event is a low level event no user information is associated with i
 
Returns:
Number of characters actually written or 0 if you didn't handle the operation

 
 

-Definition at line 278 of file modules.cpp.
00278 { return 0; };
+Definition at line 270 of file modules.cpp.
00270 { return 0; };
 

 

     
@@ -2865,7 +2865,7 @@ This method is called prior to a /REHASH or when a SIGHUP is received from the o
 

 
 

-Definition at line 235 of file modules.cpp.
00235 { }
+Definition at line 227 of file modules.cpp.
00227 { }
 

 

     
@@ -2922,7 +2922,7 @@ Called when an oper wants to disconnect a remote user via KILL.
 
 
 

-Definition at line 283 of file modules.cpp.
00283 { };
+Definition at line 275 of file modules.cpp.
00275 { };
 

 

     
@@ -2962,9 +2962,9 @@ Please see the documentation of 271 of file modules.cpp.
+Definition at line 263 of file modules.cpp.
 

-Referenced by Request::Send().
00271 { return NULL; };
+Referenced by Request::Send().
00263 { return NULL; };
 

 

     
@@ -3021,7 +3021,7 @@ For example, when a /MODE channel +b (without any other parameters) is called, i
 
 
 

-Definition at line 255 of file modules.cpp.
00255 { };
+Definition at line 247 of file modules.cpp.
00247 { };
 

 

     
@@ -3078,7 +3078,7 @@ This method is the lowest level of handler available to a module. It will be cal
 
 
 

-Definition at line 236 of file modules.cpp.
00236 { }
+Definition at line 228 of file modules.cpp.
00228 { }
 

 

     
@@ -3118,7 +3118,7 @@ Called on all /STATS commands This method is triggered for all /STATS use, inclu
 
 
 

-Definition at line 266 of file modules.cpp.
00266 { };
+Definition at line 258 of file modules.cpp.
00258 { };
 

 

     
@@ -3177,7 +3177,7 @@ For a good example of how to use this function, please see src/modules/m_chanpro
 
 
 

-Definition at line 288 of file modules.cpp.
00288 { };
+Definition at line 280 of file modules.cpp.
00280 { };
 

 

     
@@ -3231,7 +3231,7 @@ Definition at line 288
 

 
 

-Definition at line 290 of file modules.cpp.
00290 { };
+Definition at line 282 of file modules.cpp.
00282 { };
 

 

     
@@ -3288,7 +3288,7 @@ When this function is called, it will be called from the module which implements
 
 
 

-Definition at line 287 of file modules.cpp.
00287 { };
+Definition at line 279 of file modules.cpp.
00279 { };
 

 

     
@@ -3342,7 +3342,7 @@ Definition at line 287
 

 
 

-Definition at line 291 of file modules.cpp.
00291 { };
+Definition at line 283 of file modules.cpp.
00283 { };
 

 

     
@@ -3392,7 +3392,7 @@ mod will contain a pointer to the module, and string will contain its name, for
 
 
 

-Definition at line 253 of file modules.cpp.
00253 { };
+Definition at line 245 of file modules.cpp.
00245 { };
 

 

     
@@ -3432,7 +3432,7 @@ The details of the connecting user are available to you in the parameter userrec
 
 
 

-Definition at line 230 of file modules.cpp.
00230 { }
+Definition at line 222 of file modules.cpp.
00222 { }
 

 

     
@@ -3472,7 +3472,7 @@ The details of the exiting user are available to you in the parameter userrec *u
 
 
 

-Definition at line 232 of file modules.cpp.
00232 { }
+Definition at line 224 of file modules.cpp.
00224 { }
 

 

     
@@ -3529,7 +3529,7 @@ You cannot prevent the invite from occuring using this function, to do that, use
 
 
 

-Definition at line 284 of file modules.cpp.
00284 { };
+Definition at line 276 of file modules.cpp.
00276 { };
 

 

     
@@ -3579,7 +3579,7 @@ The details of the joining user are available to you in the parameter userrec *u
 
 
 

-Definition at line 233 of file modules.cpp.
00233 { }
+Definition at line 225 of file modules.cpp.
00225 { }
 

 

     
@@ -3643,7 +3643,7 @@ If this method is called, the kick is already underway and cannot be prevented,
 
 
 

-Definition at line 260 of file modules.cpp.
00260 { };
+Definition at line 252 of file modules.cpp.
00252 { };
 

 

     
@@ -3707,7 +3707,7 @@ The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
 
 
 

-Definition at line 281 of file modules.cpp.
00281 { };
+Definition at line 273 of file modules.cpp.
00273 { };
 

 

     
@@ -3771,7 +3771,7 @@ The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
 
 
 

-Definition at line 282 of file modules.cpp.
00282 { };
+Definition at line 274 of file modules.cpp.
00274 { };
 

 

     
@@ -3821,7 +3821,7 @@ The details of the leaving user are available to you in the parameter userrec *u
 
 
 

-Definition at line 234 of file modules.cpp.
00234 { }
+Definition at line 226 of file modules.cpp.
00226 { }
 

 

     
@@ -3871,7 +3871,7 @@ This can be used to track users after nickchanges have been applied. Please note
 
 
 

-Definition at line 248 of file modules.cpp.
00248 { };
+Definition at line 240 of file modules.cpp.
00240 { };
 

 

     
@@ -3929,7 +3929,7 @@ Returning 1 from this function stops the process immediately, causing no output
 
Returns:
1 to deny the invite, 0 to allow

 
 

-Definition at line 244 of file modules.cpp.
00244 { return 0; };
+Definition at line 236 of file modules.cpp.
00236 { return 0; };
 

 

     
@@ -3988,7 +3988,7 @@ If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be
 
Returns:
1 To prevent the join, 0 to allow it.

 
 

-Definition at line 237 of file modules.cpp.
00237 { return 0; }
+Definition at line 229 of file modules.cpp.
00229 { return 0; }
 

 

     
@@ -4053,7 +4053,7 @@ Returning a value of 1 from this function stops the process immediately, causing
 
Returns:
1 to prevent the kick, 0 to allow it

 
 

-Definition at line 259 of file modules.cpp.
00259 { return 0; };
+Definition at line 251 of file modules.cpp.
00251 { return 0; };
 

 

     
@@ -4118,7 +4118,7 @@ Returning any nonzero value from this function stops the process immediately, ca
 
Returns:
1 to deny the NOTICE, 0 to allow it

 
 

-Definition at line 245 of file modules.cpp.
00245 { return 0; };
+Definition at line 237 of file modules.cpp.
00237 { return 0; };
 

 

     
@@ -4169,7 +4169,7 @@ This can be used to implement Q-lines etc. Please note that although you can see
 
Returns:
1 to deny the change, 0 to allow

 
 

-Definition at line 247 of file modules.cpp.
00247 { return 0; };
+Definition at line 239 of file modules.cpp.
00239 { return 0; };
 

 

     
@@ -4234,7 +4234,7 @@ Returning any nonzero value from this function stops the process immediately, ca
 
Returns:
1 to deny the NOTICE, 0 to allow it

 
 

-Definition at line 246 of file modules.cpp.
00246 { return 0; };
+Definition at line 238 of file modules.cpp.
00238 { return 0; };
 

 

     
@@ -4284,7 +4284,7 @@ The details of the exiting user are available to you in the parameter userrec *u
 
 
 

-Definition at line 231 of file modules.cpp.
00231 { }
+Definition at line 223 of file modules.cpp.
00223 { }
 

 

     
@@ -4324,7 +4324,7 @@ before the user is sent the MOTD etc). Modules can use this method if they are p
 
 
 

-Definition at line 258 of file modules.cpp.
00258 { };
+Definition at line 250 of file modules.cpp.
00250 { };
 

 

     
@@ -4374,7 +4374,7 @@ Called after every WALLOPS command.
 
 
 

-Definition at line 294 of file modules.cpp.
00294 { };
+Definition at line 286 of file modules.cpp.
00286 { };
 

 

     
@@ -4424,7 +4424,7 @@ The source parameter contains the details of the user who issued the WHOIS comma
 
 
 

-Definition at line 243 of file modules.cpp.
00243 { };
+Definition at line 235 of file modules.cpp.
00235 { };
 

 

     
@@ -4496,7 +4496,7 @@ More documentation to follow soon. Please see src/modules/m_swhois.cpp for examp
 
 
 

-Definition at line 293 of file modules.cpp.
00293 { };
+Definition at line 285 of file modules.cpp.
00285 { };
 

 

     
@@ -4562,7 +4562,7 @@ More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for
 
 
 

-Definition at line 289 of file modules.cpp.
00289 { };
+Definition at line 281 of file modules.cpp.
00281 { };
 

 

     
@@ -4570,7 +4570,7 @@ Definition at line 289
 
 
The documentation for this class was generated from the following files:
-
Generated on Wed Dec 14 15:55:50 2005 for InspIRCd by 
+
Generated on Wed Dec 14 19:16:27 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.2.3