From 755d67224f033aaa9b4ef3d2dd00f46bb8c19dc2 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 7 Apr 2005 20:15:05 +0000 Subject: New docs to match extra module Version class stuff, etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1008 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 448 ++++++++++++++++++++------------------- 1 file changed, 227 insertions(+), 221 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 23971e233..c126dc81a 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -84,7 +84,7 @@ Inherits classbase. virtual bool AddExtendedListMode (char modechar)  Adds an extended mode letter which is parsed by a module and handled in a list fashion.

-virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams) +virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source)  Adds a command to the command table.

virtual void SendMode (char **parameters, int pcnt, userrec *user) @@ -120,7 +120,7 @@ Inherits classbase. virtual bool IsUlined (std::string server)  Returns true if the servername you give is ulined.

-virtual chanuserlist GetUsers (chanrec *chan) +virtual chanuserlist GetUsers (chanrec *chan)  Fetches the userlist of a channel.

@@ -131,7 +131,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 371 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 378 of file modules.h.

Constructor & Destructor Documentation

@@ -161,10 +161,10 @@ Default constructor.

Creates a Server object.

-Definition at line 337 of file modules.cpp. +Definition at line 339 of file modules.cpp.

-

00338 {
-00339 }
+
00340 {
+00341 }
@@ -197,10 +197,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 341 of file modules.cpp. +Definition at line 343 of file modules.cpp.

-

00342 {
-00343 }
+
00344 {
+00345 }
 
    
   
 
@@ -232,7 +232,13 @@ Definition at line 341
           
           
           int 
-           minparams
+           minparams, 
+        
+        
+          
+          
+          char * 
+           source
         
         
           
@@ -256,15 +262,15 @@ 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:

 typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

-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'.
+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 418 of file modules.cpp.
+Definition at line 420 of file modules.cpp.
 

-References createcommand().
+References createcommand().
 

-
00419 {
-00420         createcommand(cmd,f,flags,minparams);
-00421 }
+
00421 {
+00422         createcommand(cmd,f,flags,minparams,source);
+00423 }
 
    
   
 
@@ -303,16 +309,16 @@ This call is used to implement modes like +q and +a. The characteristics of thes
 (4) The mode and its parameter are NOT stored in the channels modes structure

 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.
+Definition at line 565 of file modules.cpp.
 

-References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
+References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
 

-
00564 {
-00565         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00566         if (res)
-00567                 ModeMakeList(modechar);
-00568         return res;
-00569 }
+
00566 {
+00567         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00568         if (res)
+00569                 ModeMakeList(modechar);
+00570         return res;
+00571 }
 
    
   
 
@@ -373,28 +379,28 @@ 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.
-

-References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
-

-
00544 {
-00545         if (type == MT_SERVER)
-00546         {
-00547                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00548                 return false;
-00549         }
-00550         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00551         {
-00552                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00553                 return false;
-00554         }
-00555         if ((params_when_on>1) || (params_when_off>1))
-00556         {
-00557                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00558                 return false;
-00559         }
-00560         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00561 }
+Definition at line 545 of file modules.cpp.
+

+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+

+
00546 {
+00547         if (type == MT_SERVER)
+00548         {
+00549                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00550                 return false;
+00551         }
+00552         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00553         {
+00554                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00555                 return false;
+00556         }
+00557         if ((params_when_on>1) || (params_when_off>1))
+00558         {
+00559                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00560                 return false;
+00561         }
+00562         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00563 }
 
    
   
 
@@ -450,11 +456,11 @@ Calls the handler for a command, either implemented by the core or by another mo
 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 

 ) 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 AddCommand(). 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.
+Definition at line 410 of file modules.cpp.
 

-
00409 {
-00410         call_handler(commandname.c_str(),parameters,pcnt,user);
-00411 }
+
00411 {
+00412         call_handler(commandname.c_str(),parameters,pcnt,user);
+00413 }
 
    
   
 
@@ -497,13 +503,13 @@ 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.
+Definition at line 498 of file modules.cpp.
 

 References ChangeName().
 

-
00497 {
-00498         ChangeName(user,gecos.c_str());
-00499 }
+
00499 {
+00500         ChangeName(user,gecos.c_str());
+00501 }
 
    
   
 
@@ -546,13 +552,13 @@ 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.
+Definition at line 493 of file modules.cpp.
 

 References ChangeDisplayedHost().
 

-
00492 {
-00493         ChangeDisplayedHost(user,host.c_str());
-00494 }
+
00494 {
+00495         ChangeDisplayedHost(user,host.c_str());
+00496 }
 
    
   
 
@@ -595,11 +601,11 @@ 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.
+Definition at line 394 of file modules.cpp.
 

-
00393 {
-00394         force_nickchange(user,nickname.c_str());
-00395 }
+
00395 {
+00396         force_nickchange(user,nickname.c_str());
+00397 }
 
    
   
 
@@ -642,13 +648,13 @@ 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.
+Definition at line 518 of file modules.cpp.
 

 References cmode().
 

-
00517 {
-00518         return cmode(User,Chan);
-00519 }
+
00519 {
+00520         return cmode(User,Chan);
+00521 }
 
    
   
 
@@ -691,13 +697,13 @@ Returns true if two users share a common channel.
 

 This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.
 

-Definition at line 469 of file modules.cpp.
+Definition at line 471 of file modules.cpp.
 

 References common_channels().
 

-
00470 {
-00471         return (common_channels(u1,u2) != 0);
-00472 }
+
00472 {
+00473         return (common_channels(u1,u2) != 0);
+00474 }
 
    
   
 
@@ -731,11 +737,11 @@ 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.
+Definition at line 573 of file modules.cpp.
 

-
00572 {
-00573         return usercount(c);
-00574 }
+
00574 {
+00575         return usercount(c);
+00576 }
 
    
   
 
@@ -769,11 +775,11 @@ 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.
+Definition at line 513 of file modules.cpp.
 

-
00512 {
-00513         return FindChan(channel.c_str());
-00514 }
+
00514 {
+00515         return FindChan(channel.c_str());
+00516 }
 
    
   
 
@@ -807,11 +813,11 @@ 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.
+Definition at line 508 of file modules.cpp.
 

-
00507 {
-00508         return Find(nick);
-00509 }
+
00509 {
+00510         return Find(nick);
+00511 }
 
    
   
 
@@ -844,11 +850,11 @@ Returns the information of the server as returned by the /ADMIN command.
 

 See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.
 

-Definition at line 536 of file modules.cpp.
+Definition at line 538 of file modules.cpp.
 

-
00537 {
-00538         return Admin(getadminname(),getadminemail(),getadminnick());
-00539 }
+
00539 {
+00540         return Admin(getadminname(),getadminemail(),getadminnick());
+00541 }
 
    
   
 
@@ -881,11 +887,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 531 of file modules.cpp.
+Definition at line 533 of file modules.cpp.
 

-
00532 {
-00533         return getnetworkname();
-00534 }
+
00534 {
+00535         return getnetworkname();
+00536 }
 
    
   
 
@@ -918,11 +924,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 526 of file modules.cpp.
+Definition at line 528 of file modules.cpp.
 

-
00527 {
-00528         return getservername();
-00529 }
+
00529 {
+00530         return getservername();
+00531 }
 
    
   
 
@@ -932,7 +938,7 @@ Definition at line 526
     
       
-          
+          
@@ -956,28 +962,28 @@ 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.
-

-References chanuserlist, clientlist, has_channel(), and isnick().
-

-
00374 {
-00375         chanuserlist userl;
-00376         userl.clear();
-00377         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00378         {
-00379                 if (i->second)
-00380                 {
-00381                         if (has_channel(i->second,chan))
-00382                         {
-00383                                 if (isnick(i->second->nick))
-00384                                 {
-00385                                         userl.push_back(i->second);
-00386                                 }
-00387                         }
-00388                 }
-00389         }
-00390         return userl;
-00391 }
+Definition at line 375 of file modules.cpp.
+

+References chanuserlist, clientlist, has_channel(), and isnick().
+

+
00376 {
+00377         chanuserlist userl;
+00378         userl.clear();
+00379         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+00380         {
+00381                 if (i->second)
+00382                 {
+00383                         if (has_channel(i->second,chan))
+00384                         {
+00385                                 if (isnick(i->second->nick))
+00386                                 {
+00387                                         userl.push_back(i->second);
+00388                                 }
+00389                         }
+00390                 }
+00391         }
+00392         return userl;
+00393 }
 
    
   

         
 chanuserlist Server::GetUsers  chanuserlist Server::GetUsers 
           ( 
           chanrec * 
            chan          

 

@@ -1011,13 +1017,13 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 501 of file modules.cpp.
+Definition at line 503 of file modules.cpp.
 

 References isnick().
 

-
00502 {
-00503         return (isnick(nick.c_str()) != 0);
-00504 }
+
00504 {
+00505         return (isnick(nick.c_str()) != 0);
+00506 }
 
    
   
 
@@ -1060,13 +1066,13 @@ 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.
+Definition at line 523 of file modules.cpp.
 

 References has_channel().
 

-
00522 {
-00523         return has_channel(User,Chan);
-00524 }
+
00524 {
+00525         return has_channel(User,Chan);
+00526 }
 
    
   
 
@@ -1100,13 +1106,13 @@ 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.
+Definition at line 405 of file modules.cpp.
 

-References is_uline().
+References is_uline().
 

-
00404 {
-00405         return is_uline(server.c_str());
-00406 }
+
00406 {
+00407         return is_uline(server.c_str());
+00408 }
 
    
   
 
@@ -1155,11 +1161,11 @@ 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.
+Definition at line 365 of file modules.cpp.
 

-
00364 {
-00365         return add_channel(user,cname.c_str(),key.c_str(),true);
-00366 }
+
00366 {
+00367         return add_channel(user,cname.c_str(),key.c_str(),true);
+00368 }
 
    
   
 
@@ -1202,11 +1208,11 @@ 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.
+Definition at line 415 of file modules.cpp.
 

-
00414 {
-00415         log(level,"%s",s.c_str());
-00416 }
+
00416 {
+00417         log(level,"%s",s.c_str());
+00418 }
 
    
   
 
@@ -1249,14 +1255,14 @@ 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.
+Definition at line 352 of file modules.cpp.
 

-
00351 {
-00352         char literal[MAXBUF],pattern[MAXBUF];
-00353         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00354         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00355         return match(literal,pattern);
-00356 }
+
00353 {
+00354         char literal[MAXBUF],pattern[MAXBUF];
+00355         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00356         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00357         return match(literal,pattern);
+00358 }
 
    
   
 
@@ -1305,11 +1311,11 @@ 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.
+Definition at line 370 of file modules.cpp.
 

-
00369 {
-00370         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00371 }
+
00371 {
+00372         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00373 }
 
    
   
 
@@ -1354,14 +1360,14 @@ To the user, it will appear as if they typed /QUIT themselves, except for the fa
 WARNING!

 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.
+Definition at line 399 of file modules.cpp.
 

 References userrec::nick, and send_network_quit().
 

-
00398 {
-00399         send_network_quit(user->nick,reason.c_str());
-00400         kill_link(user,reason.c_str());
-00401 }
+
00400 {
+00401         send_network_quit(user->nick,reason.c_str());
+00402         kill_link(user,reason.c_str());
+00403 }
 
    
   
 
@@ -1404,11 +1410,11 @@ 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.
+Definition at line 430 of file modules.cpp.
 

-
00429 {
-00430         Write(Socket,"%s",s.c_str());
-00431 }
+
00431 {
+00432         Write(Socket,"%s",s.c_str());
+00433 }
 
    
   
 
@@ -1463,18 +1469,18 @@ 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.
-

-
00458 {
-00459         if (IncludeSender)
-00460         {
-00461                 WriteChannel(Channel,User,"%s",s.c_str());
-00462         }
-00463         else
-00464         {
-00465                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00466         }
-00467 }
+Definition at line 459 of file modules.cpp.
+

+
00460 {
+00461         if (IncludeSender)
+00462         {
+00463                 WriteChannel(Channel,User,"%s",s.c_str());
+00464         }
+00465         else
+00466         {
+00467                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00468         }
+00469 }
 
    
   
 
@@ -1523,18 +1529,18 @@ 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.
-

-
00475 {
-00476         if (IncludeSender)
-00477         {
-00478                 WriteCommon(User,"%s",text.c_str());
-00479         }
-00480         else
-00481         {
-00482                 WriteCommonExcept(User,"%s",text.c_str());
-00483         }
-00484 }
+Definition at line 476 of file modules.cpp.
+

+
00477 {
+00478         if (IncludeSender)
+00479         {
+00480                 WriteCommon(User,"%s",text.c_str());
+00481         }
+00482         else
+00483         {
+00484                 WriteCommonExcept(User,"%s",text.c_str());
+00485         }
+00486 }
 
    
   
 
@@ -1583,11 +1589,11 @@ 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.
+Definition at line 440 of file modules.cpp.
 

-
00439 {
-00440         WriteFrom(Socket,User,"%s",s.c_str());
-00441 }
+
00441 {
+00442         WriteFrom(Socket,User,"%s",s.c_str());
+00443 }
 
    
   
 
@@ -1643,13 +1649,13 @@ modes[2] = user->nick;

 Srv->SendMode(modes,3,user);

 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.
+Definition at line 425 of file modules.cpp.
 

-References server_mode().
+References server_mode().
 

-
00424 {
-00425         server_mode(parameters,pcnt,user);
-00426 }
+
00426 {
+00427         server_mode(parameters,pcnt,user);
+00428 }
 
    
   
 
@@ -1683,11 +1689,11 @@ 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.
+Definition at line 347 of file modules.cpp.
 

-
00346 {
-00347         WriteOpers("%s",s.c_str());
-00348 }
+
00348 {
+00349         WriteOpers("%s",s.c_str());
+00350 }
 
    
   
 
@@ -1730,11 +1736,11 @@ 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.
+Definition at line 435 of file modules.cpp.
 

-
00434 {
-00435         WriteServ(Socket,"%s",s.c_str());
-00436 }
+
00436 {
+00437         WriteServ(Socket,"%s",s.c_str());
+00438 }
 
    
   
 
@@ -1787,22 +1793,22 @@ The format will become:

 :localserver TEXT

 Which is useful for numerics and server notices to single users, etc.
 

-Definition at line 443 of file modules.cpp.
+Definition at line 445 of file modules.cpp.
 

 References connection::fd.
 

-
00444 {
-00445         if (!Source)
-00446         {
-00447                 // if source is NULL, then the message originates from the local server
-00448                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00449         }
-00450         else
-00451         {
-00452                 // otherwise it comes from the user specified
-00453                 WriteTo(Source,Dest,"%s",s.c_str());
-00454         }
-00455 }
+
00446 {
+00447         if (!Source)
+00448         {
+00449                 // if source is NULL, then the message originates from the local server
+00450                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00451         }
+00452         else
+00453         {
+00454                 // otherwise it comes from the user specified
+00455                 WriteTo(Source,Dest,"%s",s.c_str());
+00456         }
+00457 }
 
    
   
 
@@ -1853,11 +1859,11 @@ These can be RFC specified modes such as +i, or module provided modes, including
 Serv->SendToModeMask("xi", WM_OR, "m00");

 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.
+Definition at line 360 of file modules.cpp.
 

-
00359 {
-00360         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00361 }
+
00361 {
+00362         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00363 }
 
    
   
 
@@ -1900,17 +1906,17 @@ 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.
+Definition at line 488 of file modules.cpp.
 

-
00487 {
-00488         WriteWallOps(User,false,"%s",text.c_str());
-00489 }
+
00489 {
+00490         WriteWallOps(User,false,"%s",text.c_str());
+00491 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Mon Apr 4 18:12:54 2005 for InspIRCd by
+
Generated on Thu Apr 7 20:14:26 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3