-.TH "Server" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*-
+.TH "Server" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
.PP
.SS "Server::Server ()"
.PP
-Default constructor. Creates a Server object.Definition at line 430 of file modules.cpp.
+Default constructor. Creates a Server object.Definition at line 431 of file modules.cpp.
.PP
.nf
-431 {
-432 }
+432 {
+433 }
.fi
.SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
.PP
-Default destructor. Destroys a Server object.Definition at line 434 of file modules.cpp.
+Default destructor. Destroys a Server object.Definition at line 435 of file modules.cpp.
.PP
.nf
-435 {
-436 }
+436 {
+437 }
.fi
.SH "Member Function Documentation"
.PP
.PP
typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
.PP
-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 503 of file modules.cpp.
+When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 504 of file modules.cpp.
.PP
References createcommand().
.PP
.nf
-504 {
-505 createcommand(cmd,f,flags,minparams,source);
-506 }
+505 {
+506 createcommand(cmd,f,flags,minparams,source);
+507 }
.fi
.SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
.PP
-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 \fBServer::CalcDuration\fP 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 749 of file modules.cpp.
+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 \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 750 of file modules.cpp.
.PP
References add_eline(), and duration().
.PP
.nf
-750 {
-751 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-752 }
+751 {
+752 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+753 }
.fi
.SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
.PP
.PP
(4) The mode and its parameter are NOT stored in the channels modes structure
.PP
-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 666 of file modules.cpp.
+It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 667 of file modules.cpp.
.PP
References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
.PP
.nf
-667 {
-668 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-669 if (res)
-670 ModeMakeList(modechar);
-671 return res;
-672 }
+668 {
+669 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+670 if (res)
+671 ModeMakeList(modechar);
+672 return res;
+673 }
.fi
.SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
.PP
-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 638 of file modules.cpp.
+Adds an extended mode letter which is parsed by a module. This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 639 of file modules.cpp.
.PP
References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
.PP
.nf
-639 {
-640 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
-641 {
-642 if (type == MT_SERVER)
-643 {
-644 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
-645 return false;
-646 }
-647 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-648 {
-649 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
-650 return false;
-651 }
-652 if ((params_when_on>1) || (params_when_off>1))
-653 {
-654 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
-655 return false;
-656 }
-657 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-658 }
-659 else
-660 {
-661 log(DEBUG,'*** API ERROR *** Muppet modechar detected.');
-662 }
-663 return false;
-664 }
+640 {
+641 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
+642 {
+643 if (type == MT_SERVER)
+644 {
+645 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
+646 return false;
+647 }
+648 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+649 {
+650 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
+651 return false;
+652 }
+653 if ((params_when_on>1) || (params_when_off>1))
+654 {
+655 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
+656 return false;
+657 }
+658 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+659 }
+660 else
+661 {
+662 log(DEBUG,'*** API ERROR *** Muppet modechar detected.');
+663 }
+664 return false;
+665 }
.fi
.SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
.PP
-Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP 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 729 of file modules.cpp.
+Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 730 of file modules.cpp.
.PP
References add_gline(), and duration().
.PP
.nf
-730 {
-731 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-732 }
+731 {
+732 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+733 }
.fi
.SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
.PP
-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 \fBServer::CalcDuration\fP 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 744 of file modules.cpp.
+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 \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 745 of file modules.cpp.
.PP
References add_kline(), and duration().
.PP
.nf
-745 {
-746 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-747 }
+746 {
+747 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+748 }
.fi
.SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP"
.PP
-Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP 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 734 of file modules.cpp.
+Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 735 of file modules.cpp.
.PP
References add_qline(), and duration().
.PP
.nf
-735 {
-736 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-737 }
+736 {
+737 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+738 }
.fi
.SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP"
.PP
-Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP 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 739 of file modules.cpp.
+Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 740 of file modules.cpp.
.PP
References add_zline(), and duration().
.PP
.nf
-740 {
-741 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-742 }
+741 {
+742 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+743 }
.fi
.SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP"
.PP
-Calculates a duration This method will take a string containing a formatted duration (e.g. '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 779 of file modules.cpp.
+Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 780 of file modules.cpp.
.PP
References duration().
.PP
.nf
-780 {
-781 return duration(delta.c_str());
-782 }
+781 {
+782 return duration(delta.c_str());
+783 }
.fi
.SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
.PP
Calls the handler for a command, either implemented by the core or by another module. You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or
.br
-) 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 \fBAddCommand()\fP. 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 493 of file modules.cpp.
+) 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 \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 494 of file modules.cpp.
.PP
.nf
-494 {
-495 call_handler(commandname.c_str(),parameters,pcnt,user);
-496 }
+495 {
+496 call_handler(commandname.c_str(),parameters,pcnt,user);
+497 }
.fi
.SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
.PP
-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 586 of file modules.cpp.
+Change GECOS (fullname) of a user. You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 587 of file modules.cpp.
.PP
References ChangeName().
.PP
.nf
-587 {
-588 ChangeName(user,gecos.c_str());
-589 }
+588 {
+589 ChangeName(user,gecos.c_str());
+590 }
.fi
.SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
.PP
-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 581 of file modules.cpp.
+Change displayed hostname of a user. You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 582 of file modules.cpp.
.PP
References ChangeDisplayedHost().
.PP
.nf
-582 {
-583 ChangeDisplayedHost(user,host.c_str());
-584 }
+583 {
+584 ChangeDisplayedHost(user,host.c_str());
+585 }
.fi
.SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
.PP
-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 478 of file modules.cpp.
+Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 479 of file modules.cpp.
.PP
.nf
-479 {
-480 force_nickchange(user,nickname.c_str());
-481 }
+480 {
+481 force_nickchange(user,nickname.c_str());
+482 }
.fi
.SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
.PP
-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 611 of file modules.cpp.
+Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 612 of file modules.cpp.
.PP
References cmode().
.PP
.nf
-612 {
-613 return cmode(User,Chan);
-614 }
+613 {
+614 return cmode(User,Chan);
+615 }
.fi
.SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
.PP
-Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 559 of file modules.cpp.
+Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 560 of file modules.cpp.
.PP
References common_channels().
.PP
.nf
-560 {
-561 return (common_channels(u1,u2) != 0);
-562 }
+561 {
+562 return (common_channels(u1,u2) != 0);
+563 }
.fi
.SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
.PP
-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 674 of file modules.cpp.
+Returns a count of the number of users on a channel. This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 675 of file modules.cpp.
.PP
.nf
-675 {
-676 return usercount(c);
-677 }
+676 {
+677 return usercount(c);
+678 }
.fi
.SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP"
.PP
-Deletes a local E-Line. Definition at line 774 of file modules.cpp.
+Deletes a local E-Line. Definition at line 775 of file modules.cpp.
.PP
References del_eline().
.PP
.nf
-775 {
-776 del_eline(hostmask.c_str());
-777 }
+776 {
+777 del_eline(hostmask.c_str());
+778 }
.fi
.SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP"
.PP
-Deletes a G-Line from all servers on the mesh. Definition at line 754 of file modules.cpp.
+Deletes a G-Line from all servers on the mesh. Definition at line 755 of file modules.cpp.
.PP
References del_gline().
.PP
.nf
-755 {
-756 del_gline(hostmask.c_str());
-757 }
+756 {
+757 del_gline(hostmask.c_str());
+758 }
.fi
.SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP"
.PP
-Deletes a local K-Line. Definition at line 769 of file modules.cpp.
+Deletes a local K-Line. Definition at line 770 of file modules.cpp.
.PP
References del_kline().
.PP
.nf
-770 {
-771 del_kline(hostmask.c_str());
-772 }
+771 {
+772 del_kline(hostmask.c_str());
+773 }
.fi
.SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP"
.PP
-Deletes a Q-Line from all servers on the mesh. Definition at line 759 of file modules.cpp.
+Deletes a Q-Line from all servers on the mesh. Definition at line 760 of file modules.cpp.
.PP
References del_qline().
.PP
.nf
-760 {
-761 del_qline(nickname.c_str());
-762 }
+761 {
+762 del_qline(nickname.c_str());
+763 }
.fi
.SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP"
.PP
-Deletes a Z-Line from all servers on the mesh. Definition at line 764 of file modules.cpp.
+Deletes a Z-Line from all servers on the mesh. Definition at line 765 of file modules.cpp.
.PP
References del_zline().
.PP
.nf
-765 {
-766 del_zline(ipaddr.c_str());
-767 }
+766 {
+767 del_zline(ipaddr.c_str());
+768 }
.fi
.SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
.PP
-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 606 of file modules.cpp.
+Attempts to look up a channel and return a pointer to it. This function will return NULL if the channel does not exist.Definition at line 607 of file modules.cpp.
.PP
.nf
-607 {
-608 return FindChan(channel.c_str());
-609 }
+608 {
+609 return FindChan(channel.c_str());
+610 }
.fi
.SS "\fBuserrec\fP * Server::FindDescriptor (int socket)\fC [virtual]\fP"
.PP
-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 601 of file modules.cpp.
+Attempts to look up a nick using the file descriptor associated with that nick. This function will return NULL if the file descriptor is not associated with a valid user.Definition at line 602 of file modules.cpp.
.PP
References fd_ref_table.
.PP
.nf
-602 {
-603 return (socket < 65536 ? fd_ref_table[socket] : NULL);
-604 }
+603 {
+604 return (socket < 65536 ? fd_ref_table[socket] : NULL);
+605 }
.fi
.SS "\fBModule\fP * Server::FindModule (std::string name)\fC [virtual]\fP"
.PP
-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 857 of file modules.cpp.
+This function finds a module by name. You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.Definition at line 858 of file modules.cpp.
.PP
References MODCOUNT, module_names, and modules.
.PP
.nf
-858 {
-859 for (int i = 0; i <= MODCOUNT; i++)
-860 {
-861 if (module_names[i] == name)
-862 {
-863 return modules[i];
-864 }
-865 }
-866 return NULL;
-867 }
+859 {
+860 for (int i = 0; i <= MODCOUNT; i++)
+861 {
+862 if (module_names[i] == name)
+863 {
+864 return modules[i];
+865 }
+866 }
+867 return NULL;
+868 }
.fi
.SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
.PP
-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 596 of file modules.cpp.
+Attempts to look up a nick and return a pointer to it. This function will return NULL if the nick does not exist.Definition at line 597 of file modules.cpp.
.PP
.nf
-597 {
-598 return Find(nick);
-599 }
+598 {
+599 return Find(nick);
+600 }
.fi
.SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
.PP
-Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 631 of file modules.cpp.
+Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 632 of file modules.cpp.
.PP
.nf
-632 {
-633 return Admin(getadminname(),getadminemail(),getadminnick());
-634 }
+633 {
+634 return Admin(getadminname(),getadminemail(),getadminnick());
+635 }
.fi
.SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
.PP
-Returns the network name, global to all linked servers. Definition at line 626 of file modules.cpp.
+Returns the network name, global to all linked servers. Definition at line 627 of file modules.cpp.
.PP
.nf
-627 {
-628 return getnetworkname();
-629 }
+628 {
+629 return getnetworkname();
+630 }
.fi
.SS "std::string Server::GetServerName ()\fC [virtual]\fP"
.PP
-Returns the server name of the server where the module is loaded. Definition at line 621 of file modules.cpp.
+Returns the server name of the server where the module is loaded. Definition at line 622 of file modules.cpp.
.PP
.nf
-622 {
-623 return getservername();
-624 }
+623 {
+624 return getservername();
+625 }
.fi
.SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP"
.PP
-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 466 of file modules.cpp.
+Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 467 of file modules.cpp.
.PP
References chanuserlist, chanrec::GetUsers(), and list.
.PP
.nf
-467 {
-468 chanuserlist userl;
-469 userl.clear();
-470 std::vector<char*> *list = chan->GetUsers();
-471 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
-472 {
-473 char* o = *i;
-474 userl.push_back((userrec*)o);
-475 }
-476 return userl;
-477 }
+468 {
+469 chanuserlist userl;
+470 userl.clear();
+471 std::vector<char*> *list = chan->GetUsers();
+472 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+473 {
+474 char* o = *i;
+475 userl.push_back((userrec*)o);
+476 }
+477 return userl;
+478 }
.fi
.SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
.PP
-Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 591 of file modules.cpp.
+Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 592 of file modules.cpp.
.PP
References isnick().
.PP
.nf
-592 {
-593 return (isnick(nick.c_str()) != 0);
-594 }
+593 {
+594 return (isnick(nick.c_str()) != 0);
+595 }
.fi
.SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
.PP
-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 616 of file modules.cpp.
+Checks if a user is on a channel. This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 617 of file modules.cpp.
.PP
References has_channel().
.PP
.nf
-617 {
-618 return has_channel(User,Chan);
-619 }
+618 {
+619 return has_channel(User,Chan);
+620 }
.fi
.SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
.PP
-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 488 of file modules.cpp.
+Returns true if the servername you give is ulined. ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 489 of file modules.cpp.
.PP
References is_uline().
.PP
.nf
-489 {
-490 return is_uline(server.c_str());
-491 }
+490 {
+491 return is_uline(server.c_str());
+492 }
.fi
.SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP"
.PP
-Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 784 of file modules.cpp.
+Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 785 of file modules.cpp.
.PP
.nf
-785 {
-786 const char* dest = mask.c_str();
-787 if (strchr(dest,'!')==0)
-788 return false;
-789 if (strchr(dest,'@')==0)
-790 return false;
-791 for (int i = 0; i < strlen(dest); i++)
-792 if (dest[i] < 32)
-793 return false;
-794 for (int i = 0; i < strlen(dest); i++)
-795 if (dest[i] > 126)
-796 return false;
-797 int c = 0;
-798 for (int i = 0; i < strlen(dest); i++)
-799 if (dest[i] == '!')
-800 c++;
-801 if (c>1)
-802 return false;
-803 c = 0;
-804 for (int i = 0; i < strlen(dest); i++)
-805 if (dest[i] == '@')
-806 c++;
-807 if (c>1)
-808 return false;
-809
-810 return true;
-811 }
+786 {
+787 const char* dest = mask.c_str();
+788 if (strchr(dest,'!')==0)
+789 return false;
+790 if (strchr(dest,'@')==0)
+791 return false;
+792 for (int i = 0; i < strlen(dest); i++)
+793 if (dest[i] < 32)
+794 return false;
+795 for (int i = 0; i < strlen(dest); i++)
+796 if (dest[i] > 126)
+797 return false;
+798 int c = 0;
+799 for (int i = 0; i < strlen(dest); i++)
+800 if (dest[i] == '!')
+801 c++;
+802 if (c>1)
+803 return false;
+804 c = 0;
+805 for (int i = 0; i < strlen(dest); i++)
+806 if (dest[i] == '@')
+807 c++;
+808 if (c>1)
+809 return false;
+810
+811 return true;
+812 }
.fi
.SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
.PP
-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 456 of file modules.cpp.
+Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 457 of file modules.cpp.
.PP
.nf
-457 {
-458 return add_channel(user,cname.c_str(),key.c_str(),false);
-459 }
+458 {
+459 return add_channel(user,cname.c_str(),key.c_str(),false);
+460 }
.fi
.SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
.PP
-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 498 of file modules.cpp.
+Writes a log string. This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 499 of file modules.cpp.
.PP
.nf
-499 {
-500 log(level,'%s',s.c_str());
-501 }
+500 {
+501 log(level,'%s',s.c_str());
+502 }
.fi
.SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
.PP
-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 443 of file modules.cpp.
+Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 444 of file modules.cpp.
.PP
.nf
-444 {
-445 char literal[MAXBUF],pattern[MAXBUF];
-446 strlcpy(literal,sliteral.c_str(),MAXBUF);
-447 strlcpy(pattern,spattern.c_str(),MAXBUF);
-448 return match(literal,pattern);
-449 }
+445 {
+446 char literal[MAXBUF],pattern[MAXBUF];
+447 strlcpy(literal,sliteral.c_str(),MAXBUF);
+448 strlcpy(pattern,spattern.c_str(),MAXBUF);
+449 return match(literal,pattern);
+450 }
.fi
.SS "bool Server::MeshCheckChan (\fBchanrec\fP * c, std::string servername)\fC [virtual]\fP"
.PP
-This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 839 of file modules.cpp.
+This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 840 of file modules.cpp.
.PP
.nf
-840 {
-841 if (c)
-842 {
-843 return ChanAnyOnThisServer(c,(char*)servername.c_str());
-844 }
-845 else return false;
-846 }
+841 {
+842 if (c)
+843 {
+844 return ChanAnyOnThisServer(c,(char*)servername.c_str());
+845 }
+846 else return false;
+847 }
.fi
.SS "bool Server::MeshCheckCommon (\fBuserrec\fP * u, std::string servername)\fC [virtual]\fP"
.PP
-This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 848 of file modules.cpp.
+This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 849 of file modules.cpp.
.PP
.nf
-849 {
-850 if (u)
-851 {
-852 return CommonOnThisServer(u,(char*)servername.c_str());
-853 }
-854 else return false;
-855 }
+850 {
+851 if (u)
+852 {
+853 return CommonOnThisServer(u,(char*)servername.c_str());
+854 }
+855 else return false;
+856 }
.fi
.SS "void Server::MeshSendAll (std::string text)\fC [virtual]\fP"
.PP
-Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 813 of file modules.cpp.
+Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 814 of file modules.cpp.
.PP
.nf
-814 {
-815 NetSendToAll((char*)text.c_str());
-816 }
+815 {
+816 NetSendToAll((char*)text.c_str());
+817 }
.fi
.SS "void Server::MeshSendAllAlive (std::string text)\fC [virtual]\fP"
.PP
-This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 824 of file modules.cpp.
+This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 825 of file modules.cpp.
.PP
.nf
-825 {
-826 NetSendToAllAlive((char*)text.c_str());
-827 }
+826 {
+827 NetSendToAllAlive((char*)text.c_str());
+828 }
.fi
.SS "void Server::MeshSendAllExcept (std::string target, std::string text)\fC [virtual]\fP"
.PP
-This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 834 of file modules.cpp.
+This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 835 of file modules.cpp.
.PP
.nf
-835 {
-836 NetSendToAllExcept(target.c_str(),(char*)text.c_str());
-837 }
+836 {
+837 NetSendToAllExcept(target.c_str(),(char*)text.c_str());
+838 }
.fi
.SS "void Server::MeshSendCommon (\fBuserrec\fP * user, std::string text)\fC [virtual]\fP"
.PP
-This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 818 of file modules.cpp.
+This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 819 of file modules.cpp.
.PP
.nf
-819 {
-820 if (user)
-821 NetSendToCommon(user,(char*)text.c_str());
-822 }
+820 {
+821 if (user)
+822 NetSendToCommon(user,(char*)text.c_str());
+823 }
.fi
.SS "void Server::MeshSendUnicast (std::string destination, std::string text)\fC [virtual]\fP"
.PP
-This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 829 of file modules.cpp.
+This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 830 of file modules.cpp.
.PP
.nf
-830 {
-831 NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
-832 }
+831 {
+832 NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
+833 }
.fi
.SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
.PP
-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 461 of file modules.cpp.
+Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 462 of file modules.cpp.
.PP
.nf
-462 {
-463 return del_channel(user,cname.c_str(),reason.c_str(),false);
-464 }
+463 {
+464 return del_channel(user,cname.c_str(),reason.c_str(),false);
+465 }
.fi
.SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP"
.PP
-This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. 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 699 of file modules.cpp.
+This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 700 of file modules.cpp.
.PP
References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
.PP
.nf
-700 {
-701 zombie->fd = alive->fd;
-702 alive->fd = FD_MAGIC_NUMBER;
-703 alive->ClearBuffer();
-704 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
-705 kill_link(alive,message.c_str());
-706 fd_ref_table[zombie->fd] = zombie;
-707 for (int i = 0; i != MAXCHANS; i++)
-708 {
-709 if (zombie->chans[i].channel != NULL)
-710 {
-711 if (zombie->chans[i].channel->name)
-712 {
-713 chanrec* Ptr = zombie->chans[i].channel;
-714 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
-715 if (Ptr->topicset)
-716 {
-717 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
-718 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-719 }
-720 userlist(zombie,Ptr);
-721 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
-722
-723 }
-724 }
-725 }
-726
-727 }
+701 {
+702 zombie->fd = alive->fd;
+703 alive->fd = FD_MAGIC_NUMBER;
+704 alive->ClearBuffer();
+705 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
+706 kill_link(alive,message.c_str());
+707 fd_ref_table[zombie->fd] = zombie;
+708 for (int i = 0; i != MAXCHANS; i++)
+709 {
+710 if (zombie->chans[i].channel != NULL)
+711 {
+712 if (zombie->chans[i].channel->name)
+713 {
+714 chanrec* Ptr = zombie->chans[i].channel;
+715 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
+716 if (Ptr->topicset)
+717 {
+718 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
+719 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+720 }
+721 userlist(zombie,Ptr);
+722 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
+723
+724 }
+725 }
+726 }
+727
+728 }
.fi
.SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
.PP
.PP
WARNING!
.PP
-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 483 of file modules.cpp.
+Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 484 of file modules.cpp.
.PP
.nf
-484 {
-485 kill_link(user,reason.c_str());
-486 }
+485 {
+486 kill_link(user,reason.c_str());
+487 }
.fi
.SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
.PP
-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 513 of file modules.cpp.
+Sends a line of text down a TCP/IP socket. This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 514 of file modules.cpp.
.PP
.nf
-514 {
-515 Write(Socket,'%s',s.c_str());
-516 }
+515 {
+516 Write(Socket,'%s',s.c_str());
+517 }
.fi
.SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
.PP
-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 547 of file modules.cpp.
+Sends text from a user to a channel (mulicast). This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 548 of file modules.cpp.
.PP
.nf
-548 {
-549 if (IncludeSender)
-550 {
-551 WriteChannel(Channel,User,'%s',s.c_str());
-552 }
-553 else
-554 {
-555 ChanExceptSender(Channel,User,'%s',s.c_str());
-556 }
-557 }
+549 {
+550 if (IncludeSender)
+551 {
+552 WriteChannel(Channel,User,'%s',s.c_str());
+553 }
+554 else
+555 {
+556 ChanExceptSender(Channel,User,'%s',s.c_str());
+557 }
+558 }
.fi
.SS "void Server::SendChannelServerNotice (std::string ServName, \fBchanrec\fP * Channel, std::string text)\fC [virtual]\fP"
.PP
-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 542 of file modules.cpp.
+Writes text to a channel, but from a server, including all. This can be used to send server notices to a group of users.Definition at line 543 of file modules.cpp.
.PP
.nf
-543 {
-544 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str());
-545 }
+544 {
+545 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str());
+546 }
.fi
.SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
.PP
-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 564 of file modules.cpp.
+Sends text from a user to one or more channels (mulicast). This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 565 of file modules.cpp.
.PP
.nf
-565 {
-566 if (IncludeSender)
-567 {
-568 WriteCommon(User,'%s',text.c_str());
-569 }
-570 else
-571 {
-572 WriteCommonExcept(User,'%s',text.c_str());
-573 }
-574 }
+566 {
+567 if (IncludeSender)
+568 {
+569 WriteCommon(User,'%s',text.c_str());
+570 }
+571 else
+572 {
+573 WriteCommonExcept(User,'%s',text.c_str());
+574 }
+575 }
.fi
.SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
.PP
-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 523 of file modules.cpp.
+Sends text from a user to a socket. This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 524 of file modules.cpp.
.PP
.nf
-524 {
-525 WriteFrom(Socket,User,'%s',s.c_str());
-526 }
+525 {
+526 WriteFrom(Socket,User,'%s',s.c_str());
+527 }
.fi
.SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
.PP
.PP
Srv->SendMode(modes,3,user);
.PP
-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 508 of file modules.cpp.
+The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 509 of file modules.cpp.
.PP
References server_mode().
.PP
.nf
-509 {
-510 server_mode(parameters,pcnt,user);
-511 }
+510 {
+511 server_mode(parameters,pcnt,user);
+512 }
.fi
.SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
.PP
-Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 438 of file modules.cpp.
+Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 439 of file modules.cpp.
.PP
.nf
-439 {
-440 WriteOpers('%s',s.c_str());
-441 }
+440 {
+441 WriteOpers('%s',s.c_str());
+442 }
.fi
.SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
.PP
-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 518 of file modules.cpp.
+Sends text from the server to a socket. This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 519 of file modules.cpp.
.PP
.nf
-519 {
-520 WriteServ(Socket,'%s',s.c_str());
-521 }
+520 {
+521 WriteServ(Socket,'%s',s.c_str());
+522 }
.fi
.SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
.PP
.PP
:localserver TEXT
.PP
-Which is useful for numerics and server notices to single users, etc.Definition at line 528 of file modules.cpp.
+Which is useful for numerics and server notices to single users, etc.Definition at line 529 of file modules.cpp.
.PP
References connection::fd.
.PP
.nf
-529 {
-530 if (!Source)
-531 {
-532 // if source is NULL, then the message originates from the local server
-533 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
-534 }
-535 else
-536 {
-537 // otherwise it comes from the user specified
-538 WriteTo(Source,Dest,'%s',s.c_str());
-539 }
-540 }
+530 {
+531 if (!Source)
+532 {
+533 // if source is NULL, then the message originates from the local server
+534 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
+535 }
+536 else
+537 {
+538 // otherwise it comes from the user specified
+539 WriteTo(Source,Dest,'%s',s.c_str());
+540 }
+541 }
.fi
.SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
.PP
.PP
Serv->SendToModeMask('xi', WM_OR, 'm00');
.PP
-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 451 of file modules.cpp.
+Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 452 of file modules.cpp.
.PP
.nf
-452 {
-453 WriteMode(modes.c_str(),flags,'%s',text.c_str());
-454 }
+453 {
+454 WriteMode(modes.c_str(),flags,'%s',text.c_str());
+455 }
.fi
.SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
.PP
-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 576 of file modules.cpp.
+Sends a WALLOPS message. This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 577 of file modules.cpp.
.PP
.nf
-577 {
-578 WriteWallOps(User,false,'%s',text.c_str());
-579 }
+578 {
+579 WriteWallOps(User,false,'%s',text.c_str());
+580 }
.fi
.SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP"
.PP
-Remove a user's connection to the irc server, but leave their client in existence in the user hash. 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 680 of file modules.cpp.
+Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 681 of file modules.cpp.
.PP
References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
.PP
.nf
-681 {
-682 unsigned int old_fd = user->fd;
-683 user->fd = FD_MAGIC_NUMBER;
-684 user->ClearBuffer();
-685 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
-686 #ifdef USE_KQUEUE
-687 struct kevent ke;
-688 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
-689 int i = kevent(kq, &ke, 1, 0, 0, NULL);
-690 if (i == -1)
-691 {
-692 log(DEBUG,'kqueue: Failed to remove user from queue!');
-693 }
-694 #endif
-695 shutdown(old_fd,2);
-696 close(old_fd);
-697 }
+682 {
+683 unsigned int old_fd = user->fd;
+684 user->fd = FD_MAGIC_NUMBER;
+685 user->ClearBuffer();
+686 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
+687 #ifdef USE_KQUEUE
+688 struct kevent ke;
+689 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
+690 int i = kevent(kq, &ke, 1, 0, 0, NULL);
+691 if (i == -1)
+692 {
+693 log(DEBUG,'kqueue: Failed to remove user from queue!');
+694 }
+695 #endif
+696 shutdown(old_fd,2);
+697 close(old_fd);
+698 }
.fi
projects / user / henk / code / inspircd.git / blobdiff