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>

Inheritance diagram for Server:

classbase 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 128 of file modules.h.

Constructor & Destructor Documentation

Server::Server (    ) 
 

Default constructor.

Creates a Server object.

Definition at line 55 of file modules.cpp. 

00056 {
00057 }

Server::~Server (    )  [virtual]
 

Default destructor.

Destroys a Server object.

Definition at line 59 of file modules.cpp. 

00060 {
00061 }

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

00143 {
00144         string mode = cmode(User,Chan);
00145         return mode;
00146 }

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 105 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 }

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

00138 {
00139         return FindChan(channel.c_str());
00140 }

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

00133 {
00134         return Find(nick);
00135 }

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

00159 {
00160         return Admin(getadminname(),getadminemail(),getadminnick());
00161 }

string Server::GetNetworkName (    )  [virtual]
 

Returns the network name, global to all linked servers.

Definition at line 153 of file modules.cpp. 

00154 {
00155         return getnetworkname();
00156 }

string Server::GetServerName (    )  [virtual]
 

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

Definition at line 148 of file modules.cpp. 

00149 {
00150         return getservername();
00151 }

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

Returns true if a nick is valid.

Nicks for unregistered connections will return false.

Definition at line 127 of file modules.cpp. 

00128 {
00129         return (isnick(nick.c_str()) != 0);
00130 }

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

00074 {
00075         Write(Socket,"%s",s.c_str());
00076 }

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 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 }

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 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 }

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

00084 {
00085         WriteFrom(Socket,User,"%s",s.c_str());
00086 }

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

00064 {
00065         WriteOpers("%s",s.c_str());
00066 }

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

00079 {
00080         WriteServ(Socket,"%s",s.c_str());
00081 }

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

00089 {
00090         WriteTo(Source,Dest,"%s",s.c_str());
00091 }

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

00123 {
00124         WriteWallOps(User,"%s",text.c_str());
00125 }

The documentation for this class was generated from the following files:
Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by doxygen1.3-rc2