diff options
Diffstat (limited to 'docs/module-doc/classServer.html')
| -rw-r--r-- | docs/module-doc/classServer.html | 376 |
1 files changed, 253 insertions, 123 deletions
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index f9af699a5..c7b08f426 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -26,40 +26,44 @@ Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph. <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> (string s)</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, string s)</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, string s)</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, string s)</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, string s)</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, string s)</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, string s, bool IncludeSender)</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, string text, bool IncludeSender)</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, string text)</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> (string nick)</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 <a class="el" href="classuserrec.html">userrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a13">FindNick</a> (string nick)</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#a13">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="#a13"></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#a14">FindChannel</a> (string channel)</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#a14">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="#a14"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual string </td><td valign=bottom><a class="el" href="classServer.html#a15">ChanMode</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr> +<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a15">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="#a15"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual string </td><td valign=bottom><a class="el" href="classServer.html#a16">GetServerName</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a16">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="#a16"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual string </td><td valign=bottom><a class="el" href="classServer.html#a17">GetNetworkName</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a17">GetNetworkName</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Returns the network name, global to all linked servers.</em> <a href="#a17"></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#a18">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="#a18"></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#a19">AddExtendedMode</a> (char modechar, int type, bool default_on, 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 This allows modules to add extra mode letters, e.g.</em> <a href="#a19"></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#a20">AddCommand</a> (char *cmd, <a class="el" href="ctables_8h.html#a0">handlerfunc</a> 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="#a20"></a><em></em></font><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. @@ -68,7 +72,7 @@ All modules should instantiate at least one copy of this class, and use its memb <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00147">147</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#l00163">163</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"> <tr> @@ -98,10 +102,10 @@ Default constructor. <p> Creates a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00043">43</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#l00105">105</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00044 { -00045 } +<div class="fragment"><pre>00106 { +00107 } </pre></div> </td> </tr> </table> @@ -134,21 +138,148 @@ Default destructor. <p> Destroys a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00047">47</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#l00109">109</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00048 { -00049 } +<div class="fragment"><pre>00110 { +00111 } </pre></div> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> +<a name="a20" doxytag="Server::AddCommand"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a> </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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>minparams</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 handle_kill(char **parameters, int pcnt, userrec *user)<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#l00123">123</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h.html#a12">createcommand()</a>. +<p> +<div class="fragment"><pre>00124 { +00125 <a class="code" href="modules_8h.html#a12">createcommand</a>(cmd,f,flags,minparams); +00126 } +</pre></div> </td> + </tr> +</table> +<a name="a19" doxytag="Server::AddExtendedMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </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>default_on</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </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> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g. +<p> ++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. default_on is true if the mode is to be applied to default connections. 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 +b, 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#l00220">220</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00221 { +00222 } +</pre></div> </td> + </tr> +</table> <a name="a15" doxytag="Server::ChanMode"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> string Server::ChanMode </td> + <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> @@ -181,12 +312,11 @@ 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#l00130">130</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#l00198">198</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00131 { -00132 string mode = cmode(User,Chan); -00133 <span class="keywordflow">return</span> mode; -00134 } +<div class="fragment"><pre>00199 { +00200 <span class="keywordflow">return</span> cmode(User,Chan); +00201 } </pre></div> </td> </tr> </table> @@ -229,11 +359,11 @@ 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#l00093">93</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#l00161">161</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00094 { -00095 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0); -00096 } +<div class="fragment"><pre>00162 { +00163 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0); +00164 } </pre></div> </td> </tr> </table> @@ -245,7 +375,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00093">93</a> o <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">string </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="md" nowrap><code> [virtual]</code></td> @@ -267,11 +397,11 @@ 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#l00125">125</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#l00193">193</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00126 { -00127 <span class="keywordflow">return</span> FindChan(channel.c_str()); -00128 } +<div class="fragment"><pre>00194 { +00195 <span class="keywordflow">return</span> FindChan(channel.c_str()); +00196 } </pre></div> </td> </tr> </table> @@ -283,7 +413,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00125">125</a> <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">string </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="md" nowrap><code> [virtual]</code></td> @@ -305,11 +435,11 @@ 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#l00120">120</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#l00188">188</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00121 { -00122 <span class="keywordflow">return</span> Find(nick); -00123 } +<div class="fragment"><pre>00189 { +00190 <span class="keywordflow">return</span> Find(nick); +00191 } </pre></div> </td> </tr> </table> @@ -342,11 +472,11 @@ 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00146">146</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#l00213">213</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00147 { -00148 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); -00149 } +<div class="fragment"><pre>00214 { +00215 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); +00216 } </pre></div> </td> </tr> </table> @@ -356,7 +486,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00146">146</a> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> string Server::GetNetworkName </td> + <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> @@ -379,11 +509,11 @@ Returns the network name, global to all linked servers. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00141">141</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#l00208">208</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00142 { -00143 <span class="keywordflow">return</span> getnetworkname(); -00144 } +<div class="fragment"><pre>00209 { +00210 <span class="keywordflow">return</span> getnetworkname(); +00211 } </pre></div> </td> </tr> </table> @@ -393,7 +523,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00141">141</a> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> string Server::GetServerName </td> + <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> @@ -416,11 +546,11 @@ 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#l00136">136</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#l00203">203</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00137 { -00138 <span class="keywordflow">return</span> getservername(); -00139 } +<div class="fragment"><pre>00204 { +00205 <span class="keywordflow">return</span> getservername(); +00206 } </pre></div> </td> </tr> </table> @@ -432,7 +562,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00136">136</a> <tr> <td class="md" nowrap valign="top"> bool Server::IsNick </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">string </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="md" nowrap><code> [virtual]</code></td> @@ -454,11 +584,11 @@ 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#l00115">115</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#l00183">183</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00116 { -00117 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0); -00118 } +<div class="fragment"><pre>00184 { +00185 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0); +00186 } </pre></div> </td> </tr> </table> @@ -476,7 +606,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00115">115</a> <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> @@ -501,11 +631,11 @@ 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#l00056">56</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#l00118">118</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00057 { -00058 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); -00059 } +<div class="fragment"><pre>00119 { +00120 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); +00121 } </pre></div> </td> </tr> </table> @@ -523,7 +653,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00056">56</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> @@ -548,11 +678,11 @@ 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#l00061">61</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#l00129">129</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00062 { -00063 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00064 } +<div class="fragment"><pre>00130 { +00131 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00132 } </pre></div> </td> </tr> </table> @@ -576,7 +706,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00061">61</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>s</em>, </td> </tr> <tr> @@ -607,18 +737,18 @@ 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#l00081">81</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00082 { -00083 <span class="keywordflow">if</span> (IncludeSender) -00084 { -00085 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00086 } -00087 <span class="keywordflow">else</span> -00088 { -00089 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00090 } -00091 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00149">149</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00150 { +00151 <span class="keywordflow">if</span> (IncludeSender) +00152 { +00153 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00154 } +00155 <span class="keywordflow">else</span> +00156 { +00157 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00158 } +00159 } </pre></div> </td> </tr> </table> @@ -636,7 +766,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00081">81</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>text</em>, </td> </tr> <tr> @@ -667,18 +797,18 @@ 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#l00098">98</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00099 { -00100 <span class="keywordflow">if</span> (IncludeSender) -00101 { -00102 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00103 } -00104 <span class="keywordflow">else</span> -00105 { -00106 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00107 } -00108 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00166">166</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00167 { +00168 <span class="keywordflow">if</span> (IncludeSender) +00169 { +00170 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00171 } +00172 <span class="keywordflow">else</span> +00173 { +00174 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00175 } +00176 } </pre></div> </td> </tr> </table> @@ -702,7 +832,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00098">98</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> @@ -727,11 +857,11 @@ 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#l00071">71</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#l00139">139</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00072 { -00073 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00074 } +<div class="fragment"><pre>00140 { +00141 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00142 } </pre></div> </td> </tr> </table> @@ -743,7 +873,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00071">71</a> o <tr> <td class="md" nowrap valign="top"> void Server::SendOpers </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">string </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="md" nowrap><code> [virtual]</code></td> @@ -765,11 +895,11 @@ 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#l00051">51</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#l00113">113</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00052 { -00053 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); -00054 } +<div class="fragment"><pre>00114 { +00115 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); +00116 } </pre></div> </td> </tr> </table> @@ -787,7 +917,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00051">51</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> @@ -812,11 +942,11 @@ 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#l00066">66</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#l00134">134</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00067 { -00068 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00069 } +<div class="fragment"><pre>00135 { +00136 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00137 } </pre></div> </td> </tr> </table> @@ -840,7 +970,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00066">66</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>s</em></td> </tr> <tr> @@ -865,11 +995,11 @@ 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) <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00076">76</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#l00144">144</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00077 { -00078 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); -00079 } +<div class="fragment"><pre>00145 { +00146 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); +00147 } </pre></div> </td> </tr> </table> @@ -887,7 +1017,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00076">76</a> o <tr> <td></td> <td></td> - <td class="md" nowrap>string </td> + <td class="md" nowrap>std::string </td> <td class="mdname" nowrap> <em>text</em></td> </tr> <tr> @@ -912,17 +1042,17 @@ 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#l00110">110</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#l00178">178</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00111 { -00112 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00113 } +<div class="fragment"><pre>00179 { +00180 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00181 } </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 Mar 30 19:36:22 2003 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:43 2004 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> |