diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2003-01-23 19:45:57 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2003-01-23 19:45:57 +0000 |
| commit | 73b9d0c5cb02f0ea8350de28bc3687e0af70ea0f (patch) | |
| tree | a5845579b1363762650f0e45c62a13890e1efa43 /docs/module-doc/classServer.html | |
Initial revision
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@132 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classServer.html')
| -rw-r--r-- | docs/module-doc/classServer.html | 913 |
1 files changed, 913 insertions, 0 deletions
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html new file mode 100644 index 000000000..d7a809046 --- /dev/null +++ b/docs/module-doc/classServer.html @@ -0,0 +1,913 @@ +<!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> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3-rc2 --> +<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. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code> +<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 Methods</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> (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">Debug</a> (string s)</td></tr> +<tr><td> </td><td><font size=-1><em>Sends a debug 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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </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> +</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. +<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#l00121">121</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> + <td class="md"> + <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="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Default constructor. +<p> +Creates a Server object. +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00052">52</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00053 { +00054 } +</pre></div> </td> + </tr> +</table> +<a name="a1" doxytag="Server::~Server"></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"> Server::~Server </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> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Default destructor. +<p> +Destroys a Server object. +<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>. +<p> +<div class="fragment"><pre>00057 { +00058 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<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" 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> + </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> + </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> +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#l00139">139</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00140 { +00141 string mode = cmode(User,Chan); +00142 <span class="keywordflow">return</span> mode; +00143 } +</pre></div> </td> + </tr> +</table> +<a name="a9" doxytag="Server::CommonChannels"></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::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> + </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> + </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> +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#l00102">102</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00103 { +00104 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0); +00105 } +</pre></div> </td> + </tr> +</table> +<a name="a3" doxytag="Server::Debug"></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::Debug </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">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> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sends a debug string. +<p> +This method writes a line of text to the debug log. If debugging is disabled in the configuration, this command has no effect. +<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>. +<p> +<div class="fragment"><pre>00066 { +00067 debug(<span class="stringliteral">"%s"</span>,s.c_str()); +00068 } +</pre></div> </td> + </tr> +</table> +<a name="a14" doxytag="Server::FindChannel"></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"> <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="mdname1" valign="top" nowrap> <em>channel</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00134">134</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00135 { +00136 <span class="keywordflow">return</span> FindChan(channel.c_str()); +00137 } +</pre></div> </td> + </tr> +</table> +<a name="a13" doxytag="Server::FindNick"></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"> <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="mdname1" valign="top" nowrap> <em>nick</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00129">129</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00130 { +00131 <span class="keywordflow">return</span> Find(nick); +00132 } +</pre></div> </td> + </tr> +</table> +<a name="a18" doxytag="Server::GetAdmin"></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"> <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="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00155">155</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00156 { +00157 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); +00158 } +</pre></div> </td> + </tr> +</table> +<a name="a17" doxytag="Server::GetNetworkName"></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::GetNetworkName </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> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the network name, global to all linked servers. +<p> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00150">150</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00151 { +00152 <span class="keywordflow">return</span> getnetworkname(); +00153 } +</pre></div> </td> + </tr> +</table> +<a name="a16" doxytag="Server::GetServerName"></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::GetServerName </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> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00145">145</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> getservername(); +00148 } +</pre></div> </td> + </tr> +</table> +<a name="a12" doxytag="Server::IsNick"></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::IsNick </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">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> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00124">124</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> (isnick(nick.c_str()) != 0); +00127 } +</pre></div> </td> + </tr> +</table> +<a name="a4" doxytag="Server::Send"></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::Send </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname" nowrap> <em>Socket</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </td> + <td class="mdname" nowrap> <em>s</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> +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#l00070">70</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00071 { +00072 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00073 } +</pre></div> </td> + </tr> +</table> +<a name="a8" doxytag="Server::SendChannel"></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::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> + </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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </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> + </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> +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#l00090">90</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00091 { +00092 <span class="keywordflow">if</span> (IncludeSender) +00093 { +00094 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00095 } +00096 <span class="keywordflow">else</span> +00097 { +00098 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00099 } +00100 } +</pre></div> </td> + </tr> +</table> +<a name="a10" doxytag="Server::SendCommon"></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::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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </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> + </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> +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#l00107">107</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00108 { +00109 <span class="keywordflow">if</span> (IncludeSender) +00110 { +00111 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00112 } +00113 <span class="keywordflow">else</span> +00114 { +00115 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00116 } +00117 } +</pre></div> </td> + </tr> +</table> +<a name="a6" doxytag="Server::SendFrom"></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::SendFrom </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </td> + <td class="mdname" nowrap> <em>s</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> +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#l00080">80</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00081 { +00082 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00083 } +</pre></div> </td> + </tr> +</table> +<a name="a2" doxytag="Server::SendOpers"></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::SendOpers </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">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> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00060">60</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00061 { +00062 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); +00063 } +</pre></div> </td> + </tr> +</table> +<a name="a5" doxytag="Server::SendServ"></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::SendServ </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname" nowrap> <em>Socket</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </td> + <td class="mdname" nowrap> <em>s</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> +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#l00075">75</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00076 { +00077 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00078 } +</pre></div> </td> + </tr> +</table> +<a name="a7" doxytag="Server::SendTo"></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::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> + </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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </td> + <td class="mdname" nowrap> <em>s</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> +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#l00085">85</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00086 { +00087 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); +00088 } +</pre></div> </td> + </tr> +</table> +<a name="a11" doxytag="Server::SendWallops"></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::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> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>string </td> + <td class="mdname" nowrap> <em>text</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> +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#l00119">119</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00120 { +00121 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00122 } +</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 Wed Jan 22 20:56:48 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> +</body> +</html> |