Creates a Server object.
-Definition at line 111 of file modules.cpp. +Definition at line 125 of file modules.cpp.
-
00112 {
-00113 }
+00126 {
+00127 }
@@ -140,10 +140,10 @@ Default destructor.
Destroys a Server object.
-Definition at line 115 of file modules.cpp.
+Definition at line 129 of file modules.cpp.
-
00116 {
-00117 }
+00130 {
+00131 }
@@ -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 129 of file modules.cpp.
+Definition at line 143 of file modules.cpp.
References createcommand().
-
00130 {
-00131 createcommand(cmd,f,flags,minparams);
-00132 }
+00144 {
+00145 createcommand(cmd,f,flags,minparams);
+00146 }
@@ -232,7 +232,7 @@ References createcommand().
bool
- default_on,
+ requires_oper,
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. 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 230 of file modules.cpp.
-
-References DoAddExtendedMode().
-
-
00231 {
-00232 return DoAddExtendedMode(modechar,type,default_on,params_when_on,params_when_off);
-00233 }
++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 244 of file modules.cpp.
+
+References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+
+
00245 {
+00246 if (type == MT_SERVER)
+00247 {
+00248 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00249 return false;
+00250 }
+00251 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00252 {
+00253 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00254 return false;
+00255 }
+00256 if ((params_when_on>1) || (params_when_off>1))
+00257 {
+00258 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00259 return false;
+00260 }
+00261 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00262 }
@@ -317,11 +332,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 208 of file modules.cpp.
+Definition at line 222 of file modules.cpp.
-
00209 {
-00210 return cmode(User,Chan);
-00211 }
+00223 {
+00224 return cmode(User,Chan);
+00225 }
@@ -364,11 +379,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 171 of file modules.cpp.
+Definition at line 185 of file modules.cpp.
-
00172 {
-00173 return (common_channels(u1,u2) != 0);
-00174 }
+00186 {
+00187 return (common_channels(u1,u2) != 0);
+00188 }
@@ -402,11 +417,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 203 of file modules.cpp.
+Definition at line 217 of file modules.cpp.
-
00204 {
-00205 return FindChan(channel.c_str());
-00206 }
+00218 {
+00219 return FindChan(channel.c_str());
+00220 }
@@ -440,11 +455,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 198 of file modules.cpp.
+Definition at line 212 of file modules.cpp.
-
00199 {
-00200 return Find(nick);
-00201 }
+00213 {
+00214 return Find(nick);
+00215 }
@@ -477,11 +492,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 223 of file modules.cpp.
+Definition at line 237 of file modules.cpp.
-
00224 {
-00225 return Admin(getadminname(),getadminemail(),getadminnick());
-00226 }
+00238 {
+00239 return Admin(getadminname(),getadminemail(),getadminnick());
+00240 }
@@ -514,11 +529,11 @@ Returns the network name, global to all linked servers.
-Definition at line 218 of file modules.cpp.
+Definition at line 232 of file modules.cpp.
-
00219 {
-00220 return getnetworkname();
-00221 }
+00233 {
+00234 return getnetworkname();
+00235 }
@@ -551,11 +566,11 @@ Returns the server name of the server where the module is loaded.
-Definition at line 213 of file modules.cpp.
+Definition at line 227 of file modules.cpp.
-
00214 {
-00215 return getservername();
-00216 }
+00228 {
+00229 return getservername();
+00230 }
@@ -589,11 +604,11 @@ Returns true if a nick is valid.
Nicks for unregistered connections will return false.
-Definition at line 193 of file modules.cpp.
+Definition at line 207 of file modules.cpp.
-
00194 {
-00195 return (isnick(nick.c_str()) != 0);
-00196 }
+00208 {
+00209 return (isnick(nick.c_str()) != 0);
+00210 }
@@ -636,11 +651,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 124 of file modules.cpp.
+Definition at line 138 of file modules.cpp.
-
00125 {
-00126 log(level,"%s",s.c_str());
-00127 }
+00139 {
+00140 log(level,"%s",s.c_str());
+00141 }
@@ -683,11 +698,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 139 of file modules.cpp.
+Definition at line 153 of file modules.cpp.
-
00140 {
-00141 Write(Socket,"%s",s.c_str());
-00142 }
+00154 {
+00155 Write(Socket,"%s",s.c_str());
+00156 }
@@ -742,18 +757,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 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 }
+Definition at line 173 of file modules.cpp.
+
+
00174 {
+00175 if (IncludeSender)
+00176 {
+00177 WriteChannel(Channel,User,"%s",s.c_str());
+00178 }
+00179 else
+00180 {
+00181 ChanExceptSender(Channel,User,"%s",s.c_str());
+00182 }
+00183 }
@@ -802,18 +817,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 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 }
+Definition at line 190 of file modules.cpp.
+
+
00191 {
+00192 if (IncludeSender)
+00193 {
+00194 WriteCommon(User,"%s",text.c_str());
+00195 }
+00196 else
+00197 {
+00198 WriteCommonExcept(User,"%s",text.c_str());
+00199 }
+00200 }
@@ -862,11 +877,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 149 of file modules.cpp.
+Definition at line 163 of file modules.cpp.
-
00150 {
-00151 WriteFrom(Socket,User,"%s",s.c_str());
-00152 }
+00164 {
+00165 WriteFrom(Socket,User,"%s",s.c_str());
+00166 }
@@ -922,13 +937,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 134 of file modules.cpp.
+Definition at line 148 of file modules.cpp.
References server_mode().
-
00135 {
-00136 server_mode(parameters,pcnt,user);
-00137 }
+00149 {
+00150 server_mode(parameters,pcnt,user);
+00151 }
@@ -962,11 +977,11 @@ Sends text to all opers.
This method sends a server notice to all opers with the usermode +s.
-Definition at line 119 of file modules.cpp.
+Definition at line 133 of file modules.cpp.
-
00120 {
-00121 WriteOpers("%s",s.c_str());
-00122 }
+00134 {
+00135 WriteOpers("%s",s.c_str());
+00136 }
@@ -1009,11 +1024,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 144 of file modules.cpp.
+Definition at line 158 of file modules.cpp.
-
00145 {
-00146 WriteServ(Socket,"%s",s.c_str());
-00147 }
+00159 {
+00160 WriteServ(Socket,"%s",s.c_str());
+00161 }
@@ -1062,11 +1077,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 154 of file modules.cpp.
+Definition at line 168 of file modules.cpp.
-
00155 {
-00156 WriteTo(Source,Dest,"%s",s.c_str());
-00157 }
+00169 {
+00170 WriteTo(Source,Dest,"%s",s.c_str());
+00171 }
@@ -1109,17 +1124,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 188 of file modules.cpp.
+Definition at line 202 of file modules.cpp.
-
00189 {
-00190 WriteWallOps(User,"%s",text.c_str());
-00191 }
+00203 {
+00204 WriteWallOps(User,"%s",text.c_str());
+00205 }
The documentation for this class was generated from the following files:
-
Generated on Sat Apr 3 16:36:18 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:31 2004 for InspIRCd by
1.3-rc3
--
cgit v1.3.1-10-gc9f91