Server class Reference

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

Creates a Server object.

-Definition at line 105 of file modules.cpp. +Definition at line 111 of file modules.cpp.

00106 {
-00107 }
+00112 {
+00113 }

@@ -140,10 +140,10 @@ Default destructor.

00110 {
-00111 }
+00116 {
+00117 }
     
   
 
@@ -201,13 +201,13 @@ This allows modules to add extra commands into the command table. You must place
 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'.
 

-Definition at line 123 of file modules.cpp.
+Definition at line 129 of file modules.cpp.
 

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

-
00124 {
-00125         createcommand(cmd,f,flags,minparams);
-00126 }
+00130 {
+00131         createcommand(cmd,f,flags,minparams);
+00132 }
     
   
 
@@ -268,10 +268,13 @@ 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 224 of file modules.cpp.
+Definition at line 230 of file modules.cpp.
 

-
00225 {
-00226 }
+References DoAddExtendedMode().
+
+
00231 {
+00232         return DoAddExtendedMode(modechar,type,default_on,params_when_on,params_when_off);
+00233 }
     
   
 
@@ -314,11 +317,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 202 of file modules.cpp.
+Definition at line 208 of file modules.cpp.
 

-
00203 {
-00204         return cmode(User,Chan);
-00205 }
+00209 {
+00210         return cmode(User,Chan);
+00211 }
     
   
 
@@ -361,11 +364,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 165 of file modules.cpp.
+Definition at line 171 of file modules.cpp.
 

-
00166 {
-00167         return (common_channels(u1,u2) != 0);
-00168 }
+00172 {
+00173         return (common_channels(u1,u2) != 0);
+00174 }
     
   
 
@@ -399,11 +402,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 197 of file modules.cpp.
+Definition at line 203 of file modules.cpp.
 

-
00198 {
-00199         return FindChan(channel.c_str());
-00200 }
+00204 {
+00205         return FindChan(channel.c_str());
+00206 }
     
   
 
@@ -437,11 +440,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 192 of file modules.cpp.
+Definition at line 198 of file modules.cpp.
 

-
00193 {
-00194         return Find(nick);
-00195 }
+00199 {
+00200         return Find(nick);
+00201 }
     
   
 
@@ -474,11 +477,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 217 of file modules.cpp.
+Definition at line 223 of file modules.cpp.
 

-
00218 {
-00219         return Admin(getadminname(),getadminemail(),getadminnick());
-00220 }
+00224 {
+00225         return Admin(getadminname(),getadminemail(),getadminnick());
+00226 }
     
   
 
@@ -511,11 +514,11 @@ Returns the network name, global to all linked servers.
 
 
 

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

-
00213 {
-00214         return getnetworkname();
-00215 }
+00219 {
+00220         return getnetworkname();
+00221 }
     
   
 
@@ -548,11 +551,11 @@ Returns the server name of the server where the module is loaded.
 
 
 

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

-
00208 {
-00209         return getservername();
-00210 }
+00214 {
+00215         return getservername();
+00216 }
     
   
 
@@ -586,11 +589,11 @@ Returns true if a nick is valid.
 
 Nicks for unregistered connections will return false.
 

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

-
00188 {
-00189         return (isnick(nick.c_str()) != 0);
-00190 }
+00194 {
+00195         return (isnick(nick.c_str()) != 0);
+00196 }
     
   
 
@@ -633,11 +636,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 118 of file modules.cpp.
+Definition at line 124 of file modules.cpp.
 

-
00119 {
-00120         log(level,"%s",s.c_str());
-00121 }
+00125 {
+00126         log(level,"%s",s.c_str());
+00127 }
     
   
 
@@ -680,11 +683,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 133 of file modules.cpp.
+Definition at line 139 of file modules.cpp.
 

-
00134 {
-00135         Write(Socket,"%s",s.c_str());
-00136 }
+00140 {
+00141         Write(Socket,"%s",s.c_str());
+00142 }
     
   
 
@@ -739,18 +742,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 153 of file modules.cpp.
-

-
00154 {
-00155         if (IncludeSender)
-00156         {
-00157                 WriteChannel(Channel,User,"%s",s.c_str());
-00158         }
-00159         else
-00160         {
-00161                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00162         }
-00163 }
+Definition at line 159 of file modules.cpp.
+
+
00160 {
+00161         if (IncludeSender)
+00162         {
+00163                 WriteChannel(Channel,User,"%s",s.c_str());
+00164         }
+00165         else
+00166         {
+00167                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00168         }
+00169 }
     
   
 
@@ -799,18 +802,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 170 of file modules.cpp.
-

-
00171 {
-00172         if (IncludeSender)
-00173         {
-00174                 WriteCommon(User,"%s",text.c_str());
-00175         }
-00176         else
-00177         {
-00178                 WriteCommonExcept(User,"%s",text.c_str());
-00179         }
-00180 }
+Definition at line 176 of file modules.cpp.
+
+
00177 {
+00178         if (IncludeSender)
+00179         {
+00180                 WriteCommon(User,"%s",text.c_str());
+00181         }
+00182         else
+00183         {
+00184                 WriteCommonExcept(User,"%s",text.c_str());
+00185         }
+00186 }
     
   
 
@@ -859,11 +862,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 143 of file modules.cpp.
+Definition at line 149 of file modules.cpp.
 

-
00144 {
-00145         WriteFrom(Socket,User,"%s",s.c_str());
-00146 }
+00150 {
+00151         WriteFrom(Socket,User,"%s",s.c_str());
+00152 }
     
   
 
@@ -912,16 +915,20 @@ 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);

+char *modes[3];

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

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

-
00129 {
-00130         server_mode(parameters,pcnt,user);
-00131 }
+00135 {
+00136         server_mode(parameters,pcnt,user);
+00137 }
     
   
 
@@ -955,11 +962,11 @@ Sends text to all opers.
 
 This method sends a server notice to all opers with the usermode +s.
 

-Definition at line 113 of file modules.cpp.
+Definition at line 119 of file modules.cpp.
 

-
00114 {
-00115         WriteOpers("%s",s.c_str());
-00116 }
+00120 {
+00121         WriteOpers("%s",s.c_str());
+00122 }
     
   
 
@@ -1002,11 +1009,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 138 of file modules.cpp.
+Definition at line 144 of file modules.cpp.
 

-
00139 {
-00140         WriteServ(Socket,"%s",s.c_str());
-00141 }
+00145 {
+00146         WriteServ(Socket,"%s",s.c_str());
+00147 }
     
   
 
@@ -1055,11 +1062,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 148 of file modules.cpp.
+Definition at line 154 of file modules.cpp.
 

-
00149 {
-00150         WriteTo(Source,Dest,"%s",s.c_str());
-00151 }
+00155 {
+00156         WriteTo(Source,Dest,"%s",s.c_str());
+00157 }
     
   
 
@@ -1102,17 +1109,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 182 of file modules.cpp.
+Definition at line 188 of file modules.cpp.
 

-
00183 {
-00184         WriteWallOps(User,"%s",text.c_str());
-00185 }
+00189 {
+00190         WriteWallOps(User,"%s",text.c_str());
+00191 }
     
   
 
 
The documentation for this class was generated from the following files:
 modules.h
modules.cpp
-
Generated on Fri Apr 2 14:46:19 2004 for InspIRCd by
+
Generated on Sat Apr 3 16:36:18 2004 for InspIRCd by
 
 1.3-rc3 
-- 
cgit v1.2.3

Constructor & Destructor Documentation

Constructor & Destructor Documentation