diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
| commit | 52899de0ff2d62ca0542b243c41626010bf62083 (patch) | |
| tree | b9c92bbdb7d65a7467cbd6ebcbc31dc2f96e09e3 /docs/module-doc/classServer.html | |
| parent | 0340f1a432d684347d8dbc3aa85c8436c56d4039 (diff) | |
Documentation update
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classServer.html')
| -rw-r--r-- | docs/module-doc/classServer.html | 1035 |
1 files changed, 532 insertions, 503 deletions
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 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>Server class Reference</title> +<title>InspIRCd: Server class Reference</title> <link href="inspircd.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.3-rc3 --> -<center> -<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> -<hr><h1>Server Class Reference</h1>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. +<!-- Generated by Doxygen 1.3.3 --> +<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>Server Class Reference</h1>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. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code> <p> -Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph.gif" border="0" usemap="#Server__inherit__map" alt="Inheritance graph"></center> -<map name="Server__inherit__map"> -<area href="classclassbase.html" shape="rect" coords="7,16,73,37" alt=""> -</map> -<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Server:<p><center><img src="classServer__coll__graph.gif" border="0" usemap="#Server__coll__map" alt="Collaboration graph"></center> -<map name="Server__coll__map"> -<area href="classclassbase.html" shape="rect" coords="7,106,73,128" alt=""> -</map> -<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classServer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +Inherits <a class="el" href="classclassbase.html">classbase</a>. +<p> +<a href="classServer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classServer.html#a0">Server</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classServer.html#a1">~Server</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Default destructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a2">SendOpers</a> (std::string s)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends text to all opers.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a3">Log</a> (int level, std::string s)</td></tr> -<tr><td> </td><td><font size=-1><em>Writes a log string.</em> <a href="#a3"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a4">Send</a> (int Socket, std::string s)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends a line of text down a TCP/IP socket.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a5">SendServ</a> (int Socket, std::string s)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends text from the server to a socket.</em> <a href="#a5"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a6">SendFrom</a> (int Socket, <a class="el" href="classuserrec.html">userrec</a> *User, std::string s)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends text from a user to a socket.</em> <a href="#a6"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a7">SendTo</a> (<a class="el" href="classuserrec.html">userrec</a> *Source, <a class="el" href="classuserrec.html">userrec</a> *Dest, std::string s)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends text from a user to another user.</em> <a href="#a7"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a8">SendChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Channel, std::string s, bool IncludeSender)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends text from a user to a channel (mulicast).</em> <a href="#a8"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a9">CommonChannels</a> (<a class="el" href="classuserrec.html">userrec</a> *u1, <a class="el" href="classuserrec.html">userrec</a> *u2)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns true if two users share a common channel.</em> <a href="#a9"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a10">SendCommon</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text, bool IncludeSender)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends text from a user to one or more channels (mulicast).</em> <a href="#a10"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a11">SendWallops</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends a WALLOPS message.</em> <a href="#a11"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a12">IsNick</a> (std::string nick)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns true if a nick is valid.</em> <a href="#a12"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="classServer.html#a13">CountUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *c)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns a count of the number of users on a channel.</em> <a href="#a13"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="classuserrec.html">userrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a14">FindNick</a> (std::string nick)</td></tr> -<tr><td> </td><td><font size=-1><em>Attempts to look up a nick and return a pointer to it.</em> <a href="#a14"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a15">FindChannel</a> (std::string channel)</td></tr> -<tr><td> </td><td><font size=-1><em>Attempts to look up a channel and return a pointer to it.</em> <a href="#a15"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a16">ChanMode</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr> -<tr><td> </td><td><font size=-1><em>Attempts to look up a user's privilages on a channel.</em> <a href="#a16"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a17">IsOnChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr> -<tr><td> </td><td><font size=-1><em>Checks if a user is on a channel.</em> <a href="#a17"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a18">GetServerName</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Returns the server name of the server where the module is loaded.</em> <a href="#a18"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a19">GetNetworkName</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Returns the network name, global to all linked servers.</em> <a href="#a19"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="classAdmin.html">Admin</a> </td><td valign=bottom><a class="el" href="classServer.html#a20">GetAdmin</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Returns the information of the server as returned by the /ADMIN command.</em> <a href="#a20"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a21">AddExtendedMode</a> (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)</td></tr> -<tr><td> </td><td><font size=-1><em>Adds an extended mode letter which is parsed by a module.</em> <a href="#a21"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a22">AddExtendedListMode</a> (char modechar)</td></tr> -<tr><td> </td><td><font size=-1><em>Adds an extended mode letter which is parsed by a module and handled in a list fashion.</em> <a href="#a22"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a23">AddCommand</a> (char *cmd, handlerfunc f, char flags, int minparams)</td></tr> -<tr><td> </td><td><font size=-1><em>Adds a command to the command table.</em> <a href="#a23"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a24">SendMode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends a servermode.</em> <a href="#a24"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a25">SendToModeMask</a> (std::string modes, int flags, std::string text)</td></tr> -<tr><td> </td><td><font size=-1><em>Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.</em> <a href="#a25"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a26">JoinUserToChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string key)</td></tr> -<tr><td> </td><td><font size=-1><em>Forces a user to join a channel.</em> <a href="#a26"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a27">PartUserFromChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string reason)</td></tr> -<tr><td> </td><td><font size=-1><em>Forces a user to part a channel.</em> <a href="#a27"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a28">ChangeUserNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string nickname)</td></tr> -<tr><td> </td><td><font size=-1><em>Forces a user nickchange.</em> <a href="#a28"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a29">QuitUser</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string reason)</td></tr> -<tr><td> </td><td><font size=-1><em>Forces a user to quit with the specified reason.</em> <a href="#a29"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a30">MatchText</a> (std::string sliteral, std::string spattern)</td></tr> -<tr><td> </td><td><font size=-1><em>Matches text against a glob pattern.</em> <a href="#a30"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a31">CallCommandHandler</a> (std::string commandname, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td> </td><td><font size=-1><em>Calls the handler for a command, either implemented by the core or by another module.</em> <a href="#a31"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a32">ChangeHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string host)</td></tr> -<tr><td> </td><td><font size=-1><em>Change displayed hostname of a user.</em> <a href="#a32"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a33">ChangeGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string gecos)</td></tr> -<tr><td> </td><td><font size=-1><em>Change GECOS (fullname) of a user.</em> <a href="#a33"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a34">IsUlined</a> (std::string server)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns true if the servername you give is ulined.</em> <a href="#a34"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a28">chanuserlist</a> </td><td valign=bottom><a class="el" href="classServer.html#a35">GetUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> -<tr><td> </td><td><font size=-1><em>Fetches the userlist of a channel.</em> <a href="#a35"></a><em></em></font><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a0">Server</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. </em> <a href="#a0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a1">~Server</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. </em> <a href="#a1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a2">SendOpers</a> (std::string s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text to all opers. </em> <a href="#a2"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a3">Log</a> (int level, std::string s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a log string. </em> <a href="#a3"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a4">Send</a> (int Socket, std::string s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a line of text down a TCP/IP socket. </em> <a href="#a4"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a5">SendServ</a> (int Socket, std::string s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from the server to a socket. </em> <a href="#a5"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a6">SendFrom</a> (int Socket, <a class="el" href="classuserrec.html">userrec</a> *User, std::string s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to a socket. </em> <a href="#a6"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a7">SendTo</a> (<a class="el" href="classuserrec.html">userrec</a> *Source, <a class="el" href="classuserrec.html">userrec</a> *Dest, std::string s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to another user. </em> <a href="#a7"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a8">SendChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Channel, std::string s, bool IncludeSender)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to a channel (mulicast). </em> <a href="#a8"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a9">CommonChannels</a> (<a class="el" href="classuserrec.html">userrec</a> *u1, <a class="el" href="classuserrec.html">userrec</a> *u2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if two users share a common channel. </em> <a href="#a9"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a10">SendCommon</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text, bool IncludeSender)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to one or more channels (mulicast). </em> <a href="#a10"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a11">SendWallops</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a WALLOPS message. </em> <a href="#a11"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a12">IsNick</a> (std::string nick)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a nick is valid. </em> <a href="#a12"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a13">CountUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *c)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a count of the number of users on a channel. </em> <a href="#a13"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classuserrec.html">userrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a14">FindNick</a> (std::string nick)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to look up a nick and return a pointer to it. </em> <a href="#a14"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a15">FindChannel</a> (std::string channel)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to look up a channel and return a pointer to it. </em> <a href="#a15"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a16">ChanMode</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to look up a user's privilages on a channel. </em> <a href="#a16"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a17">IsOnChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if a user is on a channel. </em> <a href="#a17"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a18">GetServerName</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server name of the server where the module is loaded. </em> <a href="#a18"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a19">GetNetworkName</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the network name, global to all linked servers. </em> <a href="#a19"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classAdmin.html">Admin</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a20">GetAdmin</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the information of the server as returned by the /ADMIN command. </em> <a href="#a20"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a21">AddExtendedMode</a> (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an extended mode letter which is parsed by a module. </em> <a href="#a21"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a22">AddExtendedListMode</a> (char modechar)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an extended mode letter which is parsed by a module and handled in a list fashion. </em> <a href="#a22"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a23">AddCommand</a> (char *cmd, handlerfunc f, char flags, int minparams)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a command to the command table. </em> <a href="#a23"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a24">SendMode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a servermode. </em> <a href="#a24"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a25">SendToModeMask</a> (std::string modes, int flags, std::string text)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. </em> <a href="#a25"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a26">JoinUserToChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user to join a channel. </em> <a href="#a26"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a27">PartUserFromChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string reason)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user to part a channel. </em> <a href="#a27"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a28">ChangeUserNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string nickname)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user nickchange. </em> <a href="#a28"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a29">QuitUser</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string reason)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user to quit with the specified reason. </em> <a href="#a29"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a30">MatchText</a> (std::string sliteral, std::string spattern)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Matches text against a glob pattern. </em> <a href="#a30"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a31">CallCommandHandler</a> (std::string commandname, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls the handler for a command, either implemented by the core or by another module. </em> <a href="#a31"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a32">ChangeHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string host)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Change displayed hostname of a user. </em> <a href="#a32"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a33">ChangeGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string gecos)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Change GECOS (fullname) of a user. </em> <a href="#a33"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a34">IsUlined</a> (std::string server)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the servername you give is ulined. </em> <a href="#a34"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a28">chanuserlist</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a35">GetUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetches the userlist of a channel. </em> <a href="#a35"></a><em><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> -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. <p> All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00314">314</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +Definition at line <a class="el" href="modules_8h-source.html#l00337">337</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="Server::Server"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> Server::Server </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -128,27 +157,27 @@ Definition at line <a class="el" href="modules_8h-source.html#l00314">314</a> of <td> <p> -Default constructor. +Default constructor. <p> Creates a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00313">313</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00326">326</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00314 { -00315 } +<div class="fragment"><pre>00327 { +00328 } </pre></div> </td> </tr> </table> <a name="a1" doxytag="Server::~Server"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> Server::~Server </td> + <td class="md" nowrap valign="top"> Server::~<a class="el" href="classServer.html">Server</a> </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -164,46 +193,46 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00313">313</a> <td> <p> -Default destructor. +Default destructor. <p> Destroys a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00330">330</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00318 { -00319 } +<div class="fragment"><pre>00331 { +00332 } </pre></div> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a23" doxytag="Server::AddCommand"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::AddCommand </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> - <td class="mdname" nowrap> <em>cmd</em>, </td> + <td class="mdname" nowrap> <em>cmd</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>handlerfunc </td> - <td class="mdname" nowrap> <em>f</em>, </td> + <td class="mdname" nowrap> <em>f</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>char </td> - <td class="mdname" nowrap> <em>flags</em>, </td> + <td class="mdname" nowrap> <em>flags</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>minparams</em></td> + <td class="mdname" nowrap> <em>minparams</em></td> </tr> <tr> <td></td> @@ -223,33 +252,33 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> <td> <p> -Adds a command to the command table. +Adds a command to the command table. <p> 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:<p> typedef void (handlerfunc) (char**, int, userrec*); ... void <a class="el" href="commands_8h.html#a5">handle_kill(char **parameters, int pcnt, userrec *user)</a><p> 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'. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00394">394</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00407">407</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h.html#a30">createcommand()</a>. <p> -<div class="fragment"><pre>00395 { -00396 <a class="code" href="modules_8h.html#a30">createcommand</a>(cmd,f,flags,minparams); -00397 } +<div class="fragment"><pre>00408 { +00409 <a class="code" href="modules_8h.html#a30">createcommand</a>(cmd,f,flags,minparams); +00410 } </pre></div> </td> </tr> </table> <a name="a22" doxytag="Server::AddExtendedListMode"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::AddExtendedListMode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char </td> - <td class="mdname1" valign="top" nowrap> <em>modechar</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>modechar</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -265,7 +294,7 @@ References <a class="el" href="modules_8h.html#a30">createcommand()</a>. <td> <p> -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. <p> This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:<p> (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL<p> @@ -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<p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00539">539</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00552">552</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8cpp-source.html#l00254">DoAddExtendedMode()</a>, and <a class="el" href="modules_8cpp-source.html#l00264">ModeMakeList()</a>. +References <a class="el" href="modules_8cpp-source.html#l00266">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00276">ModeMakeList()</a>, and <a class="el" href="modules_8h-source.html#l00031">MT_CHANNEL</a>. <p> -<div class="fragment"><pre>00540 { -00541 <span class="keywordtype">bool</span> res = <a class="code" href="modules_8cpp.html#a57">DoAddExtendedMode</a>(modechar,MT_CHANNEL,<span class="keyword">false</span>,1,1); -00542 <span class="keywordflow">if</span> (res) -00543 <a class="code" href="modules_8cpp.html#a58">ModeMakeList</a>(modechar); -00544 <span class="keywordflow">return</span> res; -00545 } +<div class="fragment"><pre>00553 { +00554 <span class="keywordtype">bool</span> res = <a class="code" href="modules_8cpp.html#a56">DoAddExtendedMode</a>(modechar,MT_CHANNEL,<span class="keyword">false</span>,1,1); +00555 <span class="keywordflow">if</span> (res) +00556 <a class="code" href="modules_8cpp.html#a57">ModeMakeList</a>(modechar); +00557 <span class="keywordflow">return</span> res; +00558 } </pre></div> </td> </tr> </table> <a name="a21" doxytag="Server::AddExtendedMode"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::AddExtendedMode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char </td> - <td class="mdname" nowrap> <em>modechar</em>, </td> + <td class="mdname" nowrap> <em>modechar</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>type</em>, </td> + <td class="mdname" nowrap> <em>type</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>requires_oper</em>, </td> + <td class="mdname" nowrap> <em>requires_oper</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>params_when_on</em>, </td> + <td class="mdname" nowrap> <em>params_when_on</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>params_when_off</em></td> + <td class="mdname" nowrap> <em>params_when_off</em></td> </tr> <tr> <td></td> @@ -340,63 +369,63 @@ References <a class="el" href="modules_8cpp-source.html#l00254">DoAddExtendedMod <td> <p> -Adds an extended mode letter which is parsed by a module. +Adds an extended mode letter which is parsed by a module. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00519">519</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8cpp-source.html#l00254">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00022">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00023">MT_SERVER</a>. -<p> -<div class="fragment"><pre>00520 { -00521 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#a7">MT_SERVER</a>) -00522 { -00523 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>); -00524 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00525 } -00526 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#a6">MT_CLIENT</a>)) -00527 { -00528 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>); -00529 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00530 } -00531 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1)) -00532 { -00533 log(DEBUG,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>); -00534 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00535 } -00536 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a57">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off); -00537 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00532">532</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="modules_8cpp-source.html#l00266">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00032">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00033">MT_SERVER</a>. +<p> +<div class="fragment"><pre>00533 { +00534 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#a7">MT_SERVER</a>) +00535 { +00536 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>); +00537 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00538 } +00539 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#a6">MT_CLIENT</a>)) +00540 { +00541 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>); +00542 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00543 } +00544 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1)) +00545 { +00546 log(DEBUG,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>); +00547 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00548 } +00549 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a56">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off); +00550 } </pre></div> </td> </tr> </table> <a name="a31" doxytag="Server::CallCommandHandler"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::CallCommandHandler </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname" nowrap> <em>commandname</em>, </td> + <td class="mdname" nowrap> <em>commandname</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>char ** </td> - <td class="mdname" nowrap> <em>parameters</em>, </td> + <td class="mdname" nowrap> <em>parameters</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>pcnt</em>, </td> + <td class="mdname" nowrap> <em>pcnt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em></td> + <td class="mdname" nowrap> <em>user</em></td> </tr> <tr> <td></td> @@ -416,35 +445,35 @@ References <a class="el" href="modules_8cpp-source.html#l00254">DoAddExtendedMod <td> <p> -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. <p> 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 <br> ) 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 <a class="el" href="classServer.html#a23">AddCommand()</a>. 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00384">384</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00397">397</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00385 { -00386 call_handler(commandname.c_str(),parameters,pcnt,user); -00387 } +<div class="fragment"><pre>00398 { +00399 call_handler(commandname.c_str(),parameters,pcnt,user); +00400 } </pre></div> </td> </tr> </table> <a name="a33" doxytag="Server::ChangeGECOS"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::ChangeGECOS </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> + <td class="mdname" nowrap> <em>user</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>gecos</em></td> + <td class="mdname" nowrap> <em>gecos</em></td> </tr> <tr> <td></td> @@ -464,36 +493,36 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00384">384</a> <td> <p> -Change GECOS (fullname) of a user. +Change GECOS (fullname) of a user. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00472">472</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00485">485</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="message_8h.html#a10">ChangeName()</a>. <p> -<div class="fragment"><pre>00473 { -00474 <a class="code" href="message_8h.html#a10">ChangeName</a>(user,gecos.c_str()); -00475 } +<div class="fragment"><pre>00486 { +00487 <a class="code" href="message_8h.html#a10">ChangeName</a>(user,gecos.c_str()); +00488 } </pre></div> </td> </tr> </table> <a name="a32" doxytag="Server::ChangeHost"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::ChangeHost </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> + <td class="mdname" nowrap> <em>user</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>host</em></td> + <td class="mdname" nowrap> <em>host</em></td> </tr> <tr> <td></td> @@ -513,36 +542,36 @@ References <a class="el" href="message_8h.html#a10">ChangeName()</a>. <td> <p> -Change displayed hostname of a user. +Change displayed hostname of a user. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00467">467</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00480">480</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="message_8h.html#a11">ChangeDisplayedHost()</a>. <p> -<div class="fragment"><pre>00468 { -00469 <a class="code" href="message_8h.html#a11">ChangeDisplayedHost</a>(user,host.c_str()); -00470 } +<div class="fragment"><pre>00481 { +00482 <a class="code" href="message_8h.html#a11">ChangeDisplayedHost</a>(user,host.c_str()); +00483 } </pre></div> </td> </tr> </table> <a name="a28" doxytag="Server::ChangeUserNick"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::ChangeUserNick </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> + <td class="mdname" nowrap> <em>user</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>nickname</em></td> + <td class="mdname" nowrap> <em>nickname</em></td> </tr> <tr> <td></td> @@ -562,34 +591,34 @@ References <a class="el" href="message_8h.html#a11">ChangeDisplayedHost()</a>. <td> <p> -Forces a user nickchange. +Forces a user nickchange. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00368">368</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00381">381</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00369 { -00370 force_nickchange(user,nickname.c_str()); -00371 } +<div class="fragment"><pre>00382 { +00383 force_nickchange(user,nickname.c_str()); +00384 } </pre></div> </td> </tr> </table> <a name="a16" doxytag="Server::ChanMode"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> std::string Server::ChanMode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>User</em>, </td> + <td class="mdname" nowrap> <em>User</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td> - <td class="mdname" nowrap> <em>Chan</em></td> + <td class="mdname" nowrap> <em>Chan</em></td> </tr> <tr> <td></td> @@ -609,36 +638,36 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00368">368</a> <td> <p> -Attempts to look up a user's privilages on a channel. +Attempts to look up a user's privilages on a channel. <p> This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00492">492</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00505">505</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="message_8h.html#a14">cmode()</a>. <p> -<div class="fragment"><pre>00493 { -00494 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a14">cmode</a>(User,Chan); -00495 } +<div class="fragment"><pre>00506 { +00507 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a14">cmode</a>(User,Chan); +00508 } </pre></div> </td> </tr> </table> <a name="a9" doxytag="Server::CommonChannels"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::CommonChannels </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>u1</em>, </td> + <td class="mdname" nowrap> <em>u1</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>u2</em></td> + <td class="mdname" nowrap> <em>u2</em></td> </tr> <tr> <td></td> @@ -658,31 +687,31 @@ References <a class="el" href="message_8h.html#a14">cmode()</a>. <td> <p> -Returns true if two users share a common channel. +Returns true if two users share a common channel. <p> This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#a10">Server::SendCommon</a> method. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00445">445</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00458">458</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="message_8h.html#a0">common_channels()</a>. <p> -<div class="fragment"><pre>00446 { -00447 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a0">common_channels</a>(u1,u2) != 0); -00448 } +<div class="fragment"><pre>00459 { +00460 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a0">common_channels</a>(u1,u2) != 0); +00461 } </pre></div> </td> </tr> </table> <a name="a13" doxytag="Server::CountUsers"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int Server::CountUsers </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * </td> - <td class="mdname1" valign="top" nowrap> <em>c</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>c</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -698,29 +727,29 @@ References <a class="el" href="message_8h.html#a0">common_channels()</a>. <td> <p> -Returns a count of the number of users on a channel. +Returns a count of the number of users on a channel. <p> This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00547">547</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00560">560</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00548 { -00549 <span class="keywordflow">return</span> usercount(c); -00550 } +<div class="fragment"><pre>00561 { +00562 <span class="keywordflow">return</span> usercount(c); +00563 } </pre></div> </td> </tr> </table> <a name="a15" doxytag="Server::FindChannel"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>channel</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>channel</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -736,29 +765,29 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00547">547</a> <td> <p> -Attempts to look up a channel and return a pointer to it. +Attempts to look up a channel and return a pointer to it. <p> This function will return NULL if the channel does not exist. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00487">487</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00500">500</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00488 { -00489 <span class="keywordflow">return</span> FindChan(channel.c_str()); -00490 } +<div class="fragment"><pre>00501 { +00502 <span class="keywordflow">return</span> FindChan(channel.c_str()); +00503 } </pre></div> </td> </tr> </table> <a name="a14" doxytag="Server::FindNick"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>nick</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>nick</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -774,28 +803,28 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00487">487</a> <td> <p> -Attempts to look up a nick and return a pointer to it. +Attempts to look up a nick and return a pointer to it. <p> This function will return NULL if the nick does not exist. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00482">482</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00495">495</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00483 { -00484 <span class="keywordflow">return</span> Find(nick); -00485 } +<div class="fragment"><pre>00496 { +00497 <span class="keywordflow">return</span> Find(nick); +00498 } </pre></div> </td> </tr> </table> <a name="a20" doxytag="Server::GetAdmin"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -811,28 +840,28 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00482">482</a> <td> <p> -Returns the information of the server as returned by the /ADMIN command. +Returns the information of the server as returned by the /ADMIN command. <p> -See the <a class="el" href="classAdmin.html">Admin</a> class for further information of the return value. The members <a class="el" href="classAdmin.html#m2">Admin::Nick</a>, <a class="el" href="classAdmin.html#m1">Admin::Email</a> and <a class="el" href="classAdmin.html#m0">Admin::Name</a> contain the information for the server where the module is loaded. +See the <a class="el" href="classAdmin.html">Admin</a> class for further information of the return value. The members <a class="el" href="classAdmin.html#o2">Admin::Nick</a>, <a class="el" href="classAdmin.html#o1">Admin::Email</a> and <a class="el" href="classAdmin.html#o0">Admin::Name</a> contain the information for the server where the module is loaded. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00512">512</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00525">525</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00513 { -00514 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); -00515 } +<div class="fragment"><pre>00526 { +00527 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); +00528 } </pre></div> </td> </tr> </table> <a name="a19" doxytag="Server::GetNetworkName"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -848,28 +877,28 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00512">512</a> <td> <p> -Returns the network name, global to all linked servers. +Returns the network name, global to all linked servers. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00507">507</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00520">520</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00508 { -00509 <span class="keywordflow">return</span> getnetworkname(); -00510 } +<div class="fragment"><pre>00521 { +00522 <span class="keywordflow">return</span> getnetworkname(); +00523 } </pre></div> </td> </tr> </table> <a name="a18" doxytag="Server::GetServerName"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> std::string Server::GetServerName </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -885,29 +914,29 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00507">507</a> <td> <p> -Returns the server name of the server where the module is loaded. +Returns the server name of the server where the module is loaded. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00502">502</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00515">515</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00503 { -00504 <span class="keywordflow">return</span> getservername(); -00505 } +<div class="fragment"><pre>00516 { +00517 <span class="keywordflow">return</span> getservername(); +00518 } </pre></div> </td> </tr> </table> <a name="a35" doxytag="Server::GetUsers"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a28">chanuserlist</a> Server::GetUsers </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * </td> - <td class="mdname1" valign="top" nowrap> <em>chan</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>chan</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -923,46 +952,46 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00502">502</a> <td> <p> -Fetches the userlist of a channel. +Fetches the userlist of a channel. <p> This function must be here and not a member of userrec or chanrec due to include constraints. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00349">349</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l00055">chanuserlist</a>, <a class="el" href="modules_8cpp-source.html#l00155">clientlist</a>, <a class="el" href="message_8h.html#a16">has_channel()</a>, and <a class="el" href="message_8h.html#a13">isnick()</a>. -<p> -<div class="fragment"><pre>00350 { -00351 <a class="code" href="modules_8h.html#a28">chanuserlist</a> userl; -00352 userl.clear(); -00353 <span class="keywordflow">for</span> (user_hash::const_iterator i = <a class="code" href="modules_8cpp.html#a42">clientlist</a>.begin(); i != <a class="code" href="modules_8cpp.html#a42">clientlist</a>.end(); i++) -00354 { -00355 <span class="keywordflow">if</span> (i->second) -00356 { -00357 <span class="keywordflow">if</span> (<a class="code" href="message_8h.html#a16">has_channel</a>(i->second,chan)) -00358 { -00359 <span class="keywordflow">if</span> (<a class="code" href="message_8h.html#a13">isnick</a>(i->second->nick)) -00360 { -00361 userl.push_back(i->second); -00362 } -00363 } -00364 } -00365 } -00366 <span class="keywordflow">return</span> userl; -00367 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00362">362</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00065">chanuserlist</a>, <a class="el" href="modules_8cpp-source.html#l00170">clientlist</a>, <a class="el" href="message_8h.html#a16">has_channel()</a>, and <a class="el" href="message_8h.html#a13">isnick()</a>. +<p> +<div class="fragment"><pre>00363 { +00364 <a class="code" href="modules_8h.html#a28">chanuserlist</a> userl; +00365 userl.clear(); +00366 <span class="keywordflow">for</span> (user_hash::const_iterator i = <a class="code" href="modules_8cpp.html#a41">clientlist</a>.begin(); i != <a class="code" href="modules_8cpp.html#a41">clientlist</a>.end(); i++) +00367 { +00368 <span class="keywordflow">if</span> (i->second) +00369 { +00370 <span class="keywordflow">if</span> (<a class="code" href="message_8h.html#a16">has_channel</a>(i->second,chan)) +00371 { +00372 <span class="keywordflow">if</span> (<a class="code" href="message_8h.html#a13">isnick</a>(i->second->nick)) +00373 { +00374 userl.push_back(i->second); +00375 } +00376 } +00377 } +00378 } +00379 <span class="keywordflow">return</span> userl; +00380 } </pre></div> </td> </tr> </table> <a name="a12" doxytag="Server::IsNick"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::IsNick </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>nick</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>nick</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -978,36 +1007,36 @@ References <a class="el" href="modules_8h-source.html#l00055">chanuserlist</a>, <td> <p> -Returns true if a nick is valid. +Returns true if a nick is valid. <p> Nicks for unregistered connections will return false. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00477">477</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00490">490</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="message_8h.html#a13">isnick()</a>. <p> -<div class="fragment"><pre>00478 { -00479 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a13">isnick</a>(nick.c_str()) != 0); -00480 } +<div class="fragment"><pre>00491 { +00492 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a13">isnick</a>(nick.c_str()) != 0); +00493 } </pre></div> </td> </tr> </table> <a name="a17" doxytag="Server::IsOnChannel"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::IsOnChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>User</em>, </td> + <td class="mdname" nowrap> <em>User</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td> - <td class="mdname" nowrap> <em>Chan</em></td> + <td class="mdname" nowrap> <em>Chan</em></td> </tr> <tr> <td></td> @@ -1027,31 +1056,31 @@ References <a class="el" href="message_8h.html#a13">isnick()</a>. <td> <p> -Checks if a user is on a channel. +Checks if a user is on a channel. <p> This function will return true or false to indicate if user 'User' is on channel 'Chan'. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00497">497</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00510">510</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="message_8h.html#a16">has_channel()</a>. <p> -<div class="fragment"><pre>00498 { -00499 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a16">has_channel</a>(User,Chan); -00500 } +<div class="fragment"><pre>00511 { +00512 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a16">has_channel</a>(User,Chan); +00513 } </pre></div> </td> </tr> </table> <a name="a34" doxytag="Server::IsUlined"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::IsUlined </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>server</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>server</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -1067,42 +1096,42 @@ References <a class="el" href="message_8h.html#a16">has_channel()</a>. <td> <p> -Returns true if the servername you give is ulined. +Returns true if the servername you give is ulined. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00379">379</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00392">392</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="commands_8h.html#a71">is_uline()</a>. <p> -<div class="fragment"><pre>00380 { -00381 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#a71">is_uline</a>(server.c_str()); -00382 } +<div class="fragment"><pre>00393 { +00394 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#a71">is_uline</a>(server.c_str()); +00395 } </pre></div> </td> </tr> </table> <a name="a26" doxytag="Server::JoinUserToChannel"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::JoinUserToChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> + <td class="mdname" nowrap> <em>user</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>cname</em>, </td> + <td class="mdname" nowrap> <em>cname</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>key</em></td> + <td class="mdname" nowrap> <em>key</em></td> </tr> <tr> <td></td> @@ -1122,34 +1151,34 @@ References <a class="el" href="commands_8h.html#a71">is_uline()</a>. <td> <p> -Forces a user to join a channel. +Forces a user to join a channel. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00339">339</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00352">352</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00340 { -00341 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">true</span>); -00342 } +<div class="fragment"><pre>00353 { +00354 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">true</span>); +00355 } </pre></div> </td> </tr> </table> <a name="a3" doxytag="Server::Log"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::Log </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname" nowrap> <em>level</em>, </td> + <td class="mdname" nowrap> <em>level</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>s</em></td> + <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> <td></td> @@ -1169,34 +1198,34 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00339">339</a> <td> <p> -Writes a log string. +Writes a log string. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00389">389</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00402">402</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00390 { -00391 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); -00392 } +<div class="fragment"><pre>00403 { +00404 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); +00405 } </pre></div> </td> </tr> </table> <a name="a30" doxytag="Server::MatchText"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Server::MatchText </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname" nowrap> <em>sliteral</em>, </td> + <td class="mdname" nowrap> <em>sliteral</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>spattern</em></td> + <td class="mdname" nowrap> <em>spattern</em></td> </tr> <tr> <td></td> @@ -1216,43 +1245,43 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00389">389</a> <td> <p> -Matches text against a glob pattern. +Matches text against a glob pattern. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00326">326</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00339">339</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00327 { -00328 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF]; -00329 strncpy(literal,sliteral.c_str(),MAXBUF); -00330 strncpy(pattern,spattern.c_str(),MAXBUF); -00331 <span class="keywordflow">return</span> match(literal,pattern); -00332 } +<div class="fragment"><pre>00340 { +00341 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF]; +00342 strlcpy(literal,sliteral.c_str(),MAXBUF); +00343 strlcpy(pattern,spattern.c_str(),MAXBUF); +00344 <span class="keywordflow">return</span> match(literal,pattern); +00345 } </pre></div> </td> </tr> </table> <a name="a27" doxytag="Server::PartUserFromChannel"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::PartUserFromChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> + <td class="mdname" nowrap> <em>user</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>cname</em>, </td> + <td class="mdname" nowrap> <em>cname</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>reason</em></td> + <td class="mdname" nowrap> <em>reason</em></td> </tr> <tr> <td></td> @@ -1272,34 +1301,34 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00326">326</a> <td> <p> -Forces a user to part a channel. +Forces a user to part a channel. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00344">344</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00357">357</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00345 { -00346 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>); -00347 } +<div class="fragment"><pre>00358 { +00359 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>); +00360 } </pre></div> </td> </tr> </table> <a name="a29" doxytag="Server::QuitUser"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::QuitUser </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em>, </td> + <td class="mdname" nowrap> <em>user</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>reason</em></td> + <td class="mdname" nowrap> <em>reason</em></td> </tr> <tr> <td></td> @@ -1319,39 +1348,39 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00344">344</a> <td> <p> -Forces a user to quit with the specified reason. +Forces a user to quit with the specified reason. <p> 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.<p> WARNING!<p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00373">373</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00386">386</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00091">userrec::nick</a>, and <a class="el" href="message_8h.html#a19">send_network_quit()</a>. +References <a class="el" href="users_8h-source.html#l00102">userrec::nick</a>, and <a class="el" href="message_8h.html#a19">send_network_quit()</a>. <p> -<div class="fragment"><pre>00374 { -00375 <a class="code" href="message_8h.html#a19">send_network_quit</a>(user-><a class="code" href="classuserrec.html#m0">nick</a>,reason.c_str()); -00376 kill_link(user,reason.c_str()); -00377 } +<div class="fragment"><pre>00387 { +00388 <a class="code" href="message_8h.html#a19">send_network_quit</a>(user-><a class="code" href="classuserrec.html#o0">nick</a>,reason.c_str()); +00389 kill_link(user,reason.c_str()); +00390 } </pre></div> </td> </tr> </table> <a name="a4" doxytag="Server::Send"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::Send </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname" nowrap> <em>Socket</em>, </td> + <td class="mdname" nowrap> <em>Socket</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>s</em></td> + <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> <td></td> @@ -1371,46 +1400,46 @@ References <a class="el" href="users_8h-source.html#l00091">userrec::nick</a>, a <td> <p> -Sends a line of text down a TCP/IP socket. +Sends a line of text down a TCP/IP socket. <p> This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00404">404</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00417">417</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00405 { -00406 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00407 } +<div class="fragment"><pre>00418 { +00419 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00420 } </pre></div> </td> </tr> </table> <a name="a8" doxytag="Server::SendChannel"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendChannel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>User</em>, </td> + <td class="mdname" nowrap> <em>User</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td> - <td class="mdname" nowrap> <em>Channel</em>, </td> + <td class="mdname" nowrap> <em>Channel</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>s</em>, </td> + <td class="mdname" nowrap> <em>s</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>IncludeSender</em></td> + <td class="mdname" nowrap> <em>IncludeSender</em></td> </tr> <tr> <td></td> @@ -1430,47 +1459,47 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00404">404</a> <td> <p> -Sends text from a user to a channel (mulicast). +Sends text from a user to a channel (mulicast). <p> 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). <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00433">433</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00446">446</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00434 { -00435 <span class="keywordflow">if</span> (IncludeSender) -00436 { -00437 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00438 } -00439 <span class="keywordflow">else</span> -00440 { -00441 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00442 } -00443 } +<div class="fragment"><pre>00447 { +00448 <span class="keywordflow">if</span> (IncludeSender) +00449 { +00450 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00451 } +00452 <span class="keywordflow">else</span> +00453 { +00454 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00455 } +00456 } </pre></div> </td> </tr> </table> <a name="a10" doxytag="Server::SendCommon"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendCommon </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>User</em>, </td> + <td class="mdname" nowrap> <em>User</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>text</em>, </td> + <td class="mdname" nowrap> <em>text</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>IncludeSender</em></td> + <td class="mdname" nowrap> <em>IncludeSender</em></td> </tr> <tr> <td></td> @@ -1490,47 +1519,47 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00433">433</a> <td> <p> -Sends text from a user to one or more channels (mulicast). +Sends text from a user to one or more channels (mulicast). <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00450">450</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00451 { -00452 <span class="keywordflow">if</span> (IncludeSender) -00453 { -00454 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00455 } -00456 <span class="keywordflow">else</span> -00457 { -00458 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00459 } -00460 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00463">463</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00464 { +00465 <span class="keywordflow">if</span> (IncludeSender) +00466 { +00467 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00468 } +00469 <span class="keywordflow">else</span> +00470 { +00471 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00472 } +00473 } </pre></div> </td> </tr> </table> <a name="a6" doxytag="Server::SendFrom"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendFrom </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname" nowrap> <em>Socket</em>, </td> + <td class="mdname" nowrap> <em>Socket</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>User</em>, </td> + <td class="mdname" nowrap> <em>User</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>s</em></td> + <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> <td></td> @@ -1550,40 +1579,40 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00450">450</a> <td> <p> -Sends text from a user to a socket. +Sends text from a user to a socket. <p> 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) <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00414">414</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00427">427</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00415 { -00416 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00417 } +<div class="fragment"><pre>00428 { +00429 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00430 } </pre></div> </td> </tr> </table> <a name="a24" doxytag="Server::SendMode"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendMode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char ** </td> - <td class="mdname" nowrap> <em>parameters</em>, </td> + <td class="mdname" nowrap> <em>parameters</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>pcnt</em>, </td> + <td class="mdname" nowrap> <em>pcnt</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>user</em></td> + <td class="mdname" nowrap> <em>user</em></td> </tr> <tr> <td></td> @@ -1603,7 +1632,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00414">414</a> <td> <p> -Sends a servermode. +Sends a servermode. <p> you must format the parameters array with the target, modes and parameters for those modes.<p> For example:<p> @@ -1614,27 +1643,27 @@ modes[2] = user->nick;<p> Srv->SendMode(modes,3,user);<p> 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! <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00399">399</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00412">412</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h.html#a31">server_mode()</a>. <p> -<div class="fragment"><pre>00400 { -00401 <a class="code" href="modules_8h.html#a31">server_mode</a>(parameters,pcnt,user); -00402 } +<div class="fragment"><pre>00413 { +00414 <a class="code" href="modules_8h.html#a31">server_mode</a>(parameters,pcnt,user); +00415 } </pre></div> </td> </tr> </table> <a name="a2" doxytag="Server::SendOpers"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendOpers </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>s</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>s</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> @@ -1650,34 +1679,34 @@ References <a class="el" href="modules_8h.html#a31">server_mode()</a>. <td> <p> -Sends text to all opers. +Sends text to all opers. <p> This method sends a server notice to all opers with the usermode +s. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00321">321</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00334">334</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00322 { -00323 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); -00324 } +<div class="fragment"><pre>00335 { +00336 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); +00337 } </pre></div> </td> </tr> </table> <a name="a5" doxytag="Server::SendServ"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendServ </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname" nowrap> <em>Socket</em>, </td> + <td class="mdname" nowrap> <em>Socket</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>s</em></td> + <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> <td></td> @@ -1697,40 +1726,40 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00321">321</a> <td> <p> -Sends text from the server to a socket. +Sends text from the server to a socket. <p> This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459) <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00409">409</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00422">422</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00410 { -00411 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00412 } +<div class="fragment"><pre>00423 { +00424 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00425 } </pre></div> </td> </tr> </table> <a name="a7" doxytag="Server::SendTo"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendTo </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>Source</em>, </td> + <td class="mdname" nowrap> <em>Source</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>Dest</em>, </td> + <td class="mdname" nowrap> <em>Dest</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>s</em></td> + <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> <td></td> @@ -1750,7 +1779,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00409">409</a> <td> <p> -Sends text from a user to another user. +Sends text from a user to another user. <p> 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:<p> :user!ident TEXT<p> @@ -1758,47 +1787,47 @@ The format will become:<p> :localserver TEXT<p> Which is useful for numerics and server notices to single users, etc. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00419">419</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="connection_8h-source.html#l00166">connection::fd</a>. -<p> -<div class="fragment"><pre>00420 { -00421 <span class="keywordflow">if</span> (!Source) -00422 { -00423 <span class="comment">// if source is NULL, then the message originates from the local server</span> -00424 Write(Dest-><a class="code" href="classconnection.html#m0">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str()); -00425 } -00426 <span class="keywordflow">else</span> -00427 { -00428 <span class="comment">// otherwise it comes from the user specified</span> -00429 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); -00430 } -00431 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00432">432</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="connection_8h-source.html#l00178">connection::fd</a>. +<p> +<div class="fragment"><pre>00433 { +00434 <span class="keywordflow">if</span> (!Source) +00435 { +00436 <span class="comment">// if source is NULL, then the message originates from the local server</span> +00437 Write(Dest-><a class="code" href="classconnection.html#o0">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str()); +00438 } +00439 <span class="keywordflow">else</span> +00440 { +00441 <span class="comment">// otherwise it comes from the user specified</span> +00442 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); +00443 } +00444 } </pre></div> </td> </tr> </table> <a name="a25" doxytag="Server::SendToModeMask"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendToModeMask </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname" nowrap> <em>modes</em>, </td> + <td class="mdname" nowrap> <em>modes</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>flags</em>, </td> + <td class="mdname" nowrap> <em>flags</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>text</em></td> + <td class="mdname" nowrap> <em>text</em></td> </tr> <tr> <td></td> @@ -1818,36 +1847,36 @@ References <a class="el" href="connection_8h-source.html#l00166">connection::fd< <td> <p> -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. <p> 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:<p> Serv->SendToModeMask("xi", WM_OR, "m00");<p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00334">334</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00347">347</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00335 { -00336 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str()); -00337 } +<div class="fragment"><pre>00348 { +00349 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str()); +00350 } </pre></div> </td> </tr> </table> <a name="a11" doxytag="Server::SendWallops"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Server::SendWallops </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> - <td class="mdname" nowrap> <em>User</em>, </td> + <td class="mdname" nowrap> <em>User</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>std::string </td> - <td class="mdname" nowrap> <em>text</em></td> + <td class="mdname" nowrap> <em>text</em></td> </tr> <tr> <td></td> @@ -1867,23 +1896,23 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00334">334</a> <td> <p> -Sends a WALLOPS message. +Sends a WALLOPS message. <p> This method writes a WALLOPS message to all users with the +w flag, originating from the specified user. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00462">462</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00475">475</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00463 { -00464 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str()); -00465 } +<div class="fragment"><pre>00476 { +00477 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str()); +00478 } </pre></div> </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul> -<hr><address style="align: right;"><small>Generated on Sun May 2 00:09:43 2004 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border=0 -width=110 height=53></a>1.3-rc3 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.3 </small></address> </body> </html> |