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">
6 <!-- Generated by Doxygen 1.3-rc3 -->
8 <a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
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>
12 <code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code>
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="">
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="">
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>
24 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classServer.html#a0">Server</a> ()</td></tr>
26 <tr><td> </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 </td><td valign=bottom><a class="el" href="classServer.html#a1">~Server</a> ()</td></tr>
28 <tr><td> </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 </td><td valign=bottom><a class="el" href="classServer.html#a2">SendOpers</a> (std::string s)</td></tr>
30 <tr><td> </td><td><font size=-1><em>Sends text to all opers.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
31 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a3">Log</a> (int level, std::string s)</td></tr>
32 <tr><td> </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 </td><td valign=bottom><a class="el" href="classServer.html#a4">Send</a> (int Socket, std::string s)</td></tr>
34 <tr><td> </td><td><font size=-1><em>Sends a line of text down a TCP/IP socket.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
35 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a5">SendServ</a> (int Socket, std::string s)</td></tr>
36 <tr><td> </td><td><font size=-1><em>Sends text from the server to a socket.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
37 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a6">SendFrom</a> (int Socket, <a class="el" href="classuserrec.html">userrec</a> *User, std::string s)</td></tr>
38 <tr><td> </td><td><font size=-1><em>Sends text from a user to a socket.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
39 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a7">SendTo</a> (<a class="el" href="classuserrec.html">userrec</a> *Source, <a class="el" href="classuserrec.html">userrec</a> *Dest, std::string s)</td></tr>
40 <tr><td> </td><td><font size=-1><em>Sends text from a user to another user.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
41 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a8">SendChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Channel, std::string s, bool IncludeSender)</td></tr>
42 <tr><td> </td><td><font size=-1><em>Sends text from a user to a channel (mulicast).</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
43 <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a9">CommonChannels</a> (<a class="el" href="classuserrec.html">userrec</a> *u1, <a class="el" href="classuserrec.html">userrec</a> *u2)</td></tr>
44 <tr><td> </td><td><font size=-1><em>Returns true if two users share a common channel.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
45 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a10">SendCommon</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text, bool IncludeSender)</td></tr>
46 <tr><td> </td><td><font size=-1><em>Sends text from a user to one or more channels (mulicast).</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
47 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a11">SendWallops</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text)</td></tr>
48 <tr><td> </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 </td><td valign=bottom><a class="el" href="classServer.html#a12">IsNick</a> (std::string nick)</td></tr>
50 <tr><td> </td><td><font size=-1><em>Returns true if a nick is valid.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
51 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classuserrec.html">userrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a13">FindNick</a> (std::string nick)</td></tr>
52 <tr><td> </td><td><font size=-1><em>Attempts to look up a nick and return a pointer to it.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
53 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td valign=bottom><a class="el" href="classServer.html#a14">FindChannel</a> (std::string channel)</td></tr>
54 <tr><td> </td><td><font size=-1><em>Attempts to look up a channel and return a pointer to it.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
55 <tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a15">ChanMode</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr>
56 <tr><td> </td><td><font size=-1><em>Attempts to look up a user's privilages on a channel.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
57 <tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a16">GetServerName</a> ()</td></tr>
58 <tr><td> </td><td><font size=-1><em>Returns the server name of the server where the module is loaded.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
59 <tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classServer.html#a17">GetNetworkName</a> ()</td></tr>
60 <tr><td> </td><td><font size=-1><em>Returns the network name, global to all linked servers.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
61 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classAdmin.html">Admin</a> </td><td valign=bottom><a class="el" href="classServer.html#a18">GetAdmin</a> ()</td></tr>
62 <tr><td> </td><td><font size=-1><em>Returns the information of the server as returned by the /ADMIN command.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
63 <tr><td nowrap align=right valign=top>virtual bool </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> </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 </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> </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 </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> </td><td><font size=-1><em>Sends a servermode.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
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.
73 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
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 & Destructor Documentation</h2>
78 <a name="a0" doxytag="Server::Server"></a><p>
79 <table width="100%" cellpadding="2" cellspacing="0" border="0">
82 <table cellpadding="0" cellspacing="0" border="0">
84 <td class="md" nowrap valign="top"> Server::Server </td>
85 <td class="md" valign="top">( </td>
86 <td class="mdname1" valign="top" nowrap> </td>
87 <td class="md" valign="top">) </td>
88 <td class="md" nowrap></td>
95 <table cellspacing=5 cellpadding=0 border=0>
105 Creates a Server object.
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>.
109 <div class="fragment"><pre>00106 {
114 <a name="a1" doxytag="Server::~Server"></a><p>
115 <table width="100%" cellpadding="2" cellspacing="0" border="0">
118 <table cellpadding="0" cellspacing="0" border="0">
120 <td class="md" nowrap valign="top"> Server::~Server </td>
121 <td class="md" valign="top">( </td>
122 <td class="mdname1" valign="top" nowrap> </td>
123 <td class="md" valign="top">) </td>
124 <td class="md" nowrap><code> [virtual]</code></td>
131 <table cellspacing=5 cellpadding=0 border=0>
141 Destroys a Server object.
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>.
145 <div class="fragment"><pre>00110 {
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">
155 <table cellpadding="0" cellspacing="0" border="0">
157 <td class="md" nowrap valign="top"> void Server::AddCommand </td>
158 <td class="md" valign="top">( </td>
159 <td class="md" nowrap valign="top">char * </td>
160 <td class="mdname" nowrap> <em>cmd</em>, </td>
165 <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a> </td>
166 <td class="mdname" nowrap> <em>f</em>, </td>
171 <td class="md" nowrap>char </td>
172 <td class="mdname" nowrap> <em>flags</em>, </td>
177 <td class="md" nowrap>int </td>
178 <td class="mdname" nowrap> <em>minparams</em></td>
182 <td class="md">) </td>
183 <td class="md" colspan="2"><code> [virtual]</code></td>
190 <table cellspacing=5 cellpadding=0 border=0>
198 Adds a command to the command table.
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'.
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>.
206 References <a class="el" href="modules_8h.html#a12">createcommand()</a>.
208 <div class="fragment"><pre>00124 {
209 00125 <a class="code" href="modules_8h.html#a12">createcommand</a>(cmd,f,flags,minparams);
214 <a name="a19" doxytag="Server::AddExtendedMode"></a><p>
215 <table width="100%" cellpadding="2" cellspacing="0" border="0">
218 <table cellpadding="0" cellspacing="0" border="0">
220 <td class="md" nowrap valign="top"> bool Server::AddExtendedMode </td>
221 <td class="md" valign="top">( </td>
222 <td class="md" nowrap valign="top">char </td>
223 <td class="mdname" nowrap> <em>modechar</em>, </td>
228 <td class="md" nowrap>int </td>
229 <td class="mdname" nowrap> <em>type</em>, </td>
234 <td class="md" nowrap>bool </td>
235 <td class="mdname" nowrap> <em>default_on</em>, </td>
240 <td class="md" nowrap>int </td>
241 <td class="mdname" nowrap> <em>params_when_on</em>, </td>
246 <td class="md" nowrap>int </td>
247 <td class="mdname" nowrap> <em>params_when_off</em></td>
251 <td class="md">) </td>
252 <td class="md" colspan="2"><code> [virtual]</code></td>
259 <table cellspacing=5 cellpadding=0 border=0>
267 Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.
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.
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>.
273 <div class="fragment"><pre>00225 {
278 <a name="a15" doxytag="Server::ChanMode"></a><p>
279 <table width="100%" cellpadding="2" cellspacing="0" border="0">
282 <table cellpadding="0" cellspacing="0" border="0">
284 <td class="md" nowrap valign="top"> std::string Server::ChanMode </td>
285 <td class="md" valign="top">( </td>
286 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
287 <td class="mdname" nowrap> <em>User</em>, </td>
292 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
293 <td class="mdname" nowrap> <em>Chan</em></td>
297 <td class="md">) </td>
298 <td class="md" colspan="2"><code> [virtual]</code></td>
305 <table cellspacing=5 cellpadding=0 border=0>
313 Attempts to look up a user's privilages on a channel.
315 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
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>.
319 <div class="fragment"><pre>00203 {
320 00204 <span class="keywordflow">return</span> cmode(User,Chan);
325 <a name="a9" doxytag="Server::CommonChannels"></a><p>
326 <table width="100%" cellpadding="2" cellspacing="0" border="0">
329 <table cellpadding="0" cellspacing="0" border="0">
331 <td class="md" nowrap valign="top"> bool Server::CommonChannels </td>
332 <td class="md" valign="top">( </td>
333 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
334 <td class="mdname" nowrap> <em>u1</em>, </td>
339 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
340 <td class="mdname" nowrap> <em>u2</em></td>
344 <td class="md">) </td>
345 <td class="md" colspan="2"><code> [virtual]</code></td>
352 <table cellspacing=5 cellpadding=0 border=0>
360 Returns true if two users share a common channel.
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.
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>.
366 <div class="fragment"><pre>00166 {
367 00167 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
372 <a name="a14" doxytag="Server::FindChannel"></a><p>
373 <table width="100%" cellpadding="2" cellspacing="0" border="0">
376 <table cellpadding="0" cellspacing="0" border="0">
378 <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td>
379 <td class="md" valign="top">( </td>
380 <td class="md" nowrap valign="top">std::string </td>
381 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
382 <td class="md" valign="top">) </td>
383 <td class="md" nowrap><code> [virtual]</code></td>
390 <table cellspacing=5 cellpadding=0 border=0>
398 Attempts to look up a channel and return a pointer to it.
400 This function will return NULL if the channel does not exist.
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>.
404 <div class="fragment"><pre>00198 {
405 00199 <span class="keywordflow">return</span> FindChan(channel.c_str());
410 <a name="a13" doxytag="Server::FindNick"></a><p>
411 <table width="100%" cellpadding="2" cellspacing="0" border="0">
414 <table cellpadding="0" cellspacing="0" border="0">
416 <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td>
417 <td class="md" valign="top">( </td>
418 <td class="md" nowrap valign="top">std::string </td>
419 <td class="mdname1" valign="top" nowrap> <em>nick</em> </td>
420 <td class="md" valign="top">) </td>
421 <td class="md" nowrap><code> [virtual]</code></td>
428 <table cellspacing=5 cellpadding=0 border=0>
436 Attempts to look up a nick and return a pointer to it.
438 This function will return NULL if the nick does not exist.
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>.
442 <div class="fragment"><pre>00193 {
443 00194 <span class="keywordflow">return</span> Find(nick);
448 <a name="a18" doxytag="Server::GetAdmin"></a><p>
449 <table width="100%" cellpadding="2" cellspacing="0" border="0">
452 <table cellpadding="0" cellspacing="0" border="0">
454 <td class="md" nowrap valign="top"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td>
455 <td class="md" valign="top">( </td>
456 <td class="mdname1" valign="top" nowrap> </td>
457 <td class="md" valign="top">) </td>
458 <td class="md" nowrap><code> [virtual]</code></td>
465 <table cellspacing=5 cellpadding=0 border=0>
473 Returns the information of the server as returned by the /ADMIN command.
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.
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>.
479 <div class="fragment"><pre>00218 {
480 00219 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
485 <a name="a17" doxytag="Server::GetNetworkName"></a><p>
486 <table width="100%" cellpadding="2" cellspacing="0" border="0">
489 <table cellpadding="0" cellspacing="0" border="0">
491 <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td>
492 <td class="md" valign="top">( </td>
493 <td class="mdname1" valign="top" nowrap> </td>
494 <td class="md" valign="top">) </td>
495 <td class="md" nowrap><code> [virtual]</code></td>
502 <table cellspacing=5 cellpadding=0 border=0>
510 Returns the network name, global to all linked servers.
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>.
516 <div class="fragment"><pre>00213 {
517 00214 <span class="keywordflow">return</span> getnetworkname();
522 <a name="a16" doxytag="Server::GetServerName"></a><p>
523 <table width="100%" cellpadding="2" cellspacing="0" border="0">
526 <table cellpadding="0" cellspacing="0" border="0">
528 <td class="md" nowrap valign="top"> std::string Server::GetServerName </td>
529 <td class="md" valign="top">( </td>
530 <td class="mdname1" valign="top" nowrap> </td>
531 <td class="md" valign="top">) </td>
532 <td class="md" nowrap><code> [virtual]</code></td>
539 <table cellspacing=5 cellpadding=0 border=0>
547 Returns the server name of the server where the module is loaded.
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>.
553 <div class="fragment"><pre>00208 {
554 00209 <span class="keywordflow">return</span> getservername();
559 <a name="a12" doxytag="Server::IsNick"></a><p>
560 <table width="100%" cellpadding="2" cellspacing="0" border="0">
563 <table cellpadding="0" cellspacing="0" border="0">
565 <td class="md" nowrap valign="top"> bool Server::IsNick </td>
566 <td class="md" valign="top">( </td>
567 <td class="md" nowrap valign="top">std::string </td>
568 <td class="mdname1" valign="top" nowrap> <em>nick</em> </td>
569 <td class="md" valign="top">) </td>
570 <td class="md" nowrap><code> [virtual]</code></td>
577 <table cellspacing=5 cellpadding=0 border=0>
585 Returns true if a nick is valid.
587 Nicks for unregistered connections will return false.
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>.
591 <div class="fragment"><pre>00188 {
592 00189 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
597 <a name="a3" doxytag="Server::Log"></a><p>
598 <table width="100%" cellpadding="2" cellspacing="0" border="0">
601 <table cellpadding="0" cellspacing="0" border="0">
603 <td class="md" nowrap valign="top"> void Server::Log </td>
604 <td class="md" valign="top">( </td>
605 <td class="md" nowrap valign="top">int </td>
606 <td class="mdname" nowrap> <em>level</em>, </td>
611 <td class="md" nowrap>std::string </td>
612 <td class="mdname" nowrap> <em>s</em></td>
616 <td class="md">) </td>
617 <td class="md" colspan="2"><code> [virtual]</code></td>
624 <table cellspacing=5 cellpadding=0 border=0>
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.
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>.
638 <div class="fragment"><pre>00119 {
639 00120 log(level,<span class="stringliteral">"%s"</span>,s.c_str());
644 <a name="a4" doxytag="Server::Send"></a><p>
645 <table width="100%" cellpadding="2" cellspacing="0" border="0">
648 <table cellpadding="0" cellspacing="0" border="0">
650 <td class="md" nowrap valign="top"> void Server::Send </td>
651 <td class="md" valign="top">( </td>
652 <td class="md" nowrap valign="top">int </td>
653 <td class="mdname" nowrap> <em>Socket</em>, </td>
658 <td class="md" nowrap>std::string </td>
659 <td class="mdname" nowrap> <em>s</em></td>
663 <td class="md">) </td>
664 <td class="md" colspan="2"><code> [virtual]</code></td>
671 <table cellspacing=5 cellpadding=0 border=0>
679 Sends a line of text down a TCP/IP socket.
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.
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>.
685 <div class="fragment"><pre>00134 {
686 00135 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
691 <a name="a8" doxytag="Server::SendChannel"></a><p>
692 <table width="100%" cellpadding="2" cellspacing="0" border="0">
695 <table cellpadding="0" cellspacing="0" border="0">
697 <td class="md" nowrap valign="top"> void Server::SendChannel </td>
698 <td class="md" valign="top">( </td>
699 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
700 <td class="mdname" nowrap> <em>User</em>, </td>
705 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
706 <td class="mdname" nowrap> <em>Channel</em>, </td>
711 <td class="md" nowrap>std::string </td>
712 <td class="mdname" nowrap> <em>s</em>, </td>
717 <td class="md" nowrap>bool </td>
718 <td class="mdname" nowrap> <em>IncludeSender</em></td>
722 <td class="md">) </td>
723 <td class="md" colspan="2"><code> [virtual]</code></td>
730 <table cellspacing=5 cellpadding=0 border=0>
738 Sends text from a user to a channel (mulicast).
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).
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>.
744 <div class="fragment"><pre>00154 {
745 00155 <span class="keywordflow">if</span> (IncludeSender)
747 00157 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
749 00159 <span class="keywordflow">else</span>
751 00161 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
757 <a name="a10" doxytag="Server::SendCommon"></a><p>
758 <table width="100%" cellpadding="2" cellspacing="0" border="0">
761 <table cellpadding="0" cellspacing="0" border="0">
763 <td class="md" nowrap valign="top"> void Server::SendCommon </td>
764 <td class="md" valign="top">( </td>
765 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
766 <td class="mdname" nowrap> <em>User</em>, </td>
771 <td class="md" nowrap>std::string </td>
772 <td class="mdname" nowrap> <em>text</em>, </td>
777 <td class="md" nowrap>bool </td>
778 <td class="mdname" nowrap> <em>IncludeSender</em></td>
782 <td class="md">) </td>
783 <td class="md" colspan="2"><code> [virtual]</code></td>
790 <table cellspacing=5 cellpadding=0 border=0>
798 Sends text from a user to one or more channels (mulicast).
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.
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>.
804 <div class="fragment"><pre>00171 {
805 00172 <span class="keywordflow">if</span> (IncludeSender)
807 00174 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
809 00176 <span class="keywordflow">else</span>
811 00178 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
817 <a name="a6" doxytag="Server::SendFrom"></a><p>
818 <table width="100%" cellpadding="2" cellspacing="0" border="0">
821 <table cellpadding="0" cellspacing="0" border="0">
823 <td class="md" nowrap valign="top"> void Server::SendFrom </td>
824 <td class="md" valign="top">( </td>
825 <td class="md" nowrap valign="top">int </td>
826 <td class="mdname" nowrap> <em>Socket</em>, </td>
831 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
832 <td class="mdname" nowrap> <em>User</em>, </td>
837 <td class="md" nowrap>std::string </td>
838 <td class="mdname" nowrap> <em>s</em></td>
842 <td class="md">) </td>
843 <td class="md" colspan="2"><code> [virtual]</code></td>
850 <table cellspacing=5 cellpadding=0 border=0>
858 Sends text from a user to a socket.
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)
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>.
864 <div class="fragment"><pre>00144 {
865 00145 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
870 <a name="a21" doxytag="Server::SendMode"></a><p>
871 <table width="100%" cellpadding="2" cellspacing="0" border="0">
874 <table cellpadding="0" cellspacing="0" border="0">
876 <td class="md" nowrap valign="top"> void Server::SendMode </td>
877 <td class="md" valign="top">( </td>
878 <td class="md" nowrap valign="top">char ** </td>
879 <td class="mdname" nowrap> <em>parameters</em>, </td>
884 <td class="md" nowrap>int </td>
885 <td class="mdname" nowrap> <em>pcnt</em>, </td>
890 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
891 <td class="mdname" nowrap> <em>user</em></td>
895 <td class="md">) </td>
896 <td class="md" colspan="2"><code> [virtual]</code></td>
903 <table cellspacing=5 cellpadding=0 border=0>
913 you must format the parameters array with the target, modes and parameters for those modes.<p>
915 char modes[3][MAXBUF]; modes[0] = ChannelName; modes[1] = "+o"; modes[2] = user->nick; Srv->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!
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>.
920 References <a class="el" href="modules_8h.html#a13">server_mode()</a>.
922 <div class="fragment"><pre>00129 {
923 00130 <a class="code" href="modules_8h.html#a13">server_mode</a>(parameters,pcnt,user);
928 <a name="a2" doxytag="Server::SendOpers"></a><p>
929 <table width="100%" cellpadding="2" cellspacing="0" border="0">
932 <table cellpadding="0" cellspacing="0" border="0">
934 <td class="md" nowrap valign="top"> void Server::SendOpers </td>
935 <td class="md" valign="top">( </td>
936 <td class="md" nowrap valign="top">std::string </td>
937 <td class="mdname1" valign="top" nowrap> <em>s</em> </td>
938 <td class="md" valign="top">) </td>
939 <td class="md" nowrap><code> [virtual]</code></td>
946 <table cellspacing=5 cellpadding=0 border=0>
954 Sends text to all opers.
956 This method sends a server notice to all opers with the usermode +s.
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>.
960 <div class="fragment"><pre>00114 {
961 00115 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
966 <a name="a5" doxytag="Server::SendServ"></a><p>
967 <table width="100%" cellpadding="2" cellspacing="0" border="0">
970 <table cellpadding="0" cellspacing="0" border="0">
972 <td class="md" nowrap valign="top"> void Server::SendServ </td>
973 <td class="md" valign="top">( </td>
974 <td class="md" nowrap valign="top">int </td>
975 <td class="mdname" nowrap> <em>Socket</em>, </td>
980 <td class="md" nowrap>std::string </td>
981 <td class="mdname" nowrap> <em>s</em></td>
985 <td class="md">) </td>
986 <td class="md" colspan="2"><code> [virtual]</code></td>
993 <table cellspacing=5 cellpadding=0 border=0>
1001 Sends text from the server to a socket.
1003 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
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>.
1007 <div class="fragment"><pre>00139 {
1008 00140 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1013 <a name="a7" doxytag="Server::SendTo"></a><p>
1014 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1017 <table cellpadding="0" cellspacing="0" border="0">
1019 <td class="md" nowrap valign="top"> void Server::SendTo </td>
1020 <td class="md" valign="top">( </td>
1021 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1022 <td class="mdname" nowrap> <em>Source</em>, </td>
1027 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
1028 <td class="mdname" nowrap> <em>Dest</em>, </td>
1033 <td class="md" nowrap>std::string </td>
1034 <td class="mdname" nowrap> <em>s</em></td>
1038 <td class="md">) </td>
1039 <td class="md" colspan="2"><code> [virtual]</code></td>
1046 <table cellspacing=5 cellpadding=0 border=0>
1054 Sends text from a user to another user.
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)
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>.
1060 <div class="fragment"><pre>00149 {
1061 00150 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
1066 <a name="a11" doxytag="Server::SendWallops"></a><p>
1067 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1070 <table cellpadding="0" cellspacing="0" border="0">
1072 <td class="md" nowrap valign="top"> void Server::SendWallops </td>
1073 <td class="md" valign="top">( </td>
1074 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1075 <td class="mdname" nowrap> <em>User</em>, </td>
1080 <td class="md" nowrap>std::string </td>
1081 <td class="mdname" nowrap> <em>text</em></td>
1085 <td class="md">) </td>
1086 <td class="md" colspan="2"><code> [virtual]</code></td>
1093 <table cellspacing=5 cellpadding=0 border=0>
1101 Sends a WALLOPS message.
1103 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
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>.
1107 <div class="fragment"><pre>00183 {
1108 00184 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
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>