From 08e384bb24398224856c44baa51b51977644de9d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 9 Feb 2003 12:49:00 +0000 Subject: Documentation update, 09/02/03 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 267 ++++++++++++++++++++------------------- 1 file changed, 138 insertions(+), 129 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 53060b08c..0cc7a88d7 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -25,8 +25,8 @@
-Definition at line 132 of file modules.h.
Destroys a Server object.
-Definition at line 59 of file modules.cpp. +Definition at line 46 of file modules.cpp.
-
00060 {
-00061 }
+00047 {
+00048 }
@@ -178,12 +178,12 @@ 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 142 of file modules.cpp.
+Definition at line 129 of file modules.cpp.
-
00143 {
-00144 string mode = cmode(User,Chan);
-00145 return mode;
-00146 }
+00130 {
+00131 string mode = cmode(User,Chan);
+00132 return mode;
+00133 }
@@ -226,49 +226,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 105 of file modules.cpp.
+Definition at line 92 of file modules.cpp.
-
00106 {
-00107 return (common_channels(u1,u2) != 0);
-00108 }
-
-
-
-
-
-
-
-
-
- void Server::Debug
- (
- string
- s
- )
- [virtual]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Sends a debug string.
-
-This method writes a line of text to the debug log. If debugging is disabled in the configuration, this command has no effect.
-
-Definition at line 68 of file modules.cpp.
-
-
00069 {
-00070 debug("%s",s.c_str());
-00071 }
+00093 {
+00094 return (common_channels(u1,u2) != 0);
+00095 }
@@ -302,11 +264,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 137 of file modules.cpp.
+Definition at line 124 of file modules.cpp.
-
00138 {
-00139 return FindChan(channel.c_str());
-00140 }
+00125 {
+00126 return FindChan(channel.c_str());
+00127 }
@@ -340,11 +302,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 132 of file modules.cpp.
+Definition at line 119 of file modules.cpp.
-
00133 {
-00134 return Find(nick);
-00135 }
+00120 {
+00121 return Find(nick);
+00122 }
@@ -377,11 +339,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 158 of file modules.cpp.
+Definition at line 145 of file modules.cpp.
-
00159 {
-00160 return Admin(getadminname(),getadminemail(),getadminnick());
-00161 }
+00146 {
+00147 return Admin(getadminname(),getadminemail(),getadminnick());
+00148 }
@@ -414,11 +376,11 @@ Returns the network name, global to all linked servers.
-Definition at line 153 of file modules.cpp.
+Definition at line 140 of file modules.cpp.
-
00154 {
-00155 return getnetworkname();
-00156 }
+00141 {
+00142 return getnetworkname();
+00143 }
@@ -451,11 +413,11 @@ Returns the server name of the server where the module is loaded.
-Definition at line 148 of file modules.cpp.
+Definition at line 135 of file modules.cpp.
-
00149 {
-00150 return getservername();
-00151 }
+00136 {
+00137 return getservername();
+00138 }
@@ -489,11 +451,58 @@ Returns true if a nick is valid.
Nicks for unregistered connections will return false.
-Definition at line 127 of file modules.cpp.
+Definition at line 114 of file modules.cpp.
+
+
00115 {
+00116 return (isnick(nick.c_str()) != 0);
+00117 }
+
+
+
+
+
+
+
+
+
+ void Server::Log
+ (
+ int
+ level,
+
+
+
+
+ string
+ s
+
+
+
+ )
+ [virtual]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
-
00128 {
-00129 return (isnick(nick.c_str()) != 0);
-00130 }
+Definition at line 55 of file modules.cpp.
+
+
00056 {
+00057 log(level,"%s",s.c_str());
+00058 }
@@ -536,11 +545,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 73 of file modules.cpp.
+Definition at line 60 of file modules.cpp.
-
00074 {
-00075 Write(Socket,"%s",s.c_str());
-00076 }
+00061 {
+00062 Write(Socket,"%s",s.c_str());
+00063 }
@@ -595,18 +604,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 93 of file modules.cpp.
-
-
00094 {
-00095 if (IncludeSender)
-00096 {
-00097 WriteChannel(Channel,User,"%s",s.c_str());
-00098 }
-00099 else
-00100 {
-00101 ChanExceptSender(Channel,User,"%s",s.c_str());
-00102 }
-00103 }
+Definition at line 80 of file modules.cpp.
+
+
00081 {
+00082 if (IncludeSender)
+00083 {
+00084 WriteChannel(Channel,User,"%s",s.c_str());
+00085 }
+00086 else
+00087 {
+00088 ChanExceptSender(Channel,User,"%s",s.c_str());
+00089 }
+00090 }
@@ -655,18 +664,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 110 of file modules.cpp.
-
-
00111 {
-00112 if (IncludeSender)
-00113 {
-00114 WriteCommon(User,"%s",text.c_str());
-00115 }
-00116 else
-00117 {
-00118 WriteCommonExcept(User,"%s",text.c_str());
-00119 }
-00120 }
+Definition at line 97 of file modules.cpp.
+
+
00098 {
+00099 if (IncludeSender)
+00100 {
+00101 WriteCommon(User,"%s",text.c_str());
+00102 }
+00103 else
+00104 {
+00105 WriteCommonExcept(User,"%s",text.c_str());
+00106 }
+00107 }
@@ -715,11 +724,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 83 of file modules.cpp.
+Definition at line 70 of file modules.cpp.
-
00084 {
-00085 WriteFrom(Socket,User,"%s",s.c_str());
-00086 }
+00071 {
+00072 WriteFrom(Socket,User,"%s",s.c_str());
+00073 }
@@ -753,11 +762,11 @@ Sends text to all opers.
This method sends a server notice to all opers with the usermode +s.
-Definition at line 63 of file modules.cpp.
+Definition at line 50 of file modules.cpp.
-
00064 {
-00065 WriteOpers("%s",s.c_str());
-00066 }
+00051 {
+00052 WriteOpers("%s",s.c_str());
+00053 }
@@ -800,11 +809,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 78 of file modules.cpp.
+Definition at line 65 of file modules.cpp.
-
00079 {
-00080 WriteServ(Socket,"%s",s.c_str());
-00081 }
+00066 {
+00067 WriteServ(Socket,"%s",s.c_str());
+00068 }
@@ -853,11 +862,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 88 of file modules.cpp.
+Definition at line 75 of file modules.cpp.
-
00089 {
-00090 WriteTo(Source,Dest,"%s",s.c_str());
-00091 }
+00076 {
+00077 WriteTo(Source,Dest,"%s",s.c_str());
+00078 }
@@ -900,17 +909,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 122 of file modules.cpp.
+Definition at line 109 of file modules.cpp.
-
00123 {
-00124 WriteWallOps(User,"%s",text.c_str());
-00125 }
+00110 {
+00111 WriteWallOps(User,"%s",text.c_str());
+00112 }
The documentation for this class was generated from the following files:
-
Generated on Mon Jan 27 00:23:14 2003 for InspIRCd by
+
Generated on Sun Feb 9 12:48:19 2003 for InspIRCd by
1.3-rc2
--
cgit v1.3.1-10-gc9f91