From 48e477893fdc3cd87b46e445b1e3e2d1395c4b94 Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 16:07:04 +0000 Subject: Removed depreciated docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2420 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 675 +++++++++++++++++++++------------------ 1 file changed, 357 insertions(+), 318 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 8b98f4482..065d3386c 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -27,6 +27,9 @@ Inheritance diagram for Server:

virtual ~Server ()  Default destructor.
+ServerConfig * GetConfig () + + Obtains a pointer to the server's ServerConfig object.
virtual void SendOpers (std::string s)  Sends text to all opers.
@@ -331,11 +334,11 @@ 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'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded.

-Definition at line 414 of file modules.cpp. +Definition at line 419 of file modules.cpp.

-References createcommand().

00415 {
-00416         createcommand(cmd,f,flags,minparams,source);
-00417 }
+References createcommand().
00420 {
+00421         createcommand(cmd,f,flags,minparams,source);
+00422 }
 

 

     
@@ -391,11 +394,11 @@ Adds a E-line The E-line is enforced as soon as it is added.
 

 The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
 

-Definition at line 658 of file modules.cpp.
+Definition at line 663 of file modules.cpp.
 

-References add_eline().
00659 {
-00660         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00661 }
+References add_eline().
00664 {
+00665         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00666 }
 

 

     
@@ -435,14 +438,14 @@ This call is used to implement modes like +q and +a. The characteristics of thes
 (4) The mode and its parameter are NOT stored in the channels modes structure

 It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.
 

-Definition at line 582 of file modules.cpp.
+Definition at line 587 of file modules.cpp.
 

-References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
00583 {
-00584         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00585         if (res)
-00586                 ModeMakeList(modechar);
-00587         return res;
-00588 }
+References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
00588 {
+00589         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00590         if (res)
+00591                 ModeMakeList(modechar);
+00592         return res;
+00593 }
 

 

     
@@ -504,34 +507,34 @@ Adds an extended mode letter which is parsed by a module.
 

 This allows modules to add extra mode letters, e.g. +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 554 of file modules.cpp.
-

-References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
00555 {
-00556         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
-00557         {
-00558                 if (type == MT_SERVER)
-00559                 {
-00560                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00561                         return false;
-00562                 }
-00563                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+Definition at line 559 of file modules.cpp.
+

+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
00560 {
+00561         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
+00562         {
+00563                 if (type == MT_SERVER)
 00564                 {
-00565                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00565                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
 00566                         return false;
 00567                 }
-00568                 if ((params_when_on>1) || (params_when_off>1))
+00568                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 00569                 {
-00570                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00570                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
 00571                         return false;
 00572                 }
-00573                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00574         }
-00575         else
-00576         {
-00577                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
-00578         }
-00579         return false;
-00580 }
+00573                 if ((params_when_on>1) || (params_when_off>1))
+00574                 {
+00575                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00576                         return false;
+00577                 }
+00578                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00579         }
+00580         else
+00581         {
+00582                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
+00583         }
+00584         return false;
+00585 }
 

 

     
@@ -587,11 +590,11 @@ Adds a G-line The G-line is propogated to all of the servers in the mesh and enf
 

 The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
 

-Definition at line 638 of file modules.cpp.
+Definition at line 643 of file modules.cpp.
 

-References add_gline().
00639 {
-00640         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00641 }
+References add_gline().
00644 {
+00645         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00646 }
 

 

     
@@ -647,11 +650,11 @@ Adds a K-line The K-line is enforced as soon as it is added.
 

 The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
 

-Definition at line 653 of file modules.cpp.
+Definition at line 658 of file modules.cpp.
 

-References add_kline().
00654 {
-00655         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00656 }
+References add_kline().
00659 {
+00660         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00661 }
 

 

     
@@ -707,11 +710,11 @@ Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enf
 

 The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
 

-Definition at line 643 of file modules.cpp.
+Definition at line 648 of file modules.cpp.
 

-References add_qline().
00644 {
-00645         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00646 }
+References add_qline().
00649 {
+00650         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00651 }
 

 

     
@@ -806,11 +809,11 @@ Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enf
 

 The duration must be in seconds, however you can use the Server::CalcDuration method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
 

-Definition at line 648 of file modules.cpp.
+Definition at line 653 of file modules.cpp.
 

-References add_zline().
00649 {
-00650         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00651 }
+References add_zline().
00654 {
+00655         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00656 }
 

 

     
@@ -845,11 +848,11 @@ Calculates a duration This method will take a string containing a formatted dura
 

 "1w2d") and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.
 

-Definition at line 688 of file modules.cpp.
+Definition at line 693 of file modules.cpp.
 

-References duration().
00689 {
-00690         return duration(delta.c_str());
-00691 }
+References duration().
00694 {
+00695         return duration(delta.c_str());
+00696 }
 

 

     
@@ -906,9 +909,9 @@ Calls the handler for a command, either implemented by the core or by another mo
 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 399 of file modules.cpp.
00400 {
-00401         call_handler(commandname.c_str(),parameters,pcnt,user);
-00402 }
+Definition at line 404 of file modules.cpp.
00405 {
+00406         call_handler(commandname.c_str(),parameters,pcnt,user);
+00407 }
 

 

     
@@ -952,11 +955,11 @@ 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 497 of file modules.cpp.
+Definition at line 502 of file modules.cpp.
 

-References ChangeName().
00498 {
-00499         ChangeName(user,gecos.c_str());
-00500 }
+References ChangeName().
00503 {
+00504         ChangeName(user,gecos.c_str());
+00505 }
 

 

     
@@ -1000,11 +1003,11 @@ 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 492 of file modules.cpp.
+Definition at line 497 of file modules.cpp.
 

-References ChangeDisplayedHost().
00493 {
-00494         ChangeDisplayedHost(user,host.c_str());
-00495 }
+References ChangeDisplayedHost().
00498 {
+00499         ChangeDisplayedHost(user,host.c_str());
+00500 }
 

 

     
@@ -1048,9 +1051,9 @@ Forces a user nickchange.
 

 This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.
 

-Definition at line 384 of file modules.cpp.
00385 {
-00386         force_nickchange(user,nickname.c_str());
-00387 }
+Definition at line 389 of file modules.cpp.
00390 {
+00391         force_nickchange(user,nickname.c_str());
+00392 }
 

 

     
@@ -1094,11 +1097,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 522 of file modules.cpp.
+Definition at line 527 of file modules.cpp.
 

-References cmode().
00523 {
-00524         return cmode(User,Chan);
-00525 }
+References cmode().
00528 {
+00529         return cmode(User,Chan);
+00530 }
 

 

     
@@ -1142,11 +1145,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 470 of file modules.cpp.
+Definition at line 475 of file modules.cpp.
 

-References common_channels().
00471 {
-00472         return (common_channels(u1,u2) != 0);
-00473 }
+References common_channels().
00476 {
+00477         return (common_channels(u1,u2) != 0);
+00478 }
 

 

     
@@ -1181,9 +1184,9 @@ 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 590 of file modules.cpp.
00591 {
-00592         return usercount(c);
-00593 }
+Definition at line 595 of file modules.cpp.
00596 {
+00597         return usercount(c);
+00598 }
 

 

     
@@ -1218,11 +1221,11 @@ Deletes a local E-Line.
 

 
 

-Definition at line 683 of file modules.cpp.
+Definition at line 688 of file modules.cpp.
 

-References del_eline().
00684 {
-00685         return del_eline(hostmask.c_str());
-00686 }
+References del_eline().
00689 {
+00690         return del_eline(hostmask.c_str());
+00691 }
 

 

     
@@ -1257,11 +1260,11 @@ Deletes a G-Line from all servers on the mesh.
 

 
 

-Definition at line 663 of file modules.cpp.
+Definition at line 668 of file modules.cpp.
 

-References del_gline().
00664 {
-00665         return del_gline(hostmask.c_str());
-00666 }
+References del_gline().
00669 {
+00670         return del_gline(hostmask.c_str());
+00671 }
 

 

     
@@ -1296,11 +1299,11 @@ Deletes a local K-Line.
 

 
 

-Definition at line 678 of file modules.cpp.
+Definition at line 683 of file modules.cpp.
 

-References del_kline().
00679 {
-00680         return del_kline(hostmask.c_str());
-00681 }
+References del_kline().
00684 {
+00685         return del_kline(hostmask.c_str());
+00686 }
 

 

     
@@ -1335,11 +1338,11 @@ Deletes a Q-Line from all servers on the mesh.
 

 
 

-Definition at line 668 of file modules.cpp.
+Definition at line 673 of file modules.cpp.
 

-References del_qline().
00669 {
-00670         return del_qline(nickname.c_str());
-00671 }
+References del_qline().
00674 {
+00675         return del_qline(nickname.c_str());
+00676 }
 

 

     
@@ -1374,18 +1377,18 @@ Deletes a class derived from InspSocke
 

 
 

-Definition at line 332 of file modules.cpp.
+Definition at line 337 of file modules.cpp.
 

-References module_sockets.
00333 {
-00334         for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
-00335         {
-00336                 if (*a == sock)
-00337                 {
-00338                         module_sockets.erase(a);
-00339                         return;
-00340                 }
-00341         }
-00342 }
+References module_sockets.
00338 {
+00339         for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
+00340         {
+00341                 if (*a == sock)
+00342                 {
+00343                         module_sockets.erase(a);
+00344                         return;
+00345                 }
+00346         }
+00347 }
 

 

     
@@ -1420,11 +1423,11 @@ Deletes a Z-Line from all servers on the mesh.
 

 
 

-Definition at line 673 of file modules.cpp.
+Definition at line 678 of file modules.cpp.
 

-References del_zline().
00674 {
-00675         return del_zline(ipaddr.c_str());
-00676 }
+References del_zline().
00679 {
+00680         return del_zline(ipaddr.c_str());
+00681 }
 

 

     
@@ -1459,9 +1462,9 @@ 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 517 of file modules.cpp.
00518 {
-00519         return FindChan(channel.c_str());
-00520 }
+Definition at line 522 of file modules.cpp.
00523 {
+00524         return FindChan(channel.c_str());
+00525 }
 

 

     
@@ -1496,9 +1499,9 @@ Attempts to look up a nick using the file descriptor associated with that nick.
 

 This function will return NULL if the file descriptor is not associated with a valid user.
 

-Definition at line 512 of file modules.cpp.
00513 {
-00514         return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00515 }
+Definition at line 517 of file modules.cpp.
00518 {
+00519         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00520 }
 

 

     
@@ -1533,18 +1536,18 @@ This function finds a module by name.
 

 You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.
 

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

-References MODCOUNT, ServerConfig::module_names, and modules.
00723 {
-00724         for (int i = 0; i <= MODCOUNT; i++)
-00725         {
-00726                 if (Config->module_names[i] == name)
-00727                 {
-00728                         return modules[i];
-00729                 }
-00730         }
-00731         return NULL;
-00732 }
+Definition at line 727 of file modules.cpp.
+

+References MODCOUNT, ServerConfig::module_names, and modules.
00728 {
+00729         for (int i = 0; i <= MODCOUNT; i++)
+00730         {
+00731                 if (Config->module_names[i] == name)
+00732                 {
+00733                         return modules[i];
+00734                 }
+00735         }
+00736         return NULL;
+00737 }
 

 

     
@@ -1579,9 +1582,9 @@ 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 507 of file modules.cpp.
00508 {
-00509         return Find(nick);
-00510 }
+Definition at line 512 of file modules.cpp.
00513 {
+00514         return Find(nick);
+00515 }
 

 

     
@@ -1615,9 +1618,45 @@ 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 547 of file modules.cpp.
00548 {
-00549         return Admin(getadminname(),getadminemail(),getadminnick());
-00550 }
+Definition at line 552 of file modules.cpp.
00553 {
+00554         return Admin(getadminname(),getadminemail(),getadminnick());
+00555 }
+

+

+    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+        
+      
ServerConfig * Server::GetConfig           (            ) 

+    

+
+  
+    
+    
@@ -1651,9 +1690,9 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 537 of file modules.cpp.
00538 {
-00539         return getnetworkname();
-00540 }
+Definition at line 542 of file modules.cpp.
00543 {
+00544         return getnetworkname();
+00545 }
 

 

     
@@ -1687,9 +1726,9 @@ Returns the server description string of the local server.
 

 
 

-Definition at line 542 of file modules.cpp.
00543 {
-00544         return getserverdesc();
-00545 }
+Definition at line 547 of file modules.cpp.
00548 {
+00549         return getserverdesc();
+00550 }
 

 

     
@@ -1723,9 +1762,9 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 532 of file modules.cpp.
00533 {
-00534         return getservername();
-00535 }
+Definition at line 537 of file modules.cpp.
00538 {
+00539         return getservername();
+00540 }
 

 

     
@@ -1760,19 +1799,19 @@ Fetches the userlist of a channel.
 

 This function must be here and not a member of userrec or chanrec due to include constraints.
 

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

-References chanrec::GetUsers().
00373 {
-00374         chanuserlist userl;
-00375         userl.clear();
-00376         std::vector<char*> *list = chan->GetUsers();
-00377         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
-00378         {
-00379                 char* o = *i;
-00380                 userl.push_back((userrec*)o);
-00381         }
-00382         return userl;
-00383 }
+Definition at line 377 of file modules.cpp.
+

+References chanrec::GetUsers().
00378 {
+00379         chanuserlist userl;
+00380         userl.clear();
+00381         std::vector<char*> *list = chan->GetUsers();
+00382         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+00383         {
+00384                 char* o = *i;
+00385                 userl.push_back((userrec*)o);
+00386         }
+00387         return userl;
+00388 }
 

 

     
@@ -1807,11 +1846,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 502 of file modules.cpp.
+Definition at line 507 of file modules.cpp.
 

-References isnick().
00503 {
-00504         return (isnick(nick.c_str()) != 0);
-00505 }
+References isnick().
00508 {
+00509         return (isnick(nick.c_str()) != 0);
+00510 }
 

 

     
@@ -1855,11 +1894,11 @@ Checks if a user is on a channel.
 

 This function will return true or false to indicate if user 'User' is on channel 'Chan'.
 

-Definition at line 527 of file modules.cpp.
+Definition at line 532 of file modules.cpp.
 

-References has_channel().
00528 {
-00529         return has_channel(User,Chan);
-00530 }
+References has_channel().
00533 {
+00534         return has_channel(User,Chan);
+00535 }
 

 

     
@@ -1894,11 +1933,11 @@ Returns true if the servername you give is ulined.
 

 ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.
 

-Definition at line 394 of file modules.cpp.
+Definition at line 399 of file modules.cpp.
 

-References is_uline().
00395 {
-00396         return is_uline(server.c_str());
-00397 }
+References is_uline().
00400 {
+00401         return is_uline(server.c_str());
+00402 }
 

 

     
@@ -1933,33 +1972,33 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.
 

 
 

-Definition at line 693 of file modules.cpp.
00694 {
-00695         const char* dest = mask.c_str();
-00696         if (strchr(dest,'!')==0)
-00697                 return false;
-00698         if (strchr(dest,'@')==0)
-00699                 return false;
-00700         for (unsigned int i = 0; i < strlen(dest); i++)
-00701                 if (dest[i] < 32)
-00702                         return false;
-00703         for (unsigned int i = 0; i < strlen(dest); i++)
-00704                 if (dest[i] > 126)
-00705                         return false;
-00706         unsigned int c = 0;
-00707         for (unsigned int i = 0; i < strlen(dest); i++)
-00708                 if (dest[i] == '!')
-00709                         c++;
-00710         if (c>1)
-00711                 return false;
-00712         c = 0;
-00713         for (unsigned int i = 0; i < strlen(dest); i++)
-00714                 if (dest[i] == '@')
-00715                         c++;
-00716         if (c>1)
-00717                 return false;
-00718 
-00719         return true;
-00720 }
+Definition at line 698 of file modules.cpp.
00699 {
+00700         const char* dest = mask.c_str();
+00701         if (strchr(dest,'!')==0)
+00702                 return false;
+00703         if (strchr(dest,'@')==0)
+00704                 return false;
+00705         for (unsigned int i = 0; i < strlen(dest); i++)
+00706                 if (dest[i] < 32)
+00707                         return false;
+00708         for (unsigned int i = 0; i < strlen(dest); i++)
+00709                 if (dest[i] > 126)
+00710                         return false;
+00711         unsigned int c = 0;
+00712         for (unsigned int i = 0; i < strlen(dest); i++)
+00713                 if (dest[i] == '!')
+00714                         c++;
+00715         if (c>1)
+00716                 return false;
+00717         c = 0;
+00718         for (unsigned int i = 0; i < strlen(dest); i++)
+00719                 if (dest[i] == '@')
+00720                         c++;
+00721         if (c>1)
+00722                 return false;
+00723 
+00724         return true;
+00725 }
 

 

     
@@ -2007,9 +2046,9 @@ Definition at line 693
 

 
 

-Definition at line 404 of file modules.cpp.
00405 {
-00406         return is_valid_cmd(commandname.c_str(), pcnt, user);
-00407 }
+Definition at line 409 of file modules.cpp.
00410 {
+00411         return is_valid_cmd(commandname.c_str(), pcnt, user);
+00412 }
 

 

     
@@ -2059,9 +2098,9 @@ Forces a user to join a channel.
 

 This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.
 

-Definition at line 362 of file modules.cpp.
00363 {
-00364         return add_channel(user,cname.c_str(),key.c_str(),false);
-00365 }
+Definition at line 367 of file modules.cpp.
00368 {
+00369         return add_channel(user,cname.c_str(),key.c_str(),false);
+00370 }
 

 

     
@@ -2105,9 +2144,9 @@ 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 409 of file modules.cpp.
00410 {
-00411         log(level,"%s",s.c_str());
-00412 }
+Definition at line 414 of file modules.cpp.
00415 {
+00416         log(level,"%s",s.c_str());
+00417 }
 

 

     
@@ -2151,12 +2190,12 @@ Matches text against a glob pattern.
 

 Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.
 

-Definition at line 349 of file modules.cpp.
00350 {
-00351         char literal[MAXBUF],pattern[MAXBUF];
-00352         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00353         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00354         return match(literal,pattern);
-00355 }
+Definition at line 354 of file modules.cpp.
00355 {
+00356         char literal[MAXBUF],pattern[MAXBUF];
+00357         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00358         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00359         return match(literal,pattern);
+00360 }
 

 

     
@@ -2206,9 +2245,9 @@ Forces a user to part a channel.
 

 This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.
 

-Definition at line 367 of file modules.cpp.
00368 {
-00369         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00370 }
+Definition at line 372 of file modules.cpp.
00373 {
+00374         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00375 }
 

 

     
@@ -2258,36 +2297,36 @@ This user takes one user, and switches their file descriptor with another user,
 

 The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
 

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

-References userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
00609 {
-00610         zombie->fd = alive->fd;
-00611         alive->fd = FD_MAGIC_NUMBER;
-00612         alive->ClearBuffer();
-00613         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00614         kill_link(alive,message.c_str());
-00615         fd_ref_table[zombie->fd] = zombie;
-00616         for (unsigned int i = 0; i < zombie->chans.size(); i++)
-00617         {
-00618                 if (zombie->chans[i].channel != NULL)
-00619                 {
-00620                         if (zombie->chans[i].channel->name)
-00621                         {
-00622                                 chanrec* Ptr = zombie->chans[i].channel;
-00623                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00624                                 if (Ptr->topicset)
-00625                                 {
-00626                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00627                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00628                                 }
-00629                                 userlist(zombie,Ptr);
-00630                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00631 
-00632                         }
-00633                 }
-00634         }
-00635         return true;
-00636 }
+Definition at line 613 of file modules.cpp.
+

+References userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
00614 {
+00615         zombie->fd = alive->fd;
+00616         alive->fd = FD_MAGIC_NUMBER;
+00617         alive->ClearBuffer();
+00618         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00619         kill_link(alive,message.c_str());
+00620         fd_ref_table[zombie->fd] = zombie;
+00621         for (unsigned int i = 0; i < zombie->chans.size(); i++)
+00622         {
+00623                 if (zombie->chans[i].channel != NULL)
+00624                 {
+00625                         if (zombie->chans[i].channel->name)
+00626                         {
+00627                                 chanrec* Ptr = zombie->chans[i].channel;
+00628                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00629                                 if (Ptr->topicset)
+00630                                 {
+00631                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00632                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00633                                 }
+00634                                 userlist(zombie,Ptr);
+00635                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00636 
+00637                         }
+00638                 }
+00639         }
+00640         return true;
+00641 }
 

 

     
@@ -2333,9 +2372,9 @@ To the user, it will appear as if they typed /QUIT themselves, except for the fa
 WARNING!

 Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.
 

-Definition at line 389 of file modules.cpp.
00390 {
-00391         kill_link(user,reason.c_str());
-00392 }
+Definition at line 394 of file modules.cpp.
00395 {
+00396         kill_link(user,reason.c_str());
+00397 }
 

 

     
@@ -2416,9 +2455,9 @@ 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 424 of file modules.cpp.
00425 {
-00426         Write(Socket,"%s",s.c_str());
-00427 }
+Definition at line 429 of file modules.cpp.
00430 {
+00431         Write(Socket,"%s",s.c_str());
+00432 }
 

 

     
@@ -2474,16 +2513,16 @@ 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 458 of file modules.cpp.
00459 {
-00460         if (IncludeSender)
-00461         {
-00462                 WriteChannel(Channel,User,"%s",s.c_str());
-00463         }
-00464         else
-00465         {
-00466                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00467         }
-00468 }
+Definition at line 463 of file modules.cpp.
00464 {
+00465         if (IncludeSender)
+00466         {
+00467                 WriteChannel(Channel,User,"%s",s.c_str());
+00468         }
+00469         else
+00470         {
+00471                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00472         }
+00473 }
 

 

     
@@ -2533,9 +2572,9 @@ Writes text to a channel, but from a server, including all.
 

 This can be used to send server notices to a group of users.
 

-Definition at line 453 of file modules.cpp.
00454 {
-00455         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00456 }
+Definition at line 458 of file modules.cpp.
00459 {
+00460         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00461 }
 

 

     
@@ -2585,16 +2624,16 @@ 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 475 of file modules.cpp.
00476 {
-00477         if (IncludeSender)
-00478         {
-00479                 WriteCommon(User,"%s",text.c_str());
-00480         }
-00481         else
-00482         {
-00483                 WriteCommonExcept(User,"%s",text.c_str());
-00484         }
-00485 }
+Definition at line 480 of file modules.cpp.
00481 {
+00482         if (IncludeSender)
+00483         {
+00484                 WriteCommon(User,"%s",text.c_str());
+00485         }
+00486         else
+00487         {
+00488                 WriteCommonExcept(User,"%s",text.c_str());
+00489         }
+00490 }
 

 

     
@@ -2644,9 +2683,9 @@ 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 434 of file modules.cpp.
00435 {
-00436         WriteFrom(Socket,User,"%s",s.c_str());
-00437 }
+Definition at line 439 of file modules.cpp.
00440 {
+00441         WriteFrom(Socket,User,"%s",s.c_str());
+00442 }
 

 

     
@@ -2703,11 +2742,11 @@ 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 419 of file modules.cpp.
+Definition at line 424 of file modules.cpp.
 

-References server_mode().
00420 {
-00421         server_mode(parameters,pcnt,user);
-00422 }
+References server_mode().
00425 {
+00426         server_mode(parameters,pcnt,user);
+00427 }
 

 

     
@@ -2742,9 +2781,9 @@ Sends text to all opers.
 

 This method sends a server notice to all opers with the usermode +s.
 

-Definition at line 344 of file modules.cpp.
00345 {
-00346         WriteOpers("%s",s.c_str());
-00347 }
+Definition at line 349 of file modules.cpp.
00350 {
+00351         WriteOpers("%s",s.c_str());
+00352 }
 

 

     
@@ -2788,9 +2827,9 @@ 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 429 of file modules.cpp.
00430 {
-00431         WriteServ(Socket,"%s",s.c_str());
-00432 }
+Definition at line 434 of file modules.cpp.
00435 {
+00436         WriteServ(Socket,"%s",s.c_str());
+00437 }
 

 

     
@@ -2844,20 +2883,20 @@ The format will become:

 :localserver TEXT

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

-Definition at line 439 of file modules.cpp.
+Definition at line 444 of file modules.cpp.
 

-References connection::fd.
00440 {
-00441         if (!Source)
-00442         {
-00443                 // if source is NULL, then the message originates from the local server
-00444                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00445         }
-00446         else
+References connection::fd.
00445 {
+00446         if (!Source)
 00447         {
-00448                 // otherwise it comes from the user specified
-00449                 WriteTo(Source,Dest,"%s",s.c_str());
+00448                 // if source is NULL, then the message originates from the local server
+00449                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
 00450         }
-00451 }
+00451         else
+00452         {
+00453                 // otherwise it comes from the user specified
+00454                 WriteTo(Source,Dest,"%s",s.c_str());
+00455         }
+00456 }
 

 

     
@@ -2909,9 +2948,9 @@ These can be RFC specified modes such as +i, or module provided modes, including
 Serv->SendToModeMask("xi", WM_OR, "m00");

 Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.
 

-Definition at line 357 of file modules.cpp.
00358 {
-00359         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00360 }
+Definition at line 362 of file modules.cpp.
00363 {
+00364         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00365 }
 

 

     
@@ -2955,9 +2994,9 @@ 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 487 of file modules.cpp.
00488 {
-00489         WriteWallOps(User,false,"%s",text.c_str());
-00490 }
+Definition at line 492 of file modules.cpp.
00493 {
+00494         WriteWallOps(User,false,"%s",text.c_str());
+00495 }
 

 

     
@@ -3001,18 +3040,18 @@ Remove a user's connection to the irc server, but leave their client in existenc
 

 When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.
 

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

-References userrec::ClearBuffer(), SocketEngine::DelFd(), connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
00597 {
-00598         unsigned int old_fd = user->fd;
-00599         user->fd = FD_MAGIC_NUMBER;
-00600         user->ClearBuffer();
-00601         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00602         SE->DelFd(old_fd);
-00603         shutdown(old_fd,2);
-00604         close(old_fd);
-00605         return true;
-00606 }
+Definition at line 601 of file modules.cpp.
+

+References userrec::ClearBuffer(), SocketEngine::DelFd(), connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
00602 {
+00603         unsigned int old_fd = user->fd;
+00604         user->fd = FD_MAGIC_NUMBER;
+00605         user->ClearBuffer();
+00606         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00607         SE->DelFd(old_fd);
+00608         shutdown(old_fd,2);
+00609         close(old_fd);
+00610         return true;
+00611 }
 

 

     
@@ -3020,7 +3059,7 @@ References userrec::ClearBuff
 

+       
+    
+
+

+Obtains a pointer to the server's ServerConfig object. 
+

+The ServerConfig object contains most of the configuration data of the IRC server, as read from the config file by the core.
+

+Definition at line 332 of file modules.cpp.
00333 {
+00334         return Config;
+00335 }
 

 

     

 
The documentation for this class was generated from the following files:
-
Generated on Wed Dec 14 14:49:33 2005 for InspIRCd by 
+
Generated on Wed Dec 14 15:55:50 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.3.1-10-gc9f91