diff options
Diffstat (limited to 'docs/module-doc/classServer.html')
| -rw-r--r-- | docs/module-doc/classServer.html | 205 |
1 files changed, 104 insertions, 101 deletions
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 0cc7a88d7..6c055c09e 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -3,7 +3,7 @@ <title>Server class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.3-rc2 --> +<!-- Generated by Doxygen 1.3-rc3 --> <center> <a class="qindex" href="main.html">Main Page</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. @@ -11,14 +11,17 @@ <p> <code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code> <p> -<p>Inheritance diagram for Server: -<p><center><img src="classServer.png" usemap="#Server_map" border="0" alt=""></center> -<map name="Server_map"> -<area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,68,24"> +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> -<a href="classServer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<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> <tr><td></td></tr> -<tr><td colspan=2><br><h2>Public Methods</h2></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> @@ -65,7 +68,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#l00113">113</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#l00114">114</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> @@ -95,10 +98,10 @@ Default constructor. <p> Creates a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00042">42</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#l00043">43</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00043 { -00044 } +<div class="fragment"><pre>00044 { +00045 } </pre></div> </td> </tr> </table> @@ -131,10 +134,10 @@ Default destructor. <p> Destroys a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00046">46</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#l00047">47</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00047 { -00048 } +<div class="fragment"><pre>00048 { +00049 } </pre></div> </td> </tr> </table> @@ -178,12 +181,12 @@ 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#l00129">129</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#l00130">130</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00130 { -00131 string mode = cmode(User,Chan); -00132 <span class="keywordflow">return</span> mode; -00133 } +<div class="fragment"><pre>00131 { +00132 string mode = cmode(User,Chan); +00133 <span class="keywordflow">return</span> mode; +00134 } </pre></div> </td> </tr> </table> @@ -226,11 +229,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#l00092">92</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#l00093">93</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00093 { -00094 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0); -00095 } +<div class="fragment"><pre>00094 { +00095 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0); +00096 } </pre></div> </td> </tr> </table> @@ -264,11 +267,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#l00124">124</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#l00125">125</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00125 { -00126 <span class="keywordflow">return</span> FindChan(channel.c_str()); -00127 } +<div class="fragment"><pre>00126 { +00127 <span class="keywordflow">return</span> FindChan(channel.c_str()); +00128 } </pre></div> </td> </tr> </table> @@ -302,11 +305,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#l00119">119</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#l00120">120</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00120 { -00121 <span class="keywordflow">return</span> Find(nick); -00122 } +<div class="fragment"><pre>00121 { +00122 <span class="keywordflow">return</span> Find(nick); +00123 } </pre></div> </td> </tr> </table> @@ -339,11 +342,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#l00145">145</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#l00146">146</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00146 { -00147 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); -00148 } +<div class="fragment"><pre>00147 { +00148 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); +00149 } </pre></div> </td> </tr> </table> @@ -376,11 +379,11 @@ Returns the network name, global to all linked servers. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00140">140</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#l00141">141</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00141 { -00142 <span class="keywordflow">return</span> getnetworkname(); -00143 } +<div class="fragment"><pre>00142 { +00143 <span class="keywordflow">return</span> getnetworkname(); +00144 } </pre></div> </td> </tr> </table> @@ -413,11 +416,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#l00135">135</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#l00136">136</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00136 { -00137 <span class="keywordflow">return</span> getservername(); -00138 } +<div class="fragment"><pre>00137 { +00138 <span class="keywordflow">return</span> getservername(); +00139 } </pre></div> </td> </tr> </table> @@ -451,11 +454,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#l00114">114</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#l00115">115</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00115 { -00116 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0); -00117 } +<div class="fragment"><pre>00116 { +00117 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0); +00118 } </pre></div> </td> </tr> </table> @@ -498,11 +501,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#l00055">55</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#l00056">56</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00056 { -00057 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); -00058 } +<div class="fragment"><pre>00057 { +00058 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); +00059 } </pre></div> </td> </tr> </table> @@ -545,11 +548,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#l00060">60</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#l00061">61</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00061 { -00062 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00063 } +<div class="fragment"><pre>00062 { +00063 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00064 } </pre></div> </td> </tr> </table> @@ -604,18 +607,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#l00080">80</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00081 { -00082 <span class="keywordflow">if</span> (IncludeSender) -00083 { -00084 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00085 } -00086 <span class="keywordflow">else</span> -00087 { -00088 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00089 } -00090 } +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 } </pre></div> </td> </tr> </table> @@ -664,18 +667,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#l00097">97</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00098 { -00099 <span class="keywordflow">if</span> (IncludeSender) -00100 { -00101 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00102 } -00103 <span class="keywordflow">else</span> -00104 { -00105 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00106 } -00107 } +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 } </pre></div> </td> </tr> </table> @@ -724,11 +727,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#l00070">70</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#l00071">71</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00071 { -00072 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00073 } +<div class="fragment"><pre>00072 { +00073 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00074 } </pre></div> </td> </tr> </table> @@ -762,11 +765,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#l00050">50</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#l00051">51</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00051 { -00052 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); -00053 } +<div class="fragment"><pre>00052 { +00053 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); +00054 } </pre></div> </td> </tr> </table> @@ -809,11 +812,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#l00065">65</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#l00066">66</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00066 { -00067 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00068 } +<div class="fragment"><pre>00067 { +00068 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00069 } </pre></div> </td> </tr> </table> @@ -862,11 +865,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#l00075">75</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#l00076">76</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00076 { -00077 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); -00078 } +<div class="fragment"><pre>00077 { +00078 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); +00079 } </pre></div> </td> </tr> </table> @@ -909,19 +912,19 @@ 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#l00109">109</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#l00110">110</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00110 { -00111 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00112 } +<div class="fragment"><pre>00111 { +00112 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00113 } </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 Feb 9 12:48:19 2003 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sun Mar 30 13:29:18 2003 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-rc2 </small></address> +width=110 height=53></a>1.3-rc3 </small></address> </body> </html> |