docs/module-doc/classServer.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>Server class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
   9 <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.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  13 <p>
  14 Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph.gif" border="0" usemap="#Server__inherit__map" alt="Inheritance graph"></center>
  15 <map name="Server__inherit__map">
  16 <area href="classclassbase.html" shape="rect" coords="7,16,73,37" alt="">
  17 </map>
  18 <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>
  19 <map name="Server__coll__map">
  20 <area href="classclassbase.html" shape="rect" coords="7,106,73,128" alt="">
  21 </map>
  22 <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>
  23 <tr><td></td></tr>
  24 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  25 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a0">Server</a> ()</td></tr>
  26 <tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
  27 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a1">~Server</a> ()</td></tr>
  28 <tr><td>&nbsp;</td><td><font size=-1><em>Default destructor.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
  29 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a2">SendOpers</a> (std::string s)</td></tr>
  30 <tr><td>&nbsp;</td><td><font size=-1><em>Sends text to all opers.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
  31 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a3">Log</a> (int level, std::string s)</td></tr>
  32 <tr><td>&nbsp;</td><td><font size=-1><em>Writes a log string.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
  33 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a4">Send</a> (int Socket, std::string s)</td></tr>
  34 <tr><td>&nbsp;</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>
  35 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a5">SendServ</a> (int Socket, std::string s)</td></tr>
  36 <tr><td>&nbsp;</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>
  37 <tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
  38 <tr><td>&nbsp;</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>
  39 <tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
  40 <tr><td>&nbsp;</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>
  41 <tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
  42 <tr><td>&nbsp;</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>
  43 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</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>
  44 <tr><td>&nbsp;</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>
  45 <tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
  46 <tr><td>&nbsp;</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>
  47 <tr><td nowrap align=right valign=top>virtual void&nbsp;</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>
  48 <tr><td>&nbsp;</td><td><font size=-1><em>Sends a WALLOPS message.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
  49 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a12">IsNick</a> (std::string nick)</td></tr>
  50 <tr><td>&nbsp;</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>
  51 <tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a13">CountUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *c)</td></tr>
  52 <tr><td>&nbsp;</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>
  53 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a14">FindNick</a> (std::string nick)</td></tr>
  54 <tr><td>&nbsp;</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>
  55 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a15">FindChannel</a> (std::string channel)</td></tr>
  56 <tr><td>&nbsp;</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>
  57 <tr><td nowrap align=right valign=top>virtual std::string&nbsp;</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>
  58 <tr><td>&nbsp;</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>
  59 <tr><td nowrap align=right valign=top>virtual std::string&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a17">GetServerName</a> ()</td></tr>
  60 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the server name of the server where the module is loaded.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
  61 <tr><td nowrap align=right valign=top>virtual std::string&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a18">GetNetworkName</a> ()</td></tr>
  62 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the network name, global to all linked servers.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
  63 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classAdmin.html">Admin</a>&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a19">GetAdmin</a> ()</td></tr>
  64 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the information of the server as returned by the /ADMIN command.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
  65 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a20">AddExtendedMode</a> (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)</td></tr>
  66 <tr><td>&nbsp;</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="#a20"></a><em></em></font><br><br></td></tr>
  67 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a21">AddCommand</a> (char *cmd, <a class="el" href="ctables_8h.html#a0">handlerfunc</a> f, char flags, int minparams)</td></tr>
  68 <tr><td>&nbsp;</td><td><font size=-1><em>Adds a command to the command table.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
  69 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a22">SendMode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  70 <tr><td>&nbsp;</td><td><font size=-1><em>Sends a servermode.</em> <a href="#a22"></a><em></em></font><br><br></td></tr>
  71 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a23">SendToModeMask</a> (std::string modes, int flags, std::string text)</td></tr>
  72 <tr><td>&nbsp;</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="#a23"></a><em></em></font><br><br></td></tr>
  73 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a24">JoinUserToChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string key)</td></tr>
  74 <tr><td>&nbsp;</td><td><font size=-1><em>Forces a user to join a channel.</em> <a href="#a24"></a><em></em></font><br><br></td></tr>
  75 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a25">PartUserFromChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string reason)</td></tr>
  76 <tr><td>&nbsp;</td><td><font size=-1><em>Forces a user to part a channel.</em> <a href="#a25"></a><em></em></font><br><br></td></tr>
  77 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a26">ChangeUserNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string nickname)</td></tr>
  78 <tr><td>&nbsp;</td><td><font size=-1><em>Forces a user nickchange.</em> <a href="#a26"></a><em></em></font><br><br></td></tr>
  79 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a27">QuitUser</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string reason)</td></tr>
  80 <tr><td>&nbsp;</td><td><font size=-1><em>Forces a user to quit with the specified reason.</em> <a href="#a27"></a><em></em></font><br><br></td></tr>
  81 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a28">MatchText</a> (std::string sliteral, std::string spattern)</td></tr>
  82 <tr><td>&nbsp;</td><td><font size=-1><em>Matches text against a glob pattern.</em> <a href="#a28"></a><em></em></font><br><br></td></tr>
  83 </table>
  84 <hr><a name="_details"></a><h2>Detailed Description</h2>
  85 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.
  86 <p>
  87 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
  88 <p>
  89
  90 <p>
  91 Definition at line <a class="el" href="modules_8h-source.html#l00240">240</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  92 <a name="a0" doxytag="Server::Server"></a><p>
  93 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  94   <tr>
  95     <td class="md">
  96       <table cellpadding="0" cellspacing="0" border="0">
  97         <tr>
  98           <td class="md" nowrap valign="top"> Server::Server </td>
  99           <td class="md" valign="top">(&nbsp;</td>
 100           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 101           <td class="md" valign="top">)&nbsp;</td>
 102           <td class="md" nowrap></td>
 103         </tr>
 104
 105       </table>
 106     </td>
 107   </tr>
 108 </table>
 109 <table cellspacing=5 cellpadding=0 border=0>
 110   <tr>
 111     <td>
 112       &nbsp;
 113     </td>
 114     <td>
 115
 116 <p>
 117 Default constructor.
 118 <p>
 119 Creates a Server object.
 120 <p>
 121 Definition at line <a class="el" href="modules_8cpp-source.html#l00131">131</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 122 <p>
 123 <div class="fragment"><pre>00132 {
 124 00133 }
 125 </pre></div>    </td>
 126   </tr>
 127 </table>
 128 <a name="a1" doxytag="Server::~Server"></a><p>
 129 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 130   <tr>
 131     <td class="md">
 132       <table cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td class="md" nowrap valign="top"> Server::~Server </td>
 135           <td class="md" valign="top">(&nbsp;</td>
 136           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 137           <td class="md" valign="top">)&nbsp;</td>
 138           <td class="md" nowrap><code> [virtual]</code></td>
 139         </tr>
 140
 141       </table>
 142     </td>
 143   </tr>
 144 </table>
 145 <table cellspacing=5 cellpadding=0 border=0>
 146   <tr>
 147     <td>
 148       &nbsp;
 149     </td>
 150     <td>
 151
 152 <p>
 153 Default destructor.
 154 <p>
 155 Destroys a Server object.
 156 <p>
 157 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>.
 158 <p>
 159 <div class="fragment"><pre>00136 {
 160 00137 }
 161 </pre></div>    </td>
 162   </tr>
 163 </table>
 164 <hr><h2>Member Function Documentation</h2>
 165 <a name="a21" doxytag="Server::AddCommand"></a><p>
 166 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 167   <tr>
 168     <td class="md">
 169       <table cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <td class="md" nowrap valign="top"> void Server::AddCommand </td>
 172           <td class="md" valign="top">(&nbsp;</td>
 173           <td class="md" nowrap valign="top">char *&nbsp;</td>
 174           <td class="mdname" nowrap>&nbsp; <em>cmd</em>, </td>
 175         </tr>
 176         <tr>
 177           <td></td>
 178           <td></td>
 179           <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a>&nbsp;</td>
 180           <td class="mdname" nowrap>&nbsp; <em>f</em>, </td>
 181         </tr>
 182         <tr>
 183           <td></td>
 184           <td></td>
 185           <td class="md" nowrap>char&nbsp;</td>
 186           <td class="mdname" nowrap>&nbsp; <em>flags</em>, </td>
 187         </tr>
 188         <tr>
 189           <td></td>
 190           <td></td>
 191           <td class="md" nowrap>int&nbsp;</td>
 192           <td class="mdname" nowrap>&nbsp; <em>minparams</em></td>
 193         </tr>
 194         <tr>
 195           <td></td>
 196           <td class="md">)&nbsp;</td>
 197           <td class="md" colspan="2"><code> [virtual]</code></td>
 198         </tr>
 199
 200       </table>
 201     </td>
 202   </tr>
 203 </table>
 204 <table cellspacing=5 cellpadding=0 border=0>
 205   <tr>
 206     <td>
 207       &nbsp;
 208     </td>
 209     <td>
 210
 211 <p>
 212 Adds a command to the command table.
 213 <p>
 214 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>
 215 typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)<p>
 216 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'.
 217 <p>
 218 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>.
 219 <p>
 220 References <a class="el" href="modules_8h.html#a13">createcommand()</a>.
 221 <p>
 222 <div class="fragment"><pre>00184 {
 223 00185         <a class="code" href="modules_8h.html#a13">createcommand</a>(cmd,f,flags,minparams);
 224 00186 }
 225 </pre></div>    </td>
 226   </tr>
 227 </table>
 228 <a name="a20" doxytag="Server::AddExtendedMode"></a><p>
 229 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 230   <tr>
 231     <td class="md">
 232       <table cellpadding="0" cellspacing="0" border="0">
 233         <tr>
 234           <td class="md" nowrap valign="top"> bool Server::AddExtendedMode </td>
 235           <td class="md" valign="top">(&nbsp;</td>
 236           <td class="md" nowrap valign="top">char&nbsp;</td>
 237           <td class="mdname" nowrap>&nbsp; <em>modechar</em>, </td>
 238         </tr>
 239         <tr>
 240           <td></td>
 241           <td></td>
 242           <td class="md" nowrap>int&nbsp;</td>
 243           <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
 244         </tr>
 245         <tr>
 246           <td></td>
 247           <td></td>
 248           <td class="md" nowrap>bool&nbsp;</td>
 249           <td class="mdname" nowrap>&nbsp; <em>requires_oper</em>, </td>
 250         </tr>
 251         <tr>
 252           <td></td>
 253           <td></td>
 254           <td class="md" nowrap>int&nbsp;</td>
 255           <td class="mdname" nowrap>&nbsp; <em>params_when_on</em>, </td>
 256         </tr>
 257         <tr>
 258           <td></td>
 259           <td></td>
 260           <td class="md" nowrap>int&nbsp;</td>
 261           <td class="mdname" nowrap>&nbsp; <em>params_when_off</em></td>
 262         </tr>
 263         <tr>
 264           <td></td>
 265           <td class="md">)&nbsp;</td>
 266           <td class="md" colspan="2"><code> [virtual]</code></td>
 267         </tr>
 268
 269       </table>
 270     </td>
 271   </tr>
 272 </table>
 273 <table cellspacing=5 cellpadding=0 border=0>
 274   <tr>
 275     <td>
 276       &nbsp;
 277     </td>
 278     <td>
 279
 280 <p>
 281 Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.
 282 <p>
 283 +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.
 284 <p>
 285 Definition at line <a class="el" href="modules_8cpp-source.html#l00293">293</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 286 <p>
 287 References <a class="el" href="modules_8cpp-source.html#l00090">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00018">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00019">MT_SERVER</a>.
 288 <p>
 289 <div class="fragment"><pre>00294 {
 290 00295         <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#a7">MT_SERVER</a>)
 291 00296         {
 292 00297                 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>);
 293 00298                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
 294 00299         }
 295 00300         <span class="keywordflow">if</span> (((params_when_on&gt;0) || (params_when_off&gt;0)) &amp;&amp; (type == <a class="code" href="modules_8h.html#a6">MT_CLIENT</a>))
 296 00301         {
 297 00302                 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>);
 298 00303                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
 299 00304         }
 300 00305         <span class="keywordflow">if</span> ((params_when_on&gt;1) || (params_when_off&gt;1))
 301 00306         {
 302 00307                 log(DEBUG,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>);
 303 00308                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
 304 00309         }
 305 00310         <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a8">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off);
 306 00311 }
 307 </pre></div>    </td>
 308   </tr>
 309 </table>
 310 <a name="a26" doxytag="Server::ChangeUserNick"></a><p>
 311 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 312   <tr>
 313     <td class="md">
 314       <table cellpadding="0" cellspacing="0" border="0">
 315         <tr>
 316           <td class="md" nowrap valign="top"> void Server::ChangeUserNick </td>
 317           <td class="md" valign="top">(&nbsp;</td>
 318           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 319           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 320         </tr>
 321         <tr>
 322           <td></td>
 323           <td></td>
 324           <td class="md" nowrap>std::string&nbsp;</td>
 325           <td class="mdname" nowrap>&nbsp; <em>nickname</em></td>
 326         </tr>
 327         <tr>
 328           <td></td>
 329           <td class="md">)&nbsp;</td>
 330           <td class="md" colspan="2"><code> [virtual]</code></td>
 331         </tr>
 332
 333       </table>
 334     </td>
 335   </tr>
 336 </table>
 337 <table cellspacing=5 cellpadding=0 border=0>
 338   <tr>
 339     <td>
 340       &nbsp;
 341     </td>
 342     <td>
 343
 344 <p>
 345 Forces a user nickchange.
 346 <p>
 347 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.
 348 <p>
 349 Definition at line <a class="el" href="modules_8cpp-source.html#l00167">167</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 350 <p>
 351 <div class="fragment"><pre>00168 {
 352 00169         force_nickchange(user,nickname.c_str());
 353 00170 }
 354 </pre></div>    </td>
 355   </tr>
 356 </table>
 357 <a name="a16" doxytag="Server::ChanMode"></a><p>
 358 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 359   <tr>
 360     <td class="md">
 361       <table cellpadding="0" cellspacing="0" border="0">
 362         <tr>
 363           <td class="md" nowrap valign="top"> std::string Server::ChanMode </td>
 364           <td class="md" valign="top">(&nbsp;</td>
 365           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 366           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 367         </tr>
 368         <tr>
 369           <td></td>
 370           <td></td>
 371           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 372           <td class="mdname" nowrap>&nbsp; <em>Chan</em></td>
 373         </tr>
 374         <tr>
 375           <td></td>
 376           <td class="md">)&nbsp;</td>
 377           <td class="md" colspan="2"><code> [virtual]</code></td>
 378         </tr>
 379
 380       </table>
 381     </td>
 382   </tr>
 383 </table>
 384 <table cellspacing=5 cellpadding=0 border=0>
 385   <tr>
 386     <td>
 387       &nbsp;
 388     </td>
 389     <td>
 390
 391 <p>
 392 Attempts to look up a user's privilages on a channel.
 393 <p>
 394 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
 395 <p>
 396 Definition at line <a class="el" href="modules_8cpp-source.html#l00271">271</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 397 <p>
 398 <div class="fragment"><pre>00272 {
 399 00273         <span class="keywordflow">return</span> cmode(User,Chan);
 400 00274 }
 401 </pre></div>    </td>
 402   </tr>
 403 </table>
 404 <a name="a9" doxytag="Server::CommonChannels"></a><p>
 405 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 406   <tr>
 407     <td class="md">
 408       <table cellpadding="0" cellspacing="0" border="0">
 409         <tr>
 410           <td class="md" nowrap valign="top"> bool Server::CommonChannels </td>
 411           <td class="md" valign="top">(&nbsp;</td>
 412           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 413           <td class="mdname" nowrap>&nbsp; <em>u1</em>, </td>
 414         </tr>
 415         <tr>
 416           <td></td>
 417           <td></td>
 418           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 419           <td class="mdname" nowrap>&nbsp; <em>u2</em></td>
 420         </tr>
 421         <tr>
 422           <td></td>
 423           <td class="md">)&nbsp;</td>
 424           <td class="md" colspan="2"><code> [virtual]</code></td>
 425         </tr>
 426
 427       </table>
 428     </td>
 429   </tr>
 430 </table>
 431 <table cellspacing=5 cellpadding=0 border=0>
 432   <tr>
 433     <td>
 434       &nbsp;
 435     </td>
 436     <td>
 437
 438 <p>
 439 Returns true if two users share a common channel.
 440 <p>
 441 This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#a10">Server::SendCommon</a> method.
 442 <p>
 443 Definition at line <a class="el" href="modules_8cpp-source.html#l00234">234</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 444 <p>
 445 <div class="fragment"><pre>00235 {
 446 00236         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
 447 00237 }
 448 </pre></div>    </td>
 449   </tr>
 450 </table>
 451 <a name="a13" doxytag="Server::CountUsers"></a><p>
 452 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 453   <tr>
 454     <td class="md">
 455       <table cellpadding="0" cellspacing="0" border="0">
 456         <tr>
 457           <td class="md" nowrap valign="top"> int Server::CountUsers </td>
 458           <td class="md" valign="top">(&nbsp;</td>
 459           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 460           <td class="mdname1" valign="top" nowrap>&nbsp; <em>c</em>          </td>
 461           <td class="md" valign="top">)&nbsp;</td>
 462           <td class="md" nowrap><code> [virtual]</code></td>
 463         </tr>
 464
 465       </table>
 466     </td>
 467   </tr>
 468 </table>
 469 <table cellspacing=5 cellpadding=0 border=0>
 470   <tr>
 471     <td>
 472       &nbsp;
 473     </td>
 474     <td>
 475
 476 <p>
 477 Returns a count of the number of users on a channel.
 478 <p>
 479 This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
 480 <p>
 481 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>.
 482 <p>
 483 <div class="fragment"><pre>00314 {
 484 00315         <span class="keywordflow">return</span> usercount(c);
 485 00316 }
 486 </pre></div>    </td>
 487   </tr>
 488 </table>
 489 <a name="a15" doxytag="Server::FindChannel"></a><p>
 490 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 491   <tr>
 492     <td class="md">
 493       <table cellpadding="0" cellspacing="0" border="0">
 494         <tr>
 495           <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td>
 496           <td class="md" valign="top">(&nbsp;</td>
 497           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 498           <td class="mdname1" valign="top" nowrap>&nbsp; <em>channel</em>          </td>
 499           <td class="md" valign="top">)&nbsp;</td>
 500           <td class="md" nowrap><code> [virtual]</code></td>
 501         </tr>
 502
 503       </table>
 504     </td>
 505   </tr>
 506 </table>
 507 <table cellspacing=5 cellpadding=0 border=0>
 508   <tr>
 509     <td>
 510       &nbsp;
 511     </td>
 512     <td>
 513
 514 <p>
 515 Attempts to look up a channel and return a pointer to it.
 516 <p>
 517 This function will return NULL if the channel does not exist.
 518 <p>
 519 Definition at line <a class="el" href="modules_8cpp-source.html#l00266">266</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 520 <p>
 521 <div class="fragment"><pre>00267 {
 522 00268         <span class="keywordflow">return</span> FindChan(channel.c_str());
 523 00269 }
 524 </pre></div>    </td>
 525   </tr>
 526 </table>
 527 <a name="a14" doxytag="Server::FindNick"></a><p>
 528 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 529   <tr>
 530     <td class="md">
 531       <table cellpadding="0" cellspacing="0" border="0">
 532         <tr>
 533           <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td>
 534           <td class="md" valign="top">(&nbsp;</td>
 535           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 536           <td class="mdname1" valign="top" nowrap>&nbsp; <em>nick</em>          </td>
 537           <td class="md" valign="top">)&nbsp;</td>
 538           <td class="md" nowrap><code> [virtual]</code></td>
 539         </tr>
 540
 541       </table>
 542     </td>
 543   </tr>
 544 </table>
 545 <table cellspacing=5 cellpadding=0 border=0>
 546   <tr>
 547     <td>
 548       &nbsp;
 549     </td>
 550     <td>
 551
 552 <p>
 553 Attempts to look up a nick and return a pointer to it.
 554 <p>
 555 This function will return NULL if the nick does not exist.
 556 <p>
 557 Definition at line <a class="el" href="modules_8cpp-source.html#l00261">261</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 558 <p>
 559 <div class="fragment"><pre>00262 {
 560 00263         <span class="keywordflow">return</span> Find(nick);
 561 00264 }
 562 </pre></div>    </td>
 563   </tr>
 564 </table>
 565 <a name="a19" doxytag="Server::GetAdmin"></a><p>
 566 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 567   <tr>
 568     <td class="md">
 569       <table cellpadding="0" cellspacing="0" border="0">
 570         <tr>
 571           <td class="md" nowrap valign="top"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td>
 572           <td class="md" valign="top">(&nbsp;</td>
 573           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 574           <td class="md" valign="top">)&nbsp;</td>
 575           <td class="md" nowrap><code> [virtual]</code></td>
 576         </tr>
 577
 578       </table>
 579     </td>
 580   </tr>
 581 </table>
 582 <table cellspacing=5 cellpadding=0 border=0>
 583   <tr>
 584     <td>
 585       &nbsp;
 586     </td>
 587     <td>
 588
 589 <p>
 590 Returns the information of the server as returned by the /ADMIN command.
 591 <p>
 592 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.
 593 <p>
 594 Definition at line <a class="el" href="modules_8cpp-source.html#l00286">286</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 595 <p>
 596 <div class="fragment"><pre>00287 {
 597 00288         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
 598 00289 }
 599 </pre></div>    </td>
 600   </tr>
 601 </table>
 602 <a name="a18" doxytag="Server::GetNetworkName"></a><p>
 603 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 604   <tr>
 605     <td class="md">
 606       <table cellpadding="0" cellspacing="0" border="0">
 607         <tr>
 608           <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td>
 609           <td class="md" valign="top">(&nbsp;</td>
 610           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 611           <td class="md" valign="top">)&nbsp;</td>
 612           <td class="md" nowrap><code> [virtual]</code></td>
 613         </tr>
 614
 615       </table>
 616     </td>
 617   </tr>
 618 </table>
 619 <table cellspacing=5 cellpadding=0 border=0>
 620   <tr>
 621     <td>
 622       &nbsp;
 623     </td>
 624     <td>
 625
 626 <p>
 627 Returns the network name, global to all linked servers.
 628 <p>
 629
 630 <p>
 631 Definition at line <a class="el" href="modules_8cpp-source.html#l00281">281</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 632 <p>
 633 <div class="fragment"><pre>00282 {
 634 00283         <span class="keywordflow">return</span> getnetworkname();
 635 00284 }
 636 </pre></div>    </td>
 637   </tr>
 638 </table>
 639 <a name="a17" doxytag="Server::GetServerName"></a><p>
 640 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 641   <tr>
 642     <td class="md">
 643       <table cellpadding="0" cellspacing="0" border="0">
 644         <tr>
 645           <td class="md" nowrap valign="top"> std::string Server::GetServerName </td>
 646           <td class="md" valign="top">(&nbsp;</td>
 647           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 648           <td class="md" valign="top">)&nbsp;</td>
 649           <td class="md" nowrap><code> [virtual]</code></td>
 650         </tr>
 651
 652       </table>
 653     </td>
 654   </tr>
 655 </table>
 656 <table cellspacing=5 cellpadding=0 border=0>
 657   <tr>
 658     <td>
 659       &nbsp;
 660     </td>
 661     <td>
 662
 663 <p>
 664 Returns the server name of the server where the module is loaded.
 665 <p>
 666
 667 <p>
 668 Definition at line <a class="el" href="modules_8cpp-source.html#l00276">276</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 669 <p>
 670 <div class="fragment"><pre>00277 {
 671 00278         <span class="keywordflow">return</span> getservername();
 672 00279 }
 673 </pre></div>    </td>
 674   </tr>
 675 </table>
 676 <a name="a12" doxytag="Server::IsNick"></a><p>
 677 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 678   <tr>
 679     <td class="md">
 680       <table cellpadding="0" cellspacing="0" border="0">
 681         <tr>
 682           <td class="md" nowrap valign="top"> bool Server::IsNick </td>
 683           <td class="md" valign="top">(&nbsp;</td>
 684           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 685           <td class="mdname1" valign="top" nowrap>&nbsp; <em>nick</em>          </td>
 686           <td class="md" valign="top">)&nbsp;</td>
 687           <td class="md" nowrap><code> [virtual]</code></td>
 688         </tr>
 689
 690       </table>
 691     </td>
 692   </tr>
 693 </table>
 694 <table cellspacing=5 cellpadding=0 border=0>
 695   <tr>
 696     <td>
 697       &nbsp;
 698     </td>
 699     <td>
 700
 701 <p>
 702 Returns true if a nick is valid.
 703 <p>
 704 Nicks for unregistered connections will return false.
 705 <p>
 706 Definition at line <a class="el" href="modules_8cpp-source.html#l00256">256</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 707 <p>
 708 <div class="fragment"><pre>00257 {
 709 00258         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
 710 00259 }
 711 </pre></div>    </td>
 712   </tr>
 713 </table>
 714 <a name="a24" doxytag="Server::JoinUserToChannel"></a><p>
 715 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 716   <tr>
 717     <td class="md">
 718       <table cellpadding="0" cellspacing="0" border="0">
 719         <tr>
 720           <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::JoinUserToChannel </td>
 721           <td class="md" valign="top">(&nbsp;</td>
 722           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 723           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 724         </tr>
 725         <tr>
 726           <td></td>
 727           <td></td>
 728           <td class="md" nowrap>std::string&nbsp;</td>
 729           <td class="mdname" nowrap>&nbsp; <em>cname</em>, </td>
 730         </tr>
 731         <tr>
 732           <td></td>
 733           <td></td>
 734           <td class="md" nowrap>std::string&nbsp;</td>
 735           <td class="mdname" nowrap>&nbsp; <em>key</em></td>
 736         </tr>
 737         <tr>
 738           <td></td>
 739           <td class="md">)&nbsp;</td>
 740           <td class="md" colspan="2"><code> [virtual]</code></td>
 741         </tr>
 742
 743       </table>
 744     </td>
 745   </tr>
 746 </table>
 747 <table cellspacing=5 cellpadding=0 border=0>
 748   <tr>
 749     <td>
 750       &nbsp;
 751     </td>
 752     <td>
 753
 754 <p>
 755 Forces a user to join a channel.
 756 <p>
 757 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.
 758 <p>
 759 Definition at line <a class="el" href="modules_8cpp-source.html#l00157">157</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 760 <p>
 761 <div class="fragment"><pre>00158 {
 762 00159         <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str());
 763 00160 }
 764 </pre></div>    </td>
 765   </tr>
 766 </table>
 767 <a name="a3" doxytag="Server::Log"></a><p>
 768 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 769   <tr>
 770     <td class="md">
 771       <table cellpadding="0" cellspacing="0" border="0">
 772         <tr>
 773           <td class="md" nowrap valign="top"> void Server::Log </td>
 774           <td class="md" valign="top">(&nbsp;</td>
 775           <td class="md" nowrap valign="top">int&nbsp;</td>
 776           <td class="mdname" nowrap>&nbsp; <em>level</em>, </td>
 777         </tr>
 778         <tr>
 779           <td></td>
 780           <td></td>
 781           <td class="md" nowrap>std::string&nbsp;</td>
 782           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 783         </tr>
 784         <tr>
 785           <td></td>
 786           <td class="md">)&nbsp;</td>
 787           <td class="md" colspan="2"><code> [virtual]</code></td>
 788         </tr>
 789
 790       </table>
 791     </td>
 792   </tr>
 793 </table>
 794 <table cellspacing=5 cellpadding=0 border=0>
 795   <tr>
 796     <td>
 797       &nbsp;
 798     </td>
 799     <td>
 800
 801 <p>
 802 Writes a log string.
 803 <p>
 804 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.
 805 <p>
 806 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>.
 807 <p>
 808 <div class="fragment"><pre>00179 {
 809 00180         log(level,<span class="stringliteral">"%s"</span>,s.c_str());
 810 00181 }
 811 </pre></div>    </td>
 812   </tr>
 813 </table>
 814 <a name="a28" doxytag="Server::MatchText"></a><p>
 815 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 816   <tr>
 817     <td class="md">
 818       <table cellpadding="0" cellspacing="0" border="0">
 819         <tr>
 820           <td class="md" nowrap valign="top"> bool Server::MatchText </td>
 821           <td class="md" valign="top">(&nbsp;</td>
 822           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 823           <td class="mdname" nowrap>&nbsp; <em>sliteral</em>, </td>
 824         </tr>
 825         <tr>
 826           <td></td>
 827           <td></td>
 828           <td class="md" nowrap>std::string&nbsp;</td>
 829           <td class="mdname" nowrap>&nbsp; <em>spattern</em></td>
 830         </tr>
 831         <tr>
 832           <td></td>
 833           <td class="md">)&nbsp;</td>
 834           <td class="md" colspan="2"><code> [virtual]</code></td>
 835         </tr>
 836
 837       </table>
 838     </td>
 839   </tr>
 840 </table>
 841 <table cellspacing=5 cellpadding=0 border=0>
 842   <tr>
 843     <td>
 844       &nbsp;
 845     </td>
 846     <td>
 847
 848 <p>
 849 Matches text against a glob pattern.
 850 <p>
 851 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.
 852 <p>
 853 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>.
 854 <p>
 855 <div class="fragment"><pre>00145 {
 856 00146         <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF];
 857 00147         strncpy(literal,sliteral.c_str(),MAXBUF);
 858 00148         strncpy(pattern,spattern.c_str(),MAXBUF);
 859 00149         <span class="keywordflow">return</span> match(literal,pattern);
 860 00150 }
 861 </pre></div>    </td>
 862   </tr>
 863 </table>
 864 <a name="a25" doxytag="Server::PartUserFromChannel"></a><p>
 865 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 866   <tr>
 867     <td class="md">
 868       <table cellpadding="0" cellspacing="0" border="0">
 869         <tr>
 870           <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::PartUserFromChannel </td>
 871           <td class="md" valign="top">(&nbsp;</td>
 872           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 873           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 874         </tr>
 875         <tr>
 876           <td></td>
 877           <td></td>
 878           <td class="md" nowrap>std::string&nbsp;</td>
 879           <td class="mdname" nowrap>&nbsp; <em>cname</em>, </td>
 880         </tr>
 881         <tr>
 882           <td></td>
 883           <td></td>
 884           <td class="md" nowrap>std::string&nbsp;</td>
 885           <td class="mdname" nowrap>&nbsp; <em>reason</em></td>
 886         </tr>
 887         <tr>
 888           <td></td>
 889           <td class="md">)&nbsp;</td>
 890           <td class="md" colspan="2"><code> [virtual]</code></td>
 891         </tr>
 892
 893       </table>
 894     </td>
 895   </tr>
 896 </table>
 897 <table cellspacing=5 cellpadding=0 border=0>
 898   <tr>
 899     <td>
 900       &nbsp;
 901     </td>
 902     <td>
 903
 904 <p>
 905 Forces a user to part a channel.
 906 <p>
 907 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.
 908 <p>
 909 Definition at line <a class="el" href="modules_8cpp-source.html#l00162">162</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 910 <p>
 911 <div class="fragment"><pre>00163 {
 912 00164         <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str());
 913 00165 }
 914 </pre></div>    </td>
 915   </tr>
 916 </table>
 917 <a name="a27" doxytag="Server::QuitUser"></a><p>
 918 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 919   <tr>
 920     <td class="md">
 921       <table cellpadding="0" cellspacing="0" border="0">
 922         <tr>
 923           <td class="md" nowrap valign="top"> void Server::QuitUser </td>
 924           <td class="md" valign="top">(&nbsp;</td>
 925           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 926           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 927         </tr>
 928         <tr>
 929           <td></td>
 930           <td></td>
 931           <td class="md" nowrap>std::string&nbsp;</td>
 932           <td class="mdname" nowrap>&nbsp; <em>reason</em></td>
 933         </tr>
 934         <tr>
 935           <td></td>
 936           <td class="md">)&nbsp;</td>
 937           <td class="md" colspan="2"><code> [virtual]</code></td>
 938         </tr>
 939
 940       </table>
 941     </td>
 942   </tr>
 943 </table>
 944 <table cellspacing=5 cellpadding=0 border=0>
 945   <tr>
 946     <td>
 947       &nbsp;
 948     </td>
 949     <td>
 950
 951 <p>
 952 Forces a user to quit with the specified reason.
 953 <p>
 954 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>
 955 WARNING!<p>
 956 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.
 957 <p>
 958 Definition at line <a class="el" href="modules_8cpp-source.html#l00172">172</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 959 <p>
 960 <div class="fragment"><pre>00173 {
 961 00174         kill_link(user,reason.c_str());
 962 00175 }
 963 </pre></div>    </td>
 964   </tr>
 965 </table>
 966 <a name="a4" doxytag="Server::Send"></a><p>
 967 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 968   <tr>
 969     <td class="md">
 970       <table cellpadding="0" cellspacing="0" border="0">
 971         <tr>
 972           <td class="md" nowrap valign="top"> void Server::Send </td>
 973           <td class="md" valign="top">(&nbsp;</td>
 974           <td class="md" nowrap valign="top">int&nbsp;</td>
 975           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
 976         </tr>
 977         <tr>
 978           <td></td>
 979           <td></td>
 980           <td class="md" nowrap>std::string&nbsp;</td>
 981           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 982         </tr>
 983         <tr>
 984           <td></td>
 985           <td class="md">)&nbsp;</td>
 986           <td class="md" colspan="2"><code> [virtual]</code></td>
 987         </tr>
 988
 989       </table>
 990     </td>
 991   </tr>
 992 </table>
 993 <table cellspacing=5 cellpadding=0 border=0>
 994   <tr>
 995     <td>
 996       &nbsp;
 997     </td>
 998     <td>
 999
1000 <p>
1001 Sends a line of text down a TCP/IP socket.
1002 <p>
1003 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
1004 <p>
1005 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>.
1006 <p>
1007 <div class="fragment"><pre>00194 {
1008 00195         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1009 00196 }
1010 </pre></div>    </td>
1011   </tr>
1012 </table>
1013 <a name="a8" doxytag="Server::SendChannel"></a><p>
1014 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1015   <tr>
1016     <td class="md">
1017       <table cellpadding="0" cellspacing="0" border="0">
1018         <tr>
1019           <td class="md" nowrap valign="top"> void Server::SendChannel </td>
1020           <td class="md" valign="top">(&nbsp;</td>
1021           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1022           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
1023         </tr>
1024         <tr>
1025           <td></td>
1026           <td></td>
1027           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1028           <td class="mdname" nowrap>&nbsp; <em>Channel</em>, </td>
1029         </tr>
1030         <tr>
1031           <td></td>
1032           <td></td>
1033           <td class="md" nowrap>std::string&nbsp;</td>
1034           <td class="mdname" nowrap>&nbsp; <em>s</em>, </td>
1035         </tr>
1036         <tr>
1037           <td></td>
1038           <td></td>
1039           <td class="md" nowrap>bool&nbsp;</td>
1040           <td class="mdname" nowrap>&nbsp; <em>IncludeSender</em></td>
1041         </tr>
1042         <tr>
1043           <td></td>
1044           <td class="md">)&nbsp;</td>
1045           <td class="md" colspan="2"><code> [virtual]</code></td>
1046         </tr>
1047
1048       </table>
1049     </td>
1050   </tr>
1051 </table>
1052 <table cellspacing=5 cellpadding=0 border=0>
1053   <tr>
1054     <td>
1055       &nbsp;
1056     </td>
1057     <td>
1058
1059 <p>
1060 Sends text from a user to a channel (mulicast).
1061 <p>
1062 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).
1063 <p>
1064 Definition at line <a class="el" href="modules_8cpp-source.html#l00222">222</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1065 <p>
1066 <div class="fragment"><pre>00223 {
1067 00224         <span class="keywordflow">if</span> (IncludeSender)
1068 00225         {
1069 00226                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
1070 00227         }
1071 00228         <span class="keywordflow">else</span>
1072 00229         {
1073 00230                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
1074 00231         }
1075 00232 }
1076 </pre></div>    </td>
1077   </tr>
1078 </table>
1079 <a name="a10" doxytag="Server::SendCommon"></a><p>
1080 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1081   <tr>
1082     <td class="md">
1083       <table cellpadding="0" cellspacing="0" border="0">
1084         <tr>
1085           <td class="md" nowrap valign="top"> void Server::SendCommon </td>
1086           <td class="md" valign="top">(&nbsp;</td>
1087           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1088           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
1089         </tr>
1090         <tr>
1091           <td></td>
1092           <td></td>
1093           <td class="md" nowrap>std::string&nbsp;</td>
1094           <td class="mdname" nowrap>&nbsp; <em>text</em>, </td>
1095         </tr>
1096         <tr>
1097           <td></td>
1098           <td></td>
1099           <td class="md" nowrap>bool&nbsp;</td>
1100           <td class="mdname" nowrap>&nbsp; <em>IncludeSender</em></td>
1101         </tr>
1102         <tr>
1103           <td></td>
1104           <td class="md">)&nbsp;</td>
1105           <td class="md" colspan="2"><code> [virtual]</code></td>
1106         </tr>
1107
1108       </table>
1109     </td>
1110   </tr>
1111 </table>
1112 <table cellspacing=5 cellpadding=0 border=0>
1113   <tr>
1114     <td>
1115       &nbsp;
1116     </td>
1117     <td>
1118
1119 <p>
1120 Sends text from a user to one or more channels (mulicast).
1121 <p>
1122 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.
1123 <p>
1124 Definition at line <a class="el" href="modules_8cpp-source.html#l00239">239</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1125 <p>
1126 <div class="fragment"><pre>00240 {
1127 00241         <span class="keywordflow">if</span> (IncludeSender)
1128 00242         {
1129 00243                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
1130 00244         }
1131 00245         <span class="keywordflow">else</span>
1132 00246         {
1133 00247                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
1134 00248         }
1135 00249 }
1136 </pre></div>    </td>
1137   </tr>
1138 </table>
1139 <a name="a6" doxytag="Server::SendFrom"></a><p>
1140 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1141   <tr>
1142     <td class="md">
1143       <table cellpadding="0" cellspacing="0" border="0">
1144         <tr>
1145           <td class="md" nowrap valign="top"> void Server::SendFrom </td>
1146           <td class="md" valign="top">(&nbsp;</td>
1147           <td class="md" nowrap valign="top">int&nbsp;</td>
1148           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
1149         </tr>
1150         <tr>
1151           <td></td>
1152           <td></td>
1153           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1154           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
1155         </tr>
1156         <tr>
1157           <td></td>
1158           <td></td>
1159           <td class="md" nowrap>std::string&nbsp;</td>
1160           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
1161         </tr>
1162         <tr>
1163           <td></td>
1164           <td class="md">)&nbsp;</td>
1165           <td class="md" colspan="2"><code> [virtual]</code></td>
1166         </tr>
1167
1168       </table>
1169     </td>
1170   </tr>
1171 </table>
1172 <table cellspacing=5 cellpadding=0 border=0>
1173   <tr>
1174     <td>
1175       &nbsp;
1176     </td>
1177     <td>
1178
1179 <p>
1180 Sends text from a user to a socket.
1181 <p>
1182 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)
1183 <p>
1184 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>.
1185 <p>
1186 <div class="fragment"><pre>00204 {
1187 00205         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
1188 00206 }
1189 </pre></div>    </td>
1190   </tr>
1191 </table>
1192 <a name="a22" doxytag="Server::SendMode"></a><p>
1193 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1194   <tr>
1195     <td class="md">
1196       <table cellpadding="0" cellspacing="0" border="0">
1197         <tr>
1198           <td class="md" nowrap valign="top"> void Server::SendMode </td>
1199           <td class="md" valign="top">(&nbsp;</td>
1200           <td class="md" nowrap valign="top">char **&nbsp;</td>
1201           <td class="mdname" nowrap>&nbsp; <em>parameters</em>, </td>
1202         </tr>
1203         <tr>
1204           <td></td>
1205           <td></td>
1206           <td class="md" nowrap>int&nbsp;</td>
1207           <td class="mdname" nowrap>&nbsp; <em>pcnt</em>, </td>
1208         </tr>
1209         <tr>
1210           <td></td>
1211           <td></td>
1212           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1213           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
1214         </tr>
1215         <tr>
1216           <td></td>
1217           <td class="md">)&nbsp;</td>
1218           <td class="md" colspan="2"><code> [virtual]</code></td>
1219         </tr>
1220
1221       </table>
1222     </td>
1223   </tr>
1224 </table>
1225 <table cellspacing=5 cellpadding=0 border=0>
1226   <tr>
1227     <td>
1228       &nbsp;
1229     </td>
1230     <td>
1231
1232 <p>
1233 Sends a servermode.
1234 <p>
1235 you must format the parameters array with the target, modes and parameters for those modes.<p>
1236 For example:<p>
1237 char *modes[3];<p>
1238 modes[0] = ChannelName;<p>
1239 modes[1] = "+o";<p>
1240 modes[2] = user-&gt;nick;<p>
1241 Srv-&gt;SendMode(modes,3,user);<p>
1242 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!
1243 <p>
1244 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>.
1245 <p>
1246 References <a class="el" href="modules_8h.html#a14">server_mode()</a>.
1247 <p>
1248 <div class="fragment"><pre>00189 {
1249 00190         <a class="code" href="modules_8h.html#a14">server_mode</a>(parameters,pcnt,user);
1250 00191 }
1251 </pre></div>    </td>
1252   </tr>
1253 </table>
1254 <a name="a2" doxytag="Server::SendOpers"></a><p>
1255 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1256   <tr>
1257     <td class="md">
1258       <table cellpadding="0" cellspacing="0" border="0">
1259         <tr>
1260           <td class="md" nowrap valign="top"> void Server::SendOpers </td>
1261           <td class="md" valign="top">(&nbsp;</td>
1262           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1263           <td class="mdname1" valign="top" nowrap>&nbsp; <em>s</em>          </td>
1264           <td class="md" valign="top">)&nbsp;</td>
1265           <td class="md" nowrap><code> [virtual]</code></td>
1266         </tr>
1267
1268       </table>
1269     </td>
1270   </tr>
1271 </table>
1272 <table cellspacing=5 cellpadding=0 border=0>
1273   <tr>
1274     <td>
1275       &nbsp;
1276     </td>
1277     <td>
1278
1279 <p>
1280 Sends text to all opers.
1281 <p>
1282 This method sends a server notice to all opers with the usermode +s.
1283 <p>
1284 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>.
1285 <p>
1286 <div class="fragment"><pre>00140 {
1287 00141         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
1288 00142 }
1289 </pre></div>    </td>
1290   </tr>
1291 </table>
1292 <a name="a5" doxytag="Server::SendServ"></a><p>
1293 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1294   <tr>
1295     <td class="md">
1296       <table cellpadding="0" cellspacing="0" border="0">
1297         <tr>
1298           <td class="md" nowrap valign="top"> void Server::SendServ </td>
1299           <td class="md" valign="top">(&nbsp;</td>
1300           <td class="md" nowrap valign="top">int&nbsp;</td>
1301           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
1302         </tr>
1303         <tr>
1304           <td></td>
1305           <td></td>
1306           <td class="md" nowrap>std::string&nbsp;</td>
1307           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
1308         </tr>
1309         <tr>
1310           <td></td>
1311           <td class="md">)&nbsp;</td>
1312           <td class="md" colspan="2"><code> [virtual]</code></td>
1313         </tr>
1314
1315       </table>
1316     </td>
1317   </tr>
1318 </table>
1319 <table cellspacing=5 cellpadding=0 border=0>
1320   <tr>
1321     <td>
1322       &nbsp;
1323     </td>
1324     <td>
1325
1326 <p>
1327 Sends text from the server to a socket.
1328 <p>
1329 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
1330 <p>
1331 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>.
1332 <p>
1333 <div class="fragment"><pre>00199 {
1334 00200         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1335 00201 }
1336 </pre></div>    </td>
1337   </tr>
1338 </table>
1339 <a name="a7" doxytag="Server::SendTo"></a><p>
1340 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1341   <tr>
1342     <td class="md">
1343       <table cellpadding="0" cellspacing="0" border="0">
1344         <tr>
1345           <td class="md" nowrap valign="top"> void Server::SendTo </td>
1346           <td class="md" valign="top">(&nbsp;</td>
1347           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1348           <td class="mdname" nowrap>&nbsp; <em>Source</em>, </td>
1349         </tr>
1350         <tr>
1351           <td></td>
1352           <td></td>
1353           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1354           <td class="mdname" nowrap>&nbsp; <em>Dest</em>, </td>
1355         </tr>
1356         <tr>
1357           <td></td>
1358           <td></td>
1359           <td class="md" nowrap>std::string&nbsp;</td>
1360           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
1361         </tr>
1362         <tr>
1363           <td></td>
1364           <td class="md">)&nbsp;</td>
1365           <td class="md" colspan="2"><code> [virtual]</code></td>
1366         </tr>
1367
1368       </table>
1369     </td>
1370   </tr>
1371 </table>
1372 <table cellspacing=5 cellpadding=0 border=0>
1373   <tr>
1374     <td>
1375       &nbsp;
1376     </td>
1377     <td>
1378
1379 <p>
1380 Sends text from a user to another user.
1381 <p>
1382 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>
1383 :user!ident TEXT<p>
1384 The format will become:<p>
1385 :localserver TEXT<p>
1386 Which is useful for numerics and server notices to single users, etc.
1387 <p>
1388 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>.
1389 <p>
1390 References <a class="el" href="connection_8h-source.html#l00043">connection::fd</a>.
1391 <p>
1392 <div class="fragment"><pre>00209 {
1393 00210         <span class="keywordflow">if</span> (!Source)
1394 00211         {
1395 00212                 <span class="comment">// if source is NULL, then the message originates from the local server</span>
1396 00213                 Write(Dest-&gt;<a class="code" href="classconnection.html#m1">fd</a>,<span class="stringliteral">":%s %s"</span>,this-&gt;GetServerName().c_str(),s.c_str());
1397 00214         }
1398 00215         <span class="keywordflow">else</span>
1399 00216         {
1400 00217                 <span class="comment">// otherwise it comes from the user specified</span>
1401 00218                 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
1402 00219         }
1403 00220 }
1404 </pre></div>    </td>
1405   </tr>
1406 </table>
1407 <a name="a23" doxytag="Server::SendToModeMask"></a><p>
1408 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1409   <tr>
1410     <td class="md">
1411       <table cellpadding="0" cellspacing="0" border="0">
1412         <tr>
1413           <td class="md" nowrap valign="top"> void Server::SendToModeMask </td>
1414           <td class="md" valign="top">(&nbsp;</td>
1415           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1416           <td class="mdname" nowrap>&nbsp; <em>modes</em>, </td>
1417         </tr>
1418         <tr>
1419           <td></td>
1420           <td></td>
1421           <td class="md" nowrap>int&nbsp;</td>
1422           <td class="mdname" nowrap>&nbsp; <em>flags</em>, </td>
1423         </tr>
1424         <tr>
1425           <td></td>
1426           <td></td>
1427           <td class="md" nowrap>std::string&nbsp;</td>
1428           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
1429         </tr>
1430         <tr>
1431           <td></td>
1432           <td class="md">)&nbsp;</td>
1433           <td class="md" colspan="2"><code> [virtual]</code></td>
1434         </tr>
1435
1436       </table>
1437     </td>
1438   </tr>
1439 </table>
1440 <table cellspacing=5 cellpadding=0 border=0>
1441   <tr>
1442     <td>
1443       &nbsp;
1444     </td>
1445     <td>
1446
1447 <p>
1448 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.
1449 <p>
1450 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>
1451 Serv-&gt;SendToModeMask("xi", WM_OR, "m00");<p>
1452 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.
1453 <p>
1454 Definition at line <a class="el" href="modules_8cpp-source.html#l00152">152</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1455 <p>
1456 <div class="fragment"><pre>00153 {
1457 00154         WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str());
1458 00155 }
1459 </pre></div>    </td>
1460   </tr>
1461 </table>
1462 <a name="a11" doxytag="Server::SendWallops"></a><p>
1463 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1464   <tr>
1465     <td class="md">
1466       <table cellpadding="0" cellspacing="0" border="0">
1467         <tr>
1468           <td class="md" nowrap valign="top"> void Server::SendWallops </td>
1469           <td class="md" valign="top">(&nbsp;</td>
1470           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1471           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
1472         </tr>
1473         <tr>
1474           <td></td>
1475           <td></td>
1476           <td class="md" nowrap>std::string&nbsp;</td>
1477           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
1478         </tr>
1479         <tr>
1480           <td></td>
1481           <td class="md">)&nbsp;</td>
1482           <td class="md" colspan="2"><code> [virtual]</code></td>
1483         </tr>
1484
1485       </table>
1486     </td>
1487   </tr>
1488 </table>
1489 <table cellspacing=5 cellpadding=0 border=0>
1490   <tr>
1491     <td>
1492       &nbsp;
1493     </td>
1494     <td>
1495
1496 <p>
1497 Sends a WALLOPS message.
1498 <p>
1499 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
1500 <p>
1501 Definition at line <a class="el" href="modules_8cpp-source.html#l00251">251</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1502 <p>
1503 <div class="fragment"><pre>00252 {
1504 00253         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
1505 00254 }
1506 </pre></div>    </td>
1507   </tr>
1508 </table>
1509 <hr>The documentation for this class was generated from the following files:<ul>
1510 <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>
1511 <hr><address style="align: right;"><small>Generated on Wed Apr 7 19:20:54 2004 for InspIRCd by
1512 <a href="http://www.doxygen.org/index.html">
1513 <img src="doxygen.png" alt="doxygen" align="middle" border=0
1514 width=110 height=53></a>1.3-rc3 </small></address>
1515 </body>
1516 </html>