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 Log (int level, string s)
 Writes a log 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 113 of file modules.h.

Constructor & Destructor Documentation

Server::Server (    ) 
 

Default constructor.

Creates a Server object.

Definition at line 42 of file modules.cpp. 

00043 {
00044 }

Server::~Server (    )  [virtual]
 

Default destructor.

Destroys a Server object.

Definition at line 46 of file modules.cpp. 

00047 {
00048 }

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

00130 {
00131         string mode = cmode(User,Chan);
00132         return mode;
00133 }

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

00093 {
00094         return (common_channels(u1,u2) != 0);
00095 }

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

00125 {
00126         return FindChan(channel.c_str());
00127 }

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

00120 {
00121         return Find(nick);
00122 }

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

00146 {
00147         return Admin(getadminname(),getadminemail(),getadminnick());
00148 }

string Server::GetNetworkName (    )  [virtual]
 

Returns the network name, global to all linked servers.

Definition at line 140 of file modules.cpp. 

00141 {
00142         return getnetworkname();
00143 }

string Server::GetServerName (    )  [virtual]
 

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

Definition at line 135 of file modules.cpp. 

00136 {
00137         return getservername();
00138 }

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

Returns true if a nick is valid.

Nicks for unregistered connections will return false.

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.

Definition at line 55 of file modules.cpp. 

00056 {
00057         log(level,"%s",s.c_str());
00058 }

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

00061 {
00062         Write(Socket,"%s",s.c_str());
00063 }

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

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

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

00071 {
00072         WriteFrom(Socket,User,"%s",s.c_str());
00073 }

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

00051 {
00052         WriteOpers("%s",s.c_str());
00053 }

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

00066 {
00067         WriteServ(Socket,"%s",s.c_str());
00068 }

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

00076 {
00077         WriteTo(Source,Dest,"%s",s.c_str());
00078 }

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

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

The documentation for this class was generated from the following files:
Generated on Sun Feb 9 12:48:19 2003 for InspIRCd by doxygen1.3-rc2