From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServer.html | 1035 ++++++++++++++++++++------------------ 1 file changed, 532 insertions(+), 503 deletions(-) (limited to 'docs/module-doc/classServer.html') diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 1c9116ffe..3f90b0048 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -1,118 +1,147 @@ -Server class Reference +InspIRCd: Server class Reference - -
-Main Page   Namespace List   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. + +
Main Page | Namespace List | 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:

Inheritance graph
- - - -
[legend]
Collaboration diagram for Server:

Collaboration graph
- - - -
[legend]
List of all members. +Inherits classbase. +

+List of all members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 Server ()
 Default constructor.

virtual ~Server ()
 Default destructor.

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

virtual void Log (int level, std::string s)
 Writes a log string.

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

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

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

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

virtual void SendChannel (userrec *User, chanrec *Channel, std::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, std::string text, bool IncludeSender)
 Sends text from a user to one or more channels (mulicast).

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

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

virtual int CountUsers (chanrec *c)
 Returns a count of the number of users on a channel.

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

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

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

virtual bool IsOnChannel (userrec *User, chanrec *Chan)
 Checks if a user is on a channel.

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

virtual std::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.

virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
 Adds an extended mode letter which is parsed by a module.

virtual bool AddExtendedListMode (char modechar)
 Adds an extended mode letter which is parsed by a module and handled in a list fashion.

virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams)
 Adds a command to the command table.

virtual void SendMode (char **parameters, int pcnt, userrec *user)
 Sends a servermode.

virtual void SendToModeMask (std::string modes, int flags, std::string text)
 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

virtual chanrec * JoinUserToChannel (userrec *user, std::string cname, std::string key)
 Forces a user to join a channel.

virtual chanrec * PartUserFromChannel (userrec *user, std::string cname, std::string reason)
 Forces a user to part a channel.

virtual void ChangeUserNick (userrec *user, std::string nickname)
 Forces a user nickchange.

virtual void QuitUser (userrec *user, std::string reason)
 Forces a user to quit with the specified reason.

virtual bool MatchText (std::string sliteral, std::string spattern)
 Matches text against a glob pattern.

virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user)
 Calls the handler for a command, either implemented by the core or by another module.

virtual void ChangeHost (userrec *user, std::string host)
 Change displayed hostname of a user.

virtual void ChangeGECOS (userrec *user, std::string gecos)
 Change GECOS (fullname) of a user.

virtual bool IsUlined (std::string server)
 Returns true if the servername you give is ulined.

virtual chanuserlist GetUsers (chanrec *chan)
 Fetches the userlist of a channel.

 Server ()
 Default constructor.

virtual ~Server ()
 Default destructor.

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

virtual void Log (int level, std::string s)
 Writes a log string.

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

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

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

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

virtual void SendChannel (userrec *User, chanrec *Channel, std::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, std::string text, bool IncludeSender)
 Sends text from a user to one or more channels (mulicast).

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

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

virtual int CountUsers (chanrec *c)
 Returns a count of the number of users on a channel.

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

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

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

virtual bool IsOnChannel (userrec *User, chanrec *Chan)
 Checks if a user is on a channel.

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

virtual std::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.

virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)
 Adds an extended mode letter which is parsed by a module.

virtual bool AddExtendedListMode (char modechar)
 Adds an extended mode letter which is parsed by a module and handled in a list fashion.

virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams)
 Adds a command to the command table.

virtual void SendMode (char **parameters, int pcnt, userrec *user)
 Sends a servermode.

virtual void SendToModeMask (std::string modes, int flags, std::string text)
 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

virtual chanrec * JoinUserToChannel (userrec *user, std::string cname, std::string key)
 Forces a user to join a channel.

virtual chanrec * PartUserFromChannel (userrec *user, std::string cname, std::string reason)
 Forces a user to part a channel.

virtual void ChangeUserNick (userrec *user, std::string nickname)
 Forces a user nickchange.

virtual void QuitUser (userrec *user, std::string reason)
 Forces a user to quit with the specified reason.

virtual bool MatchText (std::string sliteral, std::string spattern)
 Matches text against a glob pattern.

virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user)
 Calls the handler for a command, either implemented by the core or by another module.

virtual void ChangeHost (userrec *user, std::string host)
 Change displayed hostname of a user.

virtual void ChangeGECOS (userrec *user, std::string gecos)
 Change GECOS (fullname) of a user.

virtual bool IsUlined (std::string server)
 Returns true if the servername you give is ulined.

virtual chanuserlist GetUsers (chanrec *chan)
 Fetches the userlist of a channel.

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. +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 314 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 337 of file modules.h.

Constructor & Destructor Documentation

- +
-
+ - - + + @@ -128,27 +157,27 @@ Definition at line 314 of
Server::Server (   )   ) 

-Default constructor. +Default constructor.

Creates a Server object.

-Definition at line 313 of file modules.cpp. +Definition at line 326 of file modules.cpp.

-

00314 {
-00315 }
+
00327 {
+00328 }

- +
-
+ - + - - + + @@ -164,46 +193,46 @@ Definition at line 313
Server::~Server Server::~Server (   )   )  [virtual]

-Default destructor. +Default destructor.

Destroys a Server object.

-Definition at line 317 of file modules.cpp. +Definition at line 330 of file modules.cpp.

-

00318 {
-00319 }
+
00331 {
+00332 }

Member Function Documentation

- +
-
+ - + - + - + - + @@ -223,33 +252,33 @@ Definition at line 317
void Server::AddCommand (  char *   cmd, cmd,
handlerfunc   f, f,
char   flags, flags,
int   minparams minparams

-Adds a command to the command table. +Adds a command to the command table.

This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:

typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.

-Definition at line 394 of file modules.cpp. +Definition at line 407 of file modules.cpp.

References createcommand().

-

00395 {
-00396         createcommand(cmd,f,flags,minparams);
-00397 }
+
00408 {
+00409         createcommand(cmd,f,flags,minparams);
+00410 }

- +
-
+ - - + + @@ -265,7 +294,7 @@ References createcommand().
bool Server::AddExtendedListMode (  char   modechar )  modechar  )  [virtual]

-Adds an extended mode letter which is parsed by a module and handled in a list fashion. +Adds an extended mode letter which is parsed by a module and handled in a list fashion.

This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:

(1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL

@@ -274,53 +303,53 @@ This call is used to implement modes like +q and +a. The characteristics of thes (4) The mode and its parameter are NOT stored in the channels modes structure

It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.

-Definition at line 539 of file modules.cpp. +Definition at line 552 of file modules.cpp.

-References DoAddExtendedMode(), and ModeMakeList(). +References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.

-

00540 {
-00541         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00542         if (res)
-00543                 ModeMakeList(modechar);
-00544         return res;
-00545 }
+
00553 {
+00554         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00555         if (res)
+00556                 ModeMakeList(modechar);
+00557         return res;
+00558 }

- +
-
+ - + - + - + - + - + @@ -340,63 +369,63 @@ References DoAddExtendedMod
bool Server::AddExtendedMode (  char   modechar, modechar,
int   type, type,
bool   requires_oper, requires_oper,
int   params_when_on, params_when_on,
int   params_when_off params_when_off

-Adds an extended mode letter which is parsed by a module. +Adds an extended mode letter which is parsed by a module.

This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.

-Definition at line 519 of file modules.cpp. -

-References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. -

-

00520 {
-00521         if (type == MT_SERVER)
-00522         {
-00523                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00524                 return false;
-00525         }
-00526         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00527         {
-00528                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00529                 return false;
-00530         }
-00531         if ((params_when_on>1) || (params_when_off>1))
-00532         {
-00533                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00534                 return false;
-00535         }
-00536         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00537 }
+Definition at line 532 of file modules.cpp.
+

+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+

+
00533 {
+00534         if (type == MT_SERVER)
+00535         {
+00536                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00537                 return false;
+00538         }
+00539         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00540         {
+00541                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00542                 return false;
+00543         }
+00544         if ((params_when_on>1) || (params_when_off>1))
+00545         {
+00546                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00547                 return false;
+00548         }
+00549         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00550 }

- +
-
+ - + - + - + - + @@ -416,35 +445,35 @@ References DoAddExtendedMod
void Server::CallCommandHandler (  std::string   commandname, commandname,
char **   parameters, parameters,
int   pcnt, pcnt,
userrec *   user user

-Calls the handler for a command, either implemented by the core or by another module. +Calls the handler for a command, either implemented by the core or by another module.

You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or
) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand(). The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.

-Definition at line 384 of file modules.cpp. +Definition at line 397 of file modules.cpp.

-

00385 {
-00386         call_handler(commandname.c_str(),parameters,pcnt,user);
-00387 }
+
00398 {
+00399         call_handler(commandname.c_str(),parameters,pcnt,user);
+00400 }

- +
-
+ - + - + @@ -464,36 +493,36 @@ Definition at line 384
void Server::ChangeGECOS (  userrec *   user, user,
std::string   gecos gecos

-Change GECOS (fullname) of a user. +Change GECOS (fullname) of a user.

You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.

-Definition at line 472 of file modules.cpp. +Definition at line 485 of file modules.cpp.

References ChangeName().

-

00473 {
-00474         ChangeName(user,gecos.c_str());
-00475 }
+
00486 {
+00487         ChangeName(user,gecos.c_str());
+00488 }

- +
-
+ - + - + @@ -513,36 +542,36 @@ References ChangeName().
void Server::ChangeHost (  userrec *   user, user,
std::string   host host

-Change displayed hostname of a user. +Change displayed hostname of a user.

You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.

-Definition at line 467 of file modules.cpp. +Definition at line 480 of file modules.cpp.

References ChangeDisplayedHost().

-

00468 {
-00469         ChangeDisplayedHost(user,host.c_str());
-00470 }
+
00481 {
+00482         ChangeDisplayedHost(user,host.c_str());
+00483 }

- +
-
+ - + - + @@ -562,34 +591,34 @@ References ChangeDisplayedHost().
void Server::ChangeUserNick (  userrec *   user, user,
std::string   nickname nickname

-Forces a user nickchange. +Forces a user nickchange.

This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.

-Definition at line 368 of file modules.cpp. +Definition at line 381 of file modules.cpp.

-

00369 {
-00370         force_nickchange(user,nickname.c_str());
-00371 }
+
00382 {
+00383         force_nickchange(user,nickname.c_str());
+00384 }

- +
-
+ - + - + @@ -609,36 +638,36 @@ Definition at line 368
std::string Server::ChanMode (  userrec *   User, User,
chanrec *   Chan Chan

-Attempts to look up a user's privilages on a channel. +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 492 of file modules.cpp. +Definition at line 505 of file modules.cpp.

References cmode().

-

00493 {
-00494         return cmode(User,Chan);
-00495 }
+
00506 {
+00507         return cmode(User,Chan);
+00508 }

- +
-
+ - + - + @@ -658,31 +687,31 @@ References cmode().
bool Server::CommonChannels (  userrec *   u1, u1,
userrec *   u2 u2

-Returns true if two users share a common channel. +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 445 of file modules.cpp. +Definition at line 458 of file modules.cpp.

References common_channels().

-

00446 {
-00447         return (common_channels(u1,u2) != 0);
-00448 }
+
00459 {
+00460         return (common_channels(u1,u2) != 0);
+00461 }

- +
-
+ - - + + @@ -698,29 +727,29 @@ References common_channels().
int Server::CountUsers (  chanrec *   c )  c  )  [virtual]

-Returns a count of the number of users on a channel. +Returns a count of the number of users on a channel.

This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.

-Definition at line 547 of file modules.cpp. +Definition at line 560 of file modules.cpp.

-

00548 {
-00549         return usercount(c);
-00550 }
+
00561 {
+00562         return usercount(c);
+00563 }

- +
-
+ - - + + @@ -736,29 +765,29 @@ Definition at line 547
chanrec * Server::FindChannel (  std::string   channel )  channel  )  [virtual]

-Attempts to look up a channel and return a pointer to it. +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 487 of file modules.cpp. +Definition at line 500 of file modules.cpp.

-

00488 {
-00489         return FindChan(channel.c_str());
-00490 }
+
00501 {
+00502         return FindChan(channel.c_str());
+00503 }

- +
-
+ - - + + @@ -774,28 +803,28 @@ Definition at line 487
userrec * Server::FindNick (  std::string   nick )  nick  )  [virtual]

-Attempts to look up a nick and return a pointer to it. +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 482 of file modules.cpp. +Definition at line 495 of file modules.cpp.

-

00483 {
-00484         return Find(nick);
-00485 }
+
00496 {
+00497         return Find(nick);
+00498 }

- +
-
+ - - + + @@ -811,28 +840,28 @@ Definition at line 482
Admin Server::GetAdmin (   )   )  [virtual]

-Returns the information of the server as returned by the /ADMIN command. +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. +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 512 of file modules.cpp. +Definition at line 525 of file modules.cpp.

-

00513 {
-00514         return Admin(getadminname(),getadminemail(),getadminnick());
-00515 }
+
00526 {
+00527         return Admin(getadminname(),getadminemail(),getadminnick());
+00528 }

- +
-
+ - - + + @@ -848,28 +877,28 @@ Definition at line 512
std::string Server::GetNetworkName (   )   )  [virtual]

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

-Definition at line 507 of file modules.cpp. +Definition at line 520 of file modules.cpp.

-

00508 {
-00509         return getnetworkname();
-00510 }
+
00521 {
+00522         return getnetworkname();
+00523 }

- +
-
+ - - + + @@ -885,29 +914,29 @@ Definition at line 507
std::string Server::GetServerName (   )   )  [virtual]

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

-Definition at line 502 of file modules.cpp. +Definition at line 515 of file modules.cpp.

-

00503 {
-00504         return getservername();
-00505 }
+
00516 {
+00517         return getservername();
+00518 }

- +
-
+ - - + + @@ -923,46 +952,46 @@ Definition at line 502
chanuserlist Server::GetUsers (  chanrec *   chan )  chan  )  [virtual]

-Fetches the userlist of a channel. +Fetches the userlist of a channel.

This function must be here and not a member of userrec or chanrec due to include constraints.

-Definition at line 349 of file modules.cpp. -

-References chanuserlist, clientlist, has_channel(), and isnick(). -

-

00350 {
-00351         chanuserlist userl;
-00352         userl.clear();
-00353         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00354         {
-00355                 if (i->second)
-00356                 {
-00357                         if (has_channel(i->second,chan))
-00358                         {
-00359                                 if (isnick(i->second->nick))
-00360                                 {
-00361                                         userl.push_back(i->second);
-00362                                 }
-00363                         }
-00364                 }
-00365         }
-00366         return userl;
-00367 }
+Definition at line 362 of file modules.cpp.
+

+References chanuserlist, clientlist, has_channel(), and isnick().
+

+
00363 {
+00364         chanuserlist userl;
+00365         userl.clear();
+00366         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+00367         {
+00368                 if (i->second)
+00369                 {
+00370                         if (has_channel(i->second,chan))
+00371                         {
+00372                                 if (isnick(i->second->nick))
+00373                                 {
+00374                                         userl.push_back(i->second);
+00375                                 }
+00376                         }
+00377                 }
+00378         }
+00379         return userl;
+00380 }

- +
-
+ - - + + @@ -978,36 +1007,36 @@ References chanuserlist,
bool Server::IsNick (  std::string   nick )  nick  )  [virtual]

-Returns true if a nick is valid. +Returns true if a nick is valid.

Nicks for unregistered connections will return false.

-Definition at line 477 of file modules.cpp. +Definition at line 490 of file modules.cpp.

References isnick().

-

00478 {
-00479         return (isnick(nick.c_str()) != 0);
-00480 }
+
00491 {
+00492         return (isnick(nick.c_str()) != 0);
+00493 }

- +
-
+ - + - + @@ -1027,31 +1056,31 @@ References isnick().
bool Server::IsOnChannel (  userrec *   User, User,
chanrec *   Chan Chan

-Checks if a user is on a channel. +Checks if a user is on a channel.

This function will return true or false to indicate if user 'User' is on channel 'Chan'.

-Definition at line 497 of file modules.cpp. +Definition at line 510 of file modules.cpp.

References has_channel().

-

00498 {
-00499         return has_channel(User,Chan);
-00500 }
+
00511 {
+00512         return has_channel(User,Chan);
+00513 }

- +
-
+ - - + + @@ -1067,42 +1096,42 @@ References has_channel().
bool Server::IsUlined (  std::string   server )  server  )  [virtual]

-Returns true if the servername you give is ulined. +Returns true if the servername you give is ulined.

ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.

-Definition at line 379 of file modules.cpp. +Definition at line 392 of file modules.cpp.

References is_uline().

-

00380 {
-00381         return is_uline(server.c_str());
-00382 }
+
00393 {
+00394         return is_uline(server.c_str());
+00395 }

- +
-
+ - + - + - + @@ -1122,34 +1151,34 @@ References is_uline().
chanrec * Server::JoinUserToChannel (  userrec *   user, user,
std::string   cname, cname,
std::string   key key

-Forces a user to join a channel. +Forces a user to join a channel.

This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.

-Definition at line 339 of file modules.cpp. +Definition at line 352 of file modules.cpp.

-

00340 {
-00341         return add_channel(user,cname.c_str(),key.c_str(),true);
-00342 }
+
00353 {
+00354         return add_channel(user,cname.c_str(),key.c_str(),true);
+00355 }

- +
-
+ - + - + @@ -1169,34 +1198,34 @@ Definition at line 339
void Server::Log (  int   level, level,
std::string   s s

-Writes a log string. +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 389 of file modules.cpp. +Definition at line 402 of file modules.cpp.

-

00390 {
-00391         log(level,"%s",s.c_str());
-00392 }
+
00403 {
+00404         log(level,"%s",s.c_str());
+00405 }

- +
-
+ - + - + @@ -1216,43 +1245,43 @@ Definition at line 389
bool Server::MatchText (  std::string   sliteral, sliteral,
std::string   spattern spattern

-Matches text against a glob pattern. +Matches text against a glob pattern.

Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.

-Definition at line 326 of file modules.cpp. +Definition at line 339 of file modules.cpp.

-

00327 {
-00328         char literal[MAXBUF],pattern[MAXBUF];
-00329         strncpy(literal,sliteral.c_str(),MAXBUF);
-00330         strncpy(pattern,spattern.c_str(),MAXBUF);
-00331         return match(literal,pattern);
-00332 }
+
00340 {
+00341         char literal[MAXBUF],pattern[MAXBUF];
+00342         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00343         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00344         return match(literal,pattern);
+00345 }

- +
-
+ - + - + - + @@ -1272,34 +1301,34 @@ Definition at line 326
chanrec * Server::PartUserFromChannel (  userrec *   user, user,
std::string   cname, cname,
std::string   reason reason

-Forces a user to part a channel. +Forces a user to part a channel.

This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.

-Definition at line 344 of file modules.cpp. +Definition at line 357 of file modules.cpp.

-

00345 {
-00346         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00347 }
+
00358 {
+00359         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00360 }

- +
-
+ - + - + @@ -1319,39 +1348,39 @@ Definition at line 344
void Server::QuitUser (  userrec *   user, user,
std::string   reason reason

-Forces a user to quit with the specified reason. +Forces a user to quit with the specified reason.

To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.

WARNING!

Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.

-Definition at line 373 of file modules.cpp. +Definition at line 386 of file modules.cpp.

-References userrec::nick, and send_network_quit(). +References userrec::nick, and send_network_quit().

-

00374 {
-00375         send_network_quit(user->nick,reason.c_str());
-00376         kill_link(user,reason.c_str());
-00377 }
+
00387 {
+00388         send_network_quit(user->nick,reason.c_str());
+00389         kill_link(user,reason.c_str());
+00390 }

- +
-
+ - + - + @@ -1371,46 +1400,46 @@ References userrec::nick, a
void Server::Send (  int   Socket, Socket,
std::string   s s

-Sends a line of text down a TCP/IP socket. +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 404 of file modules.cpp. +Definition at line 417 of file modules.cpp.

-

00405 {
-00406         Write(Socket,"%s",s.c_str());
-00407 }
+
00418 {
+00419         Write(Socket,"%s",s.c_str());
+00420 }

- +
-
+ - + - + - + - + @@ -1430,47 +1459,47 @@ Definition at line 404
void Server::SendChannel (  userrec *   User, User,
chanrec *   Channel, Channel,
std::string   s, s,
bool   IncludeSender IncludeSender

-Sends text from a user to a channel (mulicast). +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 433 of file modules.cpp. +Definition at line 446 of file modules.cpp.

-

00434 {
-00435         if (IncludeSender)
-00436         {
-00437                 WriteChannel(Channel,User,"%s",s.c_str());
-00438         }
-00439         else
-00440         {
-00441                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00442         }
-00443 }
+
00447 {
+00448         if (IncludeSender)
+00449         {
+00450                 WriteChannel(Channel,User,"%s",s.c_str());
+00451         }
+00452         else
+00453         {
+00454                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00455         }
+00456 }

- +
-
+ - + - + - + @@ -1490,47 +1519,47 @@ Definition at line 433
void Server::SendCommon (  userrec *   User, User,
std::string   text, text,
bool   IncludeSender IncludeSender

-Sends text from a user to one or more channels (mulicast). +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 450 of file modules.cpp. -

-

00451 {
-00452         if (IncludeSender)
-00453         {
-00454                 WriteCommon(User,"%s",text.c_str());
-00455         }
-00456         else
-00457         {
-00458                 WriteCommonExcept(User,"%s",text.c_str());
-00459         }
-00460 }
+Definition at line 463 of file modules.cpp.
+

+
00464 {
+00465         if (IncludeSender)
+00466         {
+00467                 WriteCommon(User,"%s",text.c_str());
+00468         }
+00469         else
+00470         {
+00471                 WriteCommonExcept(User,"%s",text.c_str());
+00472         }
+00473 }

- +
-
+ - + - + - + @@ -1550,40 +1579,40 @@ Definition at line 450
void Server::SendFrom (  int   Socket, Socket,
userrec *   User, User,
std::string   s s

-Sends text from a user to a socket. +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 414 of file modules.cpp. +Definition at line 427 of file modules.cpp.

-

00415 {
-00416         WriteFrom(Socket,User,"%s",s.c_str());
-00417 }
+
00428 {
+00429         WriteFrom(Socket,User,"%s",s.c_str());
+00430 }

- +
-
+ - + - + - + @@ -1603,7 +1632,7 @@ Definition at line 414
void Server::SendMode (  char **   parameters, parameters,
int   pcnt, pcnt,
userrec *   user user

-Sends a servermode. +Sends a servermode.

you must format the parameters array with the target, modes and parameters for those modes.

For example:

@@ -1614,27 +1643,27 @@ modes[2] = user->nick;

Srv->SendMode(modes,3,user);

The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!

-Definition at line 399 of file modules.cpp. +Definition at line 412 of file modules.cpp.

References server_mode().

-

00400 {
-00401         server_mode(parameters,pcnt,user);
-00402 }
+
00413 {
+00414         server_mode(parameters,pcnt,user);
+00415 }

- +
-
+ - - + + @@ -1650,34 +1679,34 @@ References server_mode().
void Server::SendOpers (  std::string   s )  s  )  [virtual]

-Sends text to all opers. +Sends text to all opers.

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

-Definition at line 321 of file modules.cpp. +Definition at line 334 of file modules.cpp.

-

00322 {
-00323         WriteOpers("%s",s.c_str());
-00324 }
+
00335 {
+00336         WriteOpers("%s",s.c_str());
+00337 }

- +
-
+ - + - + @@ -1697,40 +1726,40 @@ Definition at line 321
void Server::SendServ (  int   Socket, Socket,
std::string   s s

-Sends text from the server to a socket. +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 409 of file modules.cpp. +Definition at line 422 of file modules.cpp.

-

00410 {
-00411         WriteServ(Socket,"%s",s.c_str());
-00412 }
+
00423 {
+00424         WriteServ(Socket,"%s",s.c_str());
+00425 }

- +
-
+ - + - + - + @@ -1750,7 +1779,7 @@ Definition at line 409
void Server::SendTo (  userrec *   Source, Source,
userrec *   Dest, Dest,
std::string   s s

-Sends text from a user to another user. +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) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:

:user!ident TEXT

@@ -1758,47 +1787,47 @@ The format will become:

:localserver TEXT

Which is useful for numerics and server notices to single users, etc.

-Definition at line 419 of file modules.cpp. -

-References connection::fd. -

-

00420 {
-00421         if (!Source)
-00422         {
-00423                 // if source is NULL, then the message originates from the local server
-00424                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00425         }
-00426         else
-00427         {
-00428                 // otherwise it comes from the user specified
-00429                 WriteTo(Source,Dest,"%s",s.c_str());
-00430         }
-00431 }
+Definition at line 432 of file modules.cpp.
+

+References connection::fd.
+

+
00433 {
+00434         if (!Source)
+00435         {
+00436                 // if source is NULL, then the message originates from the local server
+00437                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00438         }
+00439         else
+00440         {
+00441                 // otherwise it comes from the user specified
+00442                 WriteTo(Source,Dest,"%s",s.c_str());
+00443         }
+00444 }

- +
-
+ - + - + - + @@ -1818,36 +1847,36 @@ References connection::fd<
void Server::SendToModeMask (  std::string   modes, modes,
int   flags, flags,
std::string   text text

-Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. +Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.

These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:

Serv->SendToModeMask("xi", WM_OR, "m00");

Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.

-Definition at line 334 of file modules.cpp. +Definition at line 347 of file modules.cpp.

-

00335 {
-00336         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00337 }
+
00348 {
+00349         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00350 }

- +
-
+ - + - + @@ -1867,23 +1896,23 @@ Definition at line 334
void Server::SendWallops (  userrec *   User, User,
std::string   text text

-Sends a WALLOPS message. +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 462 of file modules.cpp. +Definition at line 475 of file modules.cpp.

-

00463 {
-00464         WriteWallOps(User,false,"%s",text.c_str());
-00465 }
+
00476 {
+00477         WriteWallOps(User,false,"%s",text.c_str());
+00478 }
The documentation for this class was generated from the following files: -
Generated on Sun May 2 00:09:43 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
-- cgit v1.3.1-10-gc9f91