diff options
Diffstat (limited to 'docs/man/man3/Server.3')
| -rw-r--r-- | docs/man/man3/Server.3 | 412 |
1 files changed, 206 insertions, 206 deletions
diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 56e6c0252..d3268626a 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -108,7 +108,7 @@ Inherits \fBclassbase\fP. .br .RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion. \fP" .ti -1c -.RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams)" +.RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)" .br .RI "\fIAdds a command to the command table. \fP" .ti -1c @@ -166,41 +166,41 @@ Allows server output and query functions This class contains methods which allow All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. .PP -Definition at line 371 of file modules.h. +Definition at line 378 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 337 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 339 of file modules.cpp. .PP .nf -338 { -339 } +340 { +341 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 341 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 343 of file modules.cpp. .PP .nf -342 { -343 } +344 { +345 } .fi .SH "Member Function Documentation" .PP -.SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams)\fC [virtual]\fP" +.SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)\fC [virtual]\fP" .PP 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: .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'.Definition at line 418 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 420 of file modules.cpp. .PP References createcommand(). .PP .nf -419 { -420 createcommand(cmd,f,flags,minparams); -421 } +421 { +422 createcommand(cmd,f,flags,minparams,source); +423 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -214,259 +214,259 @@ Adds an extended mode letter which is parsed by a module and handled in a list f .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 563 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 565 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -564 { -565 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -566 if (res) -567 ModeMakeList(modechar); -568 return res; -569 } +566 { +567 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +568 if (res) +569 ModeMakeList(modechar); +570 return res; +571 } .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 543 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 545 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -544 { -545 if (type == MT_SERVER) -546 { -547 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -548 return false; -549 } -550 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -551 { -552 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -553 return false; -554 } -555 if ((params_when_on>1) || (params_when_off>1)) -556 { -557 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -558 return false; -559 } -560 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -561 } +546 { +547 if (type == MT_SERVER) +548 { +549 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +550 return false; +551 } +552 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +553 { +554 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +555 return false; +556 } +557 if ((params_when_on>1) || (params_when_off>1)) +558 { +559 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +560 return false; +561 } +562 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +563 } .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 408 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 410 of file modules.cpp. .PP .nf -409 { -410 call_handler(commandname.c_str(),parameters,pcnt,user); -411 } +411 { +412 call_handler(commandname.c_str(),parameters,pcnt,user); +413 } .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 496 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 498 of file modules.cpp. .PP References ChangeName(). .PP .nf -497 { -498 ChangeName(user,gecos.c_str()); -499 } +499 { +500 ChangeName(user,gecos.c_str()); +501 } .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 491 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 493 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -492 { -493 ChangeDisplayedHost(user,host.c_str()); -494 } +494 { +495 ChangeDisplayedHost(user,host.c_str()); +496 } .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 392 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 394 of file modules.cpp. .PP .nf -393 { -394 force_nickchange(user,nickname.c_str()); -395 } +395 { +396 force_nickchange(user,nickname.c_str()); +397 } .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 516 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 518 of file modules.cpp. .PP References cmode(). .PP .nf -517 { -518 return cmode(User,Chan); -519 } +519 { +520 return cmode(User,Chan); +521 } .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 469 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 471 of file modules.cpp. .PP References common_channels(). .PP .nf -470 { -471 return (common_channels(u1,u2) != 0); -472 } +472 { +473 return (common_channels(u1,u2) != 0); +474 } .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 571 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 573 of file modules.cpp. .PP .nf -572 { -573 return usercount(c); -574 } +574 { +575 return usercount(c); +576 } .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 511 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 513 of file modules.cpp. .PP .nf -512 { -513 return FindChan(channel.c_str()); -514 } +514 { +515 return FindChan(channel.c_str()); +516 } .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 506 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 508 of file modules.cpp. .PP .nf -507 { -508 return Find(nick); -509 } +509 { +510 return Find(nick); +511 } .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 536 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 538 of file modules.cpp. .PP .nf -537 { -538 return Admin(getadminname(),getadminemail(),getadminnick()); -539 } +539 { +540 return Admin(getadminname(),getadminemail(),getadminnick()); +541 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 531 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 533 of file modules.cpp. .PP .nf -532 { -533 return getnetworkname(); -534 } +534 { +535 return getnetworkname(); +536 } .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 526 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 528 of file modules.cpp. .PP .nf -527 { -528 return getservername(); -529 } +529 { +530 return getservername(); +531 } .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 373 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 375 of file modules.cpp. .PP References chanuserlist, clientlist, has_channel(), and isnick(). .PP .nf -374 { -375 chanuserlist userl; -376 userl.clear(); -377 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -378 { -379 if (i->second) -380 { -381 if (has_channel(i->second,chan)) -382 { -383 if (isnick(i->second->nick)) -384 { -385 userl.push_back(i->second); -386 } -387 } -388 } -389 } -390 return userl; -391 } +376 { +377 chanuserlist userl; +378 userl.clear(); +379 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) +380 { +381 if (i->second) +382 { +383 if (has_channel(i->second,chan)) +384 { +385 if (isnick(i->second->nick)) +386 { +387 userl.push_back(i->second); +388 } +389 } +390 } +391 } +392 return userl; +393 } .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 501 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 503 of file modules.cpp. .PP References isnick(). .PP .nf -502 { -503 return (isnick(nick.c_str()) != 0); -504 } +504 { +505 return (isnick(nick.c_str()) != 0); +506 } .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 521 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 523 of file modules.cpp. .PP References has_channel(). .PP .nf -522 { -523 return has_channel(User,Chan); -524 } +524 { +525 return has_channel(User,Chan); +526 } .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 403 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 405 of file modules.cpp. .PP References is_uline(). .PP .nf -404 { -405 return is_uline(server.c_str()); -406 } +406 { +407 return is_uline(server.c_str()); +408 } .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 363 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 365 of file modules.cpp. .PP .nf -364 { -365 return add_channel(user,cname.c_str(),key.c_str(),true); -366 } +366 { +367 return add_channel(user,cname.c_str(),key.c_str(),true); +368 } .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 413 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 415 of file modules.cpp. .PP .nf -414 { -415 log(level,'%s',s.c_str()); -416 } +416 { +417 log(level,'%s',s.c_str()); +418 } .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 350 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 352 of file modules.cpp. .PP .nf -351 { -352 char literal[MAXBUF],pattern[MAXBUF]; -353 strlcpy(literal,sliteral.c_str(),MAXBUF); -354 strlcpy(pattern,spattern.c_str(),MAXBUF); -355 return match(literal,pattern); -356 } +353 { +354 char literal[MAXBUF],pattern[MAXBUF]; +355 strlcpy(literal,sliteral.c_str(),MAXBUF); +356 strlcpy(pattern,spattern.c_str(),MAXBUF); +357 return match(literal,pattern); +358 } .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 368 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 370 of file modules.cpp. .PP .nf -369 { -370 return del_channel(user,cname.c_str(),reason.c_str(),false); -371 } +371 { +372 return del_channel(user,cname.c_str(),reason.c_str(),false); +373 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -474,65 +474,65 @@ Forces a user to quit with the specified reason. To the user, it will appear as .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 397 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 399 of file modules.cpp. .PP References userrec::nick, and send_network_quit(). .PP .nf -398 { -399 send_network_quit(user->nick,reason.c_str()); -400 kill_link(user,reason.c_str()); -401 } +400 { +401 send_network_quit(user->nick,reason.c_str()); +402 kill_link(user,reason.c_str()); +403 } .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 428 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 430 of file modules.cpp. .PP .nf -429 { -430 Write(Socket,'%s',s.c_str()); -431 } +431 { +432 Write(Socket,'%s',s.c_str()); +433 } .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 457 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 459 of file modules.cpp. .PP .nf -458 { -459 if (IncludeSender) -460 { -461 WriteChannel(Channel,User,'%s',s.c_str()); -462 } -463 else -464 { -465 ChanExceptSender(Channel,User,'%s',s.c_str()); -466 } -467 } +460 { +461 if (IncludeSender) +462 { +463 WriteChannel(Channel,User,'%s',s.c_str()); +464 } +465 else +466 { +467 ChanExceptSender(Channel,User,'%s',s.c_str()); +468 } +469 } .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 474 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 476 of file modules.cpp. .PP .nf -475 { -476 if (IncludeSender) -477 { -478 WriteCommon(User,'%s',text.c_str()); -479 } -480 else -481 { -482 WriteCommonExcept(User,'%s',text.c_str()); -483 } -484 } +477 { +478 if (IncludeSender) +479 { +480 WriteCommon(User,'%s',text.c_str()); +481 } +482 else +483 { +484 WriteCommonExcept(User,'%s',text.c_str()); +485 } +486 } .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 438 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 440 of file modules.cpp. .PP .nf -439 { -440 WriteFrom(Socket,User,'%s',s.c_str()); -441 } +441 { +442 WriteFrom(Socket,User,'%s',s.c_str()); +443 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -550,32 +550,32 @@ modes[2] = user->nick; .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 423 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 425 of file modules.cpp. .PP References server_mode(). .PP .nf -424 { -425 server_mode(parameters,pcnt,user); -426 } +426 { +427 server_mode(parameters,pcnt,user); +428 } .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 345 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 347 of file modules.cpp. .PP .nf -346 { -347 WriteOpers('%s',s.c_str()); -348 } +348 { +349 WriteOpers('%s',s.c_str()); +350 } .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 433 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 435 of file modules.cpp. .PP .nf -434 { -435 WriteServ(Socket,'%s',s.c_str()); -436 } +436 { +437 WriteServ(Socket,'%s',s.c_str()); +438 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -587,23 +587,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 443 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 445 of file modules.cpp. .PP References connection::fd. .PP .nf -444 { -445 if (!Source) -446 { -447 // if source is NULL, then the message originates from the local server -448 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -449 } -450 else -451 { -452 // otherwise it comes from the user specified -453 WriteTo(Source,Dest,'%s',s.c_str()); -454 } -455 } +446 { +447 if (!Source) +448 { +449 // if source is NULL, then the message originates from the local server +450 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +451 } +452 else +453 { +454 // otherwise it comes from the user specified +455 WriteTo(Source,Dest,'%s',s.c_str()); +456 } +457 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -611,21 +611,21 @@ Sends to all users matching a mode mask You must specify one or more usermodes a .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 358 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 360 of file modules.cpp. .PP .nf -359 { -360 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -361 } +361 { +362 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +363 } .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 486 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 488 of file modules.cpp. .PP .nf -487 { -488 WriteWallOps(User,false,'%s',text.c_str()); -489 } +489 { +490 WriteWallOps(User,false,'%s',text.c_str()); +491 } .fi |