From a96514c284514116300794696f062c7fa6b1f79f Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 19:17:41 +0000 Subject: Added new docs for class InspIRCd and globals.h etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 732 +++++++++++++++++++++------------------ 1 file changed, 386 insertions(+), 346 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 065d3386c..67c35d924 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -102,7 +102,7 @@ Inheritance diagram for Server:

virtual bool AddExtendedListMode (char modechar)  Adds an extended mode letter which is parsed by a module and handled in a list fashion.
-virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) +virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source)  Adds a command to the command table.
virtual void SendMode (char **parameters, int pcnt, userrec *user) @@ -233,8 +233,8 @@ Default constructor.

Creates a Server object.

-Definition at line 313 of file modules.cpp.

00314 {
-00315 }
+Definition at line 305 of file modules.cpp.
00306 {
+00307 }
 

 

     
@@ -268,8 +268,8 @@ Default destructor.
 

 Destroys a Server object.
 

-Definition at line 317 of file modules.cpp.
00318 {
-00319 }
+Definition at line 309 of file modules.cpp.
00310 {
+00311 }
 

 

     
@@ -290,7 +290,7 @@ Definition at line 317
         
           
           
-          handlerfunc 
+          handlerfunc 
            f, 
         
         
@@ -334,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 419 of file modules.cpp.
+Definition at line 411 of file modules.cpp.
 

-References createcommand().
00420 {
-00421         createcommand(cmd,f,flags,minparams,source);
-00422 }
+References createcommand().
00412 {
+00413         createcommand(cmd,f,flags,minparams,source);
+00414 }
 

 

     
@@ -394,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 663 of file modules.cpp.
+Definition at line 655 of file modules.cpp.
 

-References add_eline().
00664 {
-00665         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00666 }
+References add_eline().
00656 {
+00657         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00658 }
 

 

     
@@ -436,16 +436,16 @@ This call is used to implement modes like +q and +a. The characteristics of thes
 (2) They always take exactly one parameter when being added or removed

 (3) They can be set multiple times, usually on users in channels

 (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.
+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 587 of file modules.cpp.
+Definition at line 579 of file modules.cpp.
 

-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 }
+References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
00580 {
+00581         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00582         if (res)
+00583                 ModeMakeList(modechar);
+00584         return res;
+00585 }
 

 

     
@@ -507,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 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 *** Modes of type MT_SERVER are reserved for future expansion");
-00566                         return false;
-00567                 }
-00568                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00569                 {
-00570                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00571                         return false;
-00572                 }
-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 }
+Definition at line 551 of file modules.cpp.
+

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

 

     
@@ -590,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 643 of file modules.cpp.
+Definition at line 635 of file modules.cpp.
 

-References add_gline().
00644 {
-00645         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00646 }
+References add_gline().
00636 {
+00637         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00638 }
 

 

     
@@ -650,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 658 of file modules.cpp.
+Definition at line 650 of file modules.cpp.
 

-References add_kline().
00659 {
-00660         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00661 }
+References add_kline().
00651 {
+00652         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00653 }
 

 

     
@@ -710,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 648 of file modules.cpp.
+Definition at line 640 of file modules.cpp.
 

-References add_qline().
00649 {
-00650         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00651 }
+References add_qline().
00641 {
+00642         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00643 }
 

 

     
@@ -749,11 +749,11 @@ Adds a class derived from InspSocket
 
 

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

-References module_sockets.
00322 {
-00323         module_sockets.push_back(sock);
-00324 }
+References module_sockets.
00314 {
+00315         module_sockets.push_back(sock);
+00316 }
 

 

     
@@ -809,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 653 of file modules.cpp.
+Definition at line 645 of file modules.cpp.
 

-References add_zline().
00654 {
-00655         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00656 }
+References add_zline().
00646 {
+00647         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00648 }
 

 

     
@@ -848,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 693 of file modules.cpp.
+Definition at line 685 of file modules.cpp.
 

-References duration().
00694 {
-00695         return duration(delta.c_str());
-00696 }
+References duration().
00686 {
+00687         return duration(delta.c_str());
+00688 }
 

 

     
@@ -909,9 +909,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 404 of file modules.cpp.
00405 {
-00406         call_handler(commandname.c_str(),parameters,pcnt,user);
-00407 }
+Definition at line 396 of file modules.cpp.
+

+References call_handler().
00397 {
+00398         call_handler(commandname.c_str(),parameters,pcnt,user);
+00399 }
 

 

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

-References ChangeName().
00503 {
-00504         ChangeName(user,gecos.c_str());
-00505 }
+References ChangeName().
00495 {
+00496         ChangeName(user,gecos.c_str());
+00497 }
 

 

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

-References ChangeDisplayedHost().
00498 {
-00499         ChangeDisplayedHost(user,host.c_str());
-00500 }
+References ChangeDisplayedHost().
00490 {
+00491         ChangeDisplayedHost(user,host.c_str());
+00492 }
 

 

     
@@ -1051,9 +1053,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 389 of file modules.cpp.
00390 {
-00391         force_nickchange(user,nickname.c_str());
-00392 }
+Definition at line 381 of file modules.cpp.
+

+References force_nickchange().
00382 {
+00383         force_nickchange(user,nickname.c_str());
+00384 }
 

 

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

-References cmode().
00528 {
-00529         return cmode(User,Chan);
-00530 }
+References cmode().
00520 {
+00521         return cmode(User,Chan);
+00522 }
 

 

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

-References common_channels().
00476 {
-00477         return (common_channels(u1,u2) != 0);
-00478 }
+References common_channels().
00468 {
+00469         return (common_channels(u1,u2) != 0);
+00470 }
 

 

     
@@ -1184,9 +1188,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 595 of file modules.cpp.
00596 {
-00597         return usercount(c);
-00598 }
+Definition at line 587 of file modules.cpp.
00588 {
+00589         return usercount(c);
+00590 }
 

 

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

 
 

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

-References del_eline().
00689 {
-00690         return del_eline(hostmask.c_str());
-00691 }
+References del_eline().
00681 {
+00682         return del_eline(hostmask.c_str());
+00683 }
 

 

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

 
 

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

-References del_gline().
00669 {
-00670         return del_gline(hostmask.c_str());
-00671 }
+References del_gline().
00661 {
+00662         return del_gline(hostmask.c_str());
+00663 }
 

 

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

 
 

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

-References del_kline().
00684 {
-00685         return del_kline(hostmask.c_str());
-00686 }
+References del_kline().
00676 {
+00677         return del_kline(hostmask.c_str());
+00678 }
 

 

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

 
 

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

-References del_qline().
00674 {
-00675         return del_qline(nickname.c_str());
-00676 }
+References del_qline().
00666 {
+00667         return del_qline(nickname.c_str());
+00668 }
 

 

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

 
 

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

-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 }
+References module_sockets.
00330 {
+00331         for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
+00332         {
+00333                 if (*a == sock)
+00334                 {
+00335                         module_sockets.erase(a);
+00336                         return;
+00337                 }
+00338         }
+00339 }
 

 

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

 
 

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

-References del_zline().
00679 {
-00680         return del_zline(ipaddr.c_str());
-00681 }
+References del_zline().
00671 {
+00672         return del_zline(ipaddr.c_str());
+00673 }
 

 

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

+References FindChan().
00515 {
+00516         return FindChan(channel.c_str());
+00517 }
 

 

     
@@ -1499,9 +1505,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 517 of file modules.cpp.
00518 {
-00519         return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00520 }
+Definition at line 509 of file modules.cpp.
00510 {
+00511         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00512 }
 

 

     
@@ -1536,18 +1542,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 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 }
+Definition at line 719 of file modules.cpp.
+

+References MODCOUNT, ServerConfig::module_names, and modules.
00720 {
+00721         for (int i = 0; i <= MODCOUNT; i++)
+00722         {
+00723                 if (Config->module_names[i] == name)
+00724                 {
+00725                         return modules[i];
+00726                 }
+00727         }
+00728         return NULL;
+00729 }
 

 

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

+References Find().
00505 {
+00506         return Find(nick);
+00507 }
 

 

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

+References ServerConfig::AdminEmail, ServerConfig::AdminName, and ServerConfig::AdminNick.
00545 {
+00546         return Admin(Config->AdminName,Config->AdminEmail,Config->AdminNick);
+00547 }
 

 

     
@@ -1654,9 +1664,9 @@ Obtains a pointer to the server's Se
 

 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 }
+Definition at line 324 of file modules.cpp.
00325 {
+00326         return Config;
+00327 }
 

 

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

 
 

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

+References ServerConfig::Network.
00535 {
+00536         return Config->Network;
+00537 }
 

 

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

 
 

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

+References ServerConfig::ServerDesc.
00540 {
+00541         return Config->ServerDesc;
+00542 }
 

 

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

 
 

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

+References ServerConfig::ServerName.
00530 {
+00531         return Config->ServerName;
+00532 }
 

 

     
@@ -1799,19 +1815,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 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 }
+Definition at line 369 of file modules.cpp.
+

+References chanrec::GetUsers().
00370 {
+00371         chanuserlist userl;
+00372         userl.clear();
+00373         std::vector<char*> *list = chan->GetUsers();
+00374         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+00375         {
+00376                 char* o = *i;
+00377                 userl.push_back((userrec*)o);
+00378         }
+00379         return userl;
+00380 }
 

 

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

 Nicks for unregistered connections will return false.
 

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

-References isnick().
00508 {
-00509         return (isnick(nick.c_str()) != 0);
-00510 }
+References isnick().
00500 {
+00501         return (isnick(nick.c_str()) != 0);
+00502 }
 

 

     
@@ -1894,11 +1910,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 532 of file modules.cpp.
+Definition at line 524 of file modules.cpp.
 

-References has_channel().
00533 {
-00534         return has_channel(User,Chan);
-00535 }
+References has_channel().
00525 {
+00526         return has_channel(User,Chan);
+00527 }
 

 

     
@@ -1933,11 +1949,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 399 of file modules.cpp.
+Definition at line 391 of file modules.cpp.
 

-References is_uline().
00400 {
-00401         return is_uline(server.c_str());
-00402 }
+References is_uline().
00392 {
+00393         return is_uline(server.c_str());
+00394 }
 

 

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

 
 

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

 

     
@@ -2046,9 +2062,11 @@ Definition at line 698
 

 
 

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

+References is_valid_cmd().
00402 {
+00403         return is_valid_cmd(commandname.c_str(), pcnt, user);
+00404 }
 

 

     
@@ -2098,9 +2116,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 367 of file modules.cpp.
00368 {
-00369         return add_channel(user,cname.c_str(),key.c_str(),false);
-00370 }
+Definition at line 359 of file modules.cpp.
+

+References add_channel().
00360 {
+00361         return add_channel(user,cname.c_str(),key.c_str(),false);
+00362 }
 

 

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

+References log().
00407 {
+00408         log(level,"%s",s.c_str());
+00409 }
 

 

     
@@ -2190,12 +2212,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 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 }
+Definition at line 346 of file modules.cpp.
00347 {
+00348         char literal[MAXBUF],pattern[MAXBUF];
+00349         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00350         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00351         return match(literal,pattern);
+00352 }
 

 

     
@@ -2245,9 +2267,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 372 of file modules.cpp.
00373 {
-00374         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00375 }
+Definition at line 364 of file modules.cpp.
+

+References del_channel().
00365 {
+00366         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00367 }
 

 

     
@@ -2297,36 +2321,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 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 }
+Definition at line 605 of file modules.cpp.
+

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

 

     
@@ -2372,9 +2396,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 394 of file modules.cpp.
00395 {
-00396         kill_link(user,reason.c_str());
-00397 }
+Definition at line 386 of file modules.cpp.
+

+References kill_link().
00387 {
+00388         kill_link(user,reason.c_str());
+00389 }
 

 

     
@@ -2406,12 +2432,12 @@ Definition at line 394
 

 
 

-Definition at line 326 of file modules.cpp.
+Definition at line 318 of file modules.cpp.
 

-References ServerConfig::Read().
00327 {
-00328         WriteOpers("*** Rehashing config file");
-00329         Config->Read(false,NULL);
-00330 }
+References ServerConfig::Read(), and WriteOpers().
00319 {
+00320         WriteOpers("*** Rehashing config file");
+00321         Config->Read(false,NULL);
+00322 }
 

 

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

+References Write().
00422 {
+00423         Write(Socket,"%s",s.c_str());
+00424 }
 

 

     
@@ -2513,16 +2541,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 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 }
+Definition at line 455 of file modules.cpp.
+

+References ChanExceptSender(), and WriteChannel().
00456 {
+00457         if (IncludeSender)
+00458         {
+00459                 WriteChannel(Channel,User,"%s",s.c_str());
+00460         }
+00461         else
+00462         {
+00463                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00464         }
+00465 }
 

 

     
@@ -2572,9 +2602,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 458 of file modules.cpp.
00459 {
-00460         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00461 }
+Definition at line 450 of file modules.cpp.
00451 {
+00452         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00453 }
 

 

     
@@ -2624,16 +2654,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 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 }
+Definition at line 472 of file modules.cpp.
+

+References WriteCommon(), and WriteCommonExcept().
00473 {
+00474         if (IncludeSender)
+00475         {
+00476                 WriteCommon(User,"%s",text.c_str());
+00477         }
+00478         else
+00479         {
+00480                 WriteCommonExcept(User,"%s",text.c_str());
+00481         }
+00482 }
 

 

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

+References WriteFrom().
00432 {
+00433         WriteFrom(Socket,User,"%s",s.c_str());
+00434 }
 

 

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

-References server_mode().
00425 {
-00426         server_mode(parameters,pcnt,user);
-00427 }
+References server_mode().
00417 {
+00418         server_mode(parameters,pcnt,user);
+00419 }
 

 

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

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

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

+References WriteOpers().
00342 {
+00343         WriteOpers("%s",s.c_str());
+00344 }
 

 

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

+References WriteServ().
00427 {
+00428         WriteServ(Socket,"%s",s.c_str());
+00429 }
 

 

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

 :localserver TEXT

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

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

-References connection::fd.
00445 {
-00446         if (!Source)
-00447         {
-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         else
-00452         {
-00453                 // otherwise it comes from the user specified
-00454                 WriteTo(Source,Dest,"%s",s.c_str());
-00455         }
-00456 }
+Definition at line 436 of file modules.cpp.
+

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

 

     
@@ -2948,9 +2986,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 362 of file modules.cpp.
00363 {
-00364         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00365 }
+Definition at line 354 of file modules.cpp.
00355 {
+00356         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00357 }
 

 

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

+References WriteWallOps().
00485 {
+00486         WriteWallOps(User,false,"%s",text.c_str());
+00487 }
 

 

     
@@ -3040,18 +3080,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 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 }
+Definition at line 593 of file modules.cpp.
+

+References userrec::ClearBuffer(), SocketEngine::DelFd(), connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, and Write().
00594 {
+00595         unsigned int old_fd = user->fd;
+00596         user->fd = FD_MAGIC_NUMBER;
+00597         user->ClearBuffer();
+00598         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00599         SE->DelFd(old_fd);
+00600         shutdown(old_fd,2);
+00601         close(old_fd);
+00602         return true;
+00603 }
 

 

     
@@ -3059,7 +3099,7 @@ References userrec::ClearBuff
 
 
The documentation for this class was generated from the following files:
-
Generated on Wed Dec 14 15:55:50 2005 for InspIRCd by 
+
Generated on Wed Dec 14 19:16:27 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.2.3