From 674c868b225f0c2c0a8f7879dbaa322a8c539bec Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 15 Apr 2005 19:31:08 +0000 Subject: New docs for API: int Module::OnRawMode(userrec* user, char mode, std::string param, bool adding, int pcnt); int Module::OnCheckInvite(userrec* user, chanrec* chan); int Module::OnCheckKey(userrec* user, chanrec* chan, std::string keygiven); int Module::OnCheckLimit(userrec* user, chanrec* chan); int Module::OnCheckBan(userrec* user, chanrec* chan); void Module::OnStats(char symbol); int Module::OnChangeLocalUserHost(userrec* user, std::string newhost); int Module::OnChangeLocalUserGECOS(userrec* user, std::string newhost); int Module::OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic); git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1106 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 632 +++++++++++++++++++-------------------- 1 file changed, 316 insertions(+), 316 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 7b62cb7b9..04bc50c20 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -173,7 +173,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 437 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 493 of file modules.h.

Constructor & Destructor Documentation

@@ -203,10 +203,10 @@ Default constructor.

Creates a Server object.

-Definition at line 345 of file modules.cpp. +Definition at line 354 of file modules.cpp.

-

00346 {
-00347 }
+
00355 {
+00356 }
@@ -239,10 +239,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 349 of file modules.cpp. +Definition at line 358 of file modules.cpp.

-

00350 {
-00351 }
+
00359 {
+00360 }
 
    
   
 
@@ -306,13 +306,13 @@ This allows modules to add extra commands into the command table. You must place
 typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

 When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. 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 426 of file modules.cpp.
+Definition at line 435 of file modules.cpp.
 

 References createcommand().
 

-
00427 {
-00428         createcommand(cmd,f,flags,minparams,source);
-00429 }
+
00436 {
+00437         createcommand(cmd,f,flags,minparams,source);
+00438 }
 
    
   
 
@@ -367,13 +367,13 @@ 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 644 of file modules.cpp.
+Definition at line 653 of file modules.cpp.
 

 References add_eline(), and duration().
 

-
00645 {
-00646         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00647 }
+
00654 {
+00655         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00656 }
 
    
   
 
@@ -412,16 +412,16 @@ 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 571 of file modules.cpp.
+Definition at line 580 of file modules.cpp.
 

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

-
00572 {
-00573         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00574         if (res)
-00575                 ModeMakeList(modechar);
-00576         return res;
-00577 }
+
00581 {
+00582         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00583         if (res)
+00584                 ModeMakeList(modechar);
+00585         return res;
+00586 }
 
    
   
 
@@ -482,28 +482,28 @@ 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 551 of file modules.cpp.
+Definition at line 560 of file modules.cpp.
 

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

-
00552 {
-00553         if (type == MT_SERVER)
-00554         {
-00555                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00556                 return false;
-00557         }
-00558         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00559         {
-00560                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00561                 return false;
-00562         }
-00563         if ((params_when_on>1) || (params_when_off>1))
-00564         {
-00565                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00566                 return false;
-00567         }
-00568         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00569 }
+
00561 {
+00562         if (type == MT_SERVER)
+00563         {
+00564                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00565                 return false;
+00566         }
+00567         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00568         {
+00569                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00570                 return false;
+00571         }
+00572         if ((params_when_on>1) || (params_when_off>1))
+00573         {
+00574                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00575                 return false;
+00576         }
+00577         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00578 }
 
    
   
 
@@ -558,13 +558,13 @@ 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 624 of file modules.cpp.
+Definition at line 633 of file modules.cpp.
 

 References add_gline(), and duration().
 

-
00625 {
-00626         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00627 }
+
00634 {
+00635         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00636 }
 
    
   
 
@@ -619,13 +619,13 @@ 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 639 of file modules.cpp.
+Definition at line 648 of file modules.cpp.
 

 References add_kline(), and duration().
 

-
00640 {
-00641         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00642 }
+
00649 {
+00650         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00651 }
 
    
   
 
@@ -680,13 +680,13 @@ 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 629 of file modules.cpp.
+Definition at line 638 of file modules.cpp.
 

 References add_qline(), and duration().
 

-
00630 {
-00631         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00632 }
+
00639 {
+00640         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00641 }
 
    
   
 
@@ -741,13 +741,13 @@ 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 634 of file modules.cpp.
+Definition at line 643 of file modules.cpp.
 

 References add_zline(), and duration().
 

-
00635 {
-00636         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00637 }
+
00644 {
+00645         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00646 }
 
    
   
 
@@ -781,13 +781,13 @@ 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 674 of file modules.cpp.
+Definition at line 683 of file modules.cpp.
 

 References duration().
 

-
00675 {
-00676         return duration(delta.c_str());
-00677 }
+
00684 {
+00685         return duration(delta.c_str());
+00686 }
 
    
   
 
@@ -843,11 +843,11 @@ 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 416 of file modules.cpp.
+Definition at line 425 of file modules.cpp.
 

-
00417 {
-00418         call_handler(commandname.c_str(),parameters,pcnt,user);
-00419 }
+
00426 {
+00427         call_handler(commandname.c_str(),parameters,pcnt,user);
+00428 }
 
    
   
 
@@ -890,13 +890,13 @@ 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 504 of file modules.cpp.
+Definition at line 513 of file modules.cpp.
 

 References ChangeName().
 

-
00505 {
-00506         ChangeName(user,gecos.c_str());
-00507 }
+
00514 {
+00515         ChangeName(user,gecos.c_str());
+00516 }
 
    
   
 
@@ -939,13 +939,13 @@ 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 499 of file modules.cpp.
+Definition at line 508 of file modules.cpp.
 

 References ChangeDisplayedHost().
 

-
00500 {
-00501         ChangeDisplayedHost(user,host.c_str());
-00502 }
+
00509 {
+00510         ChangeDisplayedHost(user,host.c_str());
+00511 }
 
    
   
 
@@ -988,11 +988,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 400 of file modules.cpp.
+Definition at line 409 of file modules.cpp.
 

-
00401 {
-00402         force_nickchange(user,nickname.c_str());
-00403 }
+
00410 {
+00411         force_nickchange(user,nickname.c_str());
+00412 }
 
    
   
 
@@ -1035,13 +1035,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 524 of file modules.cpp.
+Definition at line 533 of file modules.cpp.
 

 References cmode().
 

-
00525 {
-00526         return cmode(User,Chan);
-00527 }
+
00534 {
+00535         return cmode(User,Chan);
+00536 }
 
    
   
 
@@ -1084,13 +1084,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 477 of file modules.cpp.
+Definition at line 486 of file modules.cpp.
 

 References common_channels().
 

-
00478 {
-00479         return (common_channels(u1,u2) != 0);
-00480 }
+
00487 {
+00488         return (common_channels(u1,u2) != 0);
+00489 }
 
    
   
 
@@ -1124,11 +1124,11 @@ Returns a count of the number of users on a channel.
 

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

-Definition at line 579 of file modules.cpp.
+Definition at line 588 of file modules.cpp.
 

-
00580 {
-00581         return usercount(c);
-00582 }
+
00589 {
+00590         return usercount(c);
+00591 }
 
    
   
 
@@ -1162,13 +1162,13 @@ Deletes a local E-Line.
 

 
 

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

 References del_eline().
 

-
00670 {
-00671         del_eline(hostmask.c_str());
-00672 }
+
00679 {
+00680         del_eline(hostmask.c_str());
+00681 }
 
    
   
 
@@ -1202,13 +1202,13 @@ Deletes a G-Line from all servers on the mesh.
 

 
 

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

 References del_gline().
 

-
00650 {
-00651         del_gline(hostmask.c_str());
-00652 }
+
00659 {
+00660         del_gline(hostmask.c_str());
+00661 }
 
    
   
 
@@ -1242,13 +1242,13 @@ Deletes a local K-Line.
 

 
 

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

 References del_kline().
 

-
00665 {
-00666         del_kline(hostmask.c_str());
-00667 }
+
00674 {
+00675         del_kline(hostmask.c_str());
+00676 }
 
    
   
 
@@ -1282,13 +1282,13 @@ Deletes a Q-Line from all servers on the mesh.
 

 
 

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

 References del_qline().
 

-
00655 {
-00656         del_qline(nickname.c_str());
-00657 }
+
00664 {
+00665         del_qline(nickname.c_str());
+00666 }
 
    
   
 
@@ -1322,13 +1322,13 @@ Deletes a Z-Line from all servers on the mesh.
 

 
 

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

 References del_zline().
 

-
00660 {
-00661         del_zline(ipaddr.c_str());
-00662 }
+
00669 {
+00670         del_zline(ipaddr.c_str());
+00671 }
 
    
   
 
@@ -1362,11 +1362,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 519 of file modules.cpp.
+Definition at line 528 of file modules.cpp.
 

-
00520 {
-00521         return FindChan(channel.c_str());
-00522 }
+
00529 {
+00530         return FindChan(channel.c_str());
+00531 }
 
    
   
 
@@ -1400,11 +1400,11 @@ Attempts to look up a nick and return a pointer to it.
 

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

-Definition at line 514 of file modules.cpp.
+Definition at line 523 of file modules.cpp.
 

-
00515 {
-00516         return Find(nick);
-00517 }
+
00524 {
+00525         return Find(nick);
+00526 }
 
    
   
 
@@ -1437,11 +1437,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 544 of file modules.cpp.
+Definition at line 553 of file modules.cpp.
 

-
00545 {
-00546         return Admin(getadminname(),getadminemail(),getadminnick());
-00547 }
+
00554 {
+00555         return Admin(getadminname(),getadminemail(),getadminnick());
+00556 }
 
    
   
 
@@ -1474,11 +1474,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 539 of file modules.cpp.
+Definition at line 548 of file modules.cpp.
 

-
00540 {
-00541         return getnetworkname();
-00542 }
+
00549 {
+00550         return getnetworkname();
+00551 }
 
    
   
 
@@ -1511,11 +1511,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 534 of file modules.cpp.
+Definition at line 543 of file modules.cpp.
 

-
00535 {
-00536         return getservername();
-00537 }
+
00544 {
+00545         return getservername();
+00546 }
 
    
   
 
@@ -1549,28 +1549,28 @@ 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 381 of file modules.cpp.
+Definition at line 390 of file modules.cpp.
 

 References chanuserlist, clientlist, has_channel(), and isnick().
 

-
00382 {
-00383         chanuserlist userl;
-00384         userl.clear();
-00385         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00386         {
-00387                 if (i->second)
-00388                 {
-00389                         if (has_channel(i->second,chan))
-00390                         {
-00391                                 if (isnick(i->second->nick))
-00392                                 {
-00393                                         userl.push_back(i->second);
-00394                                 }
-00395                         }
-00396                 }
-00397         }
-00398         return userl;
-00399 }
+
00391 {
+00392         chanuserlist userl;
+00393         userl.clear();
+00394         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+00395         {
+00396                 if (i->second)
+00397                 {
+00398                         if (has_channel(i->second,chan))
+00399                         {
+00400                                 if (isnick(i->second->nick))
+00401                                 {
+00402                                         userl.push_back(i->second);
+00403                                 }
+00404                         }
+00405                 }
+00406         }
+00407         return userl;
+00408 }
 
    
   
 
@@ -1604,13 +1604,13 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 509 of file modules.cpp.
+Definition at line 518 of file modules.cpp.
 

 References isnick().
 

-
00510 {
-00511         return (isnick(nick.c_str()) != 0);
-00512 }
+
00519 {
+00520         return (isnick(nick.c_str()) != 0);
+00521 }
 
    
   
 
@@ -1653,13 +1653,13 @@ 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 529 of file modules.cpp.
+Definition at line 538 of file modules.cpp.
 

 References has_channel().
 

-
00530 {
-00531         return has_channel(User,Chan);
-00532 }
+
00539 {
+00540         return has_channel(User,Chan);
+00541 }
 
    
   
 
@@ -1693,13 +1693,13 @@ 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 411 of file modules.cpp.
+Definition at line 420 of file modules.cpp.
 

 References is_uline().
 

-
00412 {
-00413         return is_uline(server.c_str());
-00414 }
+
00421 {
+00422         return is_uline(server.c_str());
+00423 }
 
    
   
 
@@ -1733,35 +1733,35 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.
 

 
 

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

-
00680 {
-00681         const char* dest = mask.c_str();
-00682         if (strchr(dest,'!')==0)
-00683                 return false;
-00684         if (strchr(dest,'@')==0)
-00685                 return false;
-00686         for (int i = 0; i < strlen(dest); i++)
-00687                 if (dest[i] < 32)
-00688                         return false;
-00689         for (int i = 0; i < strlen(dest); i++)
-00690                 if (dest[i] > 126)
-00691                         return false;
-00692         int c = 0;
-00693         for (int i = 0; i < strlen(dest); i++)
-00694                 if (dest[i] == '!')
-00695                         c++;
-00696         if (c>1)
-00697                 return false;
-00698         c = 0;
-00699         for (int i = 0; i < strlen(dest); i++)
-00700                 if (dest[i] == '@')
-00701                         c++;
-00702         if (c>1)
-00703                 return false;
-00704 
-00705         return true;
-00706 }
+Definition at line 688 of file modules.cpp.
+

+
00689 {
+00690         const char* dest = mask.c_str();
+00691         if (strchr(dest,'!')==0)
+00692                 return false;
+00693         if (strchr(dest,'@')==0)
+00694                 return false;
+00695         for (int i = 0; i < strlen(dest); i++)
+00696                 if (dest[i] < 32)
+00697                         return false;
+00698         for (int i = 0; i < strlen(dest); i++)
+00699                 if (dest[i] > 126)
+00700                         return false;
+00701         int c = 0;
+00702         for (int i = 0; i < strlen(dest); i++)
+00703                 if (dest[i] == '!')
+00704                         c++;
+00705         if (c>1)
+00706                 return false;
+00707         c = 0;
+00708         for (int i = 0; i < strlen(dest); i++)
+00709                 if (dest[i] == '@')
+00710                         c++;
+00711         if (c>1)
+00712                 return false;
+00713 
+00714         return true;
+00715 }
 
    
   
 
@@ -1810,11 +1810,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 371 of file modules.cpp.
+Definition at line 380 of file modules.cpp.
 

-
00372 {
-00373         return add_channel(user,cname.c_str(),key.c_str(),true);
-00374 }
+
00381 {
+00382         return add_channel(user,cname.c_str(),key.c_str(),true);
+00383 }
 
    
   
 
@@ -1857,11 +1857,11 @@ Writes a log string.
 

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

-Definition at line 421 of file modules.cpp.
+Definition at line 430 of file modules.cpp.
 

-
00422 {
-00423         log(level,"%s",s.c_str());
-00424 }
+
00431 {
+00432         log(level,"%s",s.c_str());
+00433 }
 
    
   
 
@@ -1904,14 +1904,14 @@ 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 358 of file modules.cpp.
+Definition at line 367 of file modules.cpp.
 

-
00359 {
-00360         char literal[MAXBUF],pattern[MAXBUF];
-00361         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00362         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00363         return match(literal,pattern);
-00364 }
+
00368 {
+00369         char literal[MAXBUF],pattern[MAXBUF];
+00370         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00371         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00372         return match(literal,pattern);
+00373 }
 
    
   
 
@@ -1960,11 +1960,11 @@ 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 376 of file modules.cpp.
+Definition at line 385 of file modules.cpp.
 

-
00377 {
-00378         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00379 }
+
00386 {
+00387         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00388 }
 
    
   
 
@@ -2013,38 +2013,38 @@ 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 594 of file modules.cpp.
+Definition at line 603 of file modules.cpp.
 

 References ucrec::channel, userrec::chans, chanrec::created, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
 

-
00595 {
-00596         zombie->fd = alive->fd;
-00597         alive->fd = FD_MAGIC_NUMBER;
-00598         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00599         kill_link(alive,message.c_str());
-00600         for (int i = 0; i != MAXCHANS; i++)
-00601         {
-00602                 if (zombie->chans[i].channel != NULL)
-00603                 {
-00604                         if (zombie->chans[i].channel->name)
-00605                         {
-00606                                 chanrec* Ptr = zombie->chans[i].channel;
-00607                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00608                                 if (Ptr->topicset)
-00609                                 {
-00610                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00611                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00612                                 }
-00613                                 userlist(zombie,Ptr);
-00614                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00615                                 WriteServ(zombie->fd,"324 %s %s +%s",zombie->nick, Ptr->name,chanmodes(Ptr));
-00616                                 WriteServ(zombie->fd,"329 %s %s %d", zombie->nick, Ptr->name, Ptr->created);
-00617 
-00618                         }
-00619                 }
-00620         }
-00621 
-00622 }
+
00604 {
+00605         zombie->fd = alive->fd;
+00606         alive->fd = FD_MAGIC_NUMBER;
+00607         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00608         kill_link(alive,message.c_str());
+00609         for (int i = 0; i != MAXCHANS; i++)
+00610         {
+00611                 if (zombie->chans[i].channel != NULL)
+00612                 {
+00613                         if (zombie->chans[i].channel->name)
+00614                         {
+00615                                 chanrec* Ptr = zombie->chans[i].channel;
+00616                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00617                                 if (Ptr->topicset)
+00618                                 {
+00619                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00620                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00621                                 }
+00622                                 userlist(zombie,Ptr);
+00623                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00624                                 WriteServ(zombie->fd,"324 %s %s +%s",zombie->nick, Ptr->name,chanmodes(Ptr));
+00625                                 WriteServ(zombie->fd,"329 %s %s %d", zombie->nick, Ptr->name, Ptr->created);
+00626 
+00627                         }
+00628                 }
+00629         }
+00630 
+00631 }
 
    
   
 
@@ -2089,14 +2089,14 @@ 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 405 of file modules.cpp.
+Definition at line 414 of file modules.cpp.
 

 References userrec::nick, and send_network_quit().
 

-
00406 {
-00407         send_network_quit(user->nick,reason.c_str());
-00408         kill_link(user,reason.c_str());
-00409 }
+
00415 {
+00416         send_network_quit(user->nick,reason.c_str());
+00417         kill_link(user,reason.c_str());
+00418 }
 
    
   
 
@@ -2139,11 +2139,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 436 of file modules.cpp.
+Definition at line 445 of file modules.cpp.
 

-
00437 {
-00438         Write(Socket,"%s",s.c_str());
-00439 }
+
00446 {
+00447         Write(Socket,"%s",s.c_str());
+00448 }
 
    
   
 
@@ -2198,18 +2198,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 465 of file modules.cpp.
-

-
00466 {
-00467         if (IncludeSender)
-00468         {
-00469                 WriteChannel(Channel,User,"%s",s.c_str());
-00470         }
-00471         else
-00472         {
-00473                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00474         }
-00475 }
+Definition at line 474 of file modules.cpp.
+

+
00475 {
+00476         if (IncludeSender)
+00477         {
+00478                 WriteChannel(Channel,User,"%s",s.c_str());
+00479         }
+00480         else
+00481         {
+00482                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00483         }
+00484 }
 
    
   
 
@@ -2258,18 +2258,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 482 of file modules.cpp.
-

-
00483 {
-00484         if (IncludeSender)
-00485         {
-00486                 WriteCommon(User,"%s",text.c_str());
-00487         }
-00488         else
-00489         {
-00490                 WriteCommonExcept(User,"%s",text.c_str());
-00491         }
-00492 }
+Definition at line 491 of file modules.cpp.
+

+
00492 {
+00493         if (IncludeSender)
+00494         {
+00495                 WriteCommon(User,"%s",text.c_str());
+00496         }
+00497         else
+00498         {
+00499                 WriteCommonExcept(User,"%s",text.c_str());
+00500         }
+00501 }
 
    
   
 
@@ -2318,11 +2318,11 @@ Sends text from a user to a socket.
 

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

-Definition at line 446 of file modules.cpp.
+Definition at line 455 of file modules.cpp.
 

-
00447 {
-00448         WriteFrom(Socket,User,"%s",s.c_str());
-00449 }
+
00456 {
+00457         WriteFrom(Socket,User,"%s",s.c_str());
+00458 }
 
    
   
 
@@ -2378,13 +2378,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 431 of file modules.cpp.
+Definition at line 440 of file modules.cpp.
 

 References server_mode().
 

-
00432 {
-00433         server_mode(parameters,pcnt,user);
-00434 }
+
00441 {
+00442         server_mode(parameters,pcnt,user);
+00443 }
 
    
   
 
@@ -2418,11 +2418,11 @@ Sends text to all opers.
 

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

-Definition at line 353 of file modules.cpp.
+Definition at line 362 of file modules.cpp.
 

-
00354 {
-00355         WriteOpers("%s",s.c_str());
-00356 }
+
00363 {
+00364         WriteOpers("%s",s.c_str());
+00365 }
 
    
   
 
@@ -2465,11 +2465,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 441 of file modules.cpp.
+Definition at line 450 of file modules.cpp.
 

-
00442 {
-00443         WriteServ(Socket,"%s",s.c_str());
-00444 }
+
00451 {
+00452         WriteServ(Socket,"%s",s.c_str());
+00453 }
 
    
   
 
@@ -2522,22 +2522,22 @@ The format will become:

 :localserver TEXT

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

-Definition at line 451 of file modules.cpp.
+Definition at line 460 of file modules.cpp.
 

 References connection::fd.
 

-
00452 {
-00453         if (!Source)
-00454         {
-00455                 // if source is NULL, then the message originates from the local server
-00456                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00457         }
-00458         else
-00459         {
-00460                 // otherwise it comes from the user specified
-00461                 WriteTo(Source,Dest,"%s",s.c_str());
-00462         }
-00463 }
+
00461 {
+00462         if (!Source)
+00463         {
+00464                 // if source is NULL, then the message originates from the local server
+00465                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00466         }
+00467         else
+00468         {
+00469                 // otherwise it comes from the user specified
+00470                 WriteTo(Source,Dest,"%s",s.c_str());
+00471         }
+00472 }
 
    
   
 
@@ -2588,11 +2588,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 366 of file modules.cpp.
+Definition at line 375 of file modules.cpp.
 

-
00367 {
-00368         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00369 }
+
00376 {
+00377         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00378 }
 
    
   
 
@@ -2635,11 +2635,11 @@ 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 494 of file modules.cpp.
+Definition at line 503 of file modules.cpp.
 

-
00495 {
-00496         WriteWallOps(User,false,"%s",text.c_str());
-00497 }
+
00504 {
+00505         WriteWallOps(User,false,"%s",text.c_str());
+00506 }
 
    
   
 
@@ -2682,23 +2682,23 @@ 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 585 of file modules.cpp.
+Definition at line 594 of file modules.cpp.
 

 References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
 

-
00586 {
-00587         unsigned int old_fd = user->fd;
-00588         user->fd = FD_MAGIC_NUMBER;
-00589         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00590         close(old_fd);
-00591         shutdown (old_fd,2);
-00592 }
+
00595 {
+00596         unsigned int old_fd = user->fd;
+00597         user->fd = FD_MAGIC_NUMBER;
+00598         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00599         close(old_fd);
+00600         shutdown (old_fd,2);
+00601 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Fri Apr 15 14:50:52 2005 for InspIRCd by
+
Generated on Fri Apr 15 19:30:25 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91