docs/man/man3/Server.3

   1 .TH "Server" 3 "20 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, char *source)"
 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 .ti -1c
 163 .RI "virtual bool \fBUserToPseudo\fP (\fBuserrec\fP *user, std::string message)"
 164 .br
 165 .RI "\fIRemove a user's connection to the irc server, but leave their client in existence in the user hash. \fP"
 166 .ti -1c
 167 .RI "virtual bool \fBPseudoToUser\fP (\fBuserrec\fP *alive, \fBuserrec\fP *zombie, std::string message)"
 168 .br
 169 .RI "\fIThis user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. \fP"
 170 .ti -1c
 171 .RI "virtual void \fBAddGLine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 172 .br
 173 .RI "\fIAdds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP"
 174 .ti -1c
 175 .RI "virtual void \fBAddQLine\fP (long duration, std::string source, std::string reason, std::string nickname)"
 176 .br
 177 .RI "\fIAdds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP"
 178 .ti -1c
 179 .RI "virtual void \fBAddZLine\fP (long duration, std::string source, std::string reason, std::string ipaddr)"
 180 .br
 181 .RI "\fIAdds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP"
 182 .ti -1c
 183 .RI "virtual void \fBAddKLine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 184 .br
 185 .RI "\fIAdds a K-line The K-line is enforced as soon as it is added. \fP"
 186 .ti -1c
 187 .RI "virtual void \fBAddELine\fP (long duration, std::string source, std::string reason, std::string hostmask)"
 188 .br
 189 .RI "\fIAdds a E-line The E-line is enforced as soon as it is added. \fP"
 190 .ti -1c
 191 .RI "virtual bool \fBDelGLine\fP (std::string hostmask)"
 192 .br
 193 .RI "\fIDeletes a G-Line from all servers on the mesh. \fP"
 194 .ti -1c
 195 .RI "virtual bool \fBDelQLine\fP (std::string nickname)"
 196 .br
 197 .RI "\fIDeletes a Q-Line from all servers on the mesh. \fP"
 198 .ti -1c
 199 .RI "virtual bool \fBDelZLine\fP (std::string ipaddr)"
 200 .br
 201 .RI "\fIDeletes a Z-Line from all servers on the mesh. \fP"
 202 .ti -1c
 203 .RI "virtual bool \fBDelKLine\fP (std::string hostmask)"
 204 .br
 205 .RI "\fIDeletes a local K-Line. \fP"
 206 .ti -1c
 207 .RI "virtual bool \fBDelELine\fP (std::string hostmask)"
 208 .br
 209 .RI "\fIDeletes a local E-Line. \fP"
 210 .ti -1c
 211 .RI "virtual long \fBCalcDuration\fP (std::string duration)"
 212 .br
 213 .RI "\fICalculates a duration This method will take a string containing a formatted duration (e.g. \fP"
 214 .ti -1c
 215 .RI "virtual bool \fBIsValidMask\fP (std::string mask)"
 216 .br
 217 .RI "\fIReturns true if a nick!ident string is correctly formatted, false if otherwise. \fP"
 218 .ti -1c
 219 .RI "virtual void \fBMeshSendAll\fP (std::string text)"
 220 .br
 221 .RI "\fISends a line of text to all connected servers. \fP"
 222 .ti -1c
 223 .RI "virtual void \fBMeshSendCommon\fP (\fBuserrec\fP *user, std::string text)"
 224 .br
 225 .RI "\fIThis method sends a line of text to all servers who have users which share common channels with the user you provide. \fP"
 226 .ti -1c
 227 .RI "virtual void \fBMeshSendAllAlive\fP (std::string text)"
 228 .br
 229 .RI "\fIThis function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. \fP"
 230 .ti -1c
 231 .RI "virtual void \fBMeshSendUnicast\fP (std::string destination, std::string text)"
 232 .br
 233 .RI "\fIThis function sends a line of text directly to a server. \fP"
 234 .ti -1c
 235 .RI "virtual void \fBMeshSendAllExcept\fP (std::string target, std::string text)"
 236 .br
 237 .RI "\fIThis function sends to all servers EXCEPT the one you specify. \fP"
 238 .ti -1c
 239 .RI "virtual bool \fBMeshCheckChan\fP (\fBchanrec\fP *c, std::string servername)"
 240 .br
 241 .RI "\fIThis function is used to check if any users on channel c are on server servername. \fP"
 242 .ti -1c
 243 .RI "virtual bool \fBMeshCheckCommon\fP (\fBuserrec\fP *u, std::string servername)"
 244 .br
 245 .RI "\fIThis function is used to check if user u has any channels in common with users on servername. \fP"
 246 .ti -1c
 247 .RI "virtual \fBModule\fP * \fBFindModule\fP (std::string name)"
 248 .br
 249 .RI "\fIThis function finds a module by name. \fP"
 250 .in -1c
 251 .SH "Detailed Description"
 252 .PP
 253 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.
 254
 255 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
 256 .PP
 257 Definition at line 627 of file modules.h.
 258 .SH "Constructor & Destructor Documentation"
 259 .PP
 260 .SS "Server::Server ()"
 261 .PP
 262 Default constructor. Creates a Server object.Definition at line 414 of file modules.cpp.
 263 .PP
 264 .nf
 265 415 {
 266 416 }
 267 .fi
 268 .SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
 269 .PP
 270 Default destructor. Destroys a Server object.Definition at line 418 of file modules.cpp.
 271 .PP
 272 .nf
 273 419 {
 274 420 }
 275 .fi
 276 .SH "Member Function Documentation"
 277 .PP
 278 .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)\fC [virtual]\fP"
 279 .PP
 280 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:
 281 .PP
 282 typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
 283 .PP
 284 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 495 of file modules.cpp.
 285 .PP
 286 References createcommand().
 287 .PP
 288 .nf
 289 496 {
 290 497         createcommand(cmd,f,flags,minparams,source);
 291 498 }
 292 .fi
 293 .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 294 .PP
 295 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 713 of file modules.cpp.
 296 .PP
 297 References add_eline(), and duration().
 298 .PP
 299 .nf
 300 714 {
 301 715         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 302 716 }
 303 .fi
 304 .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
 305 .PP
 306 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:
 307 .PP
 308 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
 309 .PP
 310 (2) They always take exactly one parameter when being added or removed
 311 .PP
 312 (3) They can be set multiple times, usually on users in channels
 313 .PP
 314 (4) The mode and its parameter are NOT stored in the channels modes structure
 315 .PP
 316 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 640 of file modules.cpp.
 317 .PP
 318 References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 319 .PP
 320 .nf
 321 641 {
 322 642         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
 323 643         if (res)
 324 644                 ModeMakeList(modechar);
 325 645         return res;
 326 646 }
 327 .fi
 328 .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
 329 .PP
 330 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 620 of file modules.cpp.
 331 .PP
 332 References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 333 .PP
 334 .nf
 335 621 {
 336 622         if (type == MT_SERVER)
 337 623         {
 338 624                 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
 339 625                 return false;
 340 626         }
 341 627         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 342 628         {
 343 629                 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
 344 630                 return false;
 345 631         }
 346 632         if ((params_when_on>1) || (params_when_off>1))
 347 633         {
 348 634                 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
 349 635                 return false;
 350 636         }
 351 637         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 352 638 }
 353 .fi
 354 .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 355 .PP
 356 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 693 of file modules.cpp.
 357 .PP
 358 References add_gline(), and duration().
 359 .PP
 360 .nf
 361 694 {
 362 695         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 363 696 }
 364 .fi
 365 .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
 366 .PP
 367 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 708 of file modules.cpp.
 368 .PP
 369 References add_kline(), and duration().
 370 .PP
 371 .nf
 372 709 {
 373 710         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
 374 711 }
 375 .fi
 376 .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP"
 377 .PP
 378 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 698 of file modules.cpp.
 379 .PP
 380 References add_qline(), and duration().
 381 .PP
 382 .nf
 383 699 {
 384 700         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
 385 701 }
 386 .fi
 387 .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP"
 388 .PP
 389 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 703 of file modules.cpp.
 390 .PP
 391 References add_zline(), and duration().
 392 .PP
 393 .nf
 394 704 {
 395 705         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
 396 706 }
 397 .fi
 398 .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP"
 399 .PP
 400 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 743 of file modules.cpp.
 401 .PP
 402 References duration().
 403 .PP
 404 .nf
 405 744 {
 406 745         return duration(delta.c_str());
 407 746 }
 408 .fi
 409 .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 410 .PP
 411 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
 412 .br
 413 ) 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 485 of file modules.cpp.
 414 .PP
 415 .nf
 416 486 {
 417 487         call_handler(commandname.c_str(),parameters,pcnt,user);
 418 488 }
 419 .fi
 420 .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
 421 .PP
 422 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 573 of file modules.cpp.
 423 .PP
 424 References ChangeName().
 425 .PP
 426 .nf
 427 574 {
 428 575         ChangeName(user,gecos.c_str());
 429 576 }
 430 .fi
 431 .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
 432 .PP
 433 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 568 of file modules.cpp.
 434 .PP
 435 References ChangeDisplayedHost().
 436 .PP
 437 .nf
 438 569 {
 439 570         ChangeDisplayedHost(user,host.c_str());
 440 571 }
 441 .fi
 442 .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
 443 .PP
 444 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 469 of file modules.cpp.
 445 .PP
 446 .nf
 447 470 {
 448 471         force_nickchange(user,nickname.c_str());
 449 472 }
 450 .fi
 451 .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 452 .PP
 453 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 593 of file modules.cpp.
 454 .PP
 455 References cmode().
 456 .PP
 457 .nf
 458 594 {
 459 595         return cmode(User,Chan);
 460 596 }
 461 .fi
 462 .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
 463 .PP
 464 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 546 of file modules.cpp.
 465 .PP
 466 References common_channels().
 467 .PP
 468 .nf
 469 547 {
 470 548         return (common_channels(u1,u2) != 0);
 471 549 }
 472 .fi
 473 .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
 474 .PP
 475 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 648 of file modules.cpp.
 476 .PP
 477 .nf
 478 649 {
 479 650         return usercount(c);
 480 651 }
 481 .fi
 482 .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP"
 483 .PP
 484 Deletes a local E-Line. Definition at line 738 of file modules.cpp.
 485 .PP
 486 References del_eline().
 487 .PP
 488 .nf
 489 739 {
 490 740         del_eline(hostmask.c_str());
 491 741 }
 492 .fi
 493 .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP"
 494 .PP
 495 Deletes a G-Line from all servers on the mesh. Definition at line 718 of file modules.cpp.
 496 .PP
 497 References del_gline().
 498 .PP
 499 .nf
 500 719 {
 501 720         del_gline(hostmask.c_str());
 502 721 }
 503 .fi
 504 .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP"
 505 .PP
 506 Deletes a local K-Line. Definition at line 733 of file modules.cpp.
 507 .PP
 508 References del_kline().
 509 .PP
 510 .nf
 511 734 {
 512 735         del_kline(hostmask.c_str());
 513 736 }
 514 .fi
 515 .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP"
 516 .PP
 517 Deletes a Q-Line from all servers on the mesh. Definition at line 723 of file modules.cpp.
 518 .PP
 519 References del_qline().
 520 .PP
 521 .nf
 522 724 {
 523 725         del_qline(nickname.c_str());
 524 726 }
 525 .fi
 526 .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP"
 527 .PP
 528 Deletes a Z-Line from all servers on the mesh. Definition at line 728 of file modules.cpp.
 529 .PP
 530 References del_zline().
 531 .PP
 532 .nf
 533 729 {
 534 730         del_zline(ipaddr.c_str());
 535 731 }
 536 .fi
 537 .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
 538 .PP
 539 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 588 of file modules.cpp.
 540 .PP
 541 .nf
 542 589 {
 543 590         return FindChan(channel.c_str());
 544 591 }
 545 .fi
 546 .SS "\fBModule\fP * Server::FindModule (std::string name)\fC [virtual]\fP"
 547 .PP
 548 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 821 of file modules.cpp.
 549 .PP
 550 References MODCOUNT, module_names, and modules.
 551 .PP
 552 .nf
 553 822 {
 554 823         for (int i = 0; i <= MODCOUNT; i++)
 555 824         {
 556 825                 if (module_names[i] == name)
 557 826                 {
 558 827                         return modules[i];
 559 828                 }
 560 829         }
 561 830         return NULL;
 562 831 }
 563 .fi
 564 .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
 565 .PP
 566 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 583 of file modules.cpp.
 567 .PP
 568 .nf
 569 584 {
 570 585         return Find(nick);
 571 586 }
 572 .fi
 573 .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
 574 .PP
 575 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 613 of file modules.cpp.
 576 .PP
 577 .nf
 578 614 {
 579 615         return Admin(getadminname(),getadminemail(),getadminnick());
 580 616 }
 581 .fi
 582 .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
 583 .PP
 584 Returns the network name, global to all linked servers. Definition at line 608 of file modules.cpp.
 585 .PP
 586 .nf
 587 609 {
 588 610         return getnetworkname();
 589 611 }
 590 .fi
 591 .SS "std::string Server::GetServerName ()\fC [virtual]\fP"
 592 .PP
 593 Returns the server name of the server where the module is loaded. Definition at line 603 of file modules.cpp.
 594 .PP
 595 .nf
 596 604 {
 597 605         return getservername();
 598 606 }
 599 .fi
 600 .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP"
 601 .PP
 602 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 450 of file modules.cpp.
 603 .PP
 604 References chanuserlist, clientlist, has_channel(), and isnick().
 605 .PP
 606 .nf
 607 451 {
 608 452         chanuserlist userl;
 609 453         userl.clear();
 610 454         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 611 455         {
 612 456                 if (i->second)
 613 457                 {
 614 458                         if (has_channel(i->second,chan))
 615 459                         {
 616 460                                 if (isnick(i->second->nick))
 617 461                                 {
 618 462                                         userl.push_back(i->second);
 619 463                                 }
 620 464                         }
 621 465                 }
 622 466         }
 623 467         return userl;
 624 468 }
 625 .fi
 626 .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
 627 .PP
 628 Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 578 of file modules.cpp.
 629 .PP
 630 References isnick().
 631 .PP
 632 .nf
 633 579 {
 634 580         return (isnick(nick.c_str()) != 0);
 635 581 }
 636 .fi
 637 .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 638 .PP
 639 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 598 of file modules.cpp.
 640 .PP
 641 References has_channel().
 642 .PP
 643 .nf
 644 599 {
 645 600         return has_channel(User,Chan);
 646 601 }
 647 .fi
 648 .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
 649 .PP
 650 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 480 of file modules.cpp.
 651 .PP
 652 References is_uline().
 653 .PP
 654 .nf
 655 481 {
 656 482         return is_uline(server.c_str());
 657 483 }
 658 .fi
 659 .SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP"
 660 .PP
 661 Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 748 of file modules.cpp.
 662 .PP
 663 .nf
 664 749 {
 665 750         const char* dest = mask.c_str();
 666 751         if (strchr(dest,'!')==0)
 667 752                 return false;
 668 753         if (strchr(dest,'@')==0)
 669 754                 return false;
 670 755         for (int i = 0; i < strlen(dest); i++)
 671 756                 if (dest[i] < 32)
 672 757                         return false;
 673 758         for (int i = 0; i < strlen(dest); i++)
 674 759                 if (dest[i] > 126)
 675 760                         return false;
 676 761         int c = 0;
 677 762         for (int i = 0; i < strlen(dest); i++)
 678 763                 if (dest[i] == '!')
 679 764                         c++;
 680 765         if (c>1)
 681 766                 return false;
 682 767         c = 0;
 683 768         for (int i = 0; i < strlen(dest); i++)
 684 769                 if (dest[i] == '@')
 685 770                         c++;
 686 771         if (c>1)
 687 772                 return false;
 688 773
 689 774         return true;
 690 775 }
 691 .fi
 692 .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
 693 .PP
 694 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 440 of file modules.cpp.
 695 .PP
 696 .nf
 697 441 {
 698 442         return add_channel(user,cname.c_str(),key.c_str(),true);
 699 443 }
 700 .fi
 701 .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
 702 .PP
 703 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 490 of file modules.cpp.
 704 .PP
 705 .nf
 706 491 {
 707 492         log(level,'%s',s.c_str());
 708 493 }
 709 .fi
 710 .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
 711 .PP
 712 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 427 of file modules.cpp.
 713 .PP
 714 .nf
 715 428 {
 716 429         char literal[MAXBUF],pattern[MAXBUF];
 717 430         strlcpy(literal,sliteral.c_str(),MAXBUF);
 718 431         strlcpy(pattern,spattern.c_str(),MAXBUF);
 719 432         return match(literal,pattern);
 720 433 }
 721 .fi
 722 .SS "bool Server::MeshCheckChan (\fBchanrec\fP * c, std::string servername)\fC [virtual]\fP"
 723 .PP
 724 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 803 of file modules.cpp.
 725 .PP
 726 .nf
 727 804 {
 728 805         if (c)
 729 806         {
 730 807                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
 731 808         }
 732 809         else return false;
 733 810 }
 734 .fi
 735 .SS "bool Server::MeshCheckCommon (\fBuserrec\fP * u, std::string servername)\fC [virtual]\fP"
 736 .PP
 737 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 812 of file modules.cpp.
 738 .PP
 739 .nf
 740 813 {
 741 814         if (u)
 742 815         {
 743 816                 return CommonOnThisServer(u,(char*)servername.c_str());
 744 817         }
 745 818         else return false;
 746 819 }
 747 .fi
 748 .SS "void Server::MeshSendAll (std::string text)\fC [virtual]\fP"
 749 .PP
 750 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 777 of file modules.cpp.
 751 .PP
 752 .nf
 753 778 {
 754 779         NetSendToAll((char*)text.c_str());
 755 780 }
 756 .fi
 757 .SS "void Server::MeshSendAllAlive (std::string text)\fC [virtual]\fP"
 758 .PP
 759 This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 788 of file modules.cpp.
 760 .PP
 761 .nf
 762 789 {
 763 790         NetSendToAllAlive((char*)text.c_str());
 764 791 }
 765 .fi
 766 .SS "void Server::MeshSendAllExcept (std::string target, std::string text)\fC [virtual]\fP"
 767 .PP
 768 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 798 of file modules.cpp.
 769 .PP
 770 .nf
 771 799 {
 772 800         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
 773 801 }
 774 .fi
 775 .SS "void Server::MeshSendCommon (\fBuserrec\fP * user, std::string text)\fC [virtual]\fP"
 776 .PP
 777 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 782 of file modules.cpp.
 778 .PP
 779 .nf
 780 783 {
 781 784         if (user)
 782 785                 NetSendToCommon(user,(char*)text.c_str());
 783 786 }
 784 .fi
 785 .SS "void Server::MeshSendUnicast (std::string destination, std::string text)\fC [virtual]\fP"
 786 .PP
 787 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 793 of file modules.cpp.
 788 .PP
 789 .nf
 790 794 {
 791 795         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
 792 796 }
 793 .fi
 794 .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
 795 .PP
 796 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 445 of file modules.cpp.
 797 .PP
 798 .nf
 799 446 {
 800 447         return del_channel(user,cname.c_str(),reason.c_str(),false);
 801 448 }
 802 .fi
 803 .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP"
 804 .PP
 805 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 663 of file modules.cpp.
 806 .PP
 807 References ucrec::channel, userrec::chans, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
 808 .PP
 809 .nf
 810 664 {
 811 665         zombie->fd = alive->fd;
 812 666         alive->fd = FD_MAGIC_NUMBER;
 813 667         Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
 814 668         kill_link(alive,message.c_str());
 815 669         for (int i = 0; i != MAXCHANS; i++)
 816 670         {
 817 671                 if (zombie->chans[i].channel != NULL)
 818 672                 {
 819 673                         if (zombie->chans[i].channel->name)
 820 674                         {
 821 675                                 chanrec* Ptr = zombie->chans[i].channel;
 822 676                                 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
 823 677                                 if (Ptr->topicset)
 824 678                                 {
 825 679                                         WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
 826 680                                         WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
 827 681                                 }
 828 682                                 userlist(zombie,Ptr);
 829 683                                 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
 830 684                                 //WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr));
 831 685                                 //WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created);
 832 686
 833 687                         }
 834 688                 }
 835 689         }
 836 690
 837 691 }
 838 .fi
 839 .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
 840 .PP
 841 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.
 842 .PP
 843 WARNING!
 844 .PP
 845 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 474 of file modules.cpp.
 846 .PP
 847 References userrec::nick, and send_network_quit().
 848 .PP
 849 .nf
 850 475 {
 851 476         send_network_quit(user->nick,reason.c_str());
 852 477         kill_link(user,reason.c_str());
 853 478 }
 854 .fi
 855 .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
 856 .PP
 857 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 505 of file modules.cpp.
 858 .PP
 859 .nf
 860 506 {
 861 507         Write(Socket,'%s',s.c_str());
 862 508 }
 863 .fi
 864 .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
 865 .PP
 866 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 534 of file modules.cpp.
 867 .PP
 868 .nf
 869 535 {
 870 536         if (IncludeSender)
 871 537         {
 872 538                 WriteChannel(Channel,User,'%s',s.c_str());
 873 539         }
 874 540         else
 875 541         {
 876 542                 ChanExceptSender(Channel,User,'%s',s.c_str());
 877 543         }
 878 544 }
 879 .fi
 880 .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
 881 .PP
 882 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 551 of file modules.cpp.
 883 .PP
 884 .nf
 885 552 {
 886 553         if (IncludeSender)
 887 554         {
 888 555                 WriteCommon(User,'%s',text.c_str());
 889 556         }
 890 557         else
 891 558         {
 892 559                 WriteCommonExcept(User,'%s',text.c_str());
 893 560         }
 894 561 }
 895 .fi
 896 .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
 897 .PP
 898 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 515 of file modules.cpp.
 899 .PP
 900 .nf
 901 516 {
 902 517         WriteFrom(Socket,User,'%s',s.c_str());
 903 518 }
 904 .fi
 905 .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 906 .PP
 907 Sends a servermode. you must format the parameters array with the target, modes and parameters for those modes.
 908 .PP
 909 For example:
 910 .PP
 911 char *modes[3];
 912 .PP
 913 modes[0] = ChannelName;
 914 .PP
 915 modes[1] = '+o';
 916 .PP
 917 modes[2] = user->nick;
 918 .PP
 919 Srv->SendMode(modes,3,user);
 920 .PP
 921 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 500 of file modules.cpp.
 922 .PP
 923 References server_mode().
 924 .PP
 925 .nf
 926 501 {
 927 502         server_mode(parameters,pcnt,user);
 928 503 }
 929 .fi
 930 .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
 931 .PP
 932 Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 422 of file modules.cpp.
 933 .PP
 934 .nf
 935 423 {
 936 424         WriteOpers('%s',s.c_str());
 937 425 }
 938 .fi
 939 .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
 940 .PP
 941 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 510 of file modules.cpp.
 942 .PP
 943 .nf
 944 511 {
 945 512         WriteServ(Socket,'%s',s.c_str());
 946 513 }
 947 .fi
 948 .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
 949 .PP
 950 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:
 951 .PP
 952 :user!ident TEXT
 953 .PP
 954 The format will become:
 955 .PP
 956 :localserver TEXT
 957 .PP
 958 Which is useful for numerics and server notices to single users, etc.Definition at line 520 of file modules.cpp.
 959 .PP
 960 References connection::fd.
 961 .PP
 962 .nf
 963 521 {
 964 522         if (!Source)
 965 523         {
 966 524                 // if source is NULL, then the message originates from the local server
 967 525                 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
 968 526         }
 969 527         else
 970 528         {
 971 529                 // otherwise it comes from the user specified
 972 530                 WriteTo(Source,Dest,'%s',s.c_str());
 973 531         }
 974 532 }
 975 .fi
 976 .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
 977 .PP
 978 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:
 979 .PP
 980 Serv->SendToModeMask('xi', WM_OR, 'm00');
 981 .PP
 982 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 435 of file modules.cpp.
 983 .PP
 984 .nf
 985 436 {
 986 437         WriteMode(modes.c_str(),flags,'%s',text.c_str());
 987 438 }
 988 .fi
 989 .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
 990 .PP
 991 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 563 of file modules.cpp.
 992 .PP
 993 .nf
 994 564 {
 995 565         WriteWallOps(User,false,'%s',text.c_str());
 996 566 }
 997 .fi
 998 .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP"
 999 .PP
1000 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 654 of file modules.cpp.
1001 .PP
1002 References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
1003 .PP
1004 .nf
1005 655 {
1006 656         unsigned int old_fd = user->fd;
1007 657         user->fd = FD_MAGIC_NUMBER;
1008 658         Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
1009 659         close(old_fd);
1010 660         shutdown (old_fd,2);
1011 661 }
1012 .fi
1013
1014
1015 .SH "Author"
1016 .PP
1017 Generated automatically by Doxygen for InspIRCd from the source code.