00432 {
-00433 }
+00356 {
+00357 }
     
   
 
@@ -275,15 +278,15 @@ Default destructor.
 
 Destroys a Server object.
 

-Definition at line 435 of file modules.cpp.
+Definition at line 359 of file modules.cpp.
 

-
00436 {
-00437 }
+00360 {
+00361 }
     
   
 
 
Member Function Documentation
-
+

 
   
     
@@ -342,17 +345,17 @@ 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 504 of file modules.cpp.
+Definition at line 428 of file modules.cpp.
 

 References createcommand().
 

-
00505 {
-00506         createcommand(cmd,f,flags,minparams,source);
-00507 }
+00429 {
+00430         createcommand(cmd,f,flags,minparams,source);
+00431 }
 
    
   
 
-

+

 
   
     
@@ -401,19 +404,19 @@ References createcommand().
 
 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. 
+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 750 of file modules.cpp.
+Definition at line 679 of file modules.cpp.
 

 References add_eline(), and duration().
 

-
00751 {
-00752         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00753 }
+00680 {
+00681         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00682 }
 
    
   
 
-

+

 
   
     
@@ -448,20 +451,20 @@ 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 667 of file modules.cpp.
+Definition at line 596 of file modules.cpp.
 

-References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
+References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 

-
00668 {
-00669         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00670         if (res)
-00671                 ModeMakeList(modechar);
-00672         return res;
-00673 }
+00597 {
+00598         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00599         if (res)
+00600                 ModeMakeList(modechar);
+00601         return res;
+00602 }
 
    
   
 
-

+

 
   
     
@@ -518,40 +521,40 @@ 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 639 of file modules.cpp.
-

-References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
-

-
00640 {
-00641         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
-00642         {
-00643                 if (type == MT_SERVER)
-00644                 {
-00645                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00646                         return false;
-00647                 }
-00648                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00649                 {
-00650                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00651                         return false;
-00652                 }
-00653                 if ((params_when_on>1) || (params_when_off>1))
-00654                 {
-00655                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00656                         return false;
-00657                 }
-00658                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00659         }
-00660         else
-00661         {
-00662                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
-00663         }
-00664         return false;
-00665 }
+Definition at line 568 of file modules.cpp.
+
+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+

+
00569 {
+00570         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
+00571         {
+00572                 if (type == MT_SERVER)
+00573                 {
+00574                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00575                         return false;
+00576                 }
+00577                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00578                 {
+00579                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00580                         return false;
+00581                 }
+00582                 if ((params_when_on>1) || (params_when_off>1))
+00583                 {
+00584                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00585                         return false;
+00586                 }
+00587                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00588         }
+00589         else
+00590         {
+00591                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
+00592         }
+00593         return false;
+00594 }
 
    
   
 
-

+

 
   
     
@@ -600,19 +603,19 @@ References DEBUG, 
 Adds a G-line The G-line is propogated to all of the servers in the mesh and 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.
+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 730 of file modules.cpp.
+Definition at line 659 of file modules.cpp.
 

 References add_gline(), and duration().
 

-
00731 {
-00732         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00733 }
+00660 {
+00661         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00662 }
 
    
   
 
-

+

 
   
     
@@ -661,19 +664,19 @@ References add_gline(), and 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. 
+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 745 of file modules.cpp.
+Definition at line 674 of file modules.cpp.
 

 References add_kline(), and duration().
 

-
00746 {
-00747         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00748 }
+00675 {
+00676         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00677 }
 
    
   
 
-

+

 
   
     
@@ -722,19 +725,19 @@ References add_kline(), and 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. 
+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 735 of file modules.cpp.
+Definition at line 664 of file modules.cpp.
 

 References add_qline(), and duration().
 

-
00736 {
-00737         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00738 }
+00665 {
+00666         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00667 }
 
    
   
 
-

+

 
   
     
@@ -783,19 +786,19 @@ References add_qline(), and 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. 
+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 740 of file modules.cpp.
+Definition at line 669 of file modules.cpp.
 

 References add_zline(), and duration().
 

-
00741 {
-00742         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00743 }
+00670 {
+00671         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00672 }
 
    
   
 
-

+

 
   
     
@@ -825,17 +828,17 @@ 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 780 of file modules.cpp.
+Definition at line 709 of file modules.cpp.
 

 References duration().
 

-
00781 {
-00782         return duration(delta.c_str());
-00783 }
+00710 {
+00711         return duration(delta.c_str());
+00712 }
 
    
   
 
-

+

 
   
     
@@ -885,17 +888,17 @@ References duration().
 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.
+) 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 494 of file modules.cpp.
+Definition at line 418 of file modules.cpp.
 

-
00495 {
-00496         call_handler(commandname.c_str(),parameters,pcnt,user);
-00497 }
+00419 {
+00420         call_handler(commandname.c_str(),parameters,pcnt,user);
+00421 }
 
    
   
 
-

+

 
   
     
@@ -934,17 +937,17 @@ 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 587 of file modules.cpp.
+Definition at line 511 of file modules.cpp.
 

 References ChangeName().
 

-
00588 {
-00589         ChangeName(user,gecos.c_str());
-00590 }
+00512 {
+00513         ChangeName(user,gecos.c_str());
+00514 }
 
    
   
 
-

+

 
   
     
@@ -983,17 +986,17 @@ 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 582 of file modules.cpp.
+Definition at line 506 of file modules.cpp.
 

 References ChangeDisplayedHost().
 

-
00583 {
-00584         ChangeDisplayedHost(user,host.c_str());
-00585 }
+00507 {
+00508         ChangeDisplayedHost(user,host.c_str());
+00509 }
 
    
   
 
-

+

 
   
     
@@ -1032,11 +1035,11 @@ 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 479 of file modules.cpp.
+Definition at line 403 of file modules.cpp.
 

-
00480 {
-00481         force_nickchange(user,nickname.c_str());
-00482 }
+00404 {
+00405         force_nickchange(user,nickname.c_str());
+00406 }
 
    
   
 
@@ -1079,13 +1082,13 @@ 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 612 of file modules.cpp.
+Definition at line 536 of file modules.cpp.
 

 References cmode().
 

-
00613 {
-00614         return cmode(User,Chan);
-00615 }
+00537 {
+00538         return cmode(User,Chan);
+00539 }
     
   
 
@@ -1128,13 +1131,13 @@ 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 560 of file modules.cpp.
+Definition at line 484 of file modules.cpp.
 

 References common_channels().
 

-
00561 {
-00562         return (common_channels(u1,u2) != 0);
-00563 }
+00485 {
+00486         return (common_channels(u1,u2) != 0);
+00487 }
     
   
 
@@ -1168,15 +1171,15 @@ 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 675 of file modules.cpp.
+Definition at line 604 of file modules.cpp.
 

-
00676 {
-00677         return usercount(c);
-00678 }
+00605 {
+00606         return usercount(c);
+00607 }
     
   
 
-
+

 
   
     
@@ -1206,17 +1209,17 @@ Deletes a local E-Line.
 
 
 

-Definition at line 775 of file modules.cpp.
+Definition at line 704 of file modules.cpp.
 

 References del_eline().
 

-
00776 {
-00777         del_eline(hostmask.c_str());
-00778 }
+00705 {
+00706         del_eline(hostmask.c_str());
+00707 }
 
    
   
 
-

+

 
   
     
@@ -1246,17 +1249,17 @@ Deletes a G-Line from all servers on the mesh.
 
 
 

-Definition at line 755 of file modules.cpp.
+Definition at line 684 of file modules.cpp.
 

 References del_gline().
 

-
00756 {
-00757         del_gline(hostmask.c_str());
-00758 }
+00685 {
+00686         del_gline(hostmask.c_str());
+00687 }
 
    
   
 
-

+

 
   
     
@@ -1286,17 +1289,17 @@ Deletes a local K-Line.
 
 
 

-Definition at line 770 of file modules.cpp.
+Definition at line 699 of file modules.cpp.
 

 References del_kline().
 

-
00771 {
-00772         del_kline(hostmask.c_str());
-00773 }
+00700 {
+00701         del_kline(hostmask.c_str());
+00702 }
 
    
   
 
-

+

 
   
     
@@ -1326,17 +1329,17 @@ Deletes a Q-Line from all servers on the mesh.
 
 
 

-Definition at line 760 of file modules.cpp.
+Definition at line 689 of file modules.cpp.
 

 References del_qline().
 

-
00761 {
-00762         del_qline(nickname.c_str());
-00763 }
+00690 {
+00691         del_qline(nickname.c_str());
+00692 }
 
    
   
 
-

+

 
   
     
@@ -1366,13 +1369,13 @@ Deletes a Z-Line from all servers on the mesh.
 
 
 

-Definition at line 765 of file modules.cpp.
+Definition at line 694 of file modules.cpp.
 

 References del_zline().
 

-
00766 {
-00767         del_zline(ipaddr.c_str());
-00768 }
+00695 {
+00696         del_zline(ipaddr.c_str());
+00697 }
 
    
   
 
@@ -1406,11 +1409,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 607 of file modules.cpp.
+Definition at line 531 of file modules.cpp.
 

-
00608 {
-00609         return FindChan(channel.c_str());
-00610 }
+00532 {
+00533         return FindChan(channel.c_str());
+00534 }
     
   
 
@@ -1444,17 +1447,17 @@ 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 602 of file modules.cpp.
+Definition at line 526 of file modules.cpp.
 

-References fd_ref_table.
+References fd_ref_table.
 

-
00603 {
-00604         return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00605 }
+00527 {
+00528         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00529 }
     
   
 
-
+

 
   
     
@@ -1484,20 +1487,20 @@ 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 858 of file modules.cpp.
+Definition at line 787 of file modules.cpp.
 

-References MODCOUNT, module_names, and modules.
+References MODCOUNT, module_names, and modules.
 

-
00859 {
-00860         for (int i = 0; i <= MODCOUNT; i++)
-00861         {
-00862                 if (module_names[i] == name)
-00863                 {
-00864                         return modules[i];
-00865                 }
-00866         }
-00867         return NULL;
-00868 }
+00788 {
+00789         for (int i = 0; i <= MODCOUNT; i++)
+00790         {
+00791                 if (module_names[i] == name)
+00792                 {
+00793                         return modules[i];
+00794                 }
+00795         }
+00796         return NULL;
+00797 }
 
    
   
 
@@ -1531,15 +1534,15 @@ 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 597 of file modules.cpp.
+Definition at line 521 of file modules.cpp.
 

-
00598 {
-00599         return Find(nick);
-00600 }
+00522 {
+00523         return Find(nick);
+00524 }
     
   
 
-
+

 
   
     
@@ -1568,11 +1571,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 632 of file modules.cpp.
+Definition at line 561 of file modules.cpp.
 

-
00633 {
-00634         return Admin(getadminname(),getadminemail(),getadminnick());
-00635 }
+00562 {
+00563         return Admin(getadminname(),getadminemail(),getadminnick());
+00564 }
 
    
   
 
@@ -1605,11 +1608,48 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 627 of file modules.cpp.
+Definition at line 551 of file modules.cpp.
+

+
00552 {
+00553         return getnetworkname();
+00554 }
+    
+  
+
+
+
+  
+    
+  
+
+      
+        
+          
+          
+          
+          
+          
+        
+
+       std::string Server::GetServerDescription (             )   [virtual]
+    
+
+  
+    
+    
+       
+    
+
+
+Returns the server description string of the local server. 
+

+
+

+Definition at line 556 of file modules.cpp.
 

-
00628 {
-00629         return getnetworkname();
-00630 }
+00557 {
+00558         return getserverdesc();
+00559 }
 
    
   
 
@@ -1642,15 +1682,15 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 622 of file modules.cpp.
+Definition at line 546 of file modules.cpp.
 

-
00623 {
-00624         return getservername();
-00625 }
+00547 {
+00548         return getservername();
+00549 }
     
   
 
-
+

 
   
     
@@ -1680,21 +1720,21 @@ 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 467 of file modules.cpp.
-

-References chanuserlist, chanrec::GetUsers(), and list.
-

-
00468 {
-00469         chanuserlist userl;
-00470         userl.clear();
-00471         std::vector<char*> *list = chan->GetUsers();
-00472         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
-00473         {
-00474                 char* o = *i;
-00475                 userl.push_back((userrec*)o);
-00476         }
-00477         return userl;
-00478 }
+Definition at line 391 of file modules.cpp.
+
+References chanuserlist, chanrec::GetUsers(), and list.
+

+
00392 {
+00393         chanuserlist userl;
+00394         userl.clear();
+00395         std::vector<char*> *list = chan->GetUsers();
+00396         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+00397         {
+00398                 char* o = *i;
+00399                 userl.push_back((userrec*)o);
+00400         }
+00401         return userl;
+00402 }
 
    
   
 
@@ -1728,13 +1768,13 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 592 of file modules.cpp.
+Definition at line 516 of file modules.cpp.
 

 References isnick().
 

-
00593 {
-00594         return (isnick(nick.c_str()) != 0);
-00595 }
+00517 {
+00518         return (isnick(nick.c_str()) != 0);
+00519 }
     
   
 
@@ -1777,17 +1817,17 @@ 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 617 of file modules.cpp.
+Definition at line 541 of file modules.cpp.
 

 References has_channel().
 

-
00618 {
-00619         return has_channel(User,Chan);
-00620 }
+00542 {
+00543         return has_channel(User,Chan);
+00544 }
     
   
 
-
+

 
   
     
@@ -1817,17 +1857,17 @@ 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 489 of file modules.cpp.
+Definition at line 413 of file modules.cpp.
 

 References is_uline().
 

-
00490 {
-00491         return is_uline(server.c_str());
-00492 }
+00414 {
+00415         return is_uline(server.c_str());
+00416 }
 
    
   
 
-

+

 
   
     
@@ -1857,39 +1897,39 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.
 
 
 

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

-
00786 {
-00787         const char* dest = mask.c_str();
-00788         if (strchr(dest,'!')==0)
-00789                 return false;
-00790         if (strchr(dest,'@')==0)
-00791                 return false;
-00792         for (int i = 0; i < strlen(dest); i++)
-00793                 if (dest[i] < 32)
-00794                         return false;
-00795         for (int i = 0; i < strlen(dest); i++)
-00796                 if (dest[i] > 126)
-00797                         return false;
-00798         int c = 0;
-00799         for (int i = 0; i < strlen(dest); i++)
-00800                 if (dest[i] == '!')
-00801                         c++;
-00802         if (c>1)
-00803                 return false;
-00804         c = 0;
-00805         for (int i = 0; i < strlen(dest); i++)
-00806                 if (dest[i] == '@')
-00807                         c++;
-00808         if (c>1)
-00809                 return false;
-00810 
-00811         return true;
-00812 }
+Definition at line 714 of file modules.cpp.
+
+
00715 {
+00716         const char* dest = mask.c_str();
+00717         if (strchr(dest,'!')==0)
+00718                 return false;
+00719         if (strchr(dest,'@')==0)
+00720                 return false;
+00721         for (int i = 0; i < strlen(dest); i++)
+00722                 if (dest[i] < 32)
+00723                         return false;
+00724         for (int i = 0; i < strlen(dest); i++)
+00725                 if (dest[i] > 126)
+00726                         return false;
+00727         int c = 0;
+00728         for (int i = 0; i < strlen(dest); i++)
+00729                 if (dest[i] == '!')
+00730                         c++;
+00731         if (c>1)
+00732                 return false;
+00733         c = 0;
+00734         for (int i = 0; i < strlen(dest); i++)
+00735                 if (dest[i] == '@')
+00736                         c++;
+00737         if (c>1)
+00738                 return false;
+00739 
+00740         return true;
+00741 }
 
    
   
 
-

+

 
   
     
@@ -1934,11 +1974,11 @@ 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 457 of file modules.cpp.
+Definition at line 381 of file modules.cpp.
 

-
00458 {
-00459         return add_channel(user,cname.c_str(),key.c_str(),false);
-00460 }
+00382 {
+00383         return add_channel(user,cname.c_str(),key.c_str(),false);
+00384 }
 
    
   
 
@@ -1981,15 +2021,15 @@ 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 499 of file modules.cpp.
+Definition at line 423 of file modules.cpp.
 

-
00500 {
-00501         log(level,"%s",s.c_str());
-00502 }
+00424 {
+00425         log(level,"%s",s.c_str());
+00426 }
     
   
 
-
+

 
   
     
@@ -2028,18 +2068,18 @@ 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 444 of file modules.cpp.
+Definition at line 368 of file modules.cpp.
 

-
00445 {
-00446         char literal[MAXBUF],pattern[MAXBUF];
-00447         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00448         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00449         return match(literal,pattern);
-00450 }
+00369 {
+00370         char literal[MAXBUF],pattern[MAXBUF];
+00371         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00372         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00373         return match(literal,pattern);
+00374 }
 
    
   
 
-

+

 
   
     
@@ -2078,19 +2118,19 @@ This function is used to check if any users on channel c are on server servernam
 
 This is used internally by PRIVMSG etc. You should not need to use it.
 

-Definition at line 840 of file modules.cpp.
+Definition at line 769 of file modules.cpp.
 

-
00841 {
-00842         if (c)
-00843         {
-00844                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
-00845         }
-00846         else return false;
-00847 }
+00770 {
+00771         if (c)
+00772         {
+00773                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
+00774         }
+00775         else return false;
+00776 }
 
    
   
 
-

+

 
   
     
@@ -2127,21 +2167,21 @@ Definition at line 840
 
 This function is used to check if user u has any channels in common with users on servername. 
 

-This is used internally by Server::MeshSendCommon. You should very rarely need to use it.
+This is used internally by Server::MeshSendCommon. You should very rarely need to use it.
 

-Definition at line 849 of file modules.cpp.
+Definition at line 778 of file modules.cpp.
 

-
00850 {
-00851         if (u)
-00852         {
-00853                 return CommonOnThisServer(u,(char*)servername.c_str());
-00854         }
-00855         else return false;
-00856 }
+00779 {
+00780         if (u)
+00781         {
+00782                 return CommonOnThisServer(u,(char*)servername.c_str());
+00783         }
+00784         else return false;
+00785 }
 
    
   
 
-

+

 
   
     
@@ -2171,15 +2211,15 @@ Sends a line of text to all connected servers.
 
 If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.
 

-Definition at line 814 of file modules.cpp.
+Definition at line 743 of file modules.cpp.
 

-
00815 {
-00816         NetSendToAll((char*)text.c_str());
-00817 }
+00744 {
+00745         NetSendToAll((char*)text.c_str());
+00746 }
 
    
   
 
-

+

 
   
     
@@ -2209,15 +2249,15 @@ This function is equivalent to Server::MeshSendToAll except it will only route t
 
 
 

-Definition at line 825 of file modules.cpp.
+Definition at line 754 of file modules.cpp.
 

-
00826 {
-00827         NetSendToAllAlive((char*)text.c_str());
-00828 }
+00755 {
+00756         NetSendToAllAlive((char*)text.c_str());
+00757 }
 
    
   
 
-

+

 
   
     
@@ -2256,15 +2296,15 @@ This function sends to all servers EXCEPT the one you specify.
 
 You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.
 

-Definition at line 835 of file modules.cpp.
+Definition at line 764 of file modules.cpp.
 

-
00836 {
-00837         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
-00838 }
+00765 {
+00766         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
+00767 }
 
    
   
 
-

+

 
   
     
@@ -2303,16 +2343,16 @@ This method sends a line of text to all servers who have users which share commo
 
 For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)
 

-Definition at line 819 of file modules.cpp.
+Definition at line 748 of file modules.cpp.
 

-
00820 {
-00821         if (user)
-00822                 NetSendToCommon(user,(char*)text.c_str());
-00823 }
+00749 {
+00750         if (user)
+00751                 NetSendToCommon(user,(char*)text.c_str());
+00752 }
 
    
   
 
-

+

 
   
     
@@ -2351,15 +2391,15 @@ This function sends a line of text directly to a server.
 
 If the server is not directly routable at this time, the server attempts to route text through the mesh.
 

-Definition at line 830 of file modules.cpp.
+Definition at line 759 of file modules.cpp.
 

-
00831 {
-00832         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
-00833 }
+00760 {
+00761         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
+00762 }
 
    
   
 
-

+

 
   
     
@@ -2404,15 +2444,15 @@ 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 462 of file modules.cpp.
+Definition at line 386 of file modules.cpp.
 

-
00463 {
-00464         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00465 }
+00387 {
+00388         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00389 }
 
    
   
 
-

+

 
   
     
@@ -2457,42 +2497,42 @@ 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 700 of file modules.cpp.
-

-References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
-

-
00701 {
-00702         zombie->fd = alive->fd;
-00703         alive->fd = FD_MAGIC_NUMBER;
-00704         alive->ClearBuffer();
-00705         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00706         kill_link(alive,message.c_str());
-00707         fd_ref_table[zombie->fd] = zombie;
-00708         for (int i = 0; i != MAXCHANS; i++)
-00709         {
-00710                 if (zombie->chans[i].channel != NULL)
-00711                 {
-00712                         if (zombie->chans[i].channel->name)
-00713                         {
-00714                                 chanrec* Ptr = zombie->chans[i].channel;
-00715                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00716                                 if (Ptr->topicset)
-00717                                 {
-00718                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00719                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00720                                 }
-00721                                 userlist(zombie,Ptr);
-00722                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00723 
-00724                         }
-00725                 }
-00726         }
-00727 
-00728 }
+Definition at line 629 of file modules.cpp.
+
+References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
+

+
00630 {
+00631         zombie->fd = alive->fd;
+00632         alive->fd = FD_MAGIC_NUMBER;
+00633         alive->ClearBuffer();
+00634         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00635         kill_link(alive,message.c_str());
+00636         fd_ref_table[zombie->fd] = zombie;
+00637         for (int i = 0; i != MAXCHANS; i++)
+00638         {
+00639                 if (zombie->chans[i].channel != NULL)
+00640                 {
+00641                         if (zombie->chans[i].channel->name)
+00642                         {
+00643                                 chanrec* Ptr = zombie->chans[i].channel;
+00644                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00645                                 if (Ptr->topicset)
+00646                                 {
+00647                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00648                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00649                                 }
+00650                                 userlist(zombie,Ptr);
+00651                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00652 
+00653                         }
+00654                 }
+00655         }
+00656 
+00657 }
 
    
   
 
-

+

 
   
     
@@ -2533,11 +2573,11 @@ 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 484 of file modules.cpp.
+Definition at line 408 of file modules.cpp.
 

-
00485 {
-00486         kill_link(user,reason.c_str());
-00487 }
+00409 {
+00410         kill_link(user,reason.c_str());
+00411 }
 
    
   
 
@@ -2580,11 +2620,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 514 of file modules.cpp.
+Definition at line 438 of file modules.cpp.
 

-
00515 {
-00516         Write(Socket,"%s",s.c_str());
-00517 }
+00439 {
+00440         Write(Socket,"%s",s.c_str());
+00441 }
     
   
 
@@ -2639,18 +2679,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 548 of file modules.cpp.
-

-
00549 {
-00550         if (IncludeSender)
-00551         {
-00552                 WriteChannel(Channel,User,"%s",s.c_str());
-00553         }
-00554         else
-00555         {
-00556                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00557         }
-00558 }
+Definition at line 472 of file modules.cpp.
+
+
00473 {
+00474         if (IncludeSender)
+00475         {
+00476                 WriteChannel(Channel,User,"%s",s.c_str());
+00477         }
+00478         else
+00479         {
+00480                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00481         }
+00482 }
     
   
 
@@ -2699,11 +2739,11 @@ 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 543 of file modules.cpp.
+Definition at line 467 of file modules.cpp.
 

-
00544 {
-00545         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00546 }
+00468 {
+00469         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00470 }
     
   
 
@@ -2752,18 +2792,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 565 of file modules.cpp.
-

-
00566 {
-00567         if (IncludeSender)
-00568         {
-00569                 WriteCommon(User,"%s",text.c_str());
-00570         }
-00571         else
-00572         {
-00573                 WriteCommonExcept(User,"%s",text.c_str());
-00574         }
-00575 }
+Definition at line 489 of file modules.cpp.
+
+
00490 {
+00491         if (IncludeSender)
+00492         {
+00493                 WriteCommon(User,"%s",text.c_str());
+00494         }
+00495         else
+00496         {
+00497                 WriteCommonExcept(User,"%s",text.c_str());
+00498         }
+00499 }
     
   
 
@@ -2812,15 +2852,15 @@ 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 524 of file modules.cpp.
+Definition at line 448 of file modules.cpp.
 

-
00525 {
-00526         WriteFrom(Socket,User,"%s",s.c_str());
-00527 }
+00449 {
+00450         WriteFrom(Socket,User,"%s",s.c_str());
+00451 }
     
   
 
-
+

 
   
     
@@ -2872,13 +2912,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 509 of file modules.cpp.
+Definition at line 433 of file modules.cpp.
 

 References server_mode().
 

-
00510 {
-00511         server_mode(parameters,pcnt,user);
-00512 }
+00434 {
+00435         server_mode(parameters,pcnt,user);
+00436 }
 
    
   
 
@@ -2912,11 +2952,11 @@ Sends text to all opers.
 

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

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

-
00440 {
-00441         WriteOpers("%s",s.c_str());
-00442 }
+00364 {
+00365         WriteOpers("%s",s.c_str());
+00366 }
     
   
 
@@ -2959,11 +2999,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 519 of file modules.cpp.
+Definition at line 443 of file modules.cpp.
 

-
00520 {
-00521         WriteServ(Socket,"%s",s.c_str());
-00522 }
+00444 {
+00445         WriteServ(Socket,"%s",s.c_str());
+00446 }
     
   
 
@@ -3016,26 +3056,26 @@ The format will become:
 :localserver TEXT

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

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

-References connection::fd.
-

-
00530 {
-00531         if (!Source)
-00532         {
-00533                 // if source is NULL, then the message originates from the local server
-00534                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00535         }
-00536         else
-00537         {
-00538                 // otherwise it comes from the user specified
-00539                 WriteTo(Source,Dest,"%s",s.c_str());
-00540         }
-00541 }
+Definition at line 453 of file modules.cpp.
+
+References connection::fd.
+

+
00454 {
+00455         if (!Source)
+00456         {
+00457                 // if source is NULL, then the message originates from the local server
+00458                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00459         }
+00460         else
+00461         {
+00462                 // otherwise it comes from the user specified
+00463                 WriteTo(Source,Dest,"%s",s.c_str());
+00464         }
+00465 }
     
   
 
-
+

 
   
     
@@ -3082,11 +3122,11 @@ 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 452 of file modules.cpp.
+Definition at line 376 of file modules.cpp.
 

-
00453 {
-00454         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00455 }
+00377 {
+00378         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00379 }
 
    
   
 
@@ -3129,15 +3169,15 @@ 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 577 of file modules.cpp.
+Definition at line 501 of file modules.cpp.
 

-
00578 {
-00579         WriteWallOps(User,false,"%s",text.c_str());
-00580 }
+00502 {
+00503         WriteWallOps(User,false,"%s",text.c_str());
+00504 }
     
   
 
-
+

 
   
     
@@ -3176,33 +3216,33 @@ 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 681 of file modules.cpp.
-

-References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
-

-
00682 {
-00683         unsigned int old_fd = user->fd;
-00684         user->fd = FD_MAGIC_NUMBER;
-00685         user->ClearBuffer();
-00686         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00687 #ifdef USE_KQUEUE
-00688         struct kevent ke;
-00689         EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
-00690         int i = kevent(kq, &ke, 1, 0, 0, NULL);
-00691         if (i == -1)
-00692         {
-00693                 log(DEBUG,"kqueue: Failed to remove user from queue!");
-00694         }
-00695 #endif
-00696         shutdown(old_fd,2);
-00697         close(old_fd);
-00698 }
+Definition at line 610 of file modules.cpp.
+
+References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
+

+
00611 {
+00612         unsigned int old_fd = user->fd;
+00613         user->fd = FD_MAGIC_NUMBER;
+00614         user->ClearBuffer();
+00615         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00616 #ifdef USE_KQUEUE
+00617         struct kevent ke;
+00618         EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
+00619         int i = kevent(kq, &ke, 1, 0, 0, NULL);
+00620         if (i == -1)
+00621         {
+00622                 log(DEBUG,"kqueue: Failed to remove user from queue!");
+00623         }
+00624 #endif
+00625         shutdown(old_fd,2);
+00626         close(old_fd);
+00627 }
 
    
   
 
 
The documentation for this class was generated from the following files:
 modules.h
modules.cpp
-
Generated on Fri May 13 15:49:55 2005 for InspIRCd by
+
Generated on Sun May 15 17:03:43 2005 for InspIRCd by
 
  
 1.3.3 
-- 
cgit v1.2.3
Server Class Reference

Detailed Description

Member Function Documentation
