docs/man/Server.3

   1 .TH "Server" 3 "30 Apr 2004" "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 std::string \fBGetServerName\fP ()"
  88 .br
  89 .RI "\fIReturns the server name of the server where the module is loaded.\fP"
  90 .ti -1c
  91 .RI "virtual std::string \fBGetNetworkName\fP ()"
  92 .br
  93 .RI "\fIReturns the network name, global to all linked servers.\fP"
  94 .ti -1c
  95 .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()"
  96 .br
  97 .RI "\fIReturns the information of the server as returned by the /ADMIN command.\fP"
  98 .ti -1c
  99 .RI "virtual bool \fBAddExtendedMode\fP (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)"
 100 .br
 101 .RI "\fIAdds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.\fP"
 102 .ti -1c
 103 .RI "virtual void \fBAddCommand\fP (char *cmd, handlerfunc f, char flags, int minparams)"
 104 .br
 105 .RI "\fIAdds a command to the command table.\fP"
 106 .ti -1c
 107 .RI "virtual void \fBSendMode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
 108 .br
 109 .RI "\fISends a servermode.\fP"
 110 .ti -1c
 111 .RI "virtual void \fBSendToModeMask\fP (std::string modes, int flags, std::string text)"
 112 .br
 113 .RI "\fISends to all users matching a mode mask You must specify one or more usermodes as the first parameter.\fP"
 114 .ti -1c
 115 .RI "virtual \fBchanrec\fP * \fBJoinUserToChannel\fP (\fBuserrec\fP *user, std::string cname, std::string key)"
 116 .br
 117 .RI "\fIForces a user to join a channel.\fP"
 118 .ti -1c
 119 .RI "virtual \fBchanrec\fP * \fBPartUserFromChannel\fP (\fBuserrec\fP *user, std::string cname, std::string reason)"
 120 .br
 121 .RI "\fIForces a user to part a channel.\fP"
 122 .ti -1c
 123 .RI "virtual void \fBChangeUserNick\fP (\fBuserrec\fP *user, std::string nickname)"
 124 .br
 125 .RI "\fIForces a user nickchange.\fP"
 126 .ti -1c
 127 .RI "virtual void \fBQuitUser\fP (\fBuserrec\fP *user, std::string reason)"
 128 .br
 129 .RI "\fIForces a user to quit with the specified reason.\fP"
 130 .ti -1c
 131 .RI "virtual bool \fBMatchText\fP (std::string sliteral, std::string spattern)"
 132 .br
 133 .RI "\fIMatches text against a glob pattern.\fP"
 134 .ti -1c
 135 .RI "virtual void \fBCallCommandHandler\fP (std::string commandname, char **parameters, int pcnt, \fBuserrec\fP *user)"
 136 .br
 137 .RI "\fICalls the handler for a command, either implemented by the core or by another module.\fP"
 138 .ti -1c
 139 .RI "virtual void \fBChangeHost\fP (\fBuserrec\fP *user, std::string host)"
 140 .br
 141 .RI "\fIChange displayed hostname of a user.\fP"
 142 .ti -1c
 143 .RI "virtual void \fBChangeGECOS\fP (\fBuserrec\fP *user, std::string gecos)"
 144 .br
 145 .RI "\fIChange GECOS (fullname) of a user.\fP"
 146 .ti -1c
 147 .RI "virtual bool \fBIsUlined\fP (std::string server)"
 148 .br
 149 .RI "\fIReturns true if the servername you give is ulined.\fP"
 150 .in -1c
 151 .SH "Detailed Description"
 152 .PP
 153 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.
 154
 155 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
 156 .PP
 157 Definition at line 252 of file modules.h.
 158 .SH "Constructor & Destructor Documentation"
 159 .PP
 160 .SS "Server::Server ()"
 161 .PP
 162 Default constructor.Creates a Server object.Definition at line 135 of file modules.cpp.
 163 .PP
 164 .nf
 165 136 {
 166 137 }
 167 .fi
 168 .SS "Server::~Server ()\fC [virtual]\fP"
 169 .PP
 170 Default destructor.Destroys a Server object.Definition at line 139 of file modules.cpp.
 171 .PP
 172 .nf
 173 140 {
 174 141 }
 175 .fi
 176 .SH "Member Function Documentation"
 177 .PP
 178 .SS "void Server::AddCommand (char * cmd, handlerfunc f, char flags, int minparams)\fC [virtual]\fP"
 179 .PP
 180 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:
 181 .PP
 182 typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
 183 .PP
 184 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 197 of file modules.cpp.
 185 .PP
 186 References createcommand().
 187 .PP
 188 .nf
 189 198 {
 190 199         createcommand(cmd,f,flags,minparams);
 191 200 }
 192 .fi
 193 .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP"
 194 .PP
 195 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 317 of file modules.cpp.
 196 .PP
 197 References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
 198 .PP
 199 .nf
 200 318 {
 201 319         if (type == MT_SERVER)
 202 320         {
 203 321                 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
 204 322                 return false;
 205 323         }
 206 324         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
 207 325         {
 208 326                 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
 209 327                 return false;
 210 328         }
 211 329         if ((params_when_on>1) || (params_when_off>1))
 212 330         {
 213 331                 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
 214 332                 return false;
 215 333         }
 216 334         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
 217 335 }
 218 .fi
 219 .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 220 .PP
 221 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
 222 .br
 223 ) 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 187 of file modules.cpp.
 224 .PP
 225 .nf
 226 188 {
 227 189         call_handler(commandname.c_str(),parameters,pcnt,user);
 228 190 }
 229 .fi
 230 .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP"
 231 .PP
 232 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 275 of file modules.cpp.
 233 .PP
 234 References ChangeName().
 235 .PP
 236 .nf
 237 276 {
 238 277         ChangeName(user,gecos.c_str());
 239 278 }
 240 .fi
 241 .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP"
 242 .PP
 243 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 270 of file modules.cpp.
 244 .PP
 245 References ChangeDisplayedHost().
 246 .PP
 247 .nf
 248 271 {
 249 272         ChangeDisplayedHost(user,host.c_str());
 250 273 }
 251 .fi
 252 .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP"
 253 .PP
 254 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 171 of file modules.cpp.
 255 .PP
 256 .nf
 257 172 {
 258 173         force_nickchange(user,nickname.c_str());
 259 174 }
 260 .fi
 261 .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP"
 262 .PP
 263 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 295 of file modules.cpp.
 264 .PP
 265 References cmode().
 266 .PP
 267 .nf
 268 296 {
 269 297         return cmode(User,Chan);
 270 298 }
 271 .fi
 272 .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP"
 273 .PP
 274 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 248 of file modules.cpp.
 275 .PP
 276 References common_channels().
 277 .PP
 278 .nf
 279 249 {
 280 250         return (common_channels(u1,u2) != 0);
 281 251 }
 282 .fi
 283 .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP"
 284 .PP
 285 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 337 of file modules.cpp.
 286 .PP
 287 .nf
 288 338 {
 289 339         return usercount(c);
 290 340 }
 291 .fi
 292 .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP"
 293 .PP
 294 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 290 of file modules.cpp.
 295 .PP
 296 .nf
 297 291 {
 298 292         return FindChan(channel.c_str());
 299 293 }
 300 .fi
 301 .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP"
 302 .PP
 303 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 285 of file modules.cpp.
 304 .PP
 305 .nf
 306 286 {
 307 287         return Find(nick);
 308 288 }
 309 .fi
 310 .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP"
 311 .PP
 312 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 310 of file modules.cpp.
 313 .PP
 314 .nf
 315 311 {
 316 312         return Admin(getadminname(),getadminemail(),getadminnick());
 317 313 }
 318 .fi
 319 .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
 320 .PP
 321 Returns the network name, global to all linked servers.Definition at line 305 of file modules.cpp.
 322 .PP
 323 .nf
 324 306 {
 325 307         return getnetworkname();
 326 308 }
 327 .fi
 328 .SS "std::string Server::GetServerName ()\fC [virtual]\fP"
 329 .PP
 330 Returns the server name of the server where the module is loaded.Definition at line 300 of file modules.cpp.
 331 .PP
 332 .nf
 333 301 {
 334 302         return getservername();
 335 303 }
 336 .fi
 337 .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP"
 338 .PP
 339 Returns true if a nick is valid.Nicks for unregistered connections will return false.Definition at line 280 of file modules.cpp.
 340 .PP
 341 References isnick().
 342 .PP
 343 .nf
 344 281 {
 345 282         return (isnick(nick.c_str()) != 0);
 346 283 }
 347 .fi
 348 .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP"
 349 .PP
 350 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 182 of file modules.cpp.
 351 .PP
 352 References is_uline().
 353 .PP
 354 .nf
 355 183 {
 356 184         return is_uline(server.c_str());
 357 185 }
 358 .fi
 359 .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP"
 360 .PP
 361 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 161 of file modules.cpp.
 362 .PP
 363 .nf
 364 162 {
 365 163         return add_channel(user,cname.c_str(),key.c_str(),true);
 366 164 }
 367 .fi
 368 .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP"
 369 .PP
 370 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 192 of file modules.cpp.
 371 .PP
 372 .nf
 373 193 {
 374 194         log(level,'%s',s.c_str());
 375 195 }
 376 .fi
 377 .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP"
 378 .PP
 379 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 148 of file modules.cpp.
 380 .PP
 381 .nf
 382 149 {
 383 150         char literal[MAXBUF],pattern[MAXBUF];
 384 151         strncpy(literal,sliteral.c_str(),MAXBUF);
 385 152         strncpy(pattern,spattern.c_str(),MAXBUF);
 386 153         return match(literal,pattern);
 387 154 }
 388 .fi
 389 .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP"
 390 .PP
 391 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 166 of file modules.cpp.
 392 .PP
 393 .nf
 394 167 {
 395 168         return del_channel(user,cname.c_str(),reason.c_str(),false);
 396 169 }
 397 .fi
 398 .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
 399 .PP
 400 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.
 401 .PP
 402 WARNING!
 403 .PP
 404 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 176 of file modules.cpp.
 405 .PP
 406 References userrec::nick, and send_network_quit().
 407 .PP
 408 .nf
 409 177 {
 410 178         send_network_quit(user->nick,reason.c_str());
 411 179         kill_link(user,reason.c_str());
 412 180 }
 413 .fi
 414 .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP"
 415 .PP
 416 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 207 of file modules.cpp.
 417 .PP
 418 .nf
 419 208 {
 420 209         Write(Socket,'%s',s.c_str());
 421 210 }
 422 .fi
 423 .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP"
 424 .PP
 425 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 236 of file modules.cpp.
 426 .PP
 427 .nf
 428 237 {
 429 238         if (IncludeSender)
 430 239         {
 431 240                 WriteChannel(Channel,User,'%s',s.c_str());
 432 241         }
 433 242         else
 434 243         {
 435 244                 ChanExceptSender(Channel,User,'%s',s.c_str());
 436 245         }
 437 246 }
 438 .fi
 439 .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP"
 440 .PP
 441 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 253 of file modules.cpp.
 442 .PP
 443 .nf
 444 254 {
 445 255         if (IncludeSender)
 446 256         {
 447 257                 WriteCommon(User,'%s',text.c_str());
 448 258         }
 449 259         else
 450 260         {
 451 261                 WriteCommonExcept(User,'%s',text.c_str());
 452 262         }
 453 263 }
 454 .fi
 455 .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP"
 456 .PP
 457 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 217 of file modules.cpp.
 458 .PP
 459 .nf
 460 218 {
 461 219         WriteFrom(Socket,User,'%s',s.c_str());
 462 220 }
 463 .fi
 464 .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
 465 .PP
 466 Sends a servermode.you must format the parameters array with the target, modes and parameters for those modes.
 467 .PP
 468 For example:
 469 .PP
 470 char *modes[3];
 471 .PP
 472 modes[0] = ChannelName;
 473 .PP
 474 modes[1] = '+o';
 475 .PP
 476 modes[2] = user->nick;
 477 .PP
 478 Srv->SendMode(modes,3,user);
 479 .PP
 480 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 202 of file modules.cpp.
 481 .PP
 482 References server_mode().
 483 .PP
 484 .nf
 485 203 {
 486 204         server_mode(parameters,pcnt,user);
 487 205 }
 488 .fi
 489 .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP"
 490 .PP
 491 Sends text to all opers.This method sends a server notice to all opers with the usermode +s.Definition at line 143 of file modules.cpp.
 492 .PP
 493 .nf
 494 144 {
 495 145         WriteOpers('%s',s.c_str());
 496 146 }
 497 .fi
 498 .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP"
 499 .PP
 500 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 212 of file modules.cpp.
 501 .PP
 502 .nf
 503 213 {
 504 214         WriteServ(Socket,'%s',s.c_str());
 505 215 }
 506 .fi
 507 .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
 508 .PP
 509 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:
 510 .PP
 511 :user!ident TEXT
 512 .PP
 513 The format will become:
 514 .PP
 515 :localserver TEXT
 516 .PP
 517 Which is useful for numerics and server notices to single users, etc.Definition at line 222 of file modules.cpp.
 518 .PP
 519 References connection::fd.
 520 .PP
 521 .nf
 522 223 {
 523 224         if (!Source)
 524 225         {
 525 226                 // if source is NULL, then the message originates from the local server
 526 227                 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
 527 228         }
 528 229         else
 529 230         {
 530 231                 // otherwise it comes from the user specified
 531 232                 WriteTo(Source,Dest,'%s',s.c_str());
 532 233         }
 533 234 }
 534 .fi
 535 .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
 536 .PP
 537 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:
 538 .PP
 539 Serv->SendToModeMask('xi', WM_OR, 'm00');
 540 .PP
 541 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 156 of file modules.cpp.
 542 .PP
 543 .nf
 544 157 {
 545 158         WriteMode(modes.c_str(),flags,'%s',text.c_str());
 546 159 }
 547 .fi
 548 .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP"
 549 .PP
 550 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 265 of file modules.cpp.
 551 .PP
 552 .nf
 553 266 {
 554 267         WriteWallOps(User,false,'%s',text.c_str());
 555 268 }
 556 .fi
 557
 558
 559 .SH "Author"
 560 .PP
 561 Generated automatically by Doxygen for InspIRCd from the source code.