From 1ea860b5708d065f9ed51234fc031969215fd806 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 2 Apr 2004 13:47:31 +0000 Subject: Updated documentation to document Server::SendMode git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@356 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 210 +++++++++++++++++++++++++-------------- 1 file changed, 135 insertions(+), 75 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index c7b08f426..1565c1d30 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -64,6 +64,8 @@ Inheritance diagram for Server:



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

+virtual void SendMode (char **parameters, int pcnt, userrec *user) + Sends a servermode.

Detailed Description

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. @@ -72,7 +74,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 163 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 165 of file modules.h.

Constructor & Destructor Documentation

@@ -266,10 +268,10 @@ Adds an extended mode letter which is parsed by a module This allows modules to

+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. default_on is true if the mode is to be applied to default connections. 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 +b, 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 220 of file modules.cpp. +Definition at line 224 of file modules.cpp.

-

00221 {
-00222 }
+
00225 {
+00226 }
@@ -312,11 +314,11 @@ 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 198 of file modules.cpp. +Definition at line 202 of file modules.cpp.

-

00199 {
-00200         return cmode(User,Chan);
-00201 }
+
00203 {
+00204         return cmode(User,Chan);
+00205 }
 
    
   
 
@@ -359,11 +361,11 @@ 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 161 of file modules.cpp.
+Definition at line 165 of file modules.cpp.
 

-
00162 {
-00163         return (common_channels(u1,u2) != 0);
-00164 }
+
00166 {
+00167         return (common_channels(u1,u2) != 0);
+00168 }
 
    
   
 
@@ -397,11 +399,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 193 of file modules.cpp.
+Definition at line 197 of file modules.cpp.
 

-
00194 {
-00195         return FindChan(channel.c_str());
-00196 }
+
00198 {
+00199         return FindChan(channel.c_str());
+00200 }
 
    
   
 
@@ -435,11 +437,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 188 of file modules.cpp.
+Definition at line 192 of file modules.cpp.
 

-
00189 {
-00190         return Find(nick);
-00191 }
+
00193 {
+00194         return Find(nick);
+00195 }
 
    
   
 
@@ -472,11 +474,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 213 of file modules.cpp.
+Definition at line 217 of file modules.cpp.
 

-
00214 {
-00215         return Admin(getadminname(),getadminemail(),getadminnick());
-00216 }
+
00218 {
+00219         return Admin(getadminname(),getadminemail(),getadminnick());
+00220 }
 
    
   
 
@@ -509,11 +511,11 @@ Returns the network name, global to all linked servers.
 

 
 

-Definition at line 208 of file modules.cpp.
+Definition at line 212 of file modules.cpp.
 

-
00209 {
-00210         return getnetworkname();
-00211 }
+
00213 {
+00214         return getnetworkname();
+00215 }
 
    
   
 
@@ -546,11 +548,11 @@ Returns the server name of the server where the module is loaded.
 

 
 

-Definition at line 203 of file modules.cpp.
+Definition at line 207 of file modules.cpp.
 

-
00204 {
-00205         return getservername();
-00206 }
+
00208 {
+00209         return getservername();
+00210 }
 
    
   
 
@@ -584,11 +586,11 @@ Returns true if a nick is valid.
 

 Nicks for unregistered connections will return false.
 

-Definition at line 183 of file modules.cpp.
+Definition at line 187 of file modules.cpp.
 

-
00184 {
-00185         return (isnick(nick.c_str()) != 0);
-00186 }
+
00188 {
+00189         return (isnick(nick.c_str()) != 0);
+00190 }
 
    
   
 
@@ -678,11 +680,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 129 of file modules.cpp.
+Definition at line 133 of file modules.cpp.
 

-
00130 {
-00131         Write(Socket,"%s",s.c_str());
-00132 }
+
00134 {
+00135         Write(Socket,"%s",s.c_str());
+00136 }
 
    
   
 
@@ -737,18 +739,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 149 of file modules.cpp.
+Definition at line 153 of file modules.cpp.
 

-
00150 {
-00151         if (IncludeSender)
-00152         {
-00153                 WriteChannel(Channel,User,"%s",s.c_str());
-00154         }
-00155         else
+
00154 {
+00155         if (IncludeSender)
 00156         {
-00157                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00157                 WriteChannel(Channel,User,"%s",s.c_str());
 00158         }
-00159 }
+00159         else
+00160         {
+00161                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00162         }
+00163 }
 
    
   
 
@@ -797,18 +799,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 166 of file modules.cpp.
+Definition at line 170 of file modules.cpp.
 

-
00167 {
-00168         if (IncludeSender)
-00169         {
-00170                 WriteCommon(User,"%s",text.c_str());
-00171         }
-00172         else
+
00171 {
+00172         if (IncludeSender)
 00173         {
-00174                 WriteCommonExcept(User,"%s",text.c_str());
+00174                 WriteCommon(User,"%s",text.c_str());
 00175         }
-00176 }
+00176         else
+00177         {
+00178                 WriteCommonExcept(User,"%s",text.c_str());
+00179         }
+00180 }
 
    
   
 
@@ -857,11 +859,69 @@ 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 139 of file modules.cpp.
+Definition at line 143 of file modules.cpp.
 

-
00140 {
-00141         WriteFrom(Socket,User,"%s",s.c_str());
-00142 }
+
00144 {
+00145         WriteFrom(Socket,User,"%s",s.c_str());
+00146 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 void Server::SendMode ( char **   parameters, 
int   pcnt, 
userrec *   user
)  [virtual]

+    

+
+  
+    
+    

+       
+    
+
+

+Sends a servermode.
+

+you must format the parameters array with the target, modes and parameters for those modes.

+For example:

+char modes[3][MAXBUF]; modes[0] = ChannelName; modes[1] = "+o"; 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 128 of file modules.cpp.
+

+References server_mode().
+

+
00129 {
+00130         server_mode(parameters,pcnt,user);
+00131 }
 
    		
   

 

@@ -942,11 +1002,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 134 of file modules.cpp.
+Definition at line 138 of file modules.cpp.
 

-
00135 {
-00136         WriteServ(Socket,"%s",s.c_str());
-00137 }
+
00139 {
+00140         WriteServ(Socket,"%s",s.c_str());
+00141 }
 
    
   
 
@@ -995,11 +1055,11 @@ 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)
 

-Definition at line 144 of file modules.cpp.
+Definition at line 148 of file modules.cpp.
 

-
00145 {
-00146         WriteTo(Source,Dest,"%s",s.c_str());
-00147 }
+
00149 {
+00150         WriteTo(Source,Dest,"%s",s.c_str());
+00151 }
 
    
   
 
@@ -1042,17 +1102,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 178 of file modules.cpp.
+Definition at line 182 of file modules.cpp.
 

-
00179 {
-00180         WriteWallOps(User,"%s",text.c_str());
-00181 }
+
00183 {
+00184         WriteWallOps(User,"%s",text.c_str());
+00185 }
 
    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Fri Apr 2 13:37:43 2004 for InspIRCd by
+
Generated on Fri Apr 2 14:46:19 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3