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="doxygen.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="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 <a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a13">FindNick</a> (std::string nick)</td></tr>
  52 <tr><td>&nbsp;</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>
  53 <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#a14">FindChannel</a> (std::string channel)</td></tr>
  54 <tr><td>&nbsp;</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>
  55 <tr><td nowrap align=right valign=top>virtual std::string&nbsp;</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>
  56 <tr><td>&nbsp;</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>
  57 <tr><td nowrap align=right valign=top>virtual std::string&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a16">GetServerName</a> ()</td></tr>
  58 <tr><td>&nbsp;</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>
  59 <tr><td nowrap align=right valign=top>virtual std::string&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a17">GetNetworkName</a> ()</td></tr>
  60 <tr><td>&nbsp;</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>
  61 <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#a18">GetAdmin</a> ()</td></tr>
  62 <tr><td>&nbsp;</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>
  63 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a19">AddExtendedMode</a> (char modechar, int type, bool default_on, int params_when_on, int params_when_off)</td></tr>
  64 <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="#a19"></a><em></em></font><br><br></td></tr>
  65 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a20">AddCommand</a> (char *cmd, <a class="el" href="ctables_8h.html#a0">handlerfunc</a> f, char flags, int minparams)</td></tr>
  66 <tr><td>&nbsp;</td><td><font size=-1><em>Adds a command to the command table.</em> <a href="#a20"></a><em></em></font><br><br></td></tr>
  67 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classServer.html#a21">SendMode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  68 <tr><td>&nbsp;</td><td><font size=-1><em>Sends a servermode.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
  69 </table>
  70 <hr><a name="_details"></a><h2>Detailed Description</h2>
  71 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.
  72 <p>
  73 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
  74 <p>
  75
  76 <p>
  77 Definition at line <a class="el" href="modules_8h-source.html#l00165">165</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  78 <a name="a0" doxytag="Server::Server"></a><p>
  79 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  80   <tr>
  81     <td class="md">
  82       <table cellpadding="0" cellspacing="0" border="0">
  83         <tr>
  84           <td class="md" nowrap valign="top"> Server::Server </td>
  85           <td class="md" valign="top">(&nbsp;</td>
  86           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  87           <td class="md" valign="top">)&nbsp;</td>
  88           <td class="md" nowrap></td>
  89         </tr>
  90
  91       </table>
  92     </td>
  93   </tr>
  94 </table>
  95 <table cellspacing=5 cellpadding=0 border=0>
  96   <tr>
  97     <td>
  98       &nbsp;
  99     </td>
 100     <td>
 101
 102 <p>
 103 Default constructor.
 104 <p>
 105 Creates a Server object.
 106 <p>
 107 Definition at line <a class="el" href="modules_8cpp-source.html#l00105">105</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 108 <p>
 109 <div class="fragment"><pre>00106 {
 110 00107 }
 111 </pre></div>    </td>
 112   </tr>
 113 </table>
 114 <a name="a1" doxytag="Server::~Server"></a><p>
 115 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 116   <tr>
 117     <td class="md">
 118       <table cellpadding="0" cellspacing="0" border="0">
 119         <tr>
 120           <td class="md" nowrap valign="top"> Server::~Server </td>
 121           <td class="md" valign="top">(&nbsp;</td>
 122           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 123           <td class="md" valign="top">)&nbsp;</td>
 124           <td class="md" nowrap><code> [virtual]</code></td>
 125         </tr>
 126
 127       </table>
 128     </td>
 129   </tr>
 130 </table>
 131 <table cellspacing=5 cellpadding=0 border=0>
 132   <tr>
 133     <td>
 134       &nbsp;
 135     </td>
 136     <td>
 137
 138 <p>
 139 Default destructor.
 140 <p>
 141 Destroys a Server object.
 142 <p>
 143 Definition at line <a class="el" href="modules_8cpp-source.html#l00109">109</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 144 <p>
 145 <div class="fragment"><pre>00110 {
 146 00111 }
 147 </pre></div>    </td>
 148   </tr>
 149 </table>
 150 <hr><h2>Member Function Documentation</h2>
 151 <a name="a20" doxytag="Server::AddCommand"></a><p>
 152 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 153   <tr>
 154     <td class="md">
 155       <table cellpadding="0" cellspacing="0" border="0">
 156         <tr>
 157           <td class="md" nowrap valign="top"> void Server::AddCommand </td>
 158           <td class="md" valign="top">(&nbsp;</td>
 159           <td class="md" nowrap valign="top">char *&nbsp;</td>
 160           <td class="mdname" nowrap>&nbsp; <em>cmd</em>, </td>
 161         </tr>
 162         <tr>
 163           <td></td>
 164           <td></td>
 165           <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a>&nbsp;</td>
 166           <td class="mdname" nowrap>&nbsp; <em>f</em>, </td>
 167         </tr>
 168         <tr>
 169           <td></td>
 170           <td></td>
 171           <td class="md" nowrap>char&nbsp;</td>
 172           <td class="mdname" nowrap>&nbsp; <em>flags</em>, </td>
 173         </tr>
 174         <tr>
 175           <td></td>
 176           <td></td>
 177           <td class="md" nowrap>int&nbsp;</td>
 178           <td class="mdname" nowrap>&nbsp; <em>minparams</em></td>
 179         </tr>
 180         <tr>
 181           <td></td>
 182           <td class="md">)&nbsp;</td>
 183           <td class="md" colspan="2"><code> [virtual]</code></td>
 184         </tr>
 185
 186       </table>
 187     </td>
 188   </tr>
 189 </table>
 190 <table cellspacing=5 cellpadding=0 border=0>
 191   <tr>
 192     <td>
 193       &nbsp;
 194     </td>
 195     <td>
 196
 197 <p>
 198 Adds a command to the command table.
 199 <p>
 200 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>
 201 typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)<p>
 202 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'.
 203 <p>
 204 Definition at line <a class="el" href="modules_8cpp-source.html#l00123">123</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 205 <p>
 206 References <a class="el" href="modules_8h.html#a12">createcommand()</a>.
 207 <p>
 208 <div class="fragment"><pre>00124 {
 209 00125         <a class="code" href="modules_8h.html#a12">createcommand</a>(cmd,f,flags,minparams);
 210 00126 }
 211 </pre></div>    </td>
 212   </tr>
 213 </table>
 214 <a name="a19" doxytag="Server::AddExtendedMode"></a><p>
 215 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 216   <tr>
 217     <td class="md">
 218       <table cellpadding="0" cellspacing="0" border="0">
 219         <tr>
 220           <td class="md" nowrap valign="top"> bool Server::AddExtendedMode </td>
 221           <td class="md" valign="top">(&nbsp;</td>
 222           <td class="md" nowrap valign="top">char&nbsp;</td>
 223           <td class="mdname" nowrap>&nbsp; <em>modechar</em>, </td>
 224         </tr>
 225         <tr>
 226           <td></td>
 227           <td></td>
 228           <td class="md" nowrap>int&nbsp;</td>
 229           <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
 230         </tr>
 231         <tr>
 232           <td></td>
 233           <td></td>
 234           <td class="md" nowrap>bool&nbsp;</td>
 235           <td class="mdname" nowrap>&nbsp; <em>default_on</em>, </td>
 236         </tr>
 237         <tr>
 238           <td></td>
 239           <td></td>
 240           <td class="md" nowrap>int&nbsp;</td>
 241           <td class="mdname" nowrap>&nbsp; <em>params_when_on</em>, </td>
 242         </tr>
 243         <tr>
 244           <td></td>
 245           <td></td>
 246           <td class="md" nowrap>int&nbsp;</td>
 247           <td class="mdname" nowrap>&nbsp; <em>params_when_off</em></td>
 248         </tr>
 249         <tr>
 250           <td></td>
 251           <td class="md">)&nbsp;</td>
 252           <td class="md" colspan="2"><code> [virtual]</code></td>
 253         </tr>
 254
 255       </table>
 256     </td>
 257   </tr>
 258 </table>
 259 <table cellspacing=5 cellpadding=0 border=0>
 260   <tr>
 261     <td>
 262       &nbsp;
 263     </td>
 264     <td>
 265
 266 <p>
 267 Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.
 268 <p>
 269 +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. default_on is true if the mode is to be applied to default connections. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +b, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.
 270 <p>
 271 Definition at line <a class="el" href="modules_8cpp-source.html#l00224">224</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 272 <p>
 273 <div class="fragment"><pre>00225 {
 274 00226 }
 275 </pre></div>    </td>
 276   </tr>
 277 </table>
 278 <a name="a15" doxytag="Server::ChanMode"></a><p>
 279 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 280   <tr>
 281     <td class="md">
 282       <table cellpadding="0" cellspacing="0" border="0">
 283         <tr>
 284           <td class="md" nowrap valign="top"> std::string Server::ChanMode </td>
 285           <td class="md" valign="top">(&nbsp;</td>
 286           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 287           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 288         </tr>
 289         <tr>
 290           <td></td>
 291           <td></td>
 292           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 293           <td class="mdname" nowrap>&nbsp; <em>Chan</em></td>
 294         </tr>
 295         <tr>
 296           <td></td>
 297           <td class="md">)&nbsp;</td>
 298           <td class="md" colspan="2"><code> [virtual]</code></td>
 299         </tr>
 300
 301       </table>
 302     </td>
 303   </tr>
 304 </table>
 305 <table cellspacing=5 cellpadding=0 border=0>
 306   <tr>
 307     <td>
 308       &nbsp;
 309     </td>
 310     <td>
 311
 312 <p>
 313 Attempts to look up a user's privilages on a channel.
 314 <p>
 315 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
 316 <p>
 317 Definition at line <a class="el" href="modules_8cpp-source.html#l00202">202</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 318 <p>
 319 <div class="fragment"><pre>00203 {
 320 00204         <span class="keywordflow">return</span> cmode(User,Chan);
 321 00205 }
 322 </pre></div>    </td>
 323   </tr>
 324 </table>
 325 <a name="a9" doxytag="Server::CommonChannels"></a><p>
 326 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 327   <tr>
 328     <td class="md">
 329       <table cellpadding="0" cellspacing="0" border="0">
 330         <tr>
 331           <td class="md" nowrap valign="top"> bool Server::CommonChannels </td>
 332           <td class="md" valign="top">(&nbsp;</td>
 333           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 334           <td class="mdname" nowrap>&nbsp; <em>u1</em>, </td>
 335         </tr>
 336         <tr>
 337           <td></td>
 338           <td></td>
 339           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 340           <td class="mdname" nowrap>&nbsp; <em>u2</em></td>
 341         </tr>
 342         <tr>
 343           <td></td>
 344           <td class="md">)&nbsp;</td>
 345           <td class="md" colspan="2"><code> [virtual]</code></td>
 346         </tr>
 347
 348       </table>
 349     </td>
 350   </tr>
 351 </table>
 352 <table cellspacing=5 cellpadding=0 border=0>
 353   <tr>
 354     <td>
 355       &nbsp;
 356     </td>
 357     <td>
 358
 359 <p>
 360 Returns true if two users share a common channel.
 361 <p>
 362 This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#a10">Server::SendCommon</a> method.
 363 <p>
 364 Definition at line <a class="el" href="modules_8cpp-source.html#l00165">165</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 365 <p>
 366 <div class="fragment"><pre>00166 {
 367 00167         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
 368 00168 }
 369 </pre></div>    </td>
 370   </tr>
 371 </table>
 372 <a name="a14" doxytag="Server::FindChannel"></a><p>
 373 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 374   <tr>
 375     <td class="md">
 376       <table cellpadding="0" cellspacing="0" border="0">
 377         <tr>
 378           <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td>
 379           <td class="md" valign="top">(&nbsp;</td>
 380           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 381           <td class="mdname1" valign="top" nowrap>&nbsp; <em>channel</em>          </td>
 382           <td class="md" valign="top">)&nbsp;</td>
 383           <td class="md" nowrap><code> [virtual]</code></td>
 384         </tr>
 385
 386       </table>
 387     </td>
 388   </tr>
 389 </table>
 390 <table cellspacing=5 cellpadding=0 border=0>
 391   <tr>
 392     <td>
 393       &nbsp;
 394     </td>
 395     <td>
 396
 397 <p>
 398 Attempts to look up a channel and return a pointer to it.
 399 <p>
 400 This function will return NULL if the channel does not exist.
 401 <p>
 402 Definition at line <a class="el" href="modules_8cpp-source.html#l00197">197</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 403 <p>
 404 <div class="fragment"><pre>00198 {
 405 00199         <span class="keywordflow">return</span> FindChan(channel.c_str());
 406 00200 }
 407 </pre></div>    </td>
 408   </tr>
 409 </table>
 410 <a name="a13" doxytag="Server::FindNick"></a><p>
 411 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 412   <tr>
 413     <td class="md">
 414       <table cellpadding="0" cellspacing="0" border="0">
 415         <tr>
 416           <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td>
 417           <td class="md" valign="top">(&nbsp;</td>
 418           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 419           <td class="mdname1" valign="top" nowrap>&nbsp; <em>nick</em>          </td>
 420           <td class="md" valign="top">)&nbsp;</td>
 421           <td class="md" nowrap><code> [virtual]</code></td>
 422         </tr>
 423
 424       </table>
 425     </td>
 426   </tr>
 427 </table>
 428 <table cellspacing=5 cellpadding=0 border=0>
 429   <tr>
 430     <td>
 431       &nbsp;
 432     </td>
 433     <td>
 434
 435 <p>
 436 Attempts to look up a nick and return a pointer to it.
 437 <p>
 438 This function will return NULL if the nick does not exist.
 439 <p>
 440 Definition at line <a class="el" href="modules_8cpp-source.html#l00192">192</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 441 <p>
 442 <div class="fragment"><pre>00193 {
 443 00194         <span class="keywordflow">return</span> Find(nick);
 444 00195 }
 445 </pre></div>    </td>
 446   </tr>
 447 </table>
 448 <a name="a18" doxytag="Server::GetAdmin"></a><p>
 449 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 450   <tr>
 451     <td class="md">
 452       <table cellpadding="0" cellspacing="0" border="0">
 453         <tr>
 454           <td class="md" nowrap valign="top"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td>
 455           <td class="md" valign="top">(&nbsp;</td>
 456           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 457           <td class="md" valign="top">)&nbsp;</td>
 458           <td class="md" nowrap><code> [virtual]</code></td>
 459         </tr>
 460
 461       </table>
 462     </td>
 463   </tr>
 464 </table>
 465 <table cellspacing=5 cellpadding=0 border=0>
 466   <tr>
 467     <td>
 468       &nbsp;
 469     </td>
 470     <td>
 471
 472 <p>
 473 Returns the information of the server as returned by the /ADMIN command.
 474 <p>
 475 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.
 476 <p>
 477 Definition at line <a class="el" href="modules_8cpp-source.html#l00217">217</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 478 <p>
 479 <div class="fragment"><pre>00218 {
 480 00219         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
 481 00220 }
 482 </pre></div>    </td>
 483   </tr>
 484 </table>
 485 <a name="a17" doxytag="Server::GetNetworkName"></a><p>
 486 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 487   <tr>
 488     <td class="md">
 489       <table cellpadding="0" cellspacing="0" border="0">
 490         <tr>
 491           <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td>
 492           <td class="md" valign="top">(&nbsp;</td>
 493           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 494           <td class="md" valign="top">)&nbsp;</td>
 495           <td class="md" nowrap><code> [virtual]</code></td>
 496         </tr>
 497
 498       </table>
 499     </td>
 500   </tr>
 501 </table>
 502 <table cellspacing=5 cellpadding=0 border=0>
 503   <tr>
 504     <td>
 505       &nbsp;
 506     </td>
 507     <td>
 508
 509 <p>
 510 Returns the network name, global to all linked servers.
 511 <p>
 512
 513 <p>
 514 Definition at line <a class="el" href="modules_8cpp-source.html#l00212">212</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 515 <p>
 516 <div class="fragment"><pre>00213 {
 517 00214         <span class="keywordflow">return</span> getnetworkname();
 518 00215 }
 519 </pre></div>    </td>
 520   </tr>
 521 </table>
 522 <a name="a16" doxytag="Server::GetServerName"></a><p>
 523 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 524   <tr>
 525     <td class="md">
 526       <table cellpadding="0" cellspacing="0" border="0">
 527         <tr>
 528           <td class="md" nowrap valign="top"> std::string Server::GetServerName </td>
 529           <td class="md" valign="top">(&nbsp;</td>
 530           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 531           <td class="md" valign="top">)&nbsp;</td>
 532           <td class="md" nowrap><code> [virtual]</code></td>
 533         </tr>
 534
 535       </table>
 536     </td>
 537   </tr>
 538 </table>
 539 <table cellspacing=5 cellpadding=0 border=0>
 540   <tr>
 541     <td>
 542       &nbsp;
 543     </td>
 544     <td>
 545
 546 <p>
 547 Returns the server name of the server where the module is loaded.
 548 <p>
 549
 550 <p>
 551 Definition at line <a class="el" href="modules_8cpp-source.html#l00207">207</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 552 <p>
 553 <div class="fragment"><pre>00208 {
 554 00209         <span class="keywordflow">return</span> getservername();
 555 00210 }
 556 </pre></div>    </td>
 557   </tr>
 558 </table>
 559 <a name="a12" doxytag="Server::IsNick"></a><p>
 560 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 561   <tr>
 562     <td class="md">
 563       <table cellpadding="0" cellspacing="0" border="0">
 564         <tr>
 565           <td class="md" nowrap valign="top"> bool Server::IsNick </td>
 566           <td class="md" valign="top">(&nbsp;</td>
 567           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 568           <td class="mdname1" valign="top" nowrap>&nbsp; <em>nick</em>          </td>
 569           <td class="md" valign="top">)&nbsp;</td>
 570           <td class="md" nowrap><code> [virtual]</code></td>
 571         </tr>
 572
 573       </table>
 574     </td>
 575   </tr>
 576 </table>
 577 <table cellspacing=5 cellpadding=0 border=0>
 578   <tr>
 579     <td>
 580       &nbsp;
 581     </td>
 582     <td>
 583
 584 <p>
 585 Returns true if a nick is valid.
 586 <p>
 587 Nicks for unregistered connections will return false.
 588 <p>
 589 Definition at line <a class="el" href="modules_8cpp-source.html#l00187">187</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 590 <p>
 591 <div class="fragment"><pre>00188 {
 592 00189         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
 593 00190 }
 594 </pre></div>    </td>
 595   </tr>
 596 </table>
 597 <a name="a3" doxytag="Server::Log"></a><p>
 598 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 599   <tr>
 600     <td class="md">
 601       <table cellpadding="0" cellspacing="0" border="0">
 602         <tr>
 603           <td class="md" nowrap valign="top"> void Server::Log </td>
 604           <td class="md" valign="top">(&nbsp;</td>
 605           <td class="md" nowrap valign="top">int&nbsp;</td>
 606           <td class="mdname" nowrap>&nbsp; <em>level</em>, </td>
 607         </tr>
 608         <tr>
 609           <td></td>
 610           <td></td>
 611           <td class="md" nowrap>std::string&nbsp;</td>
 612           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 613         </tr>
 614         <tr>
 615           <td></td>
 616           <td class="md">)&nbsp;</td>
 617           <td class="md" colspan="2"><code> [virtual]</code></td>
 618         </tr>
 619
 620       </table>
 621     </td>
 622   </tr>
 623 </table>
 624 <table cellspacing=5 cellpadding=0 border=0>
 625   <tr>
 626     <td>
 627       &nbsp;
 628     </td>
 629     <td>
 630
 631 <p>
 632 Writes a log string.
 633 <p>
 634 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.
 635 <p>
 636 Definition at line <a class="el" href="modules_8cpp-source.html#l00118">118</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 637 <p>
 638 <div class="fragment"><pre>00119 {
 639 00120         log(level,<span class="stringliteral">"%s"</span>,s.c_str());
 640 00121 }
 641 </pre></div>    </td>
 642   </tr>
 643 </table>
 644 <a name="a4" doxytag="Server::Send"></a><p>
 645 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 646   <tr>
 647     <td class="md">
 648       <table cellpadding="0" cellspacing="0" border="0">
 649         <tr>
 650           <td class="md" nowrap valign="top"> void Server::Send </td>
 651           <td class="md" valign="top">(&nbsp;</td>
 652           <td class="md" nowrap valign="top">int&nbsp;</td>
 653           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
 654         </tr>
 655         <tr>
 656           <td></td>
 657           <td></td>
 658           <td class="md" nowrap>std::string&nbsp;</td>
 659           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 660         </tr>
 661         <tr>
 662           <td></td>
 663           <td class="md">)&nbsp;</td>
 664           <td class="md" colspan="2"><code> [virtual]</code></td>
 665         </tr>
 666
 667       </table>
 668     </td>
 669   </tr>
 670 </table>
 671 <table cellspacing=5 cellpadding=0 border=0>
 672   <tr>
 673     <td>
 674       &nbsp;
 675     </td>
 676     <td>
 677
 678 <p>
 679 Sends a line of text down a TCP/IP socket.
 680 <p>
 681 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
 682 <p>
 683 Definition at line <a class="el" href="modules_8cpp-source.html#l00133">133</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 684 <p>
 685 <div class="fragment"><pre>00134 {
 686 00135         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
 687 00136 }
 688 </pre></div>    </td>
 689   </tr>
 690 </table>
 691 <a name="a8" doxytag="Server::SendChannel"></a><p>
 692 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 693   <tr>
 694     <td class="md">
 695       <table cellpadding="0" cellspacing="0" border="0">
 696         <tr>
 697           <td class="md" nowrap valign="top"> void Server::SendChannel </td>
 698           <td class="md" valign="top">(&nbsp;</td>
 699           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 700           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 701         </tr>
 702         <tr>
 703           <td></td>
 704           <td></td>
 705           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 706           <td class="mdname" nowrap>&nbsp; <em>Channel</em>, </td>
 707         </tr>
 708         <tr>
 709           <td></td>
 710           <td></td>
 711           <td class="md" nowrap>std::string&nbsp;</td>
 712           <td class="mdname" nowrap>&nbsp; <em>s</em>, </td>
 713         </tr>
 714         <tr>
 715           <td></td>
 716           <td></td>
 717           <td class="md" nowrap>bool&nbsp;</td>
 718           <td class="mdname" nowrap>&nbsp; <em>IncludeSender</em></td>
 719         </tr>
 720         <tr>
 721           <td></td>
 722           <td class="md">)&nbsp;</td>
 723           <td class="md" colspan="2"><code> [virtual]</code></td>
 724         </tr>
 725
 726       </table>
 727     </td>
 728   </tr>
 729 </table>
 730 <table cellspacing=5 cellpadding=0 border=0>
 731   <tr>
 732     <td>
 733       &nbsp;
 734     </td>
 735     <td>
 736
 737 <p>
 738 Sends text from a user to a channel (mulicast).
 739 <p>
 740 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).
 741 <p>
 742 Definition at line <a class="el" href="modules_8cpp-source.html#l00153">153</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 743 <p>
 744 <div class="fragment"><pre>00154 {
 745 00155         <span class="keywordflow">if</span> (IncludeSender)
 746 00156         {
 747 00157                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 748 00158         }
 749 00159         <span class="keywordflow">else</span>
 750 00160         {
 751 00161                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 752 00162         }
 753 00163 }
 754 </pre></div>    </td>
 755   </tr>
 756 </table>
 757 <a name="a10" doxytag="Server::SendCommon"></a><p>
 758 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 759   <tr>
 760     <td class="md">
 761       <table cellpadding="0" cellspacing="0" border="0">
 762         <tr>
 763           <td class="md" nowrap valign="top"> void Server::SendCommon </td>
 764           <td class="md" valign="top">(&nbsp;</td>
 765           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 766           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 767         </tr>
 768         <tr>
 769           <td></td>
 770           <td></td>
 771           <td class="md" nowrap>std::string&nbsp;</td>
 772           <td class="mdname" nowrap>&nbsp; <em>text</em>, </td>
 773         </tr>
 774         <tr>
 775           <td></td>
 776           <td></td>
 777           <td class="md" nowrap>bool&nbsp;</td>
 778           <td class="mdname" nowrap>&nbsp; <em>IncludeSender</em></td>
 779         </tr>
 780         <tr>
 781           <td></td>
 782           <td class="md">)&nbsp;</td>
 783           <td class="md" colspan="2"><code> [virtual]</code></td>
 784         </tr>
 785
 786       </table>
 787     </td>
 788   </tr>
 789 </table>
 790 <table cellspacing=5 cellpadding=0 border=0>
 791   <tr>
 792     <td>
 793       &nbsp;
 794     </td>
 795     <td>
 796
 797 <p>
 798 Sends text from a user to one or more channels (mulicast).
 799 <p>
 800 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.
 801 <p>
 802 Definition at line <a class="el" href="modules_8cpp-source.html#l00170">170</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 803 <p>
 804 <div class="fragment"><pre>00171 {
 805 00172         <span class="keywordflow">if</span> (IncludeSender)
 806 00173         {
 807 00174                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
 808 00175         }
 809 00176         <span class="keywordflow">else</span>
 810 00177         {
 811 00178                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
 812 00179         }
 813 00180 }
 814 </pre></div>    </td>
 815   </tr>
 816 </table>
 817 <a name="a6" doxytag="Server::SendFrom"></a><p>
 818 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 819   <tr>
 820     <td class="md">
 821       <table cellpadding="0" cellspacing="0" border="0">
 822         <tr>
 823           <td class="md" nowrap valign="top"> void Server::SendFrom </td>
 824           <td class="md" valign="top">(&nbsp;</td>
 825           <td class="md" nowrap valign="top">int&nbsp;</td>
 826           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
 827         </tr>
 828         <tr>
 829           <td></td>
 830           <td></td>
 831           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 832           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 833         </tr>
 834         <tr>
 835           <td></td>
 836           <td></td>
 837           <td class="md" nowrap>std::string&nbsp;</td>
 838           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 839         </tr>
 840         <tr>
 841           <td></td>
 842           <td class="md">)&nbsp;</td>
 843           <td class="md" colspan="2"><code> [virtual]</code></td>
 844         </tr>
 845
 846       </table>
 847     </td>
 848   </tr>
 849 </table>
 850 <table cellspacing=5 cellpadding=0 border=0>
 851   <tr>
 852     <td>
 853       &nbsp;
 854     </td>
 855     <td>
 856
 857 <p>
 858 Sends text from a user to a socket.
 859 <p>
 860 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)
 861 <p>
 862 Definition at line <a class="el" href="modules_8cpp-source.html#l00143">143</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 863 <p>
 864 <div class="fragment"><pre>00144 {
 865 00145         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
 866 00146 }
 867 </pre></div>    </td>
 868   </tr>
 869 </table>
 870 <a name="a21" doxytag="Server::SendMode"></a><p>
 871 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 872   <tr>
 873     <td class="md">
 874       <table cellpadding="0" cellspacing="0" border="0">
 875         <tr>
 876           <td class="md" nowrap valign="top"> void Server::SendMode </td>
 877           <td class="md" valign="top">(&nbsp;</td>
 878           <td class="md" nowrap valign="top">char **&nbsp;</td>
 879           <td class="mdname" nowrap>&nbsp; <em>parameters</em>, </td>
 880         </tr>
 881         <tr>
 882           <td></td>
 883           <td></td>
 884           <td class="md" nowrap>int&nbsp;</td>
 885           <td class="mdname" nowrap>&nbsp; <em>pcnt</em>, </td>
 886         </tr>
 887         <tr>
 888           <td></td>
 889           <td></td>
 890           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 891           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
 892         </tr>
 893         <tr>
 894           <td></td>
 895           <td class="md">)&nbsp;</td>
 896           <td class="md" colspan="2"><code> [virtual]</code></td>
 897         </tr>
 898
 899       </table>
 900     </td>
 901   </tr>
 902 </table>
 903 <table cellspacing=5 cellpadding=0 border=0>
 904   <tr>
 905     <td>
 906       &nbsp;
 907     </td>
 908     <td>
 909
 910 <p>
 911 Sends a servermode.
 912 <p>
 913 you must format the parameters array with the target, modes and parameters for those modes.<p>
 914 For example:<p>
 915 char modes[3][MAXBUF]; modes[0] = ChannelName; modes[1] = "+o"; modes[2] = user-&gt;nick; Srv-&gt;SendMode(modes,3,user);<p>
 916 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!
 917 <p>
 918 Definition at line <a class="el" href="modules_8cpp-source.html#l00128">128</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 919 <p>
 920 References <a class="el" href="modules_8h.html#a13">server_mode()</a>.
 921 <p>
 922 <div class="fragment"><pre>00129 {
 923 00130         <a class="code" href="modules_8h.html#a13">server_mode</a>(parameters,pcnt,user);
 924 00131 }
 925 </pre></div>    </td>
 926   </tr>
 927 </table>
 928 <a name="a2" doxytag="Server::SendOpers"></a><p>
 929 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 930   <tr>
 931     <td class="md">
 932       <table cellpadding="0" cellspacing="0" border="0">
 933         <tr>
 934           <td class="md" nowrap valign="top"> void Server::SendOpers </td>
 935           <td class="md" valign="top">(&nbsp;</td>
 936           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 937           <td class="mdname1" valign="top" nowrap>&nbsp; <em>s</em>          </td>
 938           <td class="md" valign="top">)&nbsp;</td>
 939           <td class="md" nowrap><code> [virtual]</code></td>
 940         </tr>
 941
 942       </table>
 943     </td>
 944   </tr>
 945 </table>
 946 <table cellspacing=5 cellpadding=0 border=0>
 947   <tr>
 948     <td>
 949       &nbsp;
 950     </td>
 951     <td>
 952
 953 <p>
 954 Sends text to all opers.
 955 <p>
 956 This method sends a server notice to all opers with the usermode +s.
 957 <p>
 958 Definition at line <a class="el" href="modules_8cpp-source.html#l00113">113</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 959 <p>
 960 <div class="fragment"><pre>00114 {
 961 00115         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
 962 00116 }
 963 </pre></div>    </td>
 964   </tr>
 965 </table>
 966 <a name="a5" doxytag="Server::SendServ"></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::SendServ </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 text from the server to a socket.
1002 <p>
1003 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
1004 <p>
1005 Definition at line <a class="el" href="modules_8cpp-source.html#l00138">138</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1006 <p>
1007 <div class="fragment"><pre>00139 {
1008 00140         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1009 00141 }
1010 </pre></div>    </td>
1011   </tr>
1012 </table>
1013 <a name="a7" doxytag="Server::SendTo"></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::SendTo </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>Source</em>, </td>
1023         </tr>
1024         <tr>
1025           <td></td>
1026           <td></td>
1027           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1028           <td class="mdname" nowrap>&nbsp; <em>Dest</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 class="md">)&nbsp;</td>
1039           <td class="md" colspan="2"><code> [virtual]</code></td>
1040         </tr>
1041
1042       </table>
1043     </td>
1044   </tr>
1045 </table>
1046 <table cellspacing=5 cellpadding=0 border=0>
1047   <tr>
1048     <td>
1049       &nbsp;
1050     </td>
1051     <td>
1052
1053 <p>
1054 Sends text from a user to another user.
1055 <p>
1056 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)
1057 <p>
1058 Definition at line <a class="el" href="modules_8cpp-source.html#l00148">148</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1059 <p>
1060 <div class="fragment"><pre>00149 {
1061 00150         WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
1062 00151 }
1063 </pre></div>    </td>
1064   </tr>
1065 </table>
1066 <a name="a11" doxytag="Server::SendWallops"></a><p>
1067 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1068   <tr>
1069     <td class="md">
1070       <table cellpadding="0" cellspacing="0" border="0">
1071         <tr>
1072           <td class="md" nowrap valign="top"> void Server::SendWallops </td>
1073           <td class="md" valign="top">(&nbsp;</td>
1074           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1075           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
1076         </tr>
1077         <tr>
1078           <td></td>
1079           <td></td>
1080           <td class="md" nowrap>std::string&nbsp;</td>
1081           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
1082         </tr>
1083         <tr>
1084           <td></td>
1085           <td class="md">)&nbsp;</td>
1086           <td class="md" colspan="2"><code> [virtual]</code></td>
1087         </tr>
1088
1089       </table>
1090     </td>
1091   </tr>
1092 </table>
1093 <table cellspacing=5 cellpadding=0 border=0>
1094   <tr>
1095     <td>
1096       &nbsp;
1097     </td>
1098     <td>
1099
1100 <p>
1101 Sends a WALLOPS message.
1102 <p>
1103 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
1104 <p>
1105 Definition at line <a class="el" href="modules_8cpp-source.html#l00182">182</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1106 <p>
1107 <div class="fragment"><pre>00183 {
1108 00184         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
1109 00185 }
1110 </pre></div>    </td>
1111   </tr>
1112 </table>
1113 <hr>The documentation for this class was generated from the following files:<ul>
1114 <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>
1115 <hr><address style="align: right;"><small>Generated on Fri Apr 2 14:46:19 2004 for InspIRCd by
1116 <a href="http://www.doxygen.org/index.html">
1117 <img src="doxygen.png" alt="doxygen" align="middle" border=0
1118 width=110 height=53></a>1.3-rc3 </small></address>
1119 </body>
1120 </html>