From 9c8b44176b47d2186c88743dc1f68023c26d780b Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 4 Apr 2005 18:13:55 +0000 Subject: Added new documentation for ELine class and OnUserPostNick method git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@977 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 112 ++++++++++++++++++++++++++++----------- 1 file changed, 80 insertions(+), 32 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index a10ce0a29..527a07eb2 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -75,24 +75,27 @@ Inherits classbase. virtual int OnUserPreNick (userrec *user, std::string newnick)  Called before any nickchange, local or remote.

-virtual int OnAccessCheck (userrec *source, userrec *dest, chanrec *channel, int access_type) +virtual void OnUserPostNick (userrec *user, std::string oldnick) - Called before an action which requires a channel privilage check.

-virtual string_list OnUserSync (userrec *user) + Called after any nickchange, local or remote.

+virtual int OnAccessCheck (userrec *source, userrec *dest, chanrec *channel, int access_type) - Called during a netburst to sync user data.

-virtual string_list OnChannelSync (chanrec *chan) + Called before an action which requires a channel privilage check.

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

-virtual void On005Numeric (std::string &output) + Called during a netburst to sync user data.

+virtual string_list OnChannelSync (chanrec *chan) - Called when a 005 numeric is about to be output.

-virtual int OnKill (userrec *source, userrec *dest, std::string reason) + Called during a netburst to sync channel data.

+virtual void On005Numeric (std::string &output) - Called when a client is disconnected by KILL.

-virtual void OnLoadModule (Module *mod, std::string name) + Called when a 005 numeric is about to be output.

+virtual int OnKill (userrec *source, userrec *dest, std::string reason) - Called whenever a module is loaded.

+ Called when a client is disconnected by KILL.

+virtual void OnLoadModule (Module *mod, std::string name) + + Called whenever a module is loaded.

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -208,7 +211,7 @@ Definition at line 316 -

+

@@ -238,13 +241,13 @@ Called when a 005 numeric is about to be output.

The module should modify the 005 numeric if needed to indicate its features.

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

-

00327 { };
+
00328 { };
-

+

@@ -307,15 +310,15 @@ This function is called before many functions which check a users status on a ch
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).

-Definition at line 324 of file modules.cpp. +Definition at line 325 of file modules.cpp.

References ACR_DEFAULT.

-

00324 { return ACR_DEFAULT; };
+
00325 { return ACR_DEFAULT; };
-

+

@@ -345,11 +348,11 @@ Called during a netburst to sync channel data.

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.

-Definition at line 326 of file modules.cpp. +Definition at line 327 of file modules.cpp.

References string_list.

-

00326 { string_list empty; return empty; }
+
00327 { string_list empty; return empty; }
@@ -459,7 +462,7 @@ Definition at line 318 -

+

@@ -504,13 +507,13 @@ 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. If you do so youre risking race conditions, desyncs and worse!

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

-

00328 { return 0; };
+
00329 { return 0; };
-

+

@@ -549,9 +552,9 @@ 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).

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

-

00329 { };
+
00330 { };
@@ -875,6 +878,51 @@ Definition at line 309 +

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Module::OnUserPostNick ( userrec *  user,
std::string  oldnick
)  [virtual]
+
+ + + + + +
+   + + +

+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. +

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

+

00324 { };
+

@@ -1073,7 +1121,7 @@ Definition at line 321

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. 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. +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.

Definition at line 323 of file modules.cpp.

@@ -1174,7 +1222,7 @@ Definition at line 307

-

+

@@ -1204,11 +1252,11 @@ Called during a netburst to sync user data.

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.

-Definition at line 325 of file modules.cpp. +Definition at line 326 of file modules.cpp.

References string_list.

-

00325 { string_list empty; return empty; }
+
00326 { string_list empty; return empty; }
@@ -1259,7 +1307,7 @@ Definition at line 319

The documentation for this class was generated from the following files: -
Generated on Sat Apr 2 19:27:06 2005 for InspIRCd by +
Generated on Mon Apr 4 18:12:53 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91