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. @@ -68,7 +72,7 @@ All modules should instantiate at least one copy of this class, and use its memb
-Definition at line 147 of file modules.h.
Constructor & Destructor Documentation
+Definition at line 163 of file modules.h.Constructor & Destructor Documentation
Destroys a Server object.
-Definition at line 47 of file modules.cpp. +Definition at line 109 of file modules.cpp.
-
00048 {
-00049 }
+00110 {
+00111 }
Member Function Documentation
+
+
+
|
+ ||||||||||||||||||||
| + + | +
+
+ +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'. + +Definition at line 123 of file modules.cpp. + +References createcommand(). + + 00124 {
+00125 createcommand(cmd,f,flags,minparams);
+00126 }
+ |
+
+
+
|
+ ||||||||||||||||||||||||
| + + | +
+
+ +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 220 of file modules.cpp. + + 00221 {
+00222 }
+ |
+
This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method. -Definition at line 93 of file modules.cpp. +Definition at line 161 of file modules.cpp. - 00094 {
-00095 return (common_channels(u1,u2) != 0);
-00096 }
+ |
[virtual]This function will return NULL if the channel does not exist.
-Definition at line 125 of file modules.cpp. +Definition at line 193 of file modules.cpp.
-
00126 {
-00127 return FindChan(channel.c_str());
-00128 }
+00194 {
+00195 return FindChan(channel.c_str());
+00196 }
[virtual]This function will return NULL if the nick does not exist.
-Definition at line 120 of file modules.cpp. +Definition at line 188 of file modules.cpp.
-
00121 {
-00122 return Find(nick);
-00123 }
+00189 {
+00190 return Find(nick);
+00191 }
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 146 of file modules.cpp. +Definition at line 213 of file modules.cpp.
-
00147 {
-00148 return Admin(getadminname(),getadminemail(),getadminnick());
-00149 }
+00214 {
+00215 return Admin(getadminname(),getadminemail(),getadminnick());
+00216 }
@@ -356,7 +486,7 @@ Definition at line 146
- string Server::GetNetworkName
+ std::string Server::GetNetworkName
(
)
@@ -379,11 +509,11 @@ Returns the network name, global to all linked servers.
-Definition at line 141 of file modules.cpp.
+Definition at line 208 of file modules.cpp.
-
00142 {
-00143 return getnetworkname();
-00144 }
+00209 {
+00210 return getnetworkname();
+00211 }
@@ -393,7 +523,7 @@ Definition at line 141
- string Server::GetServerName
+ std::string Server::GetServerName
(
)
@@ -416,11 +546,11 @@ Returns the server name of the server where the module is loaded.
-Definition at line 136 of file modules.cpp.
+Definition at line 203 of file modules.cpp.
-
00137 {
-00138 return getservername();
-00139 }
+00204 {
+00205 return getservername();
+00206 }
@@ -432,7 +562,7 @@ Definition at line 136
bool Server::IsNick
(
- string
+ std::string
nick
)
[virtual]
Nicks for unregistered connections will return false.
-Definition at line 115 of file modules.cpp.
+Definition at line 183 of file modules.cpp.
-
00116 {
-00117 return (isnick(nick.c_str()) != 0);
-00118 }
+00184 {
+00185 return (isnick(nick.c_str()) != 0);
+00186 }
@@ -476,7 +606,7 @@ Definition at line 115
string
+ std::string
s
@@ -501,11 +631,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 56 of file modules.cpp.
+Definition at line 118 of file modules.cpp.
-
00057 {
-00058 log(level,"%s",s.c_str());
-00059 }
+00119 {
+00120 log(level,"%s",s.c_str());
+00121 }
@@ -523,7 +653,7 @@ Definition at line 56 o
string
+ std::string
s
@@ -548,11 +678,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 61 of file modules.cpp.
+Definition at line 129 of file modules.cpp.
-
00062 {
-00063 Write(Socket,"%s",s.c_str());
-00064 }
+00130 {
+00131 Write(Socket,"%s",s.c_str());
+00132 }
@@ -576,7 +706,7 @@ Definition at line 61 o
string
+ std::string
s,
@@ -607,18 +737,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 81 of file modules.cpp.
-
-
00082 {
-00083 if (IncludeSender)
-00084 {
-00085 WriteChannel(Channel,User,"%s",s.c_str());
-00086 }
-00087 else
-00088 {
-00089 ChanExceptSender(Channel,User,"%s",s.c_str());
-00090 }
-00091 }
+Definition at line 149 of file modules.cpp.
+
+
00150 {
+00151 if (IncludeSender)
+00152 {
+00153 WriteChannel(Channel,User,"%s",s.c_str());
+00154 }
+00155 else
+00156 {
+00157 ChanExceptSender(Channel,User,"%s",s.c_str());
+00158 }
+00159 }
@@ -636,7 +766,7 @@ Definition at line 81 o
string
+ std::string
text,
@@ -667,18 +797,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 98 of file modules.cpp.
-
-
00099 {
-00100 if (IncludeSender)
-00101 {
-00102 WriteCommon(User,"%s",text.c_str());
-00103 }
-00104 else
-00105 {
-00106 WriteCommonExcept(User,"%s",text.c_str());
-00107 }
-00108 }
+Definition at line 166 of file modules.cpp.
+
+
00167 {
+00168 if (IncludeSender)
+00169 {
+00170 WriteCommon(User,"%s",text.c_str());
+00171 }
+00172 else
+00173 {
+00174 WriteCommonExcept(User,"%s",text.c_str());
+00175 }
+00176 }
@@ -702,7 +832,7 @@ Definition at line 98 o
string
+ std::string
s
@@ -727,11 +857,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 71 of file modules.cpp.
+Definition at line 139 of file modules.cpp.
-
00072 {
-00073 WriteFrom(Socket,User,"%s",s.c_str());
-00074 }
+00140 {
+00141 WriteFrom(Socket,User,"%s",s.c_str());
+00142 }
@@ -743,7 +873,7 @@ Definition at line 71 o
void Server::SendOpers
(
- string
+ std::string
s
)
[virtual]
This method sends a server notice to all opers with the usermode +s.
-Definition at line 51 of file modules.cpp.
+Definition at line 113 of file modules.cpp.
-
00052 {
-00053 WriteOpers("%s",s.c_str());
-00054 }
+00114 {
+00115 WriteOpers("%s",s.c_str());
+00116 }
@@ -787,7 +917,7 @@ Definition at line 51 o
string
+ std::string
s
@@ -812,11 +942,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 66 of file modules.cpp.
+Definition at line 134 of file modules.cpp.
-
00067 {
-00068 WriteServ(Socket,"%s",s.c_str());
-00069 }
+00135 {
+00136 WriteServ(Socket,"%s",s.c_str());
+00137 }
@@ -840,7 +970,7 @@ Definition at line 66 o
string
+ std::string
s
@@ -865,11 +995,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 76 of file modules.cpp.
+Definition at line 144 of file modules.cpp.
-
00077 {
-00078 WriteTo(Source,Dest,"%s",s.c_str());
-00079 }
+00145 {
+00146 WriteTo(Source,Dest,"%s",s.c_str());
+00147 }
@@ -887,7 +1017,7 @@ Definition at line 76 o
string
+ std::string
text
@@ -912,17 +1042,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 110 of file modules.cpp.
+Definition at line 178 of file modules.cpp.
-
00111 {
-00112 WriteWallOps(User,"%s",text.c_str());
-00113 }
+00179 {
+00180 WriteWallOps(User,"%s",text.c_str());
+00181 }
The documentation for this class was generated from the following files:
-Generated on Sun Mar 30 19:36:22 2003 for InspIRCd by +
Generated on Fri Apr 2 13:37:43 2004 for InspIRCd by
1.3-rc3
--
cgit v1.3.1-10-gc9f91