From a753fb1bc711e10794e939e424f3cdd703116d82 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 2 Apr 2004 12:38:41 +0000 Subject: Added support for modules to create commands - this needs a proof-of-concept module yet, do not use unless you like to live dangerously. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@351 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 128 +++++++++++++++++++++++++++++++-------- 1 file changed, 102 insertions(+), 26 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 7fd4956d7..926b2a40a 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -42,8 +42,10 @@ Inheritance diagram for Module:



virtual void OnRehash ()  Called on rehash.

-virtual void Module::OnServerRaw (string &raw, bool inbound) +virtual void OnServerRaw (std::string &raw, bool inbound)  Called when a raw command is transmitted or received.

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

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -52,7 +54,7 @@ All modules must inherit from this class, its methods will be called when irc se

-Definition at line 65 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 71 of file modules.h.

Constructor & Destructor Documentation

@@ -82,9 +84,9 @@ Default constructor creates a module class.

-Definition at line 27 of file modules.cpp. +Definition at line 88 of file modules.cpp.

-

00027 { }
+
00088 { }
@@ -117,9 +119,9 @@ Default destructor destroys a module class.

-Definition at line 28 of file modules.cpp. +Definition at line 89 of file modules.cpp.

-

00028 { }
+
00089 { }
 
    
   
 
@@ -153,9 +155,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 37 of file modules.cpp.
+Definition at line 99 of file modules.cpp.
 

-
00037 { return Version(1,0,0,0); }
+
00099 { return Version(1,0,0,0); }
 
    
   
 
@@ -221,22 +223,46 @@ Called before a packet is transmitted across the irc network between two irc ser
 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.    
   
 
-

+

 
+  
+

   

     
       
-          
+          
-          
-          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
-          
+          
+        
+        
+          
+          
+          
+          
@@ -256,9 +282,14 @@ The packet is represented as a char*, as it should be regarded as a buffer, and
     
+
00098 { }
+

         
 virtual void Module::Module::OnServerRaw  bool Module::OnExtendedMode 
           ( string &   raw, userrec *   user, 
chanrec *   chan, 
char   modechar, 
int   type, 
         

         

           
           
           bool   inbound  mode_on, 
string_list &   params
         

         

           
 
 

-Called when a raw command is transmitted or received.
+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 not a channel mode, chanrec* chan is null, and should not be read from or written to.
+

+Definition at line 98 of file modules.cpp.
 

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

 

 

@@ -290,9 +321,54 @@ 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 35 of file modules.cpp.
+Definition at line 96 of file modules.cpp.
+

+
00096 { }
+
    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Module::OnServerRaw ( std::string &   raw, 
bool   inbound
)  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

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

+Definition at line 97 of file modules.cpp.
 

-
00035 { }
+
00097 { }
 
    

   

 

@@ -326,9 +402,9 @@ Called when a user connects.
 

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

-Definition at line 29 of file modules.cpp.
+Definition at line 90 of file modules.cpp.
 

-
00029 { }
+
00090 { }
 
    
   
 
@@ -371,9 +447,9 @@ 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 31 of file modules.cpp.
+Definition at line 92 of file modules.cpp.
 

-
00031 { }
+
00092 { }
 
    
   
 
@@ -416,9 +492,9 @@ 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 32 of file modules.cpp.
+Definition at line 93 of file modules.cpp.
 

-
00032 { }
+
00093 { }
 
    
   
 
@@ -452,15 +528,15 @@ Called when a user quits.
 

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

-Definition at line 30 of file modules.cpp.
+Definition at line 91 of file modules.cpp.
 

-
00030 { }
+
00091 { }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Sun Mar 30 19:36:13 2003 for InspIRCd by
+
Generated on Fri Apr 2 13:37:42 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91