From afb51347b493a6ab54fcc8595b4a3f46972ce18f Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 17 Apr 2004 12:33:39 +0000 Subject: Added new documentation to cover ircd_connector git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@629 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 413 +++++++++++++++++++++++++++------------ 1 file changed, 288 insertions(+), 125 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index c882ab073..9022d36dc 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -80,6 +80,12 @@ Inheritance diagram for Server:



virtual bool MatchText (std::string sliteral, std::string spattern)  Matches text against a glob pattern.

+virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user) + Calls the handler for a command, either implemented by the core or by another module.

+virtual void ChangeHost (userrec *user, std::string host) + Change displayed hostname of a user.

+virtual void ChangeGECOS (userrec *user, std::string gecos) + Change GECOS (fullname) of a user.

Detailed Description

Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. @@ -88,7 +94,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 240 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 241 of file modules.h.

Constructor & Destructor Documentation

@@ -215,13 +221,13 @@ This allows modules to add extra commands into the command table. You must place typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.

-Definition at line 183 of file modules.cpp. +Definition at line 188 of file modules.cpp.

References createcommand().

-

00184 {
-00185         createcommand(cmd,f,flags,minparams);
-00186 }
+
00189 {
+00190         createcommand(cmd,f,flags,minparams);
+00191 }
@@ -282,28 +288,182 @@ Adds an extended mode letter which is parsed by a module This allows modules to

+x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.

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

References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.

-

00294 {
-00295         if (type == MT_SERVER)
-00296         {
-00297                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00298                 return false;
-00299         }
-00300         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00301         {
-00302                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00303                 return false;
-00304         }
-00305         if ((params_when_on>1) || (params_when_off>1))
-00306         {
-00307                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00308                 return false;
-00309         }
-00310         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00311 }
+
00309 {
+00310         if (type == MT_SERVER)
+00311         {
+00312                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00313                 return false;
+00314         }
+00315         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00316         {
+00317                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00318                 return false;
+00319         }
+00320         if ((params_when_on>1) || (params_when_off>1))
+00321         {
+00322                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00323                 return false;
+00324         }
+00325         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00326 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::CallCommandHandler ( std::string   commandname, 
char **   parameters, 
int   pcnt, 
userrec *   user
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Calls the handler for a command, either implemented by the core or by another module.
+

+You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a  or 

+) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.
+

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

+
00179 {
+00180         call_handler(commandname.c_str(),parameters,pcnt,user);
+00181 }
+
    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::ChangeGECOS ( userrec *   user, 
std::string   gecos
)  [virtual]

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Change GECOS (fullname) of a user.
+

+You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.
+

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

+
00267 {
+00268         ChangeName(user,gecos.c_str());
+00269 }
+
    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::ChangeHost ( userrec *   user, 
std::string   host
)  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

+Change displayed hostname of a user.
+

+You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.
+

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

+
00262 {
+00263         ChangeDisplayedHost(user,host.c_str());
+00264 }
 
    		
   

 

@@ -393,11 +553,11 @@ Attempts to look up a user's privilages on a channel.
 

 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
 

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

-
00272 {
-00273         return cmode(User,Chan);
-00274 }
+
00287 {
+00288         return cmode(User,Chan);
+00289 }
 
    
   
 
@@ -440,11 +600,11 @@ Returns true if two users share a common channel.
 

 This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.
 

-Definition at line 234 of file modules.cpp.
+Definition at line 239 of file modules.cpp.
 

-
00235 {
-00236         return (common_channels(u1,u2) != 0);
-00237 }
+
00240 {
+00241         return (common_channels(u1,u2) != 0);
+00242 }
 
    
   
 
@@ -478,11 +638,11 @@ Returns a count of the number of users on a channel.
 

 This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
 

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

-
00314 {
-00315         return usercount(c);
-00316 }
+
00329 {
+00330         return usercount(c);
+00331 }
 
    
   
 
@@ -516,11 +676,11 @@ Attempts to look up a channel and return a pointer to it.
 

 This function will return NULL if the channel does not exist.
 

-Definition at line 266 of file modules.cpp.
+Definition at line 281 of file modules.cpp.
 

-
00267 {
-00268         return FindChan(channel.c_str());
-00269 }
+
00282 {
+00283         return FindChan(channel.c_str());
+00284 }
 
    
   
 
@@ -554,11 +714,11 @@ Attempts to look up a nick and return a pointer to it.
 

 This function will return NULL if the nick does not exist.
 

-Definition at line 261 of file modules.cpp.
+Definition at line 276 of file modules.cpp.
 

-
00262 {
-00263         return Find(nick);
-00264 }
+
00277 {
+00278         return Find(nick);
+00279 }
 
    
   
 
@@ -591,11 +751,11 @@ Returns the information of the server as returned by the /ADMIN command.
 

 See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.
 

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

-
00287 {
-00288         return Admin(getadminname(),getadminemail(),getadminnick());
-00289 }
+
00302 {
+00303         return Admin(getadminname(),getadminemail(),getadminnick());
+00304 }
 
    
   
 
@@ -628,11 +788,11 @@ Returns the network name, global to all linked servers.
 

 
 

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

-
00282 {
-00283         return getnetworkname();
-00284 }
+
00297 {
+00298         return getnetworkname();
+00299 }
 
    
   
 
@@ -665,11 +825,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

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

-
00277 {
-00278         return getservername();
-00279 }
+
00292 {
+00293         return getservername();
+00294 }
 
    
   
 
@@ -703,11 +863,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 256 of file modules.cpp.
+Definition at line 271 of file modules.cpp.
 

-
00257 {
-00258         return (isnick(nick.c_str()) != 0);
-00259 }
+
00272 {
+00273         return (isnick(nick.c_str()) != 0);
+00274 }
 
    
   
 
@@ -759,7 +919,7 @@ This is similar to svsjoin and can be used to implement redirection, etc. On suc
 Definition at line 157 of file modules.cpp.
 

 
00158 {
-00159         return add_channel(user,cname.c_str(),key.c_str());
+00159         return add_channel(user,cname.c_str(),key.c_str(),true);
 00160 }
 
    
   
@@ -803,11 +963,11 @@ Writes a log string.
 

 This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.
 

-Definition at line 178 of file modules.cpp.
+Definition at line 183 of file modules.cpp.
 

-
00179 {
-00180         log(level,"%s",s.c_str());
-00181 }
+
00184 {
+00185         log(level,"%s",s.c_str());
+00186 }
 
    
   
 
@@ -909,7 +1069,7 @@ This is similar to svspart and can be used to implement redirection, etc. Althou
 Definition at line 162 of file modules.cpp.
 

 
00163 {
-00164         return del_channel(user,cname.c_str(),reason.c_str());
+00164         return del_channel(user,cname.c_str(),reason.c_str(),false);
 00165 }
 
    
   
@@ -957,9 +1117,12 @@ Once you call this function, userrec* user will immediately become INVALID. You
 

 Definition at line 172 of file modules.cpp.
 

+References userrec::nick.
+

 
00173 {
-00174         kill_link(user,reason.c_str());
-00175 }
+00174         send_network_quit(user->nick,reason.c_str());
+00175         kill_link(user,reason.c_str());
+00176 }
 
    
   
 
@@ -1002,11 +1165,11 @@ Sends a line of text down a TCP/IP socket.
 

 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
 

-Definition at line 193 of file modules.cpp.
+Definition at line 198 of file modules.cpp.
 

-
00194 {
-00195         Write(Socket,"%s",s.c_str());
-00196 }
+
00199 {
+00200         Write(Socket,"%s",s.c_str());
+00201 }
 
    
   
 
@@ -1061,18 +1224,18 @@ Sends text from a user to a channel (mulicast).
 

 This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).
 

-Definition at line 222 of file modules.cpp.
-

-
00223 {
-00224         if (IncludeSender)
-00225         {
-00226                 WriteChannel(Channel,User,"%s",s.c_str());
-00227         }
-00228         else
-00229         {
-00230                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00231         }
-00232 }
+Definition at line 227 of file modules.cpp.
+

+
00228 {
+00229         if (IncludeSender)
+00230         {
+00231                 WriteChannel(Channel,User,"%s",s.c_str());
+00232         }
+00233         else
+00234         {
+00235                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00236         }
+00237 }
 
    
   
 
@@ -1121,18 +1284,18 @@ Sends text from a user to one or more channels (mulicast).
 

 This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.
 

-Definition at line 239 of file modules.cpp.
-

-
00240 {
-00241         if (IncludeSender)
-00242         {
-00243                 WriteCommon(User,"%s",text.c_str());
-00244         }
-00245         else
-00246         {
-00247                 WriteCommonExcept(User,"%s",text.c_str());
-00248         }
-00249 }
+Definition at line 244 of file modules.cpp.
+

+
00245 {
+00246         if (IncludeSender)
+00247         {
+00248                 WriteCommon(User,"%s",text.c_str());
+00249         }
+00250         else
+00251         {
+00252                 WriteCommonExcept(User,"%s",text.c_str());
+00253         }
+00254 }
 
    
   
 
@@ -1181,11 +1344,11 @@ Sends text from a user to a socket.
 

 This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
 

-Definition at line 203 of file modules.cpp.
+Definition at line 208 of file modules.cpp.
 

-
00204 {
-00205         WriteFrom(Socket,User,"%s",s.c_str());
-00206 }
+
00209 {
+00210         WriteFrom(Socket,User,"%s",s.c_str());
+00211 }
 
    
   
 
@@ -1241,13 +1404,13 @@ modes[2] = user->nick;

 Srv->SendMode(modes,3,user);

 The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!
 

-Definition at line 188 of file modules.cpp.
+Definition at line 193 of file modules.cpp.
 

 References server_mode().
 

-
00189 {
-00190         server_mode(parameters,pcnt,user);
-00191 }
+
00194 {
+00195         server_mode(parameters,pcnt,user);
+00196 }
 
    
   
 
@@ -1328,11 +1491,11 @@ Sends text from the server to a socket.
 

 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
 

-Definition at line 198 of file modules.cpp.
+Definition at line 203 of file modules.cpp.
 

-
00199 {
-00200         WriteServ(Socket,"%s",s.c_str());
-00201 }
+
00204 {
+00205         WriteServ(Socket,"%s",s.c_str());
+00206 }
 
    
   
 
@@ -1385,22 +1548,22 @@ The format will become:

 :localserver TEXT

 Which is useful for numerics and server notices to single users, etc.
 

-Definition at line 208 of file modules.cpp.
+Definition at line 213 of file modules.cpp.
 

-References connection::fd.
+References connection::fd.
 

-
00209 {
-00210         if (!Source)
-00211         {
-00212                 // if source is NULL, then the message originates from the local server
-00213                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00214         }
-00215         else
+
00214 {
+00215         if (!Source)
 00216         {
-00217                 // otherwise it comes from the user specified
-00218                 WriteTo(Source,Dest,"%s",s.c_str());
+00217                 // if source is NULL, then the message originates from the local server
+00218                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
 00219         }
-00220 }
+00220         else
+00221         {
+00222                 // otherwise it comes from the user specified
+00223                 WriteTo(Source,Dest,"%s",s.c_str());
+00224         }
+00225 }
 
    
   
 
@@ -1498,17 +1661,17 @@ Sends a WALLOPS message.
 

 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
 

-Definition at line 251 of file modules.cpp.
+Definition at line 256 of file modules.cpp.
 

-
00252 {
-00253         WriteWallOps(User,"%s",text.c_str());
-00254 }
+
00257 {
+00258         WriteWallOps(User,false,"%s",text.c_str());
+00259 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Thu Apr 8 19:13:16 2004 for InspIRCd by
+
Generated on Sat Apr 17 13:31:54 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91