From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 555 ++++++++++++++++++++++----------------- 1 file changed, 312 insertions(+), 243 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index f17ba5067..c32b72a62 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -1,90 +1,108 @@ -Module class Reference +InspIRCd: Module class Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

Module Class Reference

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

Module Class Reference

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

#include <modules.h>

-Inheritance diagram for Module:

Inheritance graph
- - - -
[legend]
Collaboration diagram for Module:

Collaboration graph
- - - -
[legend]
List of all members. +Inherits classbase. +

+List of all members.

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

Public Member Functions

 Module ()
 Default constructor creates a module class.

virtual ~Module ()
 Default destructor destroys a module class.

virtual Version GetVersion ()
 Returns the version number of a Module.

virtual void OnUserConnect (userrec *user)
 Called when a user connects.

virtual void OnUserQuit (userrec *user)
 Called when a user quits.

virtual void OnUserJoin (userrec *user, chanrec *channel)
 Called when a user joins a channel.

virtual void OnUserPart (userrec *user, chanrec *channel)
 Called when a user parts a channel.

virtual void OnPacketTransmit (char *p)
 Called before a packet is transmitted across the irc network between two irc servers.

virtual void OnPacketReceive (char *p)
 Called after a packet is received from another irc server.

virtual void OnRehash ()
 Called on rehash.

virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)
 Called when a raw command is transmitted or received.

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

virtual int OnUserPreJoin (userrec *user, chanrec *chan, const char *cname)
 Called whenever a user is about to join a channel, before any processing is done.

virtual void OnOper (userrec *user)
 Called whenever a user opers locally.

virtual void OnInfo (userrec *user)
 Called whenever a user types /INFO.

virtual void OnWhois (userrec *source, userrec *dest)
 Called whenever a /WHOIS is performed on a local user.

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.

virtual int OnUserPreNotice (userrec *user, void *dest, int target_type, std::string text)
 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

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

 Module ()
 Default constructor creates a module class.

virtual ~Module ()
 Default destructor destroys a module class.

virtual Version GetVersion ()
 Returns the version number of a Module.

virtual void OnUserConnect (userrec *user)
 Called when a user connects.

virtual void OnUserQuit (userrec *user)
 Called when a user quits.

virtual void OnUserJoin (userrec *user, chanrec *channel)
 Called when a user joins a channel.

virtual void OnUserPart (userrec *user, chanrec *channel)
 Called when a user parts a channel.

virtual void OnPacketTransmit (char *p)
 Called before a packet is transmitted across the irc network between two irc servers.

virtual void OnPacketReceive (char *p)
 Called after a packet is received from another irc server.

virtual void OnRehash ()
 Called on rehash.

virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)
 Called when a raw command is transmitted or received.

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

virtual int OnUserPreJoin (userrec *user, chanrec *chan, const char *cname)
 Called whenever a user is about to join a channel, before any processing is done.

virtual void OnOper (userrec *user)
 Called whenever a user opers locally.

virtual void OnInfo (userrec *user)
 Called whenever a user types /INFO.

virtual void OnWhois (userrec *source, userrec *dest)
 Called whenever a /WHOIS is performed on a local user.

virtual int 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 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.

virtual int OnUserPreNotice (userrec *user, void *dest, int target_type, std::string &text)
 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

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

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.

-Definition at line 116 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 126 of file modules.h.

Constructor & Destructor Documentation

- +
-
+ - - + + @@ -100,26 +118,26 @@ Definition at line 116 of
Module::Module (   )   ) 

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

-Definition at line 285 of file modules.cpp. +Definition at line 297 of file modules.cpp.

-

00285 { }
+
00297 { }

- +
-
+ - + - - + + @@ -135,27 +153,27 @@ Definition at line 285
Module::~Module Module::~Module (   )   )  [virtual]

-Default destructor destroys a module class. +Default destructor destroys a module class.

-Definition at line 286 of file modules.cpp. +Definition at line 298 of file modules.cpp.

-

00286 { }
+
00298 { }

Member Function Documentation

- +
-
+ - - + + @@ -171,44 +189,44 @@ Definition at line 286
Version Module::GetVersion (   )   )  [virtual]

-Returns the version number of a Module. +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 297 of file modules.cpp. +Definition at line 309 of file modules.cpp.

-

00297 { return Version(1,0,0,0); }
+
00309 { return Version(1,0,0,0); }
-

- +

+

-
+ - + - + - + - + @@ -228,7 +246,7 @@ Definition at line 297
int Module::OnAccessCheck (  userrec *   source, source,
userrec *   dest, dest,
chanrec *   channel, channel,
int   access_type access_type

-Called before an action which requires a channel privilage check. +Called before an action which requires a channel privilage check.

This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are:

@@ -244,25 +262,25 @@ 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 304 of file modules.cpp. +Definition at line 317 of file modules.cpp.

-References ACR_DEFAULT. +References ACR_DEFAULT.

-

00304 { return ACR_DEFAULT; };
+
00317 { return ACR_DEFAULT; };
-

- +

+

-
+ - - + + @@ -278,58 +296,58 @@ References ACR_DEFAULT.
string_list Module::OnChannelSync (  chanrec *   chan )  chan  )  [virtual]

-Called during a netburst to sync channel data. +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 306 of file modules.cpp. +Definition at line 319 of file modules.cpp.

-References string_list. +References string_list.

-

00306 { string_list empty; return empty; }
+
00319 { string_list empty; return empty; }

- +
-
+ - + - + - + - + - + - + @@ -349,27 +367,27 @@ References string_list.
int Module::OnExtendedMode (  userrec *   user, user,
void *   target, target,
char   modechar, modechar,
int   type, type,
bool   mode_on, mode_on,
string_list &   params params

-Called whenever an extended mode is to be processed. +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.

-Definition at line 296 of file modules.cpp. +Definition at line 308 of file modules.cpp.

-

00296 { return false; }
+
00308 { return false; }

- +
-
+ - - + + @@ -385,28 +403,28 @@ Definition at line 296
void Module::OnInfo (  userrec *   user )  user  )  [virtual]

-Called whenever a user types /INFO. +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

-Definition at line 299 of file modules.cpp. +Definition at line 311 of file modules.cpp.

-

00299 { };
+
00311 { };

- +
-
+ - - + + @@ -422,27 +440,27 @@ Definition at line 299
void Module::OnOper (  userrec *   user )  user  )  [virtual]

-Called whenever a user opers locally. +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.

-Definition at line 298 of file modules.cpp. +Definition at line 310 of file modules.cpp.

-

00298 { };
+
00310 { };

- +
-
+ - - + + @@ -458,27 +476,27 @@ Definition at line 298
void Module::OnPacketReceive (  char *   p )  p  )  [virtual]

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

The packet is represented as a char*, as it should be regarded as a buffer, and not a string. 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.

-Definition at line 292 of file modules.cpp. +Definition at line 304 of file modules.cpp.

-

00292 { }
+
00304 { }

- +
-
+ - - + + @@ -494,26 +512,26 @@ Definition at line 292
void Module::OnPacketTransmit (  char *   p )  p  )  [virtual]

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

The packet is represented as a char*, as it should be regarded as a buffer, and not a string. 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.

-Definition at line 291 of file modules.cpp. +Definition at line 303 of file modules.cpp.

-

00291 { }
+
00303 { }

- +
-
+ - - + + @@ -529,38 +547,38 @@ Definition at line 291
void Module::OnRehash (   )   )  [virtual]

-Called on rehash. +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.

-Definition at line 293 of file modules.cpp. +Definition at line 305 of file modules.cpp.

-

00293 { }
+
00305 { }

- +
-
+ - + - + - + @@ -580,27 +598,27 @@ Definition at line 293
void Module::OnServerRaw (  std::string &   raw, raw,
bool   inbound, inbound,
userrec *   user user

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

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.

-Definition at line 294 of file modules.cpp. +Definition at line 306 of file modules.cpp.

-

00294 { }
+
00306 { }

- +
-
+ - - + + @@ -616,32 +634,32 @@ Definition at line 294
void Module::OnUserConnect (  userrec *   user )  user  )  [virtual]

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

The details of the connecting user are available to you in the parameter userrec *user

-Definition at line 287 of file modules.cpp. +Definition at line 299 of file modules.cpp.

-

00287 { }
+
00299 { }

- +
-
+ - + - + @@ -661,32 +679,32 @@ Definition at line 287
void Module::OnUserJoin (  userrec *   user, user,
chanrec *   channel channel

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

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

-Definition at line 289 of file modules.cpp. +Definition at line 301 of file modules.cpp.

-

00289 { }
+
00301 { }

- +
-
+ - + - + @@ -706,38 +724,89 @@ Definition at line 289 + +
void Module::OnUserPart (  userrec *   user, user,
chanrec *   channel channel

-Called when a user parts a channel. +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

-Definition at line 290 of file modules.cpp. +Definition at line 302 of file modules.cpp.

-

00290 { }
+
00302 { }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnUserPreInvite ( userrec *  source,
userrec *  dest,
chanrec *  channel
)  [virtual]
+
+ + + +
+   + + +

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

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

+

00313 { return 0; };

- +
-
+ - + - + - + @@ -757,46 +826,46 @@ Definition at line 290
int Module::OnUserPreJoin (  userrec *   user, user,
chanrec *   chan, chan,
const char *   cname cname

-Called whenever a user is about to join a channel, before any processing is done. +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.

-Definition at line 295 of file modules.cpp. +Definition at line 307 of file modules.cpp.

-

00295 { return 0; }
+
00307 { return 0; }
-

- +

+

-
+ - + - + - + - - + + @@ -816,32 +885,32 @@ Definition at line 295
int Module::OnUserPreMessage (  userrec *   user, user,
void *   dest, dest,
int   target_type, target_type,
std::string   textstd::string &  text

-Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. +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.

-Definition at line 301 of file modules.cpp. +Definition at line 314 of file modules.cpp.

-

00301 { return 0; };
+
00314 { return 0; };
-

- +

+

-
+ - + - + @@ -861,44 +930,44 @@ Definition at line 301
int Module::OnUserPreNick (  userrec *   user, user,
std::string   newnick newnick

-Called before any nickchange, local or remote. +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. 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.

-Definition at line 303 of file modules.cpp. +Definition at line 316 of file modules.cpp.

-

00303 { return 0; };
+
00316 { return 0; };
-

- +

+

-
+ - + - + - + - - + + @@ -918,27 +987,27 @@ Definition at line 303
int Module::OnUserPreNotice (  userrec *   user, user,
void *   dest, dest,
int   target_type, target_type,
std::string   textstd::string &  text

-Called whenever a user is about to NOTICE A user or a channel, before any processing is done. +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. +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.

-Definition at line 302 of file modules.cpp. +Definition at line 315 of file modules.cpp.

-

00302 { return 0; };
+
00315 { return 0; };

- +
-
+ - - + + @@ -954,27 +1023,27 @@ Definition at line 302
void Module::OnUserQuit (  userrec *   user )  user  )  [virtual]

-Called when a user quits. +Called when a user quits.

The details of the exiting user are available to you in the parameter userrec *user

-Definition at line 288 of file modules.cpp. +Definition at line 300 of file modules.cpp.

-

00288 { }
+
00300 { }
-

- +

+

-
+ - - + + @@ -990,34 +1059,34 @@ Definition at line 288
string_list Module::OnUserSync (  userrec *   user )  user  )  [virtual]

-Called during a netburst to sync user data. +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 305 of file modules.cpp. +Definition at line 318 of file modules.cpp.

-References string_list. +References string_list.

-

00305 { string_list empty; return empty; }
+
00318 { string_list empty; return empty; }

- +
-
+ - + - + @@ -1037,21 +1106,21 @@ References string_list.
void Module::OnWhois (  userrec *   source, source,
userrec *   dest dest

-Called whenever a /WHOIS is performed on a local user. +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.

-Definition at line 300 of file modules.cpp. +Definition at line 312 of file modules.cpp.

-

00300 { };
+
00312 { };
The documentation for this class was generated from the following files: -
Generated on Sun May 2 00:09:41 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:33 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
-- cgit v1.3.1-10-gc9f91