From 44b62866f83dea028500d81274eaaba8e886e1c3 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 30 Mar 2003 12:32:32 +0000 Subject: Added DOT files to documentation for class diagrams (pretteh!) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@169 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 205 ++++++++++++++++++++------------------- 1 file changed, 104 insertions(+), 101 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 0cc7a88d7..6c055c09e 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -3,7 +3,7 @@ Server class Reference - +
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Server Class Reference

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. @@ -11,14 +11,17 @@

#include <modules.h>

-

Inheritance diagram for Server: -

- -classbase +Inheritance diagram for Server:

Inheritance graph
+ + -List of all members. +
[legend]
Collaboration diagram for Server:

Collaboration graph
+ + + +
[legend]
List of all members.
- + @@ -65,7 +68,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 113 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 114 of file modules.h.

Constructor & Destructor Documentation


Public Methods


Public Member Functions

 Server ()
 Default constructor.

virtual ~Server ()
@@ -95,10 +98,10 @@ Default constructor.

Creates a Server object.

-Definition at line 42 of file modules.cpp. +Definition at line 43 of file modules.cpp.

-

00043 {
-00044 }
+
00044 {
+00045 }
 
@@ -131,10 +134,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 46 of file modules.cpp. +Definition at line 47 of file modules.cpp.

-

00047 {
-00048 }
+
00048 {
+00049 }
 
@@ -178,12 +181,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 129 of file modules.cpp. +Definition at line 130 of file modules.cpp.

-

00130 {
-00131         string mode = cmode(User,Chan);
-00132         return mode;
-00133 }
+
00131 {
+00132         string mode = cmode(User,Chan);
+00133         return mode;
+00134 }
 
@@ -226,11 +229,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 92 of file modules.cpp. +Definition at line 93 of file modules.cpp.

-

00093 {
-00094         return (common_channels(u1,u2) != 0);
-00095 }
+
00094 {
+00095         return (common_channels(u1,u2) != 0);
+00096 }
 
@@ -264,11 +267,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 124 of file modules.cpp. +Definition at line 125 of file modules.cpp.

-

00125 {
-00126         return FindChan(channel.c_str());
-00127 }
+
00126 {
+00127         return FindChan(channel.c_str());
+00128 }
 
@@ -302,11 +305,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 119 of file modules.cpp. +Definition at line 120 of file modules.cpp.

-

00120 {
-00121         return Find(nick);
-00122 }
+
00121 {
+00122         return Find(nick);
+00123 }
 
@@ -339,11 +342,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 145 of file modules.cpp. +Definition at line 146 of file modules.cpp.

-

00146 {
-00147         return Admin(getadminname(),getadminemail(),getadminnick());
-00148 }
+
00147 {
+00148         return Admin(getadminname(),getadminemail(),getadminnick());
+00149 }
 
@@ -376,11 +379,11 @@ Returns the network name, global to all linked servers.

-Definition at line 140 of file modules.cpp. +Definition at line 141 of file modules.cpp.

-

00141 {
-00142         return getnetworkname();
-00143 }
+
00142 {
+00143         return getnetworkname();
+00144 }
 
@@ -413,11 +416,11 @@ Returns the server name of the server where the module is loaded.

-Definition at line 135 of file modules.cpp. +Definition at line 136 of file modules.cpp.

-

00136 {
-00137         return getservername();
-00138 }
+
00137 {
+00138         return getservername();
+00139 }
 
@@ -451,11 +454,11 @@ Returns true if a nick is valid.

Nicks for unregistered connections will return false.

-Definition at line 114 of file modules.cpp. +Definition at line 115 of file modules.cpp.

-

00115 {
-00116         return (isnick(nick.c_str()) != 0);
-00117 }
+
00116 {
+00117         return (isnick(nick.c_str()) != 0);
+00118 }
 
@@ -498,11 +501,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 55 of file modules.cpp. +Definition at line 56 of file modules.cpp.

-

00056 {
-00057         log(level,"%s",s.c_str());
-00058 }
+
00057 {
+00058         log(level,"%s",s.c_str());
+00059 }
 
@@ -545,11 +548,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 60 of file modules.cpp. +Definition at line 61 of file modules.cpp.

-

00061 {
-00062         Write(Socket,"%s",s.c_str());
-00063 }
+
00062 {
+00063         Write(Socket,"%s",s.c_str());
+00064 }
 
@@ -604,18 +607,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 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 }
+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 }
 
@@ -664,18 +667,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 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 }
+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 }
 
@@ -724,11 +727,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 70 of file modules.cpp. +Definition at line 71 of file modules.cpp.

-

00071 {
-00072         WriteFrom(Socket,User,"%s",s.c_str());
-00073 }
+
00072 {
+00073         WriteFrom(Socket,User,"%s",s.c_str());
+00074 }
 
@@ -762,11 +765,11 @@ Sends text to all opers.

This method sends a server notice to all opers with the usermode +s.

-Definition at line 50 of file modules.cpp. +Definition at line 51 of file modules.cpp.

-

00051 {
-00052         WriteOpers("%s",s.c_str());
-00053 }
+
00052 {
+00053         WriteOpers("%s",s.c_str());
+00054 }
 
@@ -809,11 +812,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 65 of file modules.cpp. +Definition at line 66 of file modules.cpp.

-

00066 {
-00067         WriteServ(Socket,"%s",s.c_str());
-00068 }
+
00067 {
+00068         WriteServ(Socket,"%s",s.c_str());
+00069 }
 
@@ -862,11 +865,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 75 of file modules.cpp. +Definition at line 76 of file modules.cpp.

-

00076 {
-00077         WriteTo(Source,Dest,"%s",s.c_str());
-00078 }
+
00077 {
+00078         WriteTo(Source,Dest,"%s",s.c_str());
+00079 }
 
@@ -909,19 +912,19 @@ 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 109 of file modules.cpp. +Definition at line 110 of file modules.cpp.

-

00110 {
-00111         WriteWallOps(User,"%s",text.c_str());
-00112 }
+
00111 {
+00112         WriteWallOps(User,"%s",text.c_str());
+00113 }
 

The documentation for this class was generated from the following files: -
Generated on Sun Feb 9 12:48:19 2003 for InspIRCd by +
Generated on Sun Mar 30 13:29:18 2003 for InspIRCd by doxygen1.3-rc2
+width=110 height=53>1.3-rc3
-- cgit v1.2.3