From 73b9d0c5cb02f0ea8350de28bc3687e0af70ea0f Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 19:45:57 +0000 Subject: Initial revision git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@132 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 913 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 913 insertions(+) create mode 100644 docs/module-doc/classServer.html (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html new file mode 100644 index 000000000..d7a809046 --- /dev/null +++ b/docs/module-doc/classServer.html @@ -0,0 +1,913 @@ + + +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. +More... +

+#include <modules.h> +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 Server ()
 Default constructor.

virtual ~Server ()
 Default destructor.

virtual void SendOpers (string s)
 Sends text to all opers.

virtual void Debug (string s)
 Sends a debug string.

virtual void Send (int Socket, string s)
 Sends a line of text down a TCP/IP socket.

virtual void SendServ (int Socket, string s)
 Sends text from the server to a socket.

virtual void SendFrom (int Socket, userrec *User, string s)
 Sends text from a user to a socket.

virtual void SendTo (userrec *Source, userrec *Dest, string s)
 Sends text from a user to another user.

virtual void SendChannel (userrec *User, chanrec *Channel, string s, bool IncludeSender)
 Sends text from a user to a channel (mulicast).

virtual bool CommonChannels (userrec *u1, userrec *u2)
 Returns true if two users share a common channel.

virtual void SendCommon (userrec *User, string text, bool IncludeSender)
 Sends text from a user to one or more channels (mulicast).

virtual void SendWallops (userrec *User, string text)
 Sends a WALLOPS message.

virtual bool IsNick (string nick)
 Returns true if a nick is valid.

virtual userrec * FindNick (string nick)
 Attempts to look up a nick and return a pointer to it.

virtual chanrec * FindChannel (string channel)
 Attempts to look up a channel and return a pointer to it.

virtual string ChanMode (userrec *User, chanrec *Chan)
 Attempts to look up a user's privilages on a channel.

virtual string GetServerName ()
 Returns the server name of the server where the module is loaded.

virtual string GetNetworkName ()
 Returns the network name, global to all linked servers.

virtual Admin GetAdmin ()
 Returns the information of the server as returned by the /ADMIN command.

+

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. +

+All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. +

+ +

+Definition at line 121 of file modules.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
Server::Server (   ) 
+
+ + + + + +
+   + + +

+Default constructor. +

+Creates a Server object. +

+Definition at line 52 of file modules.cpp. +

+

00053 {
+00054 }
+
+

+ + + + +
+ + + + + + + + + +
Server::~Server (   )  [virtual]
+
+ + + + + +
+   + + +

+Default destructor. +

+Destroys a Server object. +

+Definition at line 56 of file modules.cpp. +

+

00057 {
+00058 }
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
string Server::ChanMode ( userrec *   User,
chanrec *   Chan
)  [virtual]
+
+ + + + + +
+   + + +

+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 139 of file modules.cpp. +

+

00140 {
+00141         string mode = cmode(User,Chan);
+00142         return mode;
+00143 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool Server::CommonChannels ( userrec *   u1,
userrec *   u2
)  [virtual]
+
+ + + + + +
+   + + +

+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 102 of file modules.cpp. +

+

00103 {
+00104         return (common_channels(u1,u2) != 0);
+00105 }
+
+

+ + + + +
+ + + + + + + + + + +
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 65 of file modules.cpp. +

+

00066 {
+00067         debug("%s",s.c_str());
+00068 }
+
+

+ + + + +
+ + + + + + + + + + +
chanrec * Server::FindChannel ( string   channel )  [virtual]
+
+ + + + + +
+   + + +

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

+

00135 {
+00136         return FindChan(channel.c_str());
+00137 }
+
+

+ + + + +
+ + + + + + + + + + +
userrec * Server::FindNick ( string   nick )  [virtual]
+
+ + + + + +
+   + + +

+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 129 of file modules.cpp. +

+

00130 {
+00131         return Find(nick);
+00132 }
+
+

+ + + + +
+ + + + + + + + + +
Admin Server::GetAdmin (   )  [virtual]
+
+ + + + + +
+   + + +

+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 155 of file modules.cpp. +

+

00156 {
+00157         return Admin(getadminname(),getadminemail(),getadminnick());
+00158 }
+
+

+ + + + +
+ + + + + + + + + +
string Server::GetNetworkName (   )  [virtual]
+
+ + + + + +
+   + + +

+Returns the network name, global to all linked servers. +

+ +

+Definition at line 150 of file modules.cpp. +

+

00151 {
+00152         return getnetworkname();
+00153 }
+
+

+ + + + +
+ + + + + + + + + +
string Server::GetServerName (   )  [virtual]
+
+ + + + + +
+   + + +

+Returns the server name of the server where the module is loaded. +

+ +

+Definition at line 145 of file modules.cpp. +

+

00146 {
+00147         return getservername();
+00148 }
+
+

+ + + + +
+ + + + + + + + + + +
bool Server::IsNick ( string   nick )  [virtual]
+
+ + + + + +
+   + + +

+Returns true if a nick is valid. +

+Nicks for unregistered connections will return false. +

+Definition at line 124 of file modules.cpp. +

+

00125 {
+00126         return (isnick(nick.c_str()) != 0);
+00127 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Server::Send ( int   Socket,
string   s
)  [virtual]
+
+ + + + + +
+   + + +

+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 70 of file modules.cpp. +

+

00071 {
+00072         Write(Socket,"%s",s.c_str());
+00073 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Server::SendChannel ( userrec *   User,
chanrec *   Channel,
string   s,
bool   IncludeSender
)  [virtual]
+
+ + + + + +
+   + + +

+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 90 of file modules.cpp. +

+

00091 {
+00092         if (IncludeSender)
+00093         {
+00094                 WriteChannel(Channel,User,"%s",s.c_str());
+00095         }
+00096         else
+00097         {
+00098                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00099         }
+00100 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void Server::SendCommon ( userrec *   User,
string   text,
bool   IncludeSender
)  [virtual]
+
+ + + + + +
+   + + +

+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 107 of file modules.cpp. +

+

00108 {
+00109         if (IncludeSender)
+00110         {
+00111                 WriteCommon(User,"%s",text.c_str());
+00112         }
+00113         else
+00114         {
+00115                 WriteCommonExcept(User,"%s",text.c_str());
+00116         }
+00117 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void Server::SendFrom ( int   Socket,
userrec *   User,
string   s
)  [virtual]
+
+ + + + + +
+   + + +

+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 80 of file modules.cpp. +

+

00081 {
+00082         WriteFrom(Socket,User,"%s",s.c_str());
+00083 }
+
+

+ + + + +
+ + + + + + + + + + +
void Server::SendOpers ( string   s )  [virtual]
+
+ + + + + +
+   + + +

+Sends text to all opers. +

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

+Definition at line 60 of file modules.cpp. +

+

00061 {
+00062         WriteOpers("%s",s.c_str());
+00063 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Server::SendServ ( int   Socket,
string   s
)  [virtual]
+
+ + + + + +
+   + + +

+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 75 of file modules.cpp. +

+

00076 {
+00077         WriteServ(Socket,"%s",s.c_str());
+00078 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void Server::SendTo ( userrec *   Source,
userrec *   Dest,
string   s
)  [virtual]
+
+ + + + + +
+   + + +

+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 85 of file modules.cpp. +

+

00086 {
+00087         WriteTo(Source,Dest,"%s",s.c_str());
+00088 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void Server::SendWallops ( userrec *   User,
string   text
)  [virtual]
+
+ + + + + +
+   + + +

+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 119 of file modules.cpp. +

+

00120 {
+00121         WriteWallOps(User,"%s",text.c_str());
+00122 }
+
+

The documentation for this class was generated from the following files: +
Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by + +doxygen1.3-rc2
+ + -- cgit v1.2.3