From 71bedf497cde8b0b38afbb366828b3df9c2803d6 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:04:22 +0000 Subject: git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2578 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 785 +++++++++++++++++++-------------------- 1 file changed, 379 insertions(+), 406 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 21df2ba69..e7ec5d474 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -105,9 +105,9 @@ 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 (command_t *f) - Adds a command to the command table.
+ Adds a command to the command table.
virtual void SendMode (char **parameters, int pcnt, userrec *user)  Sends a servermode.
@@ -207,7 +207,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 1096 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1114 of file modules.h.

Constructor & Destructor Documentation

@@ -236,8 +236,8 @@ Default constructor.

Creates a Server object.

-Definition at line 305 of file modules.cpp.

00306 {
-00307 }
+Definition at line 304 of file modules.cpp.
00305 {
+00306 }
 

 

     
@@ -271,15 +271,15 @@ Default destructor.
 

 Destroys a Server object.
 

-Definition at line 309 of file modules.cpp.
00310 {
-00311 }
+Definition at line 308 of file modules.cpp.
00309 {
+00310 }

Member Function Documentation

-

+

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
@@ -287,37 +287,10 @@ Definition at line 309
void Server::AddCommand ( char *  cmd,
handlerfunc  f,
char  flags,
int  minparams,
char *  source
)  [virtual]command_t *  f  )  [virtual]
@@ -334,14 +307,14 @@ Definition at line 309 Adds a command to the command table.

This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:

-typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

+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 416 of file modules.cpp. +Definition at line 415 of file modules.cpp.

-References createcommand().

00417 {
-00418         createcommand(cmd,f,flags,minparams,source);
-00419 }
+References InspIRCd::Parser.
00416 {
+00417         ServerInstance->Parser->CreateCommand(f);
+00418 }
 

 

     
@@ -397,11 +370,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 660 of file modules.cpp.
+Definition at line 659 of file modules.cpp.
 

-References add_eline().
00661 {
-00662         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00663 }
+References add_eline().
00660 {
+00661         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00662 }
 

 

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

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

-Definition at line 584 of file modules.cpp.
+Definition at line 583 of file modules.cpp.
 

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

 

     
@@ -510,34 +483,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 556 of file modules.cpp.
-

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

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

 

     
@@ -593,11 +566,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 640 of file modules.cpp.
+Definition at line 639 of file modules.cpp.
 

-References add_gline().
00641 {
-00642         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00643 }
+References add_gline().
00640 {
+00641         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00642 }
 

 

     
@@ -653,11 +626,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 655 of file modules.cpp.
+Definition at line 654 of file modules.cpp.
 

-References add_kline().
00656 {
-00657         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00658 }
+References add_kline().
00655 {
+00656         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00657 }
 

 

     
@@ -713,11 +686,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 645 of file modules.cpp.
+Definition at line 644 of file modules.cpp.
 

-References add_qline().
00646 {
-00647         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00648 }
+References add_qline().
00645 {
+00646         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00647 }
 

 

     
@@ -752,11 +725,11 @@ Adds a class derived from InspSocket
 
 

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

-References module_sockets.
00314 {
-00315         module_sockets.push_back(sock);
-00316 }
+References module_sockets.
00313 {
+00314         module_sockets.push_back(sock);
+00315 }
 

 

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

-References add_zline().
00651 {
-00652         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00653 }
+References add_zline().
00650 {
+00651         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00652 }
 

 

     
@@ -851,11 +824,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 690 of file modules.cpp.
+Definition at line 689 of file modules.cpp.
 

-References duration().
00691 {
-00692         return duration(delta.c_str());
-00693 }
+References duration().
00690 {
+00691         return duration(delta.c_str());
+00692 }
 

 

     
@@ -910,13 +883,13 @@ References 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 401 of file modules.cpp.
+Definition at line 400 of file modules.cpp.
 

-References call_handler().
00402 {
-00403         call_handler(commandname.c_str(),parameters,pcnt,user);
-00404 }
+References InspIRCd::Parser.
00401 {
+00402         ServerInstance->Parser->CallHandler(commandname,parameters,pcnt,user);
+00403 }
 

 

     
@@ -960,11 +933,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 499 of file modules.cpp.
+Definition at line 498 of file modules.cpp.
 

-References ChangeName().
00500 {
-00501         ChangeName(user,gecos.c_str());
-00502 }
+References ChangeName().
00499 {
+00500         ChangeName(user,gecos.c_str());
+00501 }
 

 

     
@@ -1008,11 +981,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 494 of file modules.cpp.
+Definition at line 493 of file modules.cpp.
 

-References ChangeDisplayedHost().
00495 {
-00496         ChangeDisplayedHost(user,host.c_str());
-00497 }
+References ChangeDisplayedHost().
00494 {
+00495         ChangeDisplayedHost(user,host.c_str());
+00496 }
 

 

     
@@ -1056,11 +1029,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 386 of file modules.cpp.
+Definition at line 385 of file modules.cpp.
 

-References force_nickchange().
00387 {
-00388         force_nickchange(user,nickname.c_str());
-00389 }
+References force_nickchange().
00386 {
+00387         force_nickchange(user,nickname.c_str());
+00388 }
 

 

     
@@ -1104,11 +1077,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 524 of file modules.cpp.
+Definition at line 523 of file modules.cpp.
 

-References cmode().
00525 {
-00526         return cmode(User,Chan);
-00527 }
+References cmode().
00524 {
+00525         return cmode(User,Chan);
+00526 }
 

 

     
@@ -1152,11 +1125,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 472 of file modules.cpp.
+Definition at line 471 of file modules.cpp.
 

-References common_channels().
00473 {
-00474         return (common_channels(u1,u2) != 0);
-00475 }
+References common_channels().
00472 {
+00473         return (common_channels(u1,u2) != 0);
+00474 }
 

 

     
@@ -1191,9 +1164,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 592 of file modules.cpp.
00593 {
-00594         return usercount(c);
-00595 }
+Definition at line 591 of file modules.cpp.
00592 {
+00593         return usercount(c);
+00594 }
 

 

     
@@ -1228,11 +1201,11 @@ Deletes a local E-Line.
 

 
 

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

-References del_eline().
00686 {
-00687         return del_eline(hostmask.c_str());
-00688 }
+References del_eline().
00685 {
+00686         return del_eline(hostmask.c_str());
+00687 }
 

 

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

 
 

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

-References del_gline().
00666 {
-00667         return del_gline(hostmask.c_str());
-00668 }
+References del_gline().
00665 {
+00666         return del_gline(hostmask.c_str());
+00667 }
 

 

     
@@ -1306,11 +1279,11 @@ Deletes a local K-Line.
 

 
 

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

-References del_kline().
00681 {
-00682         return del_kline(hostmask.c_str());
-00683 }
+References del_kline().
00680 {
+00681         return del_kline(hostmask.c_str());
+00682 }
 

 

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

 
 

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

-References del_qline().
00671 {
-00672         return del_qline(nickname.c_str());
-00673 }
+References del_qline().
00670 {
+00671         return del_qline(nickname.c_str());
+00672 }
 

 

     
@@ -1384,18 +1357,18 @@ Deletes a class derived from InspSocke
 

 
 

-Definition at line 334 of file modules.cpp.
+Definition at line 333 of file modules.cpp.
 

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

 

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

 
 

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

-References del_zline().
00676 {
-00677         return del_zline(ipaddr.c_str());
-00678 }
+References del_zline().
00675 {
+00676         return del_zline(ipaddr.c_str());
+00677 }
 

 

     
@@ -1469,11 +1442,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 518 of file modules.cpp.
 

-References FindChan().
00520 {
-00521         return FindChan(channel.c_str());
-00522 }
+References FindChan().
00519 {
+00520         return FindChan(channel.c_str());
+00521 }
 

 

     
@@ -1508,9 +1481,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 514 of file modules.cpp.
00515 {
-00516         return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00517 }
+Definition at line 513 of file modules.cpp.
00514 {
+00515         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00516 }
 

 

     
@@ -1545,18 +1518,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 724 of file modules.cpp.
-

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

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

 

     
@@ -1591,11 +1564,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 509 of file modules.cpp.
+Definition at line 508 of file modules.cpp.
 

-References Find().
00510 {
-00511         return Find(nick);
-00512 }
+References Find().
00509 {
+00510         return Find(nick);
+00511 }
 

 

     
@@ -1629,11 +1602,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 549 of file modules.cpp.
+Definition at line 548 of file modules.cpp.
 

-References ServerConfig::AdminEmail, ServerConfig::AdminName, and ServerConfig::AdminNick.
00550 {
-00551         return Admin(Config->AdminName,Config->AdminEmail,Config->AdminNick);
-00552 }
+References ServerConfig::AdminEmail, ServerConfig::AdminName, and ServerConfig::AdminNick.
00549 {
+00550         return Admin(Config->AdminName,Config->AdminEmail,Config->AdminNick);
+00551 }
 

 

     
@@ -1667,9 +1640,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 324 of file modules.cpp.
00325 {
-00326         return Config;
-00327 }
+Definition at line 323 of file modules.cpp.
00324 {
+00325         return Config;
+00326 }
 

 

     
@@ -1703,11 +1676,11 @@ Returns the network name, global to all linked servers.
 

 
 

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

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

 

     
@@ -1741,11 +1714,11 @@ Returns the server description string of the local server.
 

 
 

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

-References ServerConfig::ServerDesc.
00545 {
-00546         return Config->ServerDesc;
-00547 }
+References ServerConfig::ServerDesc.
00544 {
+00545         return Config->ServerDesc;
+00546 }
 

 

     
@@ -1779,11 +1752,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

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

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

 

     
@@ -1818,19 +1791,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 374 of file modules.cpp.
-

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

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

 

     
@@ -1864,11 +1837,11 @@ Returns the version string of this server.
 

 
 

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

-References InspIRCd::GetVersionString().
00330 {
-00331         return ServerInstance->GetVersionString();
-00332 }
+References InspIRCd::GetVersionString().
00329 {
+00330         return ServerInstance->GetVersionString();
+00331 }
 

 

     
@@ -1903,11 +1876,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 504 of file modules.cpp.
+Definition at line 503 of file modules.cpp.
 

-References isnick().
00505 {
-00506         return (isnick(nick.c_str()) != 0);
-00507 }
+References isnick().
00504 {
+00505         return (isnick(nick.c_str()) != 0);
+00506 }
 

 

     
@@ -1951,11 +1924,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 529 of file modules.cpp.
+Definition at line 528 of file modules.cpp.
 

-References has_channel().
00530 {
-00531         return has_channel(User,Chan);
-00532 }
+References has_channel().
00529 {
+00530         return has_channel(User,Chan);
+00531 }
 

 

     
@@ -1990,11 +1963,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 396 of file modules.cpp.
+Definition at line 395 of file modules.cpp.
 

-References is_uline().
00397 {
-00398         return is_uline(server.c_str());
-00399 }
+References is_uline().
00396 {
+00397         return is_uline(server.c_str());
+00398 }
 

 

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

 
 

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

 

     
@@ -2103,11 +2076,11 @@ Definition at line 695
 

 
 

-Definition at line 406 of file modules.cpp.
+Definition at line 405 of file modules.cpp.
 

-References is_valid_cmd().
00407 {
-00408         return is_valid_cmd(commandname.c_str(), pcnt, user);
-00409 }
+References InspIRCd::Parser.
00406 {
+00407         return ServerInstance->Parser->IsValidCommand(commandname, pcnt, user);
+00408 }
 

 

     
@@ -2157,11 +2130,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 364 of file modules.cpp.
+Definition at line 363 of file modules.cpp.
 

-References add_channel().
00365 {
-00366         return add_channel(user,cname.c_str(),key.c_str(),false);
-00367 }
+References add_channel().
00364 {
+00365         return add_channel(user,cname.c_str(),key.c_str(),false);
+00366 }
 

 

     
@@ -2205,11 +2178,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 411 of file modules.cpp.
+Definition at line 410 of file modules.cpp.
 

-References log().
00412 {
-00413         log(level,"%s",s.c_str());
-00414 }
+References log().
00411 {
+00412         log(level,"%s",s.c_str());
+00413 }
 

 

     
@@ -2253,12 +2226,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 351 of file modules.cpp.
00352 {
-00353         char literal[MAXBUF],pattern[MAXBUF];
-00354         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00355         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00356         return match(literal,pattern);
-00357 }
+Definition at line 350 of file modules.cpp.
00351 {
+00352         char literal[MAXBUF],pattern[MAXBUF];
+00353         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00354         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00355         return match(literal,pattern);
+00356 }
 

 

     
@@ -2308,11 +2281,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 369 of file modules.cpp.
+Definition at line 368 of file modules.cpp.
 

-References del_channel().
00370 {
-00371         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00372 }
+References del_channel().
00369 {
+00370         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00371 }
 

 

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

 

     
@@ -2437,11 +2410,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 391 of file modules.cpp.
+Definition at line 390 of file modules.cpp.
 

-References kill_link().
00392 {
-00393         kill_link(user,reason.c_str());
-00394 }
+References kill_link().
00391 {
+00392         kill_link(user,reason.c_str());
+00393 }
 

 

     
@@ -2473,12 +2446,12 @@ References 318 of file modules.cpp.
+Definition at line 317 of file modules.cpp.
 

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

 

     
@@ -2522,11 +2495,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 426 of file modules.cpp.
+Definition at line 425 of file modules.cpp.
 

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

 

     
@@ -2582,18 +2555,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 460 of file modules.cpp.
-

-References ChanExceptSender(), and WriteChannel().
00461 {
-00462         if (IncludeSender)
-00463         {
-00464                 WriteChannel(Channel,User,"%s",s.c_str());
-00465         }
-00466         else
-00467         {
-00468                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00469         }
-00470 }
+Definition at line 459 of file modules.cpp.
+

+References ChanExceptSender(), and WriteChannel().
00460 {
+00461         if (IncludeSender)
+00462         {
+00463                 WriteChannel(Channel,User,"%s",s.c_str());
+00464         }
+00465         else
+00466         {
+00467                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00468         }
+00469 }
 

 

     
@@ -2643,9 +2616,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 455 of file modules.cpp.
00456 {
-00457         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00458 }
+Definition at line 454 of file modules.cpp.
00455 {
+00456         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00457 }
 

 

     
@@ -2695,18 +2668,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 477 of file modules.cpp.
-

-References WriteCommon(), and WriteCommonExcept().
00478 {
-00479         if (IncludeSender)
-00480         {
-00481                 WriteCommon(User,"%s",text.c_str());
-00482         }
-00483         else
-00484         {
-00485                 WriteCommonExcept(User,"%s",text.c_str());
-00486         }
-00487 }
+Definition at line 476 of file modules.cpp.
+

+References WriteCommon(), and WriteCommonExcept().
00477 {
+00478         if (IncludeSender)
+00479         {
+00480                 WriteCommon(User,"%s",text.c_str());
+00481         }
+00482         else
+00483         {
+00484                 WriteCommonExcept(User,"%s",text.c_str());
+00485         }
+00486 }
 

 

     
@@ -2756,11 +2729,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 436 of file modules.cpp.
+Definition at line 435 of file modules.cpp.
 

-References WriteFrom().
00437 {
-00438         WriteFrom(Socket,User,"%s",s.c_str());
-00439 }
+References WriteFrom().
00436 {
+00437         WriteFrom(Socket,User,"%s",s.c_str());
+00438 }
 

 

     
@@ -2817,11 +2790,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 421 of file modules.cpp.
+Definition at line 420 of file modules.cpp.
 

-References server_mode().
00422 {
-00423         server_mode(parameters,pcnt,user);
-00424 }
+References InspIRCd::ModeGrok, and ModeParser::ServerMode().
00421 {
+00422         ServerInstance->ModeGrok->ServerMode(parameters,pcnt,user);
+00423 }
 

 

     
@@ -2856,11 +2829,11 @@ Sends text to all opers.
 

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

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

-References WriteOpers().
00347 {
-00348         WriteOpers("%s",s.c_str());
-00349 }
+References WriteOpers().
00346 {
+00347         WriteOpers("%s",s.c_str());
+00348 }
 

 

     
@@ -2904,11 +2877,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 431 of file modules.cpp.
+Definition at line 430 of file modules.cpp.
 

-References WriteServ().
00432 {
-00433         WriteServ(Socket,"%s",s.c_str());
-00434 }
+References WriteServ().
00431 {
+00432         WriteServ(Socket,"%s",s.c_str());
+00433 }
 

 

     
@@ -2962,20 +2935,20 @@ The format will become:

 :localserver TEXT

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

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

-References connection::fd, Write(), and WriteTo().
00442 {
-00443         if (!Source)
-00444         {
-00445                 // if source is NULL, then the message originates from the local server
-00446                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00447         }
-00448         else
-00449         {
-00450                 // otherwise it comes from the user specified
-00451                 WriteTo(Source,Dest,"%s",s.c_str());
-00452         }
-00453 }
+Definition at line 440 of file modules.cpp.
+

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

 

     
@@ -3027,9 +3000,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 359 of file modules.cpp.
00360 {
-00361         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00362 }
+Definition at line 358 of file modules.cpp.
00359 {
+00360         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00361 }
 

 

     
@@ -3073,11 +3046,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 489 of file modules.cpp.
+Definition at line 488 of file modules.cpp.
 

-References WriteWallOps().
00490 {
-00491         WriteWallOps(User,false,"%s",text.c_str());
-00492 }
+References WriteWallOps().
00489 {
+00490         WriteWallOps(User,false,"%s",text.c_str());
+00491 }
 

 

     
@@ -3121,18 +3094,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 598 of file modules.cpp.
-

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

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

 

     
@@ -3140,7 +3113,7 @@ References userrec::ClearBuff
 
 
The documentation for this class was generated from the following files:
-
Generated on Thu Dec 15 11:14:19 2005 for InspIRCd by 
+
Generated on Mon Dec 19 18:02:16 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.3.1-10-gc9f91