docs/man/man3/Server.3

   1 .TH "Server" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Server \- Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <modules.h>\fP
  12 .PP
  13 Inherits \fBclassbase\fP.
  14 .PP
  15 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBServer\fP ()"
  20 .br
  21 .RI "\fIDefault constructor. \fP"
  22 .ti -1c
  23 .RI "virtual \fB~Server\fP ()"
  24 .br
  25 .RI "\fIDefault destructor. \fP"
  26 .ti -1c
  27 .RI "virtual void \fBSendOpers\fP (std::string s)"
  28 .br
  29 .RI "\fISends text to all opers. \fP"
  30 .ti -1c
  31 .RI "virtual void \fBLog\fP (int level, std::string s)"
  32 .br
  33 .RI "\fIWrites a log string. \fP"
  34 .ti -1c
  35 .RI "virtual void \fBSend\fP (int Socket, std::string s)"
  36 .br
  37 .RI "\fISends a line of text down a TCP/IP socket. \fP"
  38 .ti -1c
  39 .RI "virtual void \fBSendServ\fP (int Socket, std::string s)"
  40 .br
  41 .RI "\fISends text from the server to a socket. \fP"
  42 .ti -1c
  43 .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)"
  44 .br
  45 .RI "\fISends text from a user to a socket. \fP"
  46 .ti -1c
  47 .RI "virtual void \fBSendTo\fP (\fBuserrec\fP *Source, \fBuserrec\fP *Dest, std::string s)"
  48 .br
  49 .RI "\fISends text from a user to another user. \fP"
  50 .ti -1c
  51 .RI "virtual void \fBSendChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Channel, std::string s, bool IncludeSender)"
  52 .br
  53 .RI "\fISends text from a user to a channel (mulicast). \fP"
  54 .ti -1c
  55 .RI "virtual bool \fBCommonChannels\fP (\fBuserrec\fP *u1, \fBuserrec\fP *u2)"
  56 .br
  57 .RI "\fIReturns true if two users share a common channel. \fP"
  58 .ti -1c
  59 .RI "virtual void \fBSendCommon\fP (\fBuserrec\fP *User, std::string text, bool IncludeSender)"
  60 .br
  61 .RI "\fISends text from a user to one or more channels (mulicast). \fP"
  62 .ti -1c
  63 .RI "virtual void \fBSendWallops\fP (\fBuserrec\fP *User, std::string text)"
  64 .br
  65 .RI "\fISends a WALLOPS message. \fP"
  66 .ti -1c
  67 .RI "virtual bool \fBIsNick\fP (std::string nick)"
  68 .br
  69 .RI "\fIReturns true if a nick is valid. \fP"
  70 .ti -1c
  71 .RI "virtual int \fBCountUsers\fP (\fBchanrec\fP *c)"
  72 .br
  73 .RI "\fIReturns a count of the number of users on a channel. \fP"
  74 .ti -1c
  75 .RI "virtual \fBuserrec\fP * \fBFindNick\fP (std::string nick)"
  76 .br
  77 .RI "\fIAttempts to look up a nick and return a pointer to it. \fP"
  78 .ti -1c
  79 .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)"
  80 .br
  81 .RI "\fIAttempts to look up a channel and return a pointer to it. \fP"
  82 .ti -1c
  83 .RI "virtual std::string \fBChanMode\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)"
  84 .br
  85 .RI "\fIAttempts to look up a user's privilages on a channel. \fP"
  86 .ti -1c
  87 .RI "virtual bool \fBIsOnChannel\fP (\fBuserrec\fP *User, \fBchanrec\fP *Chan)"
  88 .br
  89 .RI "\fIChecks if a user is on a channel. \fP"
  90 .ti -1c
  91 .RI "virtual std::string \fBGetServerName\fP ()"
  92 .br
  93 .RI "\fIReturns the server name of the server where the module is loaded. \fP"
  94 .ti -1c
  95 .RI "virtual std::string \fBGetNetworkName\fP ()"
  96 .br
  97 .RI "\fIReturns the network name, global to all linked servers. \fP"
  98 .ti -1c
  99 .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()"
 100 .br
 101 .RI "\fIReturns the information of the server as returned by the /ADMIN command. \fP"
 102 .ti -1c
 103 .RI "virtual bool \fBAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)"
 104 .br
 105 .RI "\fIAdds an extended mode letter which is parsed by a module. \fP"
 106 .ti -1c
 107 .RI "virtual bool \fBAddExtendedListMode\fP (char modechar)"
 108 .br
 109 .RI "\fIAdds an extended mode letter which is parsed by a module and handled in a list fashion. \fP"
 110 .ti -1c
 111 .RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams)"
 112 .br
 113 .RI "\fIAdds a command to the command table. \fP"
 114 .ti -1c
 115 .RI "virtual void \fBSendMode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
 116 .br
 117 .RI "\fISends a servermode. \fP"
 118 .ti -1c
 119 .RI "virtual void \fBSendToModeMask\fP (std::string modes, int flags, std::string text)"
 120 .br
 121 .RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter. \fP"
 122 .ti -1c
 123 .RI "virtual \fBchanrec\fP * \fBJoinUserToChannel\fP (\fBuserrec\fP *user, std::string cname, std::string key)"
 124 .br
 125 .RI "\fIForces a user to join a channel. \fP"
 126 .ti -1c
 127 .RI "virtual \fBchanrec\fP * \fBPartUserFromChannel\fP (\fBuserrec\fP *user, std::string cname, std::string reason)"
 128 .br
 129 .RI "\fIForces a user to part a channel. \fP"
 130 .ti -1c
 131 .RI "virtual void \fBChangeUserNick\fP (\fBuserrec\fP *user, std::string nickname)"
 132 .br
 133 .RI "\fIForces a user nickchange. \fP"
 134 .ti -1c
 135 .RI "virtual void \fBQuitUser\fP (\fBuserrec\fP *user, std::string reason)"
 136 .br
 137 .RI "\fIForces a user to quit with the specified reason. \fP"
 138 .ti -1c
 139 .RI "virtual bool \fBMatchText\fP (std::string sliteral, std::string spattern)"
 140 .br
 141 .RI "\fIMatches text against a glob pattern. \fP"
 142 .ti -1c
 143 .RI "virtual void \fBCallCommandHandler\fP (std::string commandname, char **parameters, int pcnt, \fBuserrec\fP *user)"
 144 .br
 145 .RI "\fICalls the handler for a command, either implemented by the core or by another module. \fP"
 146 .ti -1c
 147 .RI "virtual void \fBChangeHost\fP (\fBuserrec\fP *user, std::string host)"
 148 .br
 149 .RI "\fIChange displayed hostname of a user. \fP"
 150 .ti -1c
 151 .RI "virtual void \fBChangeGECOS\fP (\fBuserrec\fP *user, std::string gecos)"
 152 .br
 153 .RI "\fIChange GECOS (fullname) of a user. \fP"
 154 .ti -1c
 155 .RI "virtual bool \fBIsUlined\fP (std::string server)"
 156 .br
 157 .RI "\fIReturns true if the servername you give is ulined. \fP"
 158 .ti -1c
 159 .RI "virtual \fBchanuserlist\fP \fBGetUsers\fP (\fBchanrec\fP *chan)"
 160 .br
 161 .RI "\fIFetches the userlist of a channel. \fP"
 162 .in -1c
 163 .SH "Detailed Description"
 164 .PP
 165 Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers.
 166
 167 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
 168 .PP
 169 Definition at line 371 of file modules.h.
 170 .SH "Constructor & Destructor Documentation"
 171 .PP
 172 .SS "Server::Server ()"
 173 .PP
 174 Default constructor. Creates a Server object.Definition at line 337 of file modules.cpp.
 175 .PP
 176 .nf
 177 338 {
 178 339 }
 179 .fi
 180 .SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
 181 .PP
 182 Default destructor. Destroys a Server object.Definition at line 341 of file modules.cpp.
 183 .PP
 184 .nf
 185 342 {
 186 343 }
 187 .fi
 188 .SH "Member Function Documentation"
 189 .PP
 190 .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams)\fC [virtual]\fP"
 191 .PP
 192 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:
 193 .PP
 194 typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
 195 .PP
 196 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.
 197 .PP
 198 References createcommand().
 199 .PP
 200 .nf
 201 419 {
 202 420         createcommand(cmd,f,flags,minparams);
 203 421 }
 204 .fi
 205 .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
 206 .PP
 207 Adds an extended mode letter which is parsed by a module and handled in a list fashion. This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:
 208 .PP
 209 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
 210 .PP
 211 (2) They always take exactly one parameter when being added or removed
 212 .PP
 213 (3) They can be set multiple times, usually on users in channels
 214 .PP
 215 (4) The mode and its parameter are NOT stored in the channels modes structure
 216 .PP
 217 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.
 218 .PP
 219 References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 220 .PP
 221 .nf
 222 564 {
 223 565         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
 224 566         if (res)
 225 567                 ModeMakeList(modechar);
 226 568         return res;
 227 569 }
 228 .fi
 229 .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
 230 .PP
 231 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.
 232 .PP
 233 References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 234 .PP
 235 .nf
 236 544 {
 237 545         if (type == MT_SERVER)
 238 546         {
 239 547                 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
 240 548                 return false;
 241 549         }
 242 550         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 243 551         {
 244 552                 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
 245 553                 return false;
 246 554         }
 247 555         if ((params_when_on>1) || (params_when_off>1))
 248 556         {
 249 557                 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
 250 558                 return false;
 251 559         }
 252 560         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 253 561 }
 254 .fi
 255 .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 256 .PP
 257 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
 258 .br
 259 ) 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.
 260 .PP
 261 .nf
 262 409 {
 263 410         call_handler(commandname.c_str(),parameters,pcnt,user);
 264 411 }
 265 .fi
 266 .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
 267 .PP
 268 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.
 269 .PP
 270 References ChangeName().
 271 .PP
 272 .nf
 273 497 {
 274 498         ChangeName(user,gecos.c_str());
 275 499 }
 276 .fi
 277 .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
 278 .PP
 279 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.
 280 .PP
 281 References ChangeDisplayedHost().
 282 .PP
 283 .nf
 284 492 {
 285 493         ChangeDisplayedHost(user,host.c_str());
 286 494 }
 287 .fi
 288 .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
 289 .PP
 290 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.
 291 .PP
 292 .nf
 293 393 {
 294 394         force_nickchange(user,nickname.c_str());
 295 395 }
 296 .fi
 297 .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 298 .PP
 299 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.
 300 .PP
 301 References cmode().
 302 .PP
 303 .nf
 304 517 {
 305 518         return cmode(User,Chan);
 306 519 }
 307 .fi
 308 .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
 309 .PP
 310 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.
 311 .PP
 312 References common_channels().
 313 .PP
 314 .nf
 315 470 {
 316 471         return (common_channels(u1,u2) != 0);
 317 472 }
 318 .fi
 319 .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
 320 .PP
 321 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.
 322 .PP
 323 .nf
 324 572 {
 325 573         return usercount(c);
 326 574 }
 327 .fi
 328 .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
 329 .PP
 330 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.
 331 .PP
 332 .nf
 333 512 {
 334 513         return FindChan(channel.c_str());
 335 514 }
 336 .fi
 337 .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
 338 .PP
 339 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.
 340 .PP
 341 .nf
 342 507 {
 343 508         return Find(nick);
 344 509 }
 345 .fi
 346 .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
 347 .PP
 348 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.
 349 .PP
 350 .nf
 351 537 {
 352 538         return Admin(getadminname(),getadminemail(),getadminnick());
 353 539 }
 354 .fi
 355 .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
 356 .PP
 357 Returns the network name, global to all linked servers. Definition at line 531 of file modules.cpp.
 358 .PP
 359 .nf
 360 532 {
 361 533         return getnetworkname();
 362 534 }
 363 .fi
 364 .SS "std::string Server::GetServerName ()\fC [virtual]\fP"
 365 .PP
 366 Returns the server name of the server where the module is loaded. Definition at line 526 of file modules.cpp.
 367 .PP
 368 .nf
 369 527 {
 370 528         return getservername();
 371 529 }
 372 .fi
 373 .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP"
 374 .PP
 375 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.
 376 .PP
 377 References chanuserlist, clientlist, has_channel(), and isnick().
 378 .PP
 379 .nf
 380 374 {
 381 375         chanuserlist userl;
 382 376         userl.clear();
 383 377         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 384 378         {
 385 379                 if (i->second)
 386 380                 {
 387 381                         if (has_channel(i->second,chan))
 388 382                         {
 389 383                                 if (isnick(i->second->nick))
 390 384                                 {
 391 385                                         userl.push_back(i->second);
 392 386                                 }
 393 387                         }
 394 388                 }
 395 389         }
 396 390         return userl;
 397 391 }
 398 .fi
 399 .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
 400 .PP
 401 Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 501 of file modules.cpp.
 402 .PP
 403 References isnick().
 404 .PP
 405 .nf
 406 502 {
 407 503         return (isnick(nick.c_str()) != 0);
 408 504 }
 409 .fi
 410 .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 411 .PP
 412 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.
 413 .PP
 414 References has_channel().
 415 .PP
 416 .nf
 417 522 {
 418 523         return has_channel(User,Chan);
 419 524 }
 420 .fi
 421 .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
 422 .PP
 423 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.
 424 .PP
 425 References is_uline().
 426 .PP
 427 .nf
 428 404 {
 429 405         return is_uline(server.c_str());
 430 406 }
 431 .fi
 432 .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
 433 .PP
 434 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.
 435 .PP
 436 .nf
 437 364 {
 438 365         return add_channel(user,cname.c_str(),key.c_str(),true);
 439 366 }
 440 .fi
 441 .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
 442 .PP
 443 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.
 444 .PP
 445 .nf
 446 414 {
 447 415         log(level,'%s',s.c_str());
 448 416 }
 449 .fi
 450 .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
 451 .PP
 452 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.
 453 .PP
 454 .nf
 455 351 {
 456 352         char literal[MAXBUF],pattern[MAXBUF];
 457 353         strlcpy(literal,sliteral.c_str(),MAXBUF);
 458 354         strlcpy(pattern,spattern.c_str(),MAXBUF);
 459 355         return match(literal,pattern);
 460 356 }
 461 .fi
 462 .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
 463 .PP
 464 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.
 465 .PP
 466 .nf
 467 369 {
 468 370         return del_channel(user,cname.c_str(),reason.c_str(),false);
 469 371 }
 470 .fi
 471 .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
 472 .PP
 473 Forces a user to quit with the specified reason. To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.
 474 .PP
 475 WARNING!
 476 .PP
 477 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.
 478 .PP
 479 References userrec::nick, and send_network_quit().
 480 .PP
 481 .nf
 482 398 {
 483 399         send_network_quit(user->nick,reason.c_str());
 484 400         kill_link(user,reason.c_str());
 485 401 }
 486 .fi
 487 .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
 488 .PP
 489 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.
 490 .PP
 491 .nf
 492 429 {
 493 430         Write(Socket,'%s',s.c_str());
 494 431 }
 495 .fi
 496 .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
 497 .PP
 498 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.
 499 .PP
 500 .nf
 501 458 {
 502 459         if (IncludeSender)
 503 460         {
 504 461                 WriteChannel(Channel,User,'%s',s.c_str());
 505 462         }
 506 463         else
 507 464         {
 508 465                 ChanExceptSender(Channel,User,'%s',s.c_str());
 509 466         }
 510 467 }
 511 .fi
 512 .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
 513 .PP
 514 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.
 515 .PP
 516 .nf
 517 475 {
 518 476         if (IncludeSender)
 519 477         {
 520 478                 WriteCommon(User,'%s',text.c_str());
 521 479         }
 522 480         else
 523 481         {
 524 482                 WriteCommonExcept(User,'%s',text.c_str());
 525 483         }
 526 484 }
 527 .fi
 528 .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
 529 .PP
 530 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.
 531 .PP
 532 .nf
 533 439 {
 534 440         WriteFrom(Socket,User,'%s',s.c_str());
 535 441 }
 536 .fi
 537 .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 538 .PP
 539 Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes.
 540 .PP
 541 For example:
 542 .PP
 543 char *modes[3];
 544 .PP
 545 modes[0] = ChannelName;
 546 .PP
 547 modes[1] = '+o';
 548 .PP
 549 modes[2] = user->nick;
 550 .PP
 551 Srv->SendMode(modes,3,user);
 552 .PP
 553 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.
 554 .PP
 555 References server_mode().
 556 .PP
 557 .nf
 558 424 {
 559 425         server_mode(parameters,pcnt,user);
 560 426 }
 561 .fi
 562 .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
 563 .PP
 564 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.
 565 .PP
 566 .nf
 567 346 {
 568 347         WriteOpers('%s',s.c_str());
 569 348 }
 570 .fi
 571 .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
 572 .PP
 573 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.
 574 .PP
 575 .nf
 576 434 {
 577 435         WriteServ(Socket,'%s',s.c_str());
 578 436 }
 579 .fi
 580 .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
 581 .PP
 582 Sends text from a user to another user. This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:
 583 .PP
 584 :user!ident TEXT
 585 .PP
 586 The format will become:
 587 .PP
 588 :localserver TEXT
 589 .PP
 590 Which is useful for numerics and server notices to single users, etc.Definition at line 443 of file modules.cpp.
 591 .PP
 592 References connection::fd.
 593 .PP
 594 .nf
 595 444 {
 596 445         if (!Source)
 597 446         {
 598 447                 // if source is NULL, then the message originates from the local server
 599 448                 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
 600 449         }
 601 450         else
 602 451         {
 603 452                 // otherwise it comes from the user specified
 604 453                 WriteTo(Source,Dest,'%s',s.c_str());
 605 454         }
 606 455 }
 607 .fi
 608 .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
 609 .PP
 610 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:
 611 .PP
 612 Serv->SendToModeMask('xi', WM_OR, 'm00');
 613 .PP
 614 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.
 615 .PP
 616 .nf
 617 359 {
 618 360         WriteMode(modes.c_str(),flags,'%s',text.c_str());
 619 361 }
 620 .fi
 621 .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
 622 .PP
 623 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.
 624 .PP
 625 .nf
 626 487 {
 627 488         WriteWallOps(User,false,'%s',text.c_str());
 628 489 }
 629 .fi
 630
 631
 632 .SH "Author"
 633 .PP
 634 Generated automatically by Doxygen for InspIRCd from the source code.