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="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#l00196">196</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#l00111">111</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 108 <p>
 109 <div class="fragment"><pre>00112 {
 110 00113 }
 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#l00115">115</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 144 <p>
 145 <div class="fragment"><pre>00116 {
 146 00117 }
 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#l00129">129</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#a13">createcommand()</a>.
 207 <p>
 208 <div class="fragment"><pre>00130 {
 209 00131         <a class="code" href="modules_8h.html#a13">createcommand</a>(cmd,f,flags,minparams);
 210 00132 }
 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#l00230">230</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 272 <p>
 273 References <a class="el" href="modules_8cpp-source.html#l00075">DoAddExtendedMode()</a>.
 274 <p>
 275 <div class="fragment"><pre>00231 {
 276 00232         <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a7">DoAddExtendedMode</a>(modechar,type,default_on,params_when_on,params_when_off);
 277 00233 }
 278 </pre></div>    </td>
 279   </tr>
 280 </table>
 281 <a name="a15" doxytag="Server::ChanMode"></a><p>
 282 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 283   <tr>
 284     <td class="md">
 285       <table cellpadding="0" cellspacing="0" border="0">
 286         <tr>
 287           <td class="md" nowrap valign="top"> std::string Server::ChanMode </td>
 288           <td class="md" valign="top">(&nbsp;</td>
 289           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 290           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 291         </tr>
 292         <tr>
 293           <td></td>
 294           <td></td>
 295           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 296           <td class="mdname" nowrap>&nbsp; <em>Chan</em></td>
 297         </tr>
 298         <tr>
 299           <td></td>
 300           <td class="md">)&nbsp;</td>
 301           <td class="md" colspan="2"><code> [virtual]</code></td>
 302         </tr>
 303
 304       </table>
 305     </td>
 306   </tr>
 307 </table>
 308 <table cellspacing=5 cellpadding=0 border=0>
 309   <tr>
 310     <td>
 311       &nbsp;
 312     </td>
 313     <td>
 314
 315 <p>
 316 Attempts to look up a user's privilages on a channel.
 317 <p>
 318 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
 319 <p>
 320 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>.
 321 <p>
 322 <div class="fragment"><pre>00209 {
 323 00210         <span class="keywordflow">return</span> cmode(User,Chan);
 324 00211 }
 325 </pre></div>    </td>
 326   </tr>
 327 </table>
 328 <a name="a9" doxytag="Server::CommonChannels"></a><p>
 329 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 330   <tr>
 331     <td class="md">
 332       <table cellpadding="0" cellspacing="0" border="0">
 333         <tr>
 334           <td class="md" nowrap valign="top"> bool Server::CommonChannels </td>
 335           <td class="md" valign="top">(&nbsp;</td>
 336           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 337           <td class="mdname" nowrap>&nbsp; <em>u1</em>, </td>
 338         </tr>
 339         <tr>
 340           <td></td>
 341           <td></td>
 342           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 343           <td class="mdname" nowrap>&nbsp; <em>u2</em></td>
 344         </tr>
 345         <tr>
 346           <td></td>
 347           <td class="md">)&nbsp;</td>
 348           <td class="md" colspan="2"><code> [virtual]</code></td>
 349         </tr>
 350
 351       </table>
 352     </td>
 353   </tr>
 354 </table>
 355 <table cellspacing=5 cellpadding=0 border=0>
 356   <tr>
 357     <td>
 358       &nbsp;
 359     </td>
 360     <td>
 361
 362 <p>
 363 Returns true if two users share a common channel.
 364 <p>
 365 This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#a10">Server::SendCommon</a> method.
 366 <p>
 367 Definition at line <a class="el" href="modules_8cpp-source.html#l00171">171</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 368 <p>
 369 <div class="fragment"><pre>00172 {
 370 00173         <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
 371 00174 }
 372 </pre></div>    </td>
 373   </tr>
 374 </table>
 375 <a name="a14" doxytag="Server::FindChannel"></a><p>
 376 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 377   <tr>
 378     <td class="md">
 379       <table cellpadding="0" cellspacing="0" border="0">
 380         <tr>
 381           <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td>
 382           <td class="md" valign="top">(&nbsp;</td>
 383           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 384           <td class="mdname1" valign="top" nowrap>&nbsp; <em>channel</em>          </td>
 385           <td class="md" valign="top">)&nbsp;</td>
 386           <td class="md" nowrap><code> [virtual]</code></td>
 387         </tr>
 388
 389       </table>
 390     </td>
 391   </tr>
 392 </table>
 393 <table cellspacing=5 cellpadding=0 border=0>
 394   <tr>
 395     <td>
 396       &nbsp;
 397     </td>
 398     <td>
 399
 400 <p>
 401 Attempts to look up a channel and return a pointer to it.
 402 <p>
 403 This function will return NULL if the channel does not exist.
 404 <p>
 405 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>.
 406 <p>
 407 <div class="fragment"><pre>00204 {
 408 00205         <span class="keywordflow">return</span> FindChan(channel.c_str());
 409 00206 }
 410 </pre></div>    </td>
 411   </tr>
 412 </table>
 413 <a name="a13" doxytag="Server::FindNick"></a><p>
 414 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 415   <tr>
 416     <td class="md">
 417       <table cellpadding="0" cellspacing="0" border="0">
 418         <tr>
 419           <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td>
 420           <td class="md" valign="top">(&nbsp;</td>
 421           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 422           <td class="mdname1" valign="top" nowrap>&nbsp; <em>nick</em>          </td>
 423           <td class="md" valign="top">)&nbsp;</td>
 424           <td class="md" nowrap><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 Attempts to look up a nick and return a pointer to it.
 440 <p>
 441 This function will return NULL if the nick does not exist.
 442 <p>
 443 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>.
 444 <p>
 445 <div class="fragment"><pre>00199 {
 446 00200         <span class="keywordflow">return</span> Find(nick);
 447 00201 }
 448 </pre></div>    </td>
 449   </tr>
 450 </table>
 451 <a name="a18" doxytag="Server::GetAdmin"></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"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td>
 458           <td class="md" valign="top">(&nbsp;</td>
 459           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 460           <td class="md" valign="top">)&nbsp;</td>
 461           <td class="md" nowrap><code> [virtual]</code></td>
 462         </tr>
 463
 464       </table>
 465     </td>
 466   </tr>
 467 </table>
 468 <table cellspacing=5 cellpadding=0 border=0>
 469   <tr>
 470     <td>
 471       &nbsp;
 472     </td>
 473     <td>
 474
 475 <p>
 476 Returns the information of the server as returned by the /ADMIN command.
 477 <p>
 478 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.
 479 <p>
 480 Definition at line <a class="el" href="modules_8cpp-source.html#l00223">223</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 481 <p>
 482 <div class="fragment"><pre>00224 {
 483 00225         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
 484 00226 }
 485 </pre></div>    </td>
 486   </tr>
 487 </table>
 488 <a name="a17" doxytag="Server::GetNetworkName"></a><p>
 489 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 490   <tr>
 491     <td class="md">
 492       <table cellpadding="0" cellspacing="0" border="0">
 493         <tr>
 494           <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td>
 495           <td class="md" valign="top">(&nbsp;</td>
 496           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 497           <td class="md" valign="top">)&nbsp;</td>
 498           <td class="md" nowrap><code> [virtual]</code></td>
 499         </tr>
 500
 501       </table>
 502     </td>
 503   </tr>
 504 </table>
 505 <table cellspacing=5 cellpadding=0 border=0>
 506   <tr>
 507     <td>
 508       &nbsp;
 509     </td>
 510     <td>
 511
 512 <p>
 513 Returns the network name, global to all linked servers.
 514 <p>
 515
 516 <p>
 517 Definition at line <a class="el" href="modules_8cpp-source.html#l00218">218</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 518 <p>
 519 <div class="fragment"><pre>00219 {
 520 00220         <span class="keywordflow">return</span> getnetworkname();
 521 00221 }
 522 </pre></div>    </td>
 523   </tr>
 524 </table>
 525 <a name="a16" doxytag="Server::GetServerName"></a><p>
 526 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 527   <tr>
 528     <td class="md">
 529       <table cellpadding="0" cellspacing="0" border="0">
 530         <tr>
 531           <td class="md" nowrap valign="top"> std::string Server::GetServerName </td>
 532           <td class="md" valign="top">(&nbsp;</td>
 533           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 534           <td class="md" valign="top">)&nbsp;</td>
 535           <td class="md" nowrap><code> [virtual]</code></td>
 536         </tr>
 537
 538       </table>
 539     </td>
 540   </tr>
 541 </table>
 542 <table cellspacing=5 cellpadding=0 border=0>
 543   <tr>
 544     <td>
 545       &nbsp;
 546     </td>
 547     <td>
 548
 549 <p>
 550 Returns the server name of the server where the module is loaded.
 551 <p>
 552
 553 <p>
 554 Definition at line <a class="el" href="modules_8cpp-source.html#l00213">213</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 555 <p>
 556 <div class="fragment"><pre>00214 {
 557 00215         <span class="keywordflow">return</span> getservername();
 558 00216 }
 559 </pre></div>    </td>
 560   </tr>
 561 </table>
 562 <a name="a12" doxytag="Server::IsNick"></a><p>
 563 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 564   <tr>
 565     <td class="md">
 566       <table cellpadding="0" cellspacing="0" border="0">
 567         <tr>
 568           <td class="md" nowrap valign="top"> bool Server::IsNick </td>
 569           <td class="md" valign="top">(&nbsp;</td>
 570           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 571           <td class="mdname1" valign="top" nowrap>&nbsp; <em>nick</em>          </td>
 572           <td class="md" valign="top">)&nbsp;</td>
 573           <td class="md" nowrap><code> [virtual]</code></td>
 574         </tr>
 575
 576       </table>
 577     </td>
 578   </tr>
 579 </table>
 580 <table cellspacing=5 cellpadding=0 border=0>
 581   <tr>
 582     <td>
 583       &nbsp;
 584     </td>
 585     <td>
 586
 587 <p>
 588 Returns true if a nick is valid.
 589 <p>
 590 Nicks for unregistered connections will return false.
 591 <p>
 592 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>.
 593 <p>
 594 <div class="fragment"><pre>00194 {
 595 00195         <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
 596 00196 }
 597 </pre></div>    </td>
 598   </tr>
 599 </table>
 600 <a name="a3" doxytag="Server::Log"></a><p>
 601 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 602   <tr>
 603     <td class="md">
 604       <table cellpadding="0" cellspacing="0" border="0">
 605         <tr>
 606           <td class="md" nowrap valign="top"> void Server::Log </td>
 607           <td class="md" valign="top">(&nbsp;</td>
 608           <td class="md" nowrap valign="top">int&nbsp;</td>
 609           <td class="mdname" nowrap>&nbsp; <em>level</em>, </td>
 610         </tr>
 611         <tr>
 612           <td></td>
 613           <td></td>
 614           <td class="md" nowrap>std::string&nbsp;</td>
 615           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 616         </tr>
 617         <tr>
 618           <td></td>
 619           <td class="md">)&nbsp;</td>
 620           <td class="md" colspan="2"><code> [virtual]</code></td>
 621         </tr>
 622
 623       </table>
 624     </td>
 625   </tr>
 626 </table>
 627 <table cellspacing=5 cellpadding=0 border=0>
 628   <tr>
 629     <td>
 630       &nbsp;
 631     </td>
 632     <td>
 633
 634 <p>
 635 Writes a log string.
 636 <p>
 637 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.
 638 <p>
 639 Definition at line <a class="el" href="modules_8cpp-source.html#l00124">124</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 640 <p>
 641 <div class="fragment"><pre>00125 {
 642 00126         log(level,<span class="stringliteral">"%s"</span>,s.c_str());
 643 00127 }
 644 </pre></div>    </td>
 645   </tr>
 646 </table>
 647 <a name="a4" doxytag="Server::Send"></a><p>
 648 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 649   <tr>
 650     <td class="md">
 651       <table cellpadding="0" cellspacing="0" border="0">
 652         <tr>
 653           <td class="md" nowrap valign="top"> void Server::Send </td>
 654           <td class="md" valign="top">(&nbsp;</td>
 655           <td class="md" nowrap valign="top">int&nbsp;</td>
 656           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
 657         </tr>
 658         <tr>
 659           <td></td>
 660           <td></td>
 661           <td class="md" nowrap>std::string&nbsp;</td>
 662           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 663         </tr>
 664         <tr>
 665           <td></td>
 666           <td class="md">)&nbsp;</td>
 667           <td class="md" colspan="2"><code> [virtual]</code></td>
 668         </tr>
 669
 670       </table>
 671     </td>
 672   </tr>
 673 </table>
 674 <table cellspacing=5 cellpadding=0 border=0>
 675   <tr>
 676     <td>
 677       &nbsp;
 678     </td>
 679     <td>
 680
 681 <p>
 682 Sends a line of text down a TCP/IP socket.
 683 <p>
 684 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
 685 <p>
 686 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>.
 687 <p>
 688 <div class="fragment"><pre>00140 {
 689 00141         Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
 690 00142 }
 691 </pre></div>    </td>
 692   </tr>
 693 </table>
 694 <a name="a8" doxytag="Server::SendChannel"></a><p>
 695 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 696   <tr>
 697     <td class="md">
 698       <table cellpadding="0" cellspacing="0" border="0">
 699         <tr>
 700           <td class="md" nowrap valign="top"> void Server::SendChannel </td>
 701           <td class="md" valign="top">(&nbsp;</td>
 702           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 703           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 704         </tr>
 705         <tr>
 706           <td></td>
 707           <td></td>
 708           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 709           <td class="mdname" nowrap>&nbsp; <em>Channel</em>, </td>
 710         </tr>
 711         <tr>
 712           <td></td>
 713           <td></td>
 714           <td class="md" nowrap>std::string&nbsp;</td>
 715           <td class="mdname" nowrap>&nbsp; <em>s</em>, </td>
 716         </tr>
 717         <tr>
 718           <td></td>
 719           <td></td>
 720           <td class="md" nowrap>bool&nbsp;</td>
 721           <td class="mdname" nowrap>&nbsp; <em>IncludeSender</em></td>
 722         </tr>
 723         <tr>
 724           <td></td>
 725           <td class="md">)&nbsp;</td>
 726           <td class="md" colspan="2"><code> [virtual]</code></td>
 727         </tr>
 728
 729       </table>
 730     </td>
 731   </tr>
 732 </table>
 733 <table cellspacing=5 cellpadding=0 border=0>
 734   <tr>
 735     <td>
 736       &nbsp;
 737     </td>
 738     <td>
 739
 740 <p>
 741 Sends text from a user to a channel (mulicast).
 742 <p>
 743 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).
 744 <p>
 745 Definition at line <a class="el" href="modules_8cpp-source.html#l00159">159</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 746 <p>
 747 <div class="fragment"><pre>00160 {
 748 00161         <span class="keywordflow">if</span> (IncludeSender)
 749 00162         {
 750 00163                 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 751 00164         }
 752 00165         <span class="keywordflow">else</span>
 753 00166         {
 754 00167                 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
 755 00168         }
 756 00169 }
 757 </pre></div>    </td>
 758   </tr>
 759 </table>
 760 <a name="a10" doxytag="Server::SendCommon"></a><p>
 761 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 762   <tr>
 763     <td class="md">
 764       <table cellpadding="0" cellspacing="0" border="0">
 765         <tr>
 766           <td class="md" nowrap valign="top"> void Server::SendCommon </td>
 767           <td class="md" valign="top">(&nbsp;</td>
 768           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 769           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 770         </tr>
 771         <tr>
 772           <td></td>
 773           <td></td>
 774           <td class="md" nowrap>std::string&nbsp;</td>
 775           <td class="mdname" nowrap>&nbsp; <em>text</em>, </td>
 776         </tr>
 777         <tr>
 778           <td></td>
 779           <td></td>
 780           <td class="md" nowrap>bool&nbsp;</td>
 781           <td class="mdname" nowrap>&nbsp; <em>IncludeSender</em></td>
 782         </tr>
 783         <tr>
 784           <td></td>
 785           <td class="md">)&nbsp;</td>
 786           <td class="md" colspan="2"><code> [virtual]</code></td>
 787         </tr>
 788
 789       </table>
 790     </td>
 791   </tr>
 792 </table>
 793 <table cellspacing=5 cellpadding=0 border=0>
 794   <tr>
 795     <td>
 796       &nbsp;
 797     </td>
 798     <td>
 799
 800 <p>
 801 Sends text from a user to one or more channels (mulicast).
 802 <p>
 803 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.
 804 <p>
 805 Definition at line <a class="el" href="modules_8cpp-source.html#l00176">176</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 806 <p>
 807 <div class="fragment"><pre>00177 {
 808 00178         <span class="keywordflow">if</span> (IncludeSender)
 809 00179         {
 810 00180                 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
 811 00181         }
 812 00182         <span class="keywordflow">else</span>
 813 00183         {
 814 00184                 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
 815 00185         }
 816 00186 }
 817 </pre></div>    </td>
 818   </tr>
 819 </table>
 820 <a name="a6" doxytag="Server::SendFrom"></a><p>
 821 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 822   <tr>
 823     <td class="md">
 824       <table cellpadding="0" cellspacing="0" border="0">
 825         <tr>
 826           <td class="md" nowrap valign="top"> void Server::SendFrom </td>
 827           <td class="md" valign="top">(&nbsp;</td>
 828           <td class="md" nowrap valign="top">int&nbsp;</td>
 829           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
 830         </tr>
 831         <tr>
 832           <td></td>
 833           <td></td>
 834           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 835           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
 836         </tr>
 837         <tr>
 838           <td></td>
 839           <td></td>
 840           <td class="md" nowrap>std::string&nbsp;</td>
 841           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 842         </tr>
 843         <tr>
 844           <td></td>
 845           <td class="md">)&nbsp;</td>
 846           <td class="md" colspan="2"><code> [virtual]</code></td>
 847         </tr>
 848
 849       </table>
 850     </td>
 851   </tr>
 852 </table>
 853 <table cellspacing=5 cellpadding=0 border=0>
 854   <tr>
 855     <td>
 856       &nbsp;
 857     </td>
 858     <td>
 859
 860 <p>
 861 Sends text from a user to a socket.
 862 <p>
 863 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)
 864 <p>
 865 Definition at line <a class="el" href="modules_8cpp-source.html#l00149">149</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 866 <p>
 867 <div class="fragment"><pre>00150 {
 868 00151         WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
 869 00152 }
 870 </pre></div>    </td>
 871   </tr>
 872 </table>
 873 <a name="a21" doxytag="Server::SendMode"></a><p>
 874 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 875   <tr>
 876     <td class="md">
 877       <table cellpadding="0" cellspacing="0" border="0">
 878         <tr>
 879           <td class="md" nowrap valign="top"> void Server::SendMode </td>
 880           <td class="md" valign="top">(&nbsp;</td>
 881           <td class="md" nowrap valign="top">char **&nbsp;</td>
 882           <td class="mdname" nowrap>&nbsp; <em>parameters</em>, </td>
 883         </tr>
 884         <tr>
 885           <td></td>
 886           <td></td>
 887           <td class="md" nowrap>int&nbsp;</td>
 888           <td class="mdname" nowrap>&nbsp; <em>pcnt</em>, </td>
 889         </tr>
 890         <tr>
 891           <td></td>
 892           <td></td>
 893           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 894           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
 895         </tr>
 896         <tr>
 897           <td></td>
 898           <td class="md">)&nbsp;</td>
 899           <td class="md" colspan="2"><code> [virtual]</code></td>
 900         </tr>
 901
 902       </table>
 903     </td>
 904   </tr>
 905 </table>
 906 <table cellspacing=5 cellpadding=0 border=0>
 907   <tr>
 908     <td>
 909       &nbsp;
 910     </td>
 911     <td>
 912
 913 <p>
 914 Sends a servermode.
 915 <p>
 916 you must format the parameters array with the target, modes and parameters for those modes.<p>
 917 For example:<p>
 918 char *modes[3];<p>
 919 modes[0] = ChannelName;<p>
 920 modes[1] = "+o";<p>
 921 modes[2] = user-&gt;nick;<p>
 922 Srv-&gt;SendMode(modes,3,user);<p>
 923 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!
 924 <p>
 925 Definition at line <a class="el" href="modules_8cpp-source.html#l00134">134</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 926 <p>
 927 References <a class="el" href="modules_8h.html#a14">server_mode()</a>.
 928 <p>
 929 <div class="fragment"><pre>00135 {
 930 00136         <a class="code" href="modules_8h.html#a14">server_mode</a>(parameters,pcnt,user);
 931 00137 }
 932 </pre></div>    </td>
 933   </tr>
 934 </table>
 935 <a name="a2" doxytag="Server::SendOpers"></a><p>
 936 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 937   <tr>
 938     <td class="md">
 939       <table cellpadding="0" cellspacing="0" border="0">
 940         <tr>
 941           <td class="md" nowrap valign="top"> void Server::SendOpers </td>
 942           <td class="md" valign="top">(&nbsp;</td>
 943           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 944           <td class="mdname1" valign="top" nowrap>&nbsp; <em>s</em>          </td>
 945           <td class="md" valign="top">)&nbsp;</td>
 946           <td class="md" nowrap><code> [virtual]</code></td>
 947         </tr>
 948
 949       </table>
 950     </td>
 951   </tr>
 952 </table>
 953 <table cellspacing=5 cellpadding=0 border=0>
 954   <tr>
 955     <td>
 956       &nbsp;
 957     </td>
 958     <td>
 959
 960 <p>
 961 Sends text to all opers.
 962 <p>
 963 This method sends a server notice to all opers with the usermode +s.
 964 <p>
 965 Definition at line <a class="el" href="modules_8cpp-source.html#l00119">119</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 966 <p>
 967 <div class="fragment"><pre>00120 {
 968 00121         WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
 969 00122 }
 970 </pre></div>    </td>
 971   </tr>
 972 </table>
 973 <a name="a5" doxytag="Server::SendServ"></a><p>
 974 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 975   <tr>
 976     <td class="md">
 977       <table cellpadding="0" cellspacing="0" border="0">
 978         <tr>
 979           <td class="md" nowrap valign="top"> void Server::SendServ </td>
 980           <td class="md" valign="top">(&nbsp;</td>
 981           <td class="md" nowrap valign="top">int&nbsp;</td>
 982           <td class="mdname" nowrap>&nbsp; <em>Socket</em>, </td>
 983         </tr>
 984         <tr>
 985           <td></td>
 986           <td></td>
 987           <td class="md" nowrap>std::string&nbsp;</td>
 988           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
 989         </tr>
 990         <tr>
 991           <td></td>
 992           <td class="md">)&nbsp;</td>
 993           <td class="md" colspan="2"><code> [virtual]</code></td>
 994         </tr>
 995
 996       </table>
 997     </td>
 998   </tr>
 999 </table>
1000 <table cellspacing=5 cellpadding=0 border=0>
1001   <tr>
1002     <td>
1003       &nbsp;
1004     </td>
1005     <td>
1006
1007 <p>
1008 Sends text from the server to a socket.
1009 <p>
1010 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
1011 <p>
1012 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>.
1013 <p>
1014 <div class="fragment"><pre>00145 {
1015 00146         WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1016 00147 }
1017 </pre></div>    </td>
1018   </tr>
1019 </table>
1020 <a name="a7" doxytag="Server::SendTo"></a><p>
1021 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1022   <tr>
1023     <td class="md">
1024       <table cellpadding="0" cellspacing="0" border="0">
1025         <tr>
1026           <td class="md" nowrap valign="top"> void Server::SendTo </td>
1027           <td class="md" valign="top">(&nbsp;</td>
1028           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1029           <td class="mdname" nowrap>&nbsp; <em>Source</em>, </td>
1030         </tr>
1031         <tr>
1032           <td></td>
1033           <td></td>
1034           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1035           <td class="mdname" nowrap>&nbsp; <em>Dest</em>, </td>
1036         </tr>
1037         <tr>
1038           <td></td>
1039           <td></td>
1040           <td class="md" nowrap>std::string&nbsp;</td>
1041           <td class="mdname" nowrap>&nbsp; <em>s</em></td>
1042         </tr>
1043         <tr>
1044           <td></td>
1045           <td class="md">)&nbsp;</td>
1046           <td class="md" colspan="2"><code> [virtual]</code></td>
1047         </tr>
1048
1049       </table>
1050     </td>
1051   </tr>
1052 </table>
1053 <table cellspacing=5 cellpadding=0 border=0>
1054   <tr>
1055     <td>
1056       &nbsp;
1057     </td>
1058     <td>
1059
1060 <p>
1061 Sends text from a user to another user.
1062 <p>
1063 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)
1064 <p>
1065 Definition at line <a class="el" href="modules_8cpp-source.html#l00154">154</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1066 <p>
1067 <div class="fragment"><pre>00155 {
1068 00156         WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
1069 00157 }
1070 </pre></div>    </td>
1071   </tr>
1072 </table>
1073 <a name="a11" doxytag="Server::SendWallops"></a><p>
1074 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1075   <tr>
1076     <td class="md">
1077       <table cellpadding="0" cellspacing="0" border="0">
1078         <tr>
1079           <td class="md" nowrap valign="top"> void Server::SendWallops </td>
1080           <td class="md" valign="top">(&nbsp;</td>
1081           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1082           <td class="mdname" nowrap>&nbsp; <em>User</em>, </td>
1083         </tr>
1084         <tr>
1085           <td></td>
1086           <td></td>
1087           <td class="md" nowrap>std::string&nbsp;</td>
1088           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
1089         </tr>
1090         <tr>
1091           <td></td>
1092           <td class="md">)&nbsp;</td>
1093           <td class="md" colspan="2"><code> [virtual]</code></td>
1094         </tr>
1095
1096       </table>
1097     </td>
1098   </tr>
1099 </table>
1100 <table cellspacing=5 cellpadding=0 border=0>
1101   <tr>
1102     <td>
1103       &nbsp;
1104     </td>
1105     <td>
1106
1107 <p>
1108 Sends a WALLOPS message.
1109 <p>
1110 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
1111 <p>
1112 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>.
1113 <p>
1114 <div class="fragment"><pre>00189 {
1115 00190         WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
1116 00191 }
1117 </pre></div>    </td>
1118   </tr>
1119 </table>
1120 <hr>The documentation for this class was generated from the following files:<ul>
1121 <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>
1122 <hr><address style="align: right;"><small>Generated on Sat Apr 3 16:36:18 2004 for InspIRCd by
1123 <a href="http://www.doxygen.org/index.html">
1124 <img src="doxygen.png" alt="doxygen" align="middle" border=0
1125 width=110 height=53></a>1.3-rc3 </small></address>
1126 </body>
1127 </html>