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>
68 <hr><a name="_details"></a><h2>Detailed Description</h2>
69 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.
71 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
75 Definition at line <a class="el" href="modules_8h-source.html#l00163">163</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
76 <a name="a0" doxytag="Server::Server"></a><p>
77 <table width="100%" cellpadding="2" cellspacing="0" border="0">
80 <table cellpadding="0" cellspacing="0" border="0">
82 <td class="md" nowrap valign="top"> Server::Server </td>
83 <td class="md" valign="top">( </td>
84 <td class="mdname1" valign="top" nowrap> </td>
85 <td class="md" valign="top">) </td>
86 <td class="md" nowrap></td>
93 <table cellspacing=5 cellpadding=0 border=0>
103 Creates a Server object.
105 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>.
107 <div class="fragment"><pre>00106 {
112 <a name="a1" doxytag="Server::~Server"></a><p>
113 <table width="100%" cellpadding="2" cellspacing="0" border="0">
116 <table cellpadding="0" cellspacing="0" border="0">
118 <td class="md" nowrap valign="top"> Server::~Server </td>
119 <td class="md" valign="top">( </td>
120 <td class="mdname1" valign="top" nowrap> </td>
121 <td class="md" valign="top">) </td>
122 <td class="md" nowrap><code> [virtual]</code></td>
129 <table cellspacing=5 cellpadding=0 border=0>
139 Destroys a Server object.
141 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>.
143 <div class="fragment"><pre>00110 {
148 <hr><h2>Member Function Documentation</h2>
149 <a name="a20" doxytag="Server::AddCommand"></a><p>
150 <table width="100%" cellpadding="2" cellspacing="0" border="0">
153 <table cellpadding="0" cellspacing="0" border="0">
155 <td class="md" nowrap valign="top"> void Server::AddCommand </td>
156 <td class="md" valign="top">( </td>
157 <td class="md" nowrap valign="top">char * </td>
158 <td class="mdname" nowrap> <em>cmd</em>, </td>
163 <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a> </td>
164 <td class="mdname" nowrap> <em>f</em>, </td>
169 <td class="md" nowrap>char </td>
170 <td class="mdname" nowrap> <em>flags</em>, </td>
175 <td class="md" nowrap>int </td>
176 <td class="mdname" nowrap> <em>minparams</em></td>
180 <td class="md">) </td>
181 <td class="md" colspan="2"><code> [virtual]</code></td>
188 <table cellspacing=5 cellpadding=0 border=0>
196 Adds a command to the command table.
198 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>
199 typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)<p>
200 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'.
202 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>.
204 References <a class="el" href="modules_8h.html#a12">createcommand()</a>.
206 <div class="fragment"><pre>00124 {
207 00125 <a class="code" href="modules_8h.html#a12">createcommand</a>(cmd,f,flags,minparams);
212 <a name="a19" doxytag="Server::AddExtendedMode"></a><p>
213 <table width="100%" cellpadding="2" cellspacing="0" border="0">
216 <table cellpadding="0" cellspacing="0" border="0">
218 <td class="md" nowrap valign="top"> bool Server::AddExtendedMode </td>
219 <td class="md" valign="top">( </td>
220 <td class="md" nowrap valign="top">char </td>
221 <td class="mdname" nowrap> <em>modechar</em>, </td>
226 <td class="md" nowrap>int </td>
227 <td class="mdname" nowrap> <em>type</em>, </td>
232 <td class="md" nowrap>bool </td>
233 <td class="mdname" nowrap> <em>default_on</em>, </td>
238 <td class="md" nowrap>int </td>
239 <td class="mdname" nowrap> <em>params_when_on</em>, </td>
244 <td class="md" nowrap>int </td>
245 <td class="mdname" nowrap> <em>params_when_off</em></td>
249 <td class="md">) </td>
250 <td class="md" colspan="2"><code> [virtual]</code></td>
257 <table cellspacing=5 cellpadding=0 border=0>
265 Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.
267 +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.
269 Definition at line <a class="el" href="modules_8cpp-source.html#l00220">220</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
271 <div class="fragment"><pre>00221 {
276 <a name="a15" doxytag="Server::ChanMode"></a><p>
277 <table width="100%" cellpadding="2" cellspacing="0" border="0">
280 <table cellpadding="0" cellspacing="0" border="0">
282 <td class="md" nowrap valign="top"> std::string Server::ChanMode </td>
283 <td class="md" valign="top">( </td>
284 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
285 <td class="mdname" nowrap> <em>User</em>, </td>
290 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
291 <td class="mdname" nowrap> <em>Chan</em></td>
295 <td class="md">) </td>
296 <td class="md" colspan="2"><code> [virtual]</code></td>
303 <table cellspacing=5 cellpadding=0 border=0>
311 Attempts to look up a user's privilages on a channel.
313 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
315 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>.
317 <div class="fragment"><pre>00199 {
318 00200 <span class="keywordflow">return</span> cmode(User,Chan);
323 <a name="a9" doxytag="Server::CommonChannels"></a><p>
324 <table width="100%" cellpadding="2" cellspacing="0" border="0">
327 <table cellpadding="0" cellspacing="0" border="0">
329 <td class="md" nowrap valign="top"> bool Server::CommonChannels </td>
330 <td class="md" valign="top">( </td>
331 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
332 <td class="mdname" nowrap> <em>u1</em>, </td>
337 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
338 <td class="mdname" nowrap> <em>u2</em></td>
342 <td class="md">) </td>
343 <td class="md" colspan="2"><code> [virtual]</code></td>
350 <table cellspacing=5 cellpadding=0 border=0>
358 Returns true if two users share a common channel.
360 This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#a10">Server::SendCommon</a> method.
362 Definition at line <a class="el" href="modules_8cpp-source.html#l00161">161</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
364 <div class="fragment"><pre>00162 {
365 00163 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0);
370 <a name="a14" doxytag="Server::FindChannel"></a><p>
371 <table width="100%" cellpadding="2" cellspacing="0" border="0">
374 <table cellpadding="0" cellspacing="0" border="0">
376 <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td>
377 <td class="md" valign="top">( </td>
378 <td class="md" nowrap valign="top">std::string </td>
379 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
380 <td class="md" valign="top">) </td>
381 <td class="md" nowrap><code> [virtual]</code></td>
388 <table cellspacing=5 cellpadding=0 border=0>
396 Attempts to look up a channel and return a pointer to it.
398 This function will return NULL if the channel does not exist.
400 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>.
402 <div class="fragment"><pre>00194 {
403 00195 <span class="keywordflow">return</span> FindChan(channel.c_str());
408 <a name="a13" doxytag="Server::FindNick"></a><p>
409 <table width="100%" cellpadding="2" cellspacing="0" border="0">
412 <table cellpadding="0" cellspacing="0" border="0">
414 <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td>
415 <td class="md" valign="top">( </td>
416 <td class="md" nowrap valign="top">std::string </td>
417 <td class="mdname1" valign="top" nowrap> <em>nick</em> </td>
418 <td class="md" valign="top">) </td>
419 <td class="md" nowrap><code> [virtual]</code></td>
426 <table cellspacing=5 cellpadding=0 border=0>
434 Attempts to look up a nick and return a pointer to it.
436 This function will return NULL if the nick does not exist.
438 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>.
440 <div class="fragment"><pre>00189 {
441 00190 <span class="keywordflow">return</span> Find(nick);
446 <a name="a18" doxytag="Server::GetAdmin"></a><p>
447 <table width="100%" cellpadding="2" cellspacing="0" border="0">
450 <table cellpadding="0" cellspacing="0" border="0">
452 <td class="md" nowrap valign="top"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td>
453 <td class="md" valign="top">( </td>
454 <td class="mdname1" valign="top" nowrap> </td>
455 <td class="md" valign="top">) </td>
456 <td class="md" nowrap><code> [virtual]</code></td>
463 <table cellspacing=5 cellpadding=0 border=0>
471 Returns the information of the server as returned by the /ADMIN command.
473 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.
475 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>.
477 <div class="fragment"><pre>00214 {
478 00215 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
483 <a name="a17" doxytag="Server::GetNetworkName"></a><p>
484 <table width="100%" cellpadding="2" cellspacing="0" border="0">
487 <table cellpadding="0" cellspacing="0" border="0">
489 <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td>
490 <td class="md" valign="top">( </td>
491 <td class="mdname1" valign="top" nowrap> </td>
492 <td class="md" valign="top">) </td>
493 <td class="md" nowrap><code> [virtual]</code></td>
500 <table cellspacing=5 cellpadding=0 border=0>
508 Returns the network name, global to all linked servers.
512 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>.
514 <div class="fragment"><pre>00209 {
515 00210 <span class="keywordflow">return</span> getnetworkname();
520 <a name="a16" doxytag="Server::GetServerName"></a><p>
521 <table width="100%" cellpadding="2" cellspacing="0" border="0">
524 <table cellpadding="0" cellspacing="0" border="0">
526 <td class="md" nowrap valign="top"> std::string Server::GetServerName </td>
527 <td class="md" valign="top">( </td>
528 <td class="mdname1" valign="top" nowrap> </td>
529 <td class="md" valign="top">) </td>
530 <td class="md" nowrap><code> [virtual]</code></td>
537 <table cellspacing=5 cellpadding=0 border=0>
545 Returns the server name of the server where the module is loaded.
549 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>.
551 <div class="fragment"><pre>00204 {
552 00205 <span class="keywordflow">return</span> getservername();
557 <a name="a12" doxytag="Server::IsNick"></a><p>
558 <table width="100%" cellpadding="2" cellspacing="0" border="0">
561 <table cellpadding="0" cellspacing="0" border="0">
563 <td class="md" nowrap valign="top"> bool Server::IsNick </td>
564 <td class="md" valign="top">( </td>
565 <td class="md" nowrap valign="top">std::string </td>
566 <td class="mdname1" valign="top" nowrap> <em>nick</em> </td>
567 <td class="md" valign="top">) </td>
568 <td class="md" nowrap><code> [virtual]</code></td>
575 <table cellspacing=5 cellpadding=0 border=0>
583 Returns true if a nick is valid.
585 Nicks for unregistered connections will return false.
587 Definition at line <a class="el" href="modules_8cpp-source.html#l00183">183</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
589 <div class="fragment"><pre>00184 {
590 00185 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0);
595 <a name="a3" doxytag="Server::Log"></a><p>
596 <table width="100%" cellpadding="2" cellspacing="0" border="0">
599 <table cellpadding="0" cellspacing="0" border="0">
601 <td class="md" nowrap valign="top"> void Server::Log </td>
602 <td class="md" valign="top">( </td>
603 <td class="md" nowrap valign="top">int </td>
604 <td class="mdname" nowrap> <em>level</em>, </td>
609 <td class="md" nowrap>std::string </td>
610 <td class="mdname" nowrap> <em>s</em></td>
614 <td class="md">) </td>
615 <td class="md" colspan="2"><code> [virtual]</code></td>
622 <table cellspacing=5 cellpadding=0 border=0>
632 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.
634 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>.
636 <div class="fragment"><pre>00119 {
637 00120 log(level,<span class="stringliteral">"%s"</span>,s.c_str());
642 <a name="a4" doxytag="Server::Send"></a><p>
643 <table width="100%" cellpadding="2" cellspacing="0" border="0">
646 <table cellpadding="0" cellspacing="0" border="0">
648 <td class="md" nowrap valign="top"> void Server::Send </td>
649 <td class="md" valign="top">( </td>
650 <td class="md" nowrap valign="top">int </td>
651 <td class="mdname" nowrap> <em>Socket</em>, </td>
656 <td class="md" nowrap>std::string </td>
657 <td class="mdname" nowrap> <em>s</em></td>
661 <td class="md">) </td>
662 <td class="md" colspan="2"><code> [virtual]</code></td>
669 <table cellspacing=5 cellpadding=0 border=0>
677 Sends a line of text down a TCP/IP socket.
679 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
681 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>.
683 <div class="fragment"><pre>00130 {
684 00131 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
689 <a name="a8" doxytag="Server::SendChannel"></a><p>
690 <table width="100%" cellpadding="2" cellspacing="0" border="0">
693 <table cellpadding="0" cellspacing="0" border="0">
695 <td class="md" nowrap valign="top"> void Server::SendChannel </td>
696 <td class="md" valign="top">( </td>
697 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
698 <td class="mdname" nowrap> <em>User</em>, </td>
703 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
704 <td class="mdname" nowrap> <em>Channel</em>, </td>
709 <td class="md" nowrap>std::string </td>
710 <td class="mdname" nowrap> <em>s</em>, </td>
715 <td class="md" nowrap>bool </td>
716 <td class="mdname" nowrap> <em>IncludeSender</em></td>
720 <td class="md">) </td>
721 <td class="md" colspan="2"><code> [virtual]</code></td>
728 <table cellspacing=5 cellpadding=0 border=0>
736 Sends text from a user to a channel (mulicast).
738 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).
740 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>.
742 <div class="fragment"><pre>00150 {
743 00151 <span class="keywordflow">if</span> (IncludeSender)
745 00153 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
747 00155 <span class="keywordflow">else</span>
749 00157 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
755 <a name="a10" doxytag="Server::SendCommon"></a><p>
756 <table width="100%" cellpadding="2" cellspacing="0" border="0">
759 <table cellpadding="0" cellspacing="0" border="0">
761 <td class="md" nowrap valign="top"> void Server::SendCommon </td>
762 <td class="md" valign="top">( </td>
763 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
764 <td class="mdname" nowrap> <em>User</em>, </td>
769 <td class="md" nowrap>std::string </td>
770 <td class="mdname" nowrap> <em>text</em>, </td>
775 <td class="md" nowrap>bool </td>
776 <td class="mdname" nowrap> <em>IncludeSender</em></td>
780 <td class="md">) </td>
781 <td class="md" colspan="2"><code> [virtual]</code></td>
788 <table cellspacing=5 cellpadding=0 border=0>
796 Sends text from a user to one or more channels (mulicast).
798 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.
800 Definition at line <a class="el" href="modules_8cpp-source.html#l00166">166</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
802 <div class="fragment"><pre>00167 {
803 00168 <span class="keywordflow">if</span> (IncludeSender)
805 00170 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
807 00172 <span class="keywordflow">else</span>
809 00174 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
815 <a name="a6" doxytag="Server::SendFrom"></a><p>
816 <table width="100%" cellpadding="2" cellspacing="0" border="0">
819 <table cellpadding="0" cellspacing="0" border="0">
821 <td class="md" nowrap valign="top"> void Server::SendFrom </td>
822 <td class="md" valign="top">( </td>
823 <td class="md" nowrap valign="top">int </td>
824 <td class="mdname" nowrap> <em>Socket</em>, </td>
829 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
830 <td class="mdname" nowrap> <em>User</em>, </td>
835 <td class="md" nowrap>std::string </td>
836 <td class="mdname" nowrap> <em>s</em></td>
840 <td class="md">) </td>
841 <td class="md" colspan="2"><code> [virtual]</code></td>
848 <table cellspacing=5 cellpadding=0 border=0>
856 Sends text from a user to a socket.
858 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)
860 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>.
862 <div class="fragment"><pre>00140 {
863 00141 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
868 <a name="a2" doxytag="Server::SendOpers"></a><p>
869 <table width="100%" cellpadding="2" cellspacing="0" border="0">
872 <table cellpadding="0" cellspacing="0" border="0">
874 <td class="md" nowrap valign="top"> void Server::SendOpers </td>
875 <td class="md" valign="top">( </td>
876 <td class="md" nowrap valign="top">std::string </td>
877 <td class="mdname1" valign="top" nowrap> <em>s</em> </td>
878 <td class="md" valign="top">) </td>
879 <td class="md" nowrap><code> [virtual]</code></td>
886 <table cellspacing=5 cellpadding=0 border=0>
894 Sends text to all opers.
896 This method sends a server notice to all opers with the usermode +s.
898 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>.
900 <div class="fragment"><pre>00114 {
901 00115 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
906 <a name="a5" doxytag="Server::SendServ"></a><p>
907 <table width="100%" cellpadding="2" cellspacing="0" border="0">
910 <table cellpadding="0" cellspacing="0" border="0">
912 <td class="md" nowrap valign="top"> void Server::SendServ </td>
913 <td class="md" valign="top">( </td>
914 <td class="md" nowrap valign="top">int </td>
915 <td class="mdname" nowrap> <em>Socket</em>, </td>
920 <td class="md" nowrap>std::string </td>
921 <td class="mdname" nowrap> <em>s</em></td>
925 <td class="md">) </td>
926 <td class="md" colspan="2"><code> [virtual]</code></td>
933 <table cellspacing=5 cellpadding=0 border=0>
941 Sends text from the server to a socket.
943 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
945 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>.
947 <div class="fragment"><pre>00135 {
948 00136 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
953 <a name="a7" doxytag="Server::SendTo"></a><p>
954 <table width="100%" cellpadding="2" cellspacing="0" border="0">
957 <table cellpadding="0" cellspacing="0" border="0">
959 <td class="md" nowrap valign="top"> void Server::SendTo </td>
960 <td class="md" valign="top">( </td>
961 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
962 <td class="mdname" nowrap> <em>Source</em>, </td>
967 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
968 <td class="mdname" nowrap> <em>Dest</em>, </td>
973 <td class="md" nowrap>std::string </td>
974 <td class="mdname" nowrap> <em>s</em></td>
978 <td class="md">) </td>
979 <td class="md" colspan="2"><code> [virtual]</code></td>
986 <table cellspacing=5 cellpadding=0 border=0>
994 Sends text from a user to another user.
996 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)
998 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>.
1000 <div class="fragment"><pre>00145 {
1001 00146 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
1006 <a name="a11" doxytag="Server::SendWallops"></a><p>
1007 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1010 <table cellpadding="0" cellspacing="0" border="0">
1012 <td class="md" nowrap valign="top"> void Server::SendWallops </td>
1013 <td class="md" valign="top">( </td>
1014 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1015 <td class="mdname" nowrap> <em>User</em>, </td>
1020 <td class="md" nowrap>std::string </td>
1021 <td class="mdname" nowrap> <em>text</em></td>
1025 <td class="md">) </td>
1026 <td class="md" colspan="2"><code> [virtual]</code></td>
1033 <table cellspacing=5 cellpadding=0 border=0>
1041 Sends a WALLOPS message.
1043 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
1045 Definition at line <a class="el" href="modules_8cpp-source.html#l00178">178</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1047 <div class="fragment"><pre>00179 {
1048 00180 WriteWallOps(User,<span class="stringliteral">"%s"</span>,text.c_str());
1053 <hr>The documentation for this class was generated from the following files:<ul>
1054 <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>
1055 <hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:43 2004 for InspIRCd by
1056 <a href="http://www.doxygen.org/index.html">
1057 <img src="doxygen.png" alt="doxygen" align="middle" border=0
1058 width=110 height=53></a>1.3-rc3 </small></address>