From 097b2479d0393d8a8bada4a50708d7a2404045ca Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 12 Dec 2005 13:32:15 +0000 Subject: Added new docs for class SocketEngine git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 168 +++++++++++++++++++-------------------- 1 file changed, 84 insertions(+), 84 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index deef06e8c..5a348e263 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -302,7 +302,7 @@ Default constructor Creates a module class.
-Definition at line 307 of file modules.cpp.
00307 { } +Definition at line 301 of file modules.cpp.@@ -336,7 +336,7 @@ Default destructor destroys a module class.
-Definition at line 308 of file modules.cpp.
00308 { } +Definition at line 302 of file modules.cpp.@@ -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 321 of file modules.cpp. +Definition at line 313 of file modules.cpp.
-References VF_VENDOR.
00321 { return Version(1,0,0,0,VF_VENDOR); } +References VF_VENDOR.@@ -413,7 +413,7 @@ The module should modify the 005 numeric if needed to indicate its features.
-Definition at line 331 of file modules.cpp.
00331 { }; +Definition at line 323 of file modules.cpp.@@ -488,9 +488,9 @@ This function is called before many functions which check a users status on a ch
-Definition at line 330 of file modules.cpp. +Definition at line 322 of file modules.cpp.
-References ACR_DEFAULT.
00330 { return ACR_DEFAULT; }; +References ACR_DEFAULT.00322 { 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 356 of file modules.cpp.
00356 { return 0; }; +Definition at line 348 of file modules.cpp.@@ -612,7 +612,7 @@ This method is triggered after the line is added.
- Parameters:
-Definition at line 382 of file modules.cpp.
00382 { }; +Definition at line 374 of file modules.cpp.@@ -676,7 +676,7 @@ This method is triggered after the line is added.
- Parameters:
-Definition at line 378 of file modules.cpp.
00378 { }; +Definition at line 370 of file modules.cpp.@@ -740,7 +740,7 @@ This method is triggered after the line is added.
- Parameters:
-Definition at line 380 of file modules.cpp.
00380 { }; +Definition at line 372 of file modules.cpp.@@ -804,7 +804,7 @@ This method is triggered after the line is added.
- Parameters:
-Definition at line 381 of file modules.cpp.
00381 { }; +Definition at line 373 of file modules.cpp.@@ -868,7 +868,7 @@ This method is triggered after the line is added.
- Parameters:
-Definition at line 379 of file modules.cpp.
00379 { }; +Definition at line 371 of file modules.cpp.@@ -908,7 +908,7 @@ This timer can be used to control timed features. Its period is not accurate eno
-Definition at line 335 of file modules.cpp.
00335 { }; +Definition at line 327 of file modules.cpp.@@ -958,7 +958,7 @@ This event triggers after the host has been set.
- Parameters:<
-Definition at line 376 of file modules.cpp.
00376 { }; +Definition at line 368 of file modules.cpp.@@ -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 349 of file modules.cpp.
00349 { return 0; }; +Definition at line 341 of file modules.cpp.@@ -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 348 of file modules.cpp.
00348 { return 0; }; +Definition at line 340 of file modules.cpp.@@ -1110,7 +1110,7 @@ This event triggers after the name has been set.
- Parameters:<
-Definition at line 377 of file modules.cpp.
00377 { }; +Definition at line 369 of file modules.cpp.@@ -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 346 of file modules.cpp.
00346 { return 0; }; +Definition at line 338 of file modules.cpp.@@ -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 343 of file modules.cpp.
00343 { return 0; }; +Definition at line 335 of file modules.cpp.@@ -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 344 of file modules.cpp.
00344 { return 0; }; +Definition at line 336 of file modules.cpp.@@ -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 345 of file modules.cpp.
00345 { return 0; }; +Definition at line 337 of file modules.cpp.@@ -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 338 of file modules.cpp.
00338 { return true; }; +Definition at line 330 of file modules.cpp.@@ -1411,7 +1411,7 @@ This method is called once for every user and channel on the network, so that wh
-Definition at line 388 of file modules.cpp.
00388 { }; +Definition at line 380 of file modules.cpp.@@ -1475,7 +1475,7 @@ Please see src/modules/m_swhois.cpp for a working example of how to use this met
-Definition at line 373 of file modules.cpp.
00373 { }; +Definition at line 365 of file modules.cpp.@@ -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 357 of file modules.cpp.
00357 { return 0; }; +Definition at line 349 of file modules.cpp.@@ -1583,7 +1583,7 @@ This method is triggered after the line is deleted.
- Parameter
-Definition at line 387 of file modules.cpp.
00387 { }; +Definition at line 379 of file modules.cpp.@@ -1633,7 +1633,7 @@ This method is triggered after the line is deleted.
- Parameter
-Definition at line 383 of file modules.cpp.
00383 { }; +Definition at line 375 of file modules.cpp.@@ -1683,7 +1683,7 @@ This method is triggered after the line is deleted.
- Parameter
-Definition at line 385 of file modules.cpp.
00385 { }; +Definition at line 377 of file modules.cpp.@@ -1733,7 +1733,7 @@ This method is triggered after the line is deleted.
- Parameter
-Definition at line 386 of file modules.cpp.
00386 { }; +Definition at line 378 of file modules.cpp.@@ -1783,7 +1783,7 @@ This method is triggered after the line is deleted.
- Parameter
-Definition at line 384 of file modules.cpp.
00384 { }; +Definition at line 376 of file modules.cpp.@@ -1823,7 +1823,7 @@ Please see the documentation of
-Definition at line 351 of file modules.cpp.
00351 { return; }; +Definition at line 343 of file modules.cpp.@@ -1901,7 +1901,7 @@ The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the
-Definition at line 319 of file modules.cpp.
00319 { return false; } +Definition at line 311 of file modules.cpp.@@ -1951,7 +1951,7 @@ You may change or define the description given in 367 of file modules.cpp.
00367 { }; +Definition at line 359 of file modules.cpp.@@ -1991,7 +1991,7 @@ This event is informational only. You should not change any user information in
-Definition at line 355 of file modules.cpp.
00355 { }; +Definition at line 347 of file modules.cpp.@@ -2031,7 +2031,7 @@ You cannot override this and prevent it from happening as it is already happened
-Definition at line 354 of file modules.cpp.
00354 { }; +Definition at line 346 of file modules.cpp.@@ -2073,7 +2073,7 @@ The userrec will contain the information of the user who typed the command. Modu
-Definition at line 323 of file modules.cpp.
00323 { }; +Definition at line 315 of file modules.cpp.@@ -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 332 of file modules.cpp.
00332 { return 0; }; +Definition at line 324 of file modules.cpp.@@ -2181,7 +2181,7 @@ mod will contain a pointer to the module, and string will contain its name, for
-Definition at line 333 of file modules.cpp.
00333 { }; +Definition at line 325 of file modules.cpp.@@ -2239,7 +2239,7 @@ Return 1 to deny the topic change, or 0 to allow it.
- Paramete
-Definition at line 350 of file modules.cpp.
00350 { return 0; }; +Definition at line 342 of file modules.cpp.@@ -2303,7 +2303,7 @@ The text variable contains the remainder of the mode string after the target, e.
-Definition at line 320 of file modules.cpp.
00320 { }; +Definition at line 312 of file modules.cpp.@@ -2353,7 +2353,7 @@ The userrec will contain the oper mode 'o' as this function is called after any
-Definition at line 322 of file modules.cpp.
00322 { }; +Definition at line 314 of file modules.cpp.@@ -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 353 of file modules.cpp.
00353 { return 0; }; +Definition at line 345 of file modules.cpp.@@ -2461,7 +2461,7 @@ To block topic changes you must use OnLocalTopicChange instead.
-Definition at line 366 of file modules.cpp.
00366 { }; +Definition at line 358 of file modules.cpp.@@ -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 337 of file modules.cpp.
00337 { return 0; }; +Definition at line 329 of file modules.cpp.@@ -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 342 of file modules.cpp.
00342 { return 0; }; +Definition at line 334 of file modules.cpp.@@ -2662,7 +2662,7 @@ This is intended for raw socket processing (e.g. modules which wrap the tcp conn
-Definition at line 358 of file modules.cpp.
00358 { }; +Definition at line 350 of file modules.cpp.@@ -2702,7 +2702,7 @@ When this event is called, shutdown() has not yet been called on the socket.
-Definition at line 360 of file modules.cpp.
00360 { }; +Definition at line 352 of file modules.cpp.@@ -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 361 of file modules.cpp.
00361 { return 0; }; +Definition at line 353 of file modules.cpp.@@ -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 359 of file modules.cpp.
00359 { return 0; }; +Definition at line 351 of file modules.cpp.@@ -2865,7 +2865,7 @@ This method is called prior to a /REHASH or when a SIGHUP is received from the o
-Definition at line 316 of file modules.cpp.
00316 { } +Definition at line 308 of file modules.cpp.@@ -2922,7 +2922,7 @@ Called when an oper wants to disconnect a remote user via KILL.
-Definition at line 364 of file modules.cpp.
00364 { }; +Definition at line 356 of file modules.cpp.@@ -2962,9 +2962,9 @@ Please see the documentation of 352 of file modules.cpp. +Definition at line 344 of file modules.cpp.
-Referenced by Request::Send().
00352 { return NULL; }; +Referenced by Request::Send().@@ -3021,7 +3021,7 @@ For example, when a /MODE channel +b (without any other parameters) is called, i
-Definition at line 336 of file modules.cpp.
00336 { }; +Definition at line 328 of file modules.cpp.@@ -3078,7 +3078,7 @@ This method is the lowest level of handler available to a module. It will be cal
-Definition at line 317 of file modules.cpp.
00317 { } +Definition at line 309 of file modules.cpp.@@ -3118,7 +3118,7 @@ Called on all /STATS commands This method is triggered for all /STATS use, inclu
-Definition at line 347 of file modules.cpp.
00347 { }; +Definition at line 339 of file modules.cpp.@@ -3177,7 +3177,7 @@ For a good example of how to use this function, please see src/modules/m_chanpro
-Definition at line 369 of file modules.cpp.
00369 { }; +Definition at line 361 of file modules.cpp.@@ -3231,7 +3231,7 @@ Definition at line 369
-Definition at line 371 of file modules.cpp.
00371 { }; +Definition at line 363 of file modules.cpp.@@ -3288,7 +3288,7 @@ When this function is called, it will be called from the module which implements
-Definition at line 368 of file modules.cpp.
00368 { }; +Definition at line 360 of file modules.cpp.@@ -3342,7 +3342,7 @@ Definition at line 368
-Definition at line 372 of file modules.cpp.
00372 { }; +Definition at line 364 of file modules.cpp.@@ -3392,7 +3392,7 @@ mod will contain a pointer to the module, and string will contain its name, for
-Definition at line 334 of file modules.cpp.
00334 { }; +Definition at line 326 of file modules.cpp.@@ -3432,7 +3432,7 @@ The details of the connecting user are available to you in the parameter userrec
-Definition at line 309 of file modules.cpp.
00309 { } +Definition at line 303 of file modules.cpp.@@ -3472,7 +3472,7 @@ The details of the exiting user are available to you in the parameter userrec *u
-Definition at line 311 of file modules.cpp.
00311 { } +Definition at line 305 of file modules.cpp.@@ -3529,7 +3529,7 @@ You cannot prevent the invite from occuring using this function, to do that, use
-Definition at line 365 of file modules.cpp.
00365 { }; +Definition at line 357 of file modules.cpp.@@ -3579,7 +3579,7 @@ The details of the joining user are available to you in the parameter userrec *u
-Definition at line 312 of file modules.cpp.
00312 { } +Definition at line 306 of file modules.cpp.@@ -3643,7 +3643,7 @@ If this method is called, the kick is already underway and cannot be prevented,
-Definition at line 341 of file modules.cpp.
00341 { }; +Definition at line 333 of file modules.cpp.@@ -3707,7 +3707,7 @@ The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
-Definition at line 362 of file modules.cpp.
00362 { }; +Definition at line 354 of file modules.cpp.@@ -3771,7 +3771,7 @@ The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
-Definition at line 363 of file modules.cpp.
00363 { }; +Definition at line 355 of file modules.cpp.@@ -3821,7 +3821,7 @@ The details of the leaving user are available to you in the parameter userrec *u
-Definition at line 313 of file modules.cpp.
00313 { } +Definition at line 307 of file modules.cpp.@@ -3871,7 +3871,7 @@ This can be used to track users after nickchanges have been applied. Please note
-Definition at line 329 of file modules.cpp.
00329 { }; +Definition at line 321 of file modules.cpp.@@ -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 325 of file modules.cpp.
00325 { return 0; }; +Definition at line 317 of file modules.cpp.@@ -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 318 of file modules.cpp.
00318 { return 0; } +Definition at line 310 of file modules.cpp.@@ -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 340 of file modules.cpp.
00340 { return 0; }; +Definition at line 332 of file modules.cpp.@@ -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 326 of file modules.cpp.
00326 { return 0; }; +Definition at line 318 of file modules.cpp.@@ -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 328 of file modules.cpp.
00328 { return 0; }; +Definition at line 320 of file modules.cpp.@@ -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 327 of file modules.cpp.
00327 { return 0; }; +Definition at line 319 of file modules.cpp.@@ -4284,7 +4284,7 @@ The details of the exiting user are available to you in the parameter userrec *u
-Definition at line 310 of file modules.cpp.
00310 { } +Definition at line 304 of file modules.cpp.@@ -4324,7 +4324,7 @@ before the user is sent the MOTD etc). Modules can use this method if they are p
-Definition at line 339 of file modules.cpp.
00339 { }; +Definition at line 331 of file modules.cpp.@@ -4374,7 +4374,7 @@ Called after every WALLOPS command.
-Definition at line 375 of file modules.cpp.
00375 { }; +Definition at line 367 of file modules.cpp.@@ -4424,7 +4424,7 @@ The source parameter contains the details of the user who issued the WHOIS comma
-Definition at line 324 of file modules.cpp.
00324 { }; +Definition at line 316 of file modules.cpp.@@ -4496,7 +4496,7 @@ More documentation to follow soon. Please see src/modules/m_swhois.cpp for examp
-Definition at line 374 of file modules.cpp.
00374 { }; +Definition at line 366 of file modules.cpp.@@ -4562,7 +4562,7 @@ More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for
-Definition at line 370 of file modules.cpp.
00370 { }; +Definition at line 362 of file modules.cpp.-@@ -4570,7 +4570,7 @@ Definition at line 370
The documentation for this class was generated from the following files:
Generated on Fri Dec 9 20:20:12 2005 for InspIRCd by +
Generated on Mon Dec 12 13:31:12 2005 for InspIRCd by1.4.4-20050815