]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classServer.html
Fixed binary images in this dir that cvs2svn stored as ascii
[user/henk/code/inspircd.git] / docs / module-doc / classServer.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>InspIRCd: Server Class Reference</title>
4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.4.4-20050815 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
8 <h1>Server Class Reference</h1><!-- doxytag: class="Server" --><!-- doxytag: inherits="classbase" -->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.  
9 <a href="#_details">More...</a>
10 <p>
11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
12 <p>
13 Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph.gif" border="0" usemap="#Server__inherit__map" alt="Inheritance graph"></center>
14 <map name="Server__inherit__map">
15 <area href="classclassbase.html" shape="rect" coords="7,7,87,34" alt="">
16 </map>
17 <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>
18 <map name="Server__coll__map">
19 <area href="classclassbase.html" shape="rect" coords="7,97,87,124" alt="">
20 </map>
21 <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">
22 <tr><td></td></tr>
23 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
24 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#Server_28_29">Server</a> ()</td></tr>
25
26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#Server_28_29"></a><br></td></tr>
27 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#_7EServer_28_29">~Server</a> ()</td></tr>
28
29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#_7EServer_28_29"></a><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classServerConfig.html">ServerConfig</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetConfig_28_29">GetConfig</a> ()</td></tr>
31
32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtains a pointer to the server's <a class="el" href="classServerConfig.html">ServerConfig</a> object.  <a href="#GetConfig_28_29"></a><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendOpers_28std_3A_3Astring_20s_29">SendOpers</a> (<a class="el" href="namespaceirc.html#string">std::string</a> s)</td></tr>
34
35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends text to all opers.  <a href="#SendOpers_28std_3A_3Astring_20s_29"></a><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetVersion_28_29">GetVersion</a> ()</td></tr>
37
38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the version string of this server.  <a href="#GetVersion_28_29"></a><br></td></tr>
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#Log_28int_20level_2C_20std_3A_3Astring_20s_29">Log</a> (int level, <a class="el" href="namespaceirc.html#string">std::string</a> s)</td></tr>
40
41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes a log string.  <a href="#Log_28int_20level_2C_20std_3A_3Astring_20s_29"></a><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#Send_28int_20Socket_2C_20std_3A_3Astring_20s_29">Send</a> (int Socket, <a class="el" href="namespaceirc.html#string">std::string</a> s)</td></tr>
43
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends a line of text down a TCP/IP socket.  <a href="#Send_28int_20Socket_2C_20std_3A_3Astring_20s_29"></a><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendServ_28int_20Socket_2C_20std_3A_3Astring_20s_29">SendServ</a> (int Socket, <a class="el" href="namespaceirc.html#string">std::string</a> s)</td></tr>
46
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends text from the server to a socket.  <a href="#SendServ_28int_20Socket_2C_20std_3A_3Astring_20s_29"></a><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendChannelServerNotice_28std_3A_3Astring_20ServName_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20text_29">SendChannelServerNotice</a> (<a class="el" href="namespaceirc.html#string">std::string</a> ServName, <a class="el" href="classchanrec.html">chanrec</a> *Channel, <a class="el" href="namespaceirc.html#string">std::string</a> text)</td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes text to a channel, but from a server, including all.  <a href="#SendChannelServerNotice_28std_3A_3Astring_20ServName_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20text_29"></a><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendFrom_28int_20Socket_2C_20userrec_20_2AUser_2C_20std_3A_3Astring_20s_29">SendFrom</a> (int Socket, <a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="namespaceirc.html#string">std::string</a> s)</td></tr>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends text from a user to a socket.  <a href="#SendFrom_28int_20Socket_2C_20userrec_20_2AUser_2C_20std_3A_3Astring_20s_29"></a><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendTo_28userrec_20_2ASource_2C_20userrec_20_2ADest_2C_20std_3A_3Astring_20s_29">SendTo</a> (<a class="el" href="classuserrec.html">userrec</a> *Source, <a class="el" href="classuserrec.html">userrec</a> *Dest, <a class="el" href="namespaceirc.html#string">std::string</a> s)</td></tr>
55
56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends text from a user to another user.  <a href="#SendTo_28userrec_20_2ASource_2C_20userrec_20_2ADest_2C_20std_3A_3Astring_20s_29"></a><br></td></tr>
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20s_2C_20bool_20IncludeSender_29">SendChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Channel, <a class="el" href="namespaceirc.html#string">std::string</a> s, bool IncludeSender)</td></tr>
58
59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends text from a user to a channel (mulicast).  <a href="#SendChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20s_2C_20bool_20IncludeSender_29"></a><br></td></tr>
60 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#CommonChannels_28userrec_20_2Au_31_2C_20userrec_20_2Au_32_29">CommonChannels</a> (<a class="el" href="classuserrec.html">userrec</a> *u1, <a class="el" href="classuserrec.html">userrec</a> *u2)</td></tr>
61
62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if two users share a common channel.  <a href="#CommonChannels_28userrec_20_2Au_31_2C_20userrec_20_2Au_32_29"></a><br></td></tr>
63 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendCommon_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_2C_20bool_20IncludeSender_29">SendCommon</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="namespaceirc.html#string">std::string</a> text, bool IncludeSender)</td></tr>
64
65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends text from a user to one or more channels (mulicast).  <a href="#SendCommon_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_2C_20bool_20IncludeSender_29"></a><br></td></tr>
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendWallops_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_29">SendWallops</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="namespaceirc.html#string">std::string</a> text)</td></tr>
67
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends a WALLOPS message.  <a href="#SendWallops_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_29"></a><br></td></tr>
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#IsNick_28std_3A_3Astring_20nick_29">IsNick</a> (<a class="el" href="namespaceirc.html#string">std::string</a> nick)</td></tr>
70
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if a nick is valid.  <a href="#IsNick_28std_3A_3Astring_20nick_29"></a><br></td></tr>
72 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#CountUsers_28chanrec_20_2Ac_29">CountUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *c)</td></tr>
73
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a count of the number of users on a channel.  <a href="#CountUsers_28chanrec_20_2Ac_29"></a><br></td></tr>
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#FindNick_28std_3A_3Astring_20nick_29">FindNick</a> (<a class="el" href="namespaceirc.html#string">std::string</a> nick)</td></tr>
76
77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to look up a nick and return a pointer to it.  <a href="#FindNick_28std_3A_3Astring_20nick_29"></a><br></td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#FindDescriptor_28int_20socket_29">FindDescriptor</a> (int socket)</td></tr>
79
80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to look up a nick using the file descriptor associated with that nick.  <a href="#FindDescriptor_28int_20socket_29"></a><br></td></tr>
81 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#FindChannel_28std_3A_3Astring_20channel_29">FindChannel</a> (<a class="el" href="namespaceirc.html#string">std::string</a> channel)</td></tr>
82
83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to look up a channel and return a pointer to it.  <a href="#FindChannel_28std_3A_3Astring_20channel_29"></a><br></td></tr>
84 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#ChanMode_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29">ChanMode</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr>
85
86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to look up a user's privilages on a channel.  <a href="#ChanMode_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29"></a><br></td></tr>
87 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#IsOnChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29">IsOnChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr>
88
89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if a user is on a channel.  <a href="#IsOnChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29"></a><br></td></tr>
90 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetServerName_28_29">GetServerName</a> ()</td></tr>
91
92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the server name of the server where the module is loaded.  <a href="#GetServerName_28_29"></a><br></td></tr>
93 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetNetworkName_28_29">GetNetworkName</a> ()</td></tr>
94
95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the network name, global to all linked servers.  <a href="#GetNetworkName_28_29"></a><br></td></tr>
96 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetServerDescription_28_29">GetServerDescription</a> ()</td></tr>
97
98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the server description string of the local server.  <a href="#GetServerDescription_28_29"></a><br></td></tr>
99 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classAdmin.html">Admin</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetAdmin_28_29">GetAdmin</a> ()</td></tr>
100
101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the information of the server as returned by the /ADMIN command.  <a href="#GetAdmin_28_29"></a><br></td></tr>
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fwhen_5Fon_2C_20int_20params_5Fwhen_5Foff_29">AddExtendedMode</a> (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)</td></tr>
103
104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds an extended mode letter which is parsed by a module.  <a href="#AddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fwhen_5Fon_2C_20int_20params_5Fwhen_5Foff_29"></a><br></td></tr>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddExtendedListMode_28char_20modechar_29">AddExtendedListMode</a> (char modechar)</td></tr>
106
107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds an extended mode letter which is parsed by a module and handled in a list fashion.  <a href="#AddExtendedListMode_28char_20modechar_29"></a><br></td></tr>
108 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddCommand_28command_5Ft_20_2Af_29">AddCommand</a> (<a class="el" href="classcommand__t.html">command_t</a> *f)</td></tr>
109
110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a command to the command table.  <a href="#AddCommand_28command_5Ft_20_2Af_29"></a><br></td></tr>
111 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendMode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">SendMode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
112
113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends a servermode.  <a href="#SendMode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><br></td></tr>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#SendToModeMask_28std_3A_3Astring_20modes_2C_20int_20flags_2C_20std_3A_3Astring_20text_29">SendToModeMask</a> (<a class="el" href="namespaceirc.html#string">std::string</a> modes, int flags, <a class="el" href="namespaceirc.html#string">std::string</a> text)</td></tr>
115
116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.  <a href="#SendToModeMask_28std_3A_3Astring_20modes_2C_20int_20flags_2C_20std_3A_3Astring_20text_29"></a><br></td></tr>
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#JoinUserToChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20key_29">JoinUserToChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> cname, <a class="el" href="namespaceirc.html#string">std::string</a> key)</td></tr>
118
119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forces a user to join a channel.  <a href="#JoinUserToChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20key_29"></a><br></td></tr>
120 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#PartUserFromChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20reason_29">PartUserFromChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> cname, <a class="el" href="namespaceirc.html#string">std::string</a> reason)</td></tr>
121
122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forces a user to part a channel.  <a href="#PartUserFromChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20reason_29"></a><br></td></tr>
123 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#ChangeUserNick_28userrec_20_2Auser_2C_20std_3A_3Astring_20nickname_29">ChangeUserNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> nickname)</td></tr>
124
125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forces a user nickchange.  <a href="#ChangeUserNick_28userrec_20_2Auser_2C_20std_3A_3Astring_20nickname_29"></a><br></td></tr>
126 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#QuitUser_28userrec_20_2Auser_2C_20std_3A_3Astring_20reason_29">QuitUser</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> reason)</td></tr>
127
128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forces a user to quit with the specified reason.  <a href="#QuitUser_28userrec_20_2Auser_2C_20std_3A_3Astring_20reason_29"></a><br></td></tr>
129 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#MatchText_28std_3A_3Astring_20sliteral_2C_20std_3A_3Astring_20spattern_29">MatchText</a> (<a class="el" href="namespaceirc.html#string">std::string</a> sliteral, <a class="el" href="namespaceirc.html#string">std::string</a> spattern)</td></tr>
130
131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matches text against a glob pattern.  <a href="#MatchText_28std_3A_3Astring_20sliteral_2C_20std_3A_3Astring_20spattern_29"></a><br></td></tr>
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#CallCommandHandler_28std_3A_3Astring_20commandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">CallCommandHandler</a> (<a class="el" href="namespaceirc.html#string">std::string</a> commandname, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
133
134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calls the handler for a command, either implemented by the core or by another module.  <a href="#CallCommandHandler_28std_3A_3Astring_20commandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><br></td></tr>
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#IsValidModuleCommand_28std_3A_3Astring_20commandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">IsValidModuleCommand</a> (<a class="el" href="namespaceirc.html#string">std::string</a> commandname, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
136
137 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#ChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20host_29">ChangeHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> host)</td></tr>
138
139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change displayed hostname of a user.  <a href="#ChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20host_29"></a><br></td></tr>
140 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#ChangeGECOS_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29">ChangeGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> gecos)</td></tr>
141
142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change GECOS (fullname) of a user.  <a href="#ChangeGECOS_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29"></a><br></td></tr>
143 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#IsUlined_28std_3A_3Astring_20server_29">IsUlined</a> (<a class="el" href="namespaceirc.html#string">std::string</a> server)</td></tr>
144
145 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the servername you give is ulined.  <a href="#IsUlined_28std_3A_3Astring_20server_29"></a><br></td></tr>
146 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="modules_8h.html#chanuserlist">chanuserlist</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#GetUsers_28chanrec_20_2Achan_29">GetUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
147
148 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fetches the userlist of a channel.  <a href="#GetUsers_28chanrec_20_2Achan_29"></a><br></td></tr>
149 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#UserToPseudo_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_29">UserToPseudo</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> message)</td></tr>
150
151 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a user's connection to the irc server, but leave their client in existence in the user hash.  <a href="#UserToPseudo_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_29"></a><br></td></tr>
152 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#PseudoToUser_28userrec_20_2Aalive_2C_20userrec_20_2Azombie_2C_20std_3A_3Astring_20message_29">PseudoToUser</a> (<a class="el" href="classuserrec.html">userrec</a> *alive, <a class="el" href="classuserrec.html">userrec</a> *zombie, <a class="el" href="namespaceirc.html#string">std::string</a> message)</td></tr>
153
154 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other.  <a href="#PseudoToUser_28userrec_20_2Aalive_2C_20userrec_20_2Azombie_2C_20std_3A_3Astring_20message_29"></a><br></td></tr>
155 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddGLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29">AddGLine</a> (long duration, <a class="el" href="namespaceirc.html#string">std::string</a> source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
156
157 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.  <a href="#AddGLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
158 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddQLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickname_29">AddQLine</a> (long duration, <a class="el" href="namespaceirc.html#string">std::string</a> source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> nickname)</td></tr>
159
160 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.  <a href="#AddQLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickname_29"></a><br></td></tr>
161 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddZLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipaddr_29">AddZLine</a> (long duration, <a class="el" href="namespaceirc.html#string">std::string</a> source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> ipaddr)</td></tr>
162
163 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.  <a href="#AddZLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipaddr_29"></a><br></td></tr>
164 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddKLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29">AddKLine</a> (long duration, <a class="el" href="namespaceirc.html#string">std::string</a> source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
165
166 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a K-line The K-line is enforced as soon as it is added.  <a href="#AddKLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
167 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddELine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29">AddELine</a> (long duration, <a class="el" href="namespaceirc.html#string">std::string</a> source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
168
169 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a E-line The E-line is enforced as soon as it is added.  <a href="#AddELine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
170 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelGLine_28std_3A_3Astring_20hostmask_29">DelGLine</a> (<a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
171
172 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes a G-Line from all servers on the mesh.  <a href="#DelGLine_28std_3A_3Astring_20hostmask_29"></a><br></td></tr>
173 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelQLine_28std_3A_3Astring_20nickname_29">DelQLine</a> (<a class="el" href="namespaceirc.html#string">std::string</a> nickname)</td></tr>
174
175 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes a Q-Line from all servers on the mesh.  <a href="#DelQLine_28std_3A_3Astring_20nickname_29"></a><br></td></tr>
176 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelZLine_28std_3A_3Astring_20ipaddr_29">DelZLine</a> (<a class="el" href="namespaceirc.html#string">std::string</a> ipaddr)</td></tr>
177
178 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes a Z-Line from all servers on the mesh.  <a href="#DelZLine_28std_3A_3Astring_20ipaddr_29"></a><br></td></tr>
179 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelKLine_28std_3A_3Astring_20hostmask_29">DelKLine</a> (<a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
180
181 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes a local K-Line.  <a href="#DelKLine_28std_3A_3Astring_20hostmask_29"></a><br></td></tr>
182 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelELine_28std_3A_3Astring_20hostmask_29">DelELine</a> (<a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
183
184 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes a local E-Line.  <a href="#DelELine_28std_3A_3Astring_20hostmask_29"></a><br></td></tr>
185 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">CalcDuration</a> (<a class="el" href="namespaceirc.html#string">std::string</a> duration)</td></tr>
186
187 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculates a duration This method will take a string containing a formatted duration (e.g.  <a href="#CalcDuration_28std_3A_3Astring_20duration_29"></a><br></td></tr>
188 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#IsValidMask_28std_3A_3Astring_20mask_29">IsValidMask</a> (<a class="el" href="namespaceirc.html#string">std::string</a> mask)</td></tr>
189
190 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if a nick!ident string is correctly formatted, false if otherwise.  <a href="#IsValidMask_28std_3A_3Astring_20mask_29"></a><br></td></tr>
191 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classModule.html">Module</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#FindModule_28std_3A_3Astring_20name_29">FindModule</a> (<a class="el" href="namespaceirc.html#string">std::string</a> name)</td></tr>
192
193 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function finds a module by name.  <a href="#FindModule_28std_3A_3Astring_20name_29"></a><br></td></tr>
194 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#AddSocket_28InspSocket_20_2Asock_29">AddSocket</a> (<a class="el" href="classInspSocket.html">InspSocket</a> *sock)</td></tr>
195
196 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> to the server's socket engine.  <a href="#AddSocket_28InspSocket_20_2Asock_29"></a><br></td></tr>
197 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelSocket_28InspSocket_20_2Asock_29">DelSocket</a> (<a class="el" href="classInspSocket.html">InspSocket</a> *sock)</td></tr>
198
199 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deletes a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> from the server's socket engine.  <a href="#DelSocket_28InspSocket_20_2Asock_29"></a><br></td></tr>
200 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#RehashServer_28_29">RehashServer</a> ()</td></tr>
201
202 </table>
203 <hr><a name="_details"></a><h2>Detailed Description</h2>
204 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. 
205 <p>
206 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
207 <p>
208
209 <p>
210 Definition at line <a class="el" href="modules_8h-source.html#l01114">1114</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
211 <a class="anchor" name="Server_28_29"></a><!-- doxytag: member="Server::Server" ref="Server_28_29" args="()" --><p>
212 <table class="mdTable" cellpadding="2" cellspacing="0">
213   <tr>
214     <td class="mdRow">
215       <table cellpadding="0" cellspacing="0" border="0">
216         <tr>
217           <td class="md" nowrap valign="top">Server::Server           </td>
218           <td class="md" valign="top">(&nbsp;</td>
219           <td class="mdname1" valign="top" nowrap>          </td>
220           <td class="md" valign="top">&nbsp;)&nbsp;</td>
221           <td class="md" nowrap></td>
222         </tr>
223       </table>
224     </td>
225   </tr>
226 </table>
227 <table cellspacing="5" cellpadding="0" border="0">
228   <tr>
229     <td>
230       &nbsp;
231     </td>
232     <td>
233
234 <p>
235 Default constructor. 
236 <p>
237 Creates a Server object.
238 <p>
239 Definition at line <a class="el" href="modules_8cpp-source.html#l00304">304</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00305"></a>00305 {
240 <a name="l00306"></a>00306 }
241 </pre></div>
242 <p>
243     </td>
244   </tr>
245 </table>
246 <a class="anchor" name="_7EServer_28_29"></a><!-- doxytag: member="Server::~Server" ref="_7EServer_28_29" args="()" --><p>
247 <table class="mdTable" cellpadding="2" cellspacing="0">
248   <tr>
249     <td class="mdRow">
250       <table cellpadding="0" cellspacing="0" border="0">
251         <tr>
252           <td class="md" nowrap valign="top">Server::~Server           </td>
253           <td class="md" valign="top">(&nbsp;</td>
254           <td class="mdname1" valign="top" nowrap>          </td>
255           <td class="md" valign="top">&nbsp;)&nbsp;</td>
256           <td class="md" nowrap><code> [virtual]</code></td>
257         </tr>
258       </table>
259     </td>
260   </tr>
261 </table>
262 <table cellspacing="5" cellpadding="0" border="0">
263   <tr>
264     <td>
265       &nbsp;
266     </td>
267     <td>
268
269 <p>
270 Default destructor. 
271 <p>
272 Destroys a Server object.
273 <p>
274 Definition at line <a class="el" href="modules_8cpp-source.html#l00308">308</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00309"></a>00309 {
275 <a name="l00310"></a>00310 }
276 </pre></div>
277 <p>
278     </td>
279   </tr>
280 </table>
281 <hr><h2>Member Function Documentation</h2>
282 <a class="anchor" name="AddCommand_28command_5Ft_20_2Af_29"></a><!-- doxytag: member="Server::AddCommand" ref="AddCommand_28command_5Ft_20_2Af_29" args="(command_t *f)" --><p>
283 <table class="mdTable" cellpadding="2" cellspacing="0">
284   <tr>
285     <td class="mdRow">
286       <table cellpadding="0" cellspacing="0" border="0">
287         <tr>
288           <td class="md" nowrap valign="top">void Server::AddCommand           </td>
289           <td class="md" valign="top">(&nbsp;</td>
290           <td class="md" nowrap valign="top"><a class="el" href="classcommand__t.html">command_t</a> *&nbsp;</td>
291           <td class="mdname1" valign="top" nowrap> <em>f</em>          </td>
292           <td class="md" valign="top">&nbsp;)&nbsp;</td>
293           <td class="md" nowrap><code> [virtual]</code></td>
294         </tr>
295       </table>
296     </td>
297   </tr>
298 </table>
299 <table cellspacing="5" cellpadding="0" border="0">
300   <tr>
301     <td>
302       &nbsp;
303     </td>
304     <td>
305
306 <p>
307 Adds a command to the command table. 
308 <p>
309 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>
310 typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)<p>
311 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'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded.
312 <p>
313 Definition at line <a class="el" href="modules_8cpp-source.html#l00415">415</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
314 <p>
315 References <a class="el" href="inspircd_8h-source.html#l00110">InspIRCd::Parser</a>.<div class="fragment"><pre class="fragment"><a name="l00416"></a>00416 {
316 <a name="l00417"></a>00417         <a class="code" href="modules_8cpp.html#ServerInstance">ServerInstance</a>-&gt;<a class="code" href="classInspIRCd.html#Parser">Parser</a>-&gt;CreateCommand(f);
317 <a name="l00418"></a>00418 }
318 </pre></div>
319 <p>
320     </td>
321   </tr>
322 </table>
323 <a class="anchor" name="AddELine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Server::AddELine" ref="AddELine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29" args="(long duration, std::string source, std::string reason, std::string hostmask)" --><p>
324 <table class="mdTable" cellpadding="2" cellspacing="0">
325   <tr>
326     <td class="mdRow">
327       <table cellpadding="0" cellspacing="0" border="0">
328         <tr>
329           <td class="md" nowrap valign="top">void Server::AddELine           </td>
330           <td class="md" valign="top">(&nbsp;</td>
331           <td class="md" nowrap valign="top">long&nbsp;</td>
332           <td class="mdname" nowrap> <em>duration</em>, </td>
333         </tr>
334         <tr>
335           <td class="md" nowrap align="right"></td>
336           <td class="md"></td>
337           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
338           <td class="mdname" nowrap> <em>source</em>, </td>
339         </tr>
340         <tr>
341           <td class="md" nowrap align="right"></td>
342           <td class="md"></td>
343           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
344           <td class="mdname" nowrap> <em>reason</em>, </td>
345         </tr>
346         <tr>
347           <td class="md" nowrap align="right"></td>
348           <td class="md"></td>
349           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
350           <td class="mdname" nowrap> <em>hostmask</em></td>
351         </tr>
352         <tr>
353           <td class="md"></td>
354           <td class="md">)&nbsp;</td>
355           <td class="md" colspan="2"><code> [virtual]</code></td>
356         </tr>
357       </table>
358     </td>
359   </tr>
360 </table>
361 <table cellspacing="5" cellpadding="0" border="0">
362   <tr>
363     <td>
364       &nbsp;
365     </td>
366     <td>
367
368 <p>
369 Adds a E-line The E-line is enforced as soon as it is added. 
370 <p>
371 The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
372 <p>
373 Definition at line <a class="el" href="modules_8cpp-source.html#l00659">659</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
374 <p>
375 References <a class="el" href="xline_8h.html#add_5Feline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_eline()</a>.<div class="fragment"><pre class="fragment"><a name="l00660"></a>00660 {
376 <a name="l00661"></a>00661         <a class="code" href="xline_8h.html#add_5Feline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_eline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str());
377 <a name="l00662"></a>00662 }
378 </pre></div>
379 <p>
380     </td>
381   </tr>
382 </table>
383 <a class="anchor" name="AddExtendedListMode_28char_20modechar_29"></a><!-- doxytag: member="Server::AddExtendedListMode" ref="AddExtendedListMode_28char_20modechar_29" args="(char modechar)" --><p>
384 <table class="mdTable" cellpadding="2" cellspacing="0">
385   <tr>
386     <td class="mdRow">
387       <table cellpadding="0" cellspacing="0" border="0">
388         <tr>
389           <td class="md" nowrap valign="top">bool Server::AddExtendedListMode           </td>
390           <td class="md" valign="top">(&nbsp;</td>
391           <td class="md" nowrap valign="top">char&nbsp;</td>
392           <td class="mdname1" valign="top" nowrap> <em>modechar</em>          </td>
393           <td class="md" valign="top">&nbsp;)&nbsp;</td>
394           <td class="md" nowrap><code> [virtual]</code></td>
395         </tr>
396       </table>
397     </td>
398   </tr>
399 </table>
400 <table cellspacing="5" cellpadding="0" border="0">
401   <tr>
402     <td>
403       &nbsp;
404     </td>
405     <td>
406
407 <p>
408 Adds an extended mode letter which is parsed by a module and handled in a list fashion. 
409 <p>
410 This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:<p>
411 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL<p>
412 (2) They always take exactly one parameter when being added or removed<p>
413 (3) They can be set multiple times, usually on users in channels<p>
414 (4) The mode and its parameter are NOT stored in the channels modes structure<p>
415 It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use <a class="el" href="globals_8h.html#Find_28std_3A_3Astring_20nick_29">Server::Find</a> to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.
416 <p>
417 Definition at line <a class="el" href="modules_8cpp-source.html#l00583">583</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
418 <p>
419 References <a class="el" href="modules_8cpp-source.html#l00133">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00143">ModeMakeList()</a>, and <a class="el" href="modules_8h-source.html#l00031">MT_CHANNEL</a>.<div class="fragment"><pre class="fragment"><a name="l00584"></a>00584 {
420 <a name="l00585"></a>00585         <span class="keywordtype">bool</span> res = <a class="code" href="modules_8cpp.html#DoAddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fon_2C_20int_20params_5Foff_29">DoAddExtendedMode</a>(modechar,<a class="code" href="modules_8h.html#MT_5FCHANNEL">MT_CHANNEL</a>,<span class="keyword">false</span>,1,1);
421 <a name="l00586"></a>00586         <span class="keywordflow">if</span> (res)
422 <a name="l00587"></a>00587                 <a class="code" href="modules_8cpp.html#ModeMakeList_28char_20modechar_29">ModeMakeList</a>(modechar);
423 <a name="l00588"></a>00588         <span class="keywordflow">return</span> res;
424 <a name="l00589"></a>00589 }
425 </pre></div>
426 <p>
427     </td>
428   </tr>
429 </table>
430 <a class="anchor" name="AddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fwhen_5Fon_2C_20int_20params_5Fwhen_5Foff_29"></a><!-- doxytag: member="Server::AddExtendedMode" ref="AddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fwhen_5Fon_2C_20int_20params_5Fwhen_5Foff_29" args="(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)" --><p>
431 <table class="mdTable" cellpadding="2" cellspacing="0">
432   <tr>
433     <td class="mdRow">
434       <table cellpadding="0" cellspacing="0" border="0">
435         <tr>
436           <td class="md" nowrap valign="top">bool Server::AddExtendedMode           </td>
437           <td class="md" valign="top">(&nbsp;</td>
438           <td class="md" nowrap valign="top">char&nbsp;</td>
439           <td class="mdname" nowrap> <em>modechar</em>, </td>
440         </tr>
441         <tr>
442           <td class="md" nowrap align="right"></td>
443           <td class="md"></td>
444           <td class="md" nowrap>int&nbsp;</td>
445           <td class="mdname" nowrap> <em>type</em>, </td>
446         </tr>
447         <tr>
448           <td class="md" nowrap align="right"></td>
449           <td class="md"></td>
450           <td class="md" nowrap>bool&nbsp;</td>
451           <td class="mdname" nowrap> <em>requires_oper</em>, </td>
452         </tr>
453         <tr>
454           <td class="md" nowrap align="right"></td>
455           <td class="md"></td>
456           <td class="md" nowrap>int&nbsp;</td>
457           <td class="mdname" nowrap> <em>params_when_on</em>, </td>
458         </tr>
459         <tr>
460           <td class="md" nowrap align="right"></td>
461           <td class="md"></td>
462           <td class="md" nowrap>int&nbsp;</td>
463           <td class="mdname" nowrap> <em>params_when_off</em></td>
464         </tr>
465         <tr>
466           <td class="md"></td>
467           <td class="md">)&nbsp;</td>
468           <td class="md" colspan="2"><code> [virtual]</code></td>
469         </tr>
470       </table>
471     </td>
472   </tr>
473 </table>
474 <table cellspacing="5" cellpadding="0" border="0">
475   <tr>
476     <td>
477       &nbsp;
478     </td>
479     <td>
480
481 <p>
482 Adds an extended mode letter which is parsed by a module. 
483 <p>
484 This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.
485 <p>
486 Definition at line <a class="el" href="modules_8cpp-source.html#l00555">555</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
487 <p>
488 References <a class="el" href="inspircd__io_8h-source.html#l00029">DEBUG</a>, <a class="el" href="modules_8cpp-source.html#l00133">DoAddExtendedMode()</a>, <a class="el" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log()</a>, <a class="el" href="modules_8h-source.html#l00032">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00033">MT_SERVER</a>.<div class="fragment"><pre class="fragment"><a name="l00556"></a>00556 {
489 <a name="l00557"></a>00557         <span class="keywordflow">if</span> (((modechar &gt;= <span class="charliteral">'A'</span>) &amp;&amp; (modechar &lt;= <span class="charliteral">'Z'</span>)) || ((modechar &gt;= <span class="charliteral">'a'</span>) &amp;&amp; (modechar &lt;= <span class="charliteral">'z'</span>)))
490 <a name="l00558"></a>00558         {
491 <a name="l00559"></a>00559                 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#MT_5FSERVER">MT_SERVER</a>)
492 <a name="l00560"></a>00560                 {
493 <a name="l00561"></a>00561                         <a class="code" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log</a>(<a class="code" href="inspircd__io_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>);
494 <a name="l00562"></a>00562                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
495 <a name="l00563"></a>00563                 }
496 <a name="l00564"></a>00564                 <span class="keywordflow">if</span> (((params_when_on&gt;0) || (params_when_off&gt;0)) &amp;&amp; (type == <a class="code" href="modules_8h.html#MT_5FCLIENT">MT_CLIENT</a>))
497 <a name="l00565"></a>00565                 {
498 <a name="l00566"></a>00566                         <a class="code" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log</a>(<a class="code" href="inspircd__io_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>);
499 <a name="l00567"></a>00567                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
500 <a name="l00568"></a>00568                 }
501 <a name="l00569"></a>00569                 <span class="keywordflow">if</span> ((params_when_on&gt;1) || (params_when_off&gt;1))
502 <a name="l00570"></a>00570                 {
503 <a name="l00571"></a>00571                         <a class="code" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log</a>(<a class="code" href="inspircd__io_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>);
504 <a name="l00572"></a>00572                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
505 <a name="l00573"></a>00573                 }
506 <a name="l00574"></a>00574                 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#DoAddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fon_2C_20int_20params_5Foff_29">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off);
507 <a name="l00575"></a>00575         }
508 <a name="l00576"></a>00576         <span class="keywordflow">else</span>
509 <a name="l00577"></a>00577         {
510 <a name="l00578"></a>00578                 <a class="code" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log</a>(<a class="code" href="inspircd__io_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Muppet modechar detected."</span>);
511 <a name="l00579"></a>00579         }
512 <a name="l00580"></a>00580         <span class="keywordflow">return</span> <span class="keyword">false</span>;
513 <a name="l00581"></a>00581 }
514 </pre></div>
515 <p>
516     </td>
517   </tr>
518 </table>
519 <a class="anchor" name="AddGLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Server::AddGLine" ref="AddGLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29" args="(long duration, std::string source, std::string reason, std::string hostmask)" --><p>
520 <table class="mdTable" cellpadding="2" cellspacing="0">
521   <tr>
522     <td class="mdRow">
523       <table cellpadding="0" cellspacing="0" border="0">
524         <tr>
525           <td class="md" nowrap valign="top">void Server::AddGLine           </td>
526           <td class="md" valign="top">(&nbsp;</td>
527           <td class="md" nowrap valign="top">long&nbsp;</td>
528           <td class="mdname" nowrap> <em>duration</em>, </td>
529         </tr>
530         <tr>
531           <td class="md" nowrap align="right"></td>
532           <td class="md"></td>
533           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
534           <td class="mdname" nowrap> <em>source</em>, </td>
535         </tr>
536         <tr>
537           <td class="md" nowrap align="right"></td>
538           <td class="md"></td>
539           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
540           <td class="mdname" nowrap> <em>reason</em>, </td>
541         </tr>
542         <tr>
543           <td class="md" nowrap align="right"></td>
544           <td class="md"></td>
545           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
546           <td class="mdname" nowrap> <em>hostmask</em></td>
547         </tr>
548         <tr>
549           <td class="md"></td>
550           <td class="md">)&nbsp;</td>
551           <td class="md" colspan="2"><code> [virtual]</code></td>
552         </tr>
553       </table>
554     </td>
555   </tr>
556 </table>
557 <table cellspacing="5" cellpadding="0" border="0">
558   <tr>
559     <td>
560       &nbsp;
561     </td>
562     <td>
563
564 <p>
565 Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. 
566 <p>
567 The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
568 <p>
569 Definition at line <a class="el" href="modules_8cpp-source.html#l00639">639</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
570 <p>
571 References <a class="el" href="xline_8h.html#add_5Fgline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_gline()</a>.<div class="fragment"><pre class="fragment"><a name="l00640"></a>00640 {
572 <a name="l00641"></a>00641         <a class="code" href="xline_8h.html#add_5Fgline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_gline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str());
573 <a name="l00642"></a>00642 }
574 </pre></div>
575 <p>
576     </td>
577   </tr>
578 </table>
579 <a class="anchor" name="AddKLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Server::AddKLine" ref="AddKLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29" args="(long duration, std::string source, std::string reason, std::string hostmask)" --><p>
580 <table class="mdTable" cellpadding="2" cellspacing="0">
581   <tr>
582     <td class="mdRow">
583       <table cellpadding="0" cellspacing="0" border="0">
584         <tr>
585           <td class="md" nowrap valign="top">void Server::AddKLine           </td>
586           <td class="md" valign="top">(&nbsp;</td>
587           <td class="md" nowrap valign="top">long&nbsp;</td>
588           <td class="mdname" nowrap> <em>duration</em>, </td>
589         </tr>
590         <tr>
591           <td class="md" nowrap align="right"></td>
592           <td class="md"></td>
593           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
594           <td class="mdname" nowrap> <em>source</em>, </td>
595         </tr>
596         <tr>
597           <td class="md" nowrap align="right"></td>
598           <td class="md"></td>
599           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
600           <td class="mdname" nowrap> <em>reason</em>, </td>
601         </tr>
602         <tr>
603           <td class="md" nowrap align="right"></td>
604           <td class="md"></td>
605           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
606           <td class="mdname" nowrap> <em>hostmask</em></td>
607         </tr>
608         <tr>
609           <td class="md"></td>
610           <td class="md">)&nbsp;</td>
611           <td class="md" colspan="2"><code> [virtual]</code></td>
612         </tr>
613       </table>
614     </td>
615   </tr>
616 </table>
617 <table cellspacing="5" cellpadding="0" border="0">
618   <tr>
619     <td>
620       &nbsp;
621     </td>
622     <td>
623
624 <p>
625 Adds a K-line The K-line is enforced as soon as it is added. 
626 <p>
627 The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
628 <p>
629 Definition at line <a class="el" href="modules_8cpp-source.html#l00654">654</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
630 <p>
631 References <a class="el" href="xline_8h.html#add_5Fkline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_kline()</a>.<div class="fragment"><pre class="fragment"><a name="l00655"></a>00655 {
632 <a name="l00656"></a>00656         <a class="code" href="xline_8h.html#add_5Fkline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_kline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str());
633 <a name="l00657"></a>00657 }
634 </pre></div>
635 <p>
636     </td>
637   </tr>
638 </table>
639 <a class="anchor" name="AddQLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickname_29"></a><!-- doxytag: member="Server::AddQLine" ref="AddQLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickname_29" args="(long duration, std::string source, std::string reason, std::string nickname)" --><p>
640 <table class="mdTable" cellpadding="2" cellspacing="0">
641   <tr>
642     <td class="mdRow">
643       <table cellpadding="0" cellspacing="0" border="0">
644         <tr>
645           <td class="md" nowrap valign="top">void Server::AddQLine           </td>
646           <td class="md" valign="top">(&nbsp;</td>
647           <td class="md" nowrap valign="top">long&nbsp;</td>
648           <td class="mdname" nowrap> <em>duration</em>, </td>
649         </tr>
650         <tr>
651           <td class="md" nowrap align="right"></td>
652           <td class="md"></td>
653           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
654           <td class="mdname" nowrap> <em>source</em>, </td>
655         </tr>
656         <tr>
657           <td class="md" nowrap align="right"></td>
658           <td class="md"></td>
659           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
660           <td class="mdname" nowrap> <em>reason</em>, </td>
661         </tr>
662         <tr>
663           <td class="md" nowrap align="right"></td>
664           <td class="md"></td>
665           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
666           <td class="mdname" nowrap> <em>nickname</em></td>
667         </tr>
668         <tr>
669           <td class="md"></td>
670           <td class="md">)&nbsp;</td>
671           <td class="md" colspan="2"><code> [virtual]</code></td>
672         </tr>
673       </table>
674     </td>
675   </tr>
676 </table>
677 <table cellspacing="5" cellpadding="0" border="0">
678   <tr>
679     <td>
680       &nbsp;
681     </td>
682     <td>
683
684 <p>
685 Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. 
686 <p>
687 The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
688 <p>
689 Definition at line <a class="el" href="modules_8cpp-source.html#l00644">644</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
690 <p>
691 References <a class="el" href="xline_8h.html#add_5Fqline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Anickname_29">add_qline()</a>.<div class="fragment"><pre class="fragment"><a name="l00645"></a>00645 {
692 <a name="l00646"></a>00646         <a class="code" href="xline_8h.html#add_5Fqline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Anickname_29">add_qline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), nickname.c_str());
693 <a name="l00647"></a>00647 }
694 </pre></div>
695 <p>
696     </td>
697   </tr>
698 </table>
699 <a class="anchor" name="AddSocket_28InspSocket_20_2Asock_29"></a><!-- doxytag: member="Server::AddSocket" ref="AddSocket_28InspSocket_20_2Asock_29" args="(InspSocket *sock)" --><p>
700 <table class="mdTable" cellpadding="2" cellspacing="0">
701   <tr>
702     <td class="mdRow">
703       <table cellpadding="0" cellspacing="0" border="0">
704         <tr>
705           <td class="md" nowrap valign="top">void Server::AddSocket           </td>
706           <td class="md" valign="top">(&nbsp;</td>
707           <td class="md" nowrap valign="top"><a class="el" href="classInspSocket.html">InspSocket</a> *&nbsp;</td>
708           <td class="mdname1" valign="top" nowrap> <em>sock</em>          </td>
709           <td class="md" valign="top">&nbsp;)&nbsp;</td>
710           <td class="md" nowrap><code> [virtual]</code></td>
711         </tr>
712       </table>
713     </td>
714   </tr>
715 </table>
716 <table cellspacing="5" cellpadding="0" border="0">
717   <tr>
718     <td>
719       &nbsp;
720     </td>
721     <td>
722
723 <p>
724 Adds a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> to the server's socket engine. 
725 <p>
726
727 <p>
728 Definition at line <a class="el" href="modules_8cpp-source.html#l00312">312</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
729 <p>
730 References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00313"></a>00313 {
731 <a name="l00314"></a>00314         <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.push_back(sock);
732 <a name="l00315"></a>00315 }
733 </pre></div>
734 <p>
735     </td>
736   </tr>
737 </table>
738 <a class="anchor" name="AddZLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipaddr_29"></a><!-- doxytag: member="Server::AddZLine" ref="AddZLine_28long_20duration_2C_20std_3A_3Astring_20source_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipaddr_29" args="(long duration, std::string source, std::string reason, std::string ipaddr)" --><p>
739 <table class="mdTable" cellpadding="2" cellspacing="0">
740   <tr>
741     <td class="mdRow">
742       <table cellpadding="0" cellspacing="0" border="0">
743         <tr>
744           <td class="md" nowrap valign="top">void Server::AddZLine           </td>
745           <td class="md" valign="top">(&nbsp;</td>
746           <td class="md" nowrap valign="top">long&nbsp;</td>
747           <td class="mdname" nowrap> <em>duration</em>, </td>
748         </tr>
749         <tr>
750           <td class="md" nowrap align="right"></td>
751           <td class="md"></td>
752           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
753           <td class="mdname" nowrap> <em>source</em>, </td>
754         </tr>
755         <tr>
756           <td class="md" nowrap align="right"></td>
757           <td class="md"></td>
758           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
759           <td class="mdname" nowrap> <em>reason</em>, </td>
760         </tr>
761         <tr>
762           <td class="md" nowrap align="right"></td>
763           <td class="md"></td>
764           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
765           <td class="mdname" nowrap> <em>ipaddr</em></td>
766         </tr>
767         <tr>
768           <td class="md"></td>
769           <td class="md">)&nbsp;</td>
770           <td class="md" colspan="2"><code> [virtual]</code></td>
771         </tr>
772       </table>
773     </td>
774   </tr>
775 </table>
776 <table cellspacing="5" cellpadding="0" border="0">
777   <tr>
778     <td>
779       &nbsp;
780     </td>
781     <td>
782
783 <p>
784 Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. 
785 <p>
786 The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.
787 <p>
788 Definition at line <a class="el" href="modules_8cpp-source.html#l00649">649</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
789 <p>
790 References <a class="el" href="xline_8h.html#add_5Fzline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Aipaddr_29">add_zline()</a>.<div class="fragment"><pre class="fragment"><a name="l00650"></a>00650 {
791 <a name="l00651"></a>00651         <a class="code" href="xline_8h.html#add_5Fzline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Aipaddr_29">add_zline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), ipaddr.c_str());
792 <a name="l00652"></a>00652 }
793 </pre></div>
794 <p>
795     </td>
796   </tr>
797 </table>
798 <a class="anchor" name="CalcDuration_28std_3A_3Astring_20duration_29"></a><!-- doxytag: member="Server::CalcDuration" ref="CalcDuration_28std_3A_3Astring_20duration_29" args="(std::string duration)" --><p>
799 <table class="mdTable" cellpadding="2" cellspacing="0">
800   <tr>
801     <td class="mdRow">
802       <table cellpadding="0" cellspacing="0" border="0">
803         <tr>
804           <td class="md" nowrap valign="top">long Server::CalcDuration           </td>
805           <td class="md" valign="top">(&nbsp;</td>
806           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
807           <td class="mdname1" valign="top" nowrap> <em>duration</em>          </td>
808           <td class="md" valign="top">&nbsp;)&nbsp;</td>
809           <td class="md" nowrap><code> [virtual]</code></td>
810         </tr>
811       </table>
812     </td>
813   </tr>
814 </table>
815 <table cellspacing="5" cellpadding="0" border="0">
816   <tr>
817     <td>
818       &nbsp;
819     </td>
820     <td>
821
822 <p>
823 Calculates a duration This method will take a string containing a formatted duration (e.g. 
824 <p>
825 "1w2d") and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.
826 <p>
827 Definition at line <a class="el" href="modules_8cpp-source.html#l00689">689</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
828 <p>
829 References <a class="el" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration()</a>.<div class="fragment"><pre class="fragment"><a name="l00690"></a>00690 {
830 <a name="l00691"></a>00691         <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>(delta.c_str());
831 <a name="l00692"></a>00692 }
832 </pre></div>
833 <p>
834     </td>
835   </tr>
836 </table>
837 <a class="anchor" name="CallCommandHandler_28std_3A_3Astring_20commandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><!-- doxytag: member="Server::CallCommandHandler" ref="CallCommandHandler_28std_3A_3Astring_20commandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29" args="(std::string commandname, char **parameters, int pcnt, userrec *user)" --><p>
838 <table class="mdTable" cellpadding="2" cellspacing="0">
839   <tr>
840     <td class="mdRow">
841       <table cellpadding="0" cellspacing="0" border="0">
842         <tr>
843           <td class="md" nowrap valign="top">void Server::CallCommandHandler           </td>
844           <td class="md" valign="top">(&nbsp;</td>
845           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
846           <td class="mdname" nowrap> <em>commandname</em>, </td>
847         </tr>
848         <tr>
849           <td class="md" nowrap align="right"></td>
850           <td class="md"></td>
851           <td class="md" nowrap>char **&nbsp;</td>
852           <td class="mdname" nowrap> <em>parameters</em>, </td>
853         </tr>
854         <tr>
855           <td class="md" nowrap align="right"></td>
856           <td class="md"></td>
857           <td class="md" nowrap>int&nbsp;</td>
858           <td class="mdname" nowrap> <em>pcnt</em>, </td>
859         </tr>
860         <tr>
861           <td class="md" nowrap align="right"></td>
862           <td class="md"></td>
863           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
864           <td class="mdname" nowrap> <em>user</em></td>
865         </tr>
866         <tr>
867           <td class="md"></td>
868           <td class="md">)&nbsp;</td>
869           <td class="md" colspan="2"><code> [virtual]</code></td>
870         </tr>
871       </table>
872     </td>
873   </tr>
874 </table>
875 <table cellspacing="5" cellpadding="0" border="0">
876   <tr>
877     <td>
878       &nbsp;
879     </td>
880     <td>
881
882 <p>
883 Calls the handler for a command, either implemented by the core or by another module. 
884 <p>
885 You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a  or <br>
886 ) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih <a class="el" href="classServer.html#AddCommand_28command_5Ft_20_2Af_29">AddCommand()</a>. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.
887 <p>
888 Definition at line <a class="el" href="modules_8cpp-source.html#l00400">400</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
889 <p>
890 References <a class="el" href="inspircd_8h-source.html#l00110">InspIRCd::Parser</a>.<div class="fragment"><pre class="fragment"><a name="l00401"></a>00401 {
891 <a name="l00402"></a>00402         <a class="code" href="modules_8cpp.html#ServerInstance">ServerInstance</a>-&gt;<a class="code" href="classInspIRCd.html#Parser">Parser</a>-&gt;CallHandler(commandname,parameters,pcnt,user);
892 <a name="l00403"></a>00403 }
893 </pre></div>
894 <p>
895     </td>
896   </tr>
897 </table>
898 <a class="anchor" name="ChangeGECOS_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29"></a><!-- doxytag: member="Server::ChangeGECOS" ref="ChangeGECOS_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29" args="(userrec *user, std::string gecos)" --><p>
899 <table class="mdTable" cellpadding="2" cellspacing="0">
900   <tr>
901     <td class="mdRow">
902       <table cellpadding="0" cellspacing="0" border="0">
903         <tr>
904           <td class="md" nowrap valign="top">void Server::ChangeGECOS           </td>
905           <td class="md" valign="top">(&nbsp;</td>
906           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
907           <td class="mdname" nowrap> <em>user</em>, </td>
908         </tr>
909         <tr>
910           <td class="md" nowrap align="right"></td>
911           <td class="md"></td>
912           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
913           <td class="mdname" nowrap> <em>gecos</em></td>
914         </tr>
915         <tr>
916           <td class="md"></td>
917           <td class="md">)&nbsp;</td>
918           <td class="md" colspan="2"><code> [virtual]</code></td>
919         </tr>
920       </table>
921     </td>
922   </tr>
923 </table>
924 <table cellspacing="5" cellpadding="0" border="0">
925   <tr>
926     <td>
927       &nbsp;
928     </td>
929     <td>
930
931 <p>
932 Change GECOS (fullname) of a user. 
933 <p>
934 You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.
935 <p>
936 Definition at line <a class="el" href="modules_8cpp-source.html#l00498">498</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
937 <p>
938 References <a class="el" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName()</a>.<div class="fragment"><pre class="fragment"><a name="l00499"></a>00499 {
939 <a name="l00500"></a>00500         <a class="code" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName</a>(user,gecos.c_str());
940 <a name="l00501"></a>00501 }
941 </pre></div>
942 <p>
943     </td>
944   </tr>
945 </table>
946 <a class="anchor" name="ChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20host_29"></a><!-- doxytag: member="Server::ChangeHost" ref="ChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20host_29" args="(userrec *user, std::string host)" --><p>
947 <table class="mdTable" cellpadding="2" cellspacing="0">
948   <tr>
949     <td class="mdRow">
950       <table cellpadding="0" cellspacing="0" border="0">
951         <tr>
952           <td class="md" nowrap valign="top">void Server::ChangeHost           </td>
953           <td class="md" valign="top">(&nbsp;</td>
954           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
955           <td class="mdname" nowrap> <em>user</em>, </td>
956         </tr>
957         <tr>
958           <td class="md" nowrap align="right"></td>
959           <td class="md"></td>
960           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
961           <td class="mdname" nowrap> <em>host</em></td>
962         </tr>
963         <tr>
964           <td class="md"></td>
965           <td class="md">)&nbsp;</td>
966           <td class="md" colspan="2"><code> [virtual]</code></td>
967         </tr>
968       </table>
969     </td>
970   </tr>
971 </table>
972 <table cellspacing="5" cellpadding="0" border="0">
973   <tr>
974     <td>
975       &nbsp;
976     </td>
977     <td>
978
979 <p>
980 Change displayed hostname of a user. 
981 <p>
982 You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.
983 <p>
984 Definition at line <a class="el" href="modules_8cpp-source.html#l00493">493</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
985 <p>
986 References <a class="el" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost()</a>.<div class="fragment"><pre class="fragment"><a name="l00494"></a>00494 {
987 <a name="l00495"></a>00495         <a class="code" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost</a>(user,host.c_str());
988 <a name="l00496"></a>00496 }
989 </pre></div>
990 <p>
991     </td>
992   </tr>
993 </table>
994 <a class="anchor" name="ChangeUserNick_28userrec_20_2Auser_2C_20std_3A_3Astring_20nickname_29"></a><!-- doxytag: member="Server::ChangeUserNick" ref="ChangeUserNick_28userrec_20_2Auser_2C_20std_3A_3Astring_20nickname_29" args="(userrec *user, std::string nickname)" --><p>
995 <table class="mdTable" cellpadding="2" cellspacing="0">
996   <tr>
997     <td class="mdRow">
998       <table cellpadding="0" cellspacing="0" border="0">
999         <tr>
1000           <td class="md" nowrap valign="top">void Server::ChangeUserNick           </td>
1001           <td class="md" valign="top">(&nbsp;</td>
1002           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1003           <td class="mdname" nowrap> <em>user</em>, </td>
1004         </tr>
1005         <tr>
1006           <td class="md" nowrap align="right"></td>
1007           <td class="md"></td>
1008           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1009           <td class="mdname" nowrap> <em>nickname</em></td>
1010         </tr>
1011         <tr>
1012           <td class="md"></td>
1013           <td class="md">)&nbsp;</td>
1014           <td class="md" colspan="2"><code> [virtual]</code></td>
1015         </tr>
1016       </table>
1017     </td>
1018   </tr>
1019 </table>
1020 <table cellspacing="5" cellpadding="0" border="0">
1021   <tr>
1022     <td>
1023       &nbsp;
1024     </td>
1025     <td>
1026
1027 <p>
1028 Forces a user nickchange. 
1029 <p>
1030 This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.
1031 <p>
1032 Definition at line <a class="el" href="modules_8cpp-source.html#l00385">385</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1033 <p>
1034 References <a class="el" href="users_8cpp-source.html#l00769">force_nickchange()</a>.<div class="fragment"><pre class="fragment"><a name="l00386"></a>00386 {
1035 <a name="l00387"></a>00387         <a class="code" href="users_8cpp.html#force_5Fnickchange_28userrec_20_2Auser_2C_20const_20char_20_2Anewnick_29">force_nickchange</a>(user,nickname.c_str());
1036 <a name="l00388"></a>00388 }
1037 </pre></div>
1038 <p>
1039     </td>
1040   </tr>
1041 </table>
1042 <a class="anchor" name="ChanMode_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29"></a><!-- doxytag: member="Server::ChanMode" ref="ChanMode_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29" args="(userrec *User, chanrec *Chan)" --><p>
1043 <table class="mdTable" cellpadding="2" cellspacing="0">
1044   <tr>
1045     <td class="mdRow">
1046       <table cellpadding="0" cellspacing="0" border="0">
1047         <tr>
1048           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::ChanMode           </td>
1049           <td class="md" valign="top">(&nbsp;</td>
1050           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1051           <td class="mdname" nowrap> <em>User</em>, </td>
1052         </tr>
1053         <tr>
1054           <td class="md" nowrap align="right"></td>
1055           <td class="md"></td>
1056           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1057           <td class="mdname" nowrap> <em>Chan</em></td>
1058         </tr>
1059         <tr>
1060           <td class="md"></td>
1061           <td class="md">)&nbsp;</td>
1062           <td class="md" colspan="2"><code> [virtual]</code></td>
1063         </tr>
1064       </table>
1065     </td>
1066   </tr>
1067 </table>
1068 <table cellspacing="5" cellpadding="0" border="0">
1069   <tr>
1070     <td>
1071       &nbsp;
1072     </td>
1073     <td>
1074
1075 <p>
1076 Attempts to look up a user's privilages on a channel. 
1077 <p>
1078 This function will return a string containing either @, %, +, or an empty string, representing the user's privilages upon the channel you specify.
1079 <p>
1080 Definition at line <a class="el" href="modules_8cpp-source.html#l00523">523</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1081 <p>
1082 References <a class="el" href="globals_8h.html#cmode_28userrec_20_2Auser_2C_20chanrec_20_2Achan_29">cmode()</a>.<div class="fragment"><pre class="fragment"><a name="l00524"></a>00524 {
1083 <a name="l00525"></a>00525         <span class="keywordflow">return</span> <a class="code" href="globals_8h.html#cmode_28userrec_20_2Auser_2C_20chanrec_20_2Achan_29">cmode</a>(User,Chan);
1084 <a name="l00526"></a>00526 }
1085 </pre></div>
1086 <p>
1087     </td>
1088   </tr>
1089 </table>
1090 <a class="anchor" name="CommonChannels_28userrec_20_2Au_31_2C_20userrec_20_2Au_32_29"></a><!-- doxytag: member="Server::CommonChannels" ref="CommonChannels_28userrec_20_2Au_31_2C_20userrec_20_2Au_32_29" args="(userrec *u1, userrec *u2)" --><p>
1091 <table class="mdTable" cellpadding="2" cellspacing="0">
1092   <tr>
1093     <td class="mdRow">
1094       <table cellpadding="0" cellspacing="0" border="0">
1095         <tr>
1096           <td class="md" nowrap valign="top">bool Server::CommonChannels           </td>
1097           <td class="md" valign="top">(&nbsp;</td>
1098           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1099           <td class="mdname" nowrap> <em>u1</em>, </td>
1100         </tr>
1101         <tr>
1102           <td class="md" nowrap align="right"></td>
1103           <td class="md"></td>
1104           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1105           <td class="mdname" nowrap> <em>u2</em></td>
1106         </tr>
1107         <tr>
1108           <td class="md"></td>
1109           <td class="md">)&nbsp;</td>
1110           <td class="md" colspan="2"><code> [virtual]</code></td>
1111         </tr>
1112       </table>
1113     </td>
1114   </tr>
1115 </table>
1116 <table cellspacing="5" cellpadding="0" border="0">
1117   <tr>
1118     <td>
1119       &nbsp;
1120     </td>
1121     <td>
1122
1123 <p>
1124 Returns true if two users share a common channel. 
1125 <p>
1126 This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#SendCommon_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_2C_20bool_20IncludeSender_29">Server::SendCommon</a> method.
1127 <p>
1128 Definition at line <a class="el" href="modules_8cpp-source.html#l00471">471</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1129 <p>
1130 References <a class="el" href="globals_8h.html#common_5Fchannels_28userrec_20_2Au_2C_20userrec_20_2Au_32_29">common_channels()</a>.<div class="fragment"><pre class="fragment"><a name="l00472"></a>00472 {
1131 <a name="l00473"></a>00473         <span class="keywordflow">return</span> (<a class="code" href="globals_8h.html#common_5Fchannels_28userrec_20_2Au_2C_20userrec_20_2Au_32_29">common_channels</a>(u1,u2) != 0);
1132 <a name="l00474"></a>00474 }
1133 </pre></div>
1134 <p>
1135     </td>
1136   </tr>
1137 </table>
1138 <a class="anchor" name="CountUsers_28chanrec_20_2Ac_29"></a><!-- doxytag: member="Server::CountUsers" ref="CountUsers_28chanrec_20_2Ac_29" args="(chanrec *c)" --><p>
1139 <table class="mdTable" cellpadding="2" cellspacing="0">
1140   <tr>
1141     <td class="mdRow">
1142       <table cellpadding="0" cellspacing="0" border="0">
1143         <tr>
1144           <td class="md" nowrap valign="top">int Server::CountUsers           </td>
1145           <td class="md" valign="top">(&nbsp;</td>
1146           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1147           <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>
1148           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1149           <td class="md" nowrap><code> [virtual]</code></td>
1150         </tr>
1151       </table>
1152     </td>
1153   </tr>
1154 </table>
1155 <table cellspacing="5" cellpadding="0" border="0">
1156   <tr>
1157     <td>
1158       &nbsp;
1159     </td>
1160     <td>
1161
1162 <p>
1163 Returns a count of the number of users on a channel. 
1164 <p>
1165 This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1166 <p>
1167 Definition at line <a class="el" href="modules_8cpp-source.html#l00591">591</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00592"></a>00592 {
1168 <a name="l00593"></a>00593         <span class="keywordflow">return</span> usercount(c);
1169 <a name="l00594"></a>00594 }
1170 </pre></div>
1171 <p>
1172     </td>
1173   </tr>
1174 </table>
1175 <a class="anchor" name="DelELine_28std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Server::DelELine" ref="DelELine_28std_3A_3Astring_20hostmask_29" args="(std::string hostmask)" --><p>
1176 <table class="mdTable" cellpadding="2" cellspacing="0">
1177   <tr>
1178     <td class="mdRow">
1179       <table cellpadding="0" cellspacing="0" border="0">
1180         <tr>
1181           <td class="md" nowrap valign="top">bool Server::DelELine           </td>
1182           <td class="md" valign="top">(&nbsp;</td>
1183           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1184           <td class="mdname1" valign="top" nowrap> <em>hostmask</em>          </td>
1185           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1186           <td class="md" nowrap><code> [virtual]</code></td>
1187         </tr>
1188       </table>
1189     </td>
1190   </tr>
1191 </table>
1192 <table cellspacing="5" cellpadding="0" border="0">
1193   <tr>
1194     <td>
1195       &nbsp;
1196     </td>
1197     <td>
1198
1199 <p>
1200 Deletes a local E-Line. 
1201 <p>
1202
1203 <p>
1204 Definition at line <a class="el" href="modules_8cpp-source.html#l00684">684</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1205 <p>
1206 References <a class="el" href="xline_8h.html#del_5Feline_28const_20char_20_2Ahostmask_29">del_eline()</a>.<div class="fragment"><pre class="fragment"><a name="l00685"></a>00685 {
1207 <a name="l00686"></a>00686         <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Feline_28const_20char_20_2Ahostmask_29">del_eline</a>(hostmask.c_str());
1208 <a name="l00687"></a>00687 }
1209 </pre></div>
1210 <p>
1211     </td>
1212   </tr>
1213 </table>
1214 <a class="anchor" name="DelGLine_28std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Server::DelGLine" ref="DelGLine_28std_3A_3Astring_20hostmask_29" args="(std::string hostmask)" --><p>
1215 <table class="mdTable" cellpadding="2" cellspacing="0">
1216   <tr>
1217     <td class="mdRow">
1218       <table cellpadding="0" cellspacing="0" border="0">
1219         <tr>
1220           <td class="md" nowrap valign="top">bool Server::DelGLine           </td>
1221           <td class="md" valign="top">(&nbsp;</td>
1222           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1223           <td class="mdname1" valign="top" nowrap> <em>hostmask</em>          </td>
1224           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1225           <td class="md" nowrap><code> [virtual]</code></td>
1226         </tr>
1227       </table>
1228     </td>
1229   </tr>
1230 </table>
1231 <table cellspacing="5" cellpadding="0" border="0">
1232   <tr>
1233     <td>
1234       &nbsp;
1235     </td>
1236     <td>
1237
1238 <p>
1239 Deletes a G-Line from all servers on the mesh. 
1240 <p>
1241
1242 <p>
1243 Definition at line <a class="el" href="modules_8cpp-source.html#l00664">664</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1244 <p>
1245 References <a class="el" href="xline_8h.html#del_5Fgline_28const_20char_20_2Ahostmask_29">del_gline()</a>.<div class="fragment"><pre class="fragment"><a name="l00665"></a>00665 {
1246 <a name="l00666"></a>00666         <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fgline_28const_20char_20_2Ahostmask_29">del_gline</a>(hostmask.c_str());
1247 <a name="l00667"></a>00667 }
1248 </pre></div>
1249 <p>
1250     </td>
1251   </tr>
1252 </table>
1253 <a class="anchor" name="DelKLine_28std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Server::DelKLine" ref="DelKLine_28std_3A_3Astring_20hostmask_29" args="(std::string hostmask)" --><p>
1254 <table class="mdTable" cellpadding="2" cellspacing="0">
1255   <tr>
1256     <td class="mdRow">
1257       <table cellpadding="0" cellspacing="0" border="0">
1258         <tr>
1259           <td class="md" nowrap valign="top">bool Server::DelKLine           </td>
1260           <td class="md" valign="top">(&nbsp;</td>
1261           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1262           <td class="mdname1" valign="top" nowrap> <em>hostmask</em>          </td>
1263           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1264           <td class="md" nowrap><code> [virtual]</code></td>
1265         </tr>
1266       </table>
1267     </td>
1268   </tr>
1269 </table>
1270 <table cellspacing="5" cellpadding="0" border="0">
1271   <tr>
1272     <td>
1273       &nbsp;
1274     </td>
1275     <td>
1276
1277 <p>
1278 Deletes a local K-Line. 
1279 <p>
1280
1281 <p>
1282 Definition at line <a class="el" href="modules_8cpp-source.html#l00679">679</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1283 <p>
1284 References <a class="el" href="xline_8h.html#del_5Fkline_28const_20char_20_2Ahostmask_29">del_kline()</a>.<div class="fragment"><pre class="fragment"><a name="l00680"></a>00680 {
1285 <a name="l00681"></a>00681         <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fkline_28const_20char_20_2Ahostmask_29">del_kline</a>(hostmask.c_str());
1286 <a name="l00682"></a>00682 }
1287 </pre></div>
1288 <p>
1289     </td>
1290   </tr>
1291 </table>
1292 <a class="anchor" name="DelQLine_28std_3A_3Astring_20nickname_29"></a><!-- doxytag: member="Server::DelQLine" ref="DelQLine_28std_3A_3Astring_20nickname_29" args="(std::string nickname)" --><p>
1293 <table class="mdTable" cellpadding="2" cellspacing="0">
1294   <tr>
1295     <td class="mdRow">
1296       <table cellpadding="0" cellspacing="0" border="0">
1297         <tr>
1298           <td class="md" nowrap valign="top">bool Server::DelQLine           </td>
1299           <td class="md" valign="top">(&nbsp;</td>
1300           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1301           <td class="mdname1" valign="top" nowrap> <em>nickname</em>          </td>
1302           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1303           <td class="md" nowrap><code> [virtual]</code></td>
1304         </tr>
1305       </table>
1306     </td>
1307   </tr>
1308 </table>
1309 <table cellspacing="5" cellpadding="0" border="0">
1310   <tr>
1311     <td>
1312       &nbsp;
1313     </td>
1314     <td>
1315
1316 <p>
1317 Deletes a Q-Line from all servers on the mesh. 
1318 <p>
1319
1320 <p>
1321 Definition at line <a class="el" href="modules_8cpp-source.html#l00669">669</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1322 <p>
1323 References <a class="el" href="xline_8h.html#del_5Fqline_28const_20char_20_2Anickname_29">del_qline()</a>.<div class="fragment"><pre class="fragment"><a name="l00670"></a>00670 {
1324 <a name="l00671"></a>00671         <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fqline_28const_20char_20_2Anickname_29">del_qline</a>(nickname.c_str());
1325 <a name="l00672"></a>00672 }
1326 </pre></div>
1327 <p>
1328     </td>
1329   </tr>
1330 </table>
1331 <a class="anchor" name="DelSocket_28InspSocket_20_2Asock_29"></a><!-- doxytag: member="Server::DelSocket" ref="DelSocket_28InspSocket_20_2Asock_29" args="(InspSocket *sock)" --><p>
1332 <table class="mdTable" cellpadding="2" cellspacing="0">
1333   <tr>
1334     <td class="mdRow">
1335       <table cellpadding="0" cellspacing="0" border="0">
1336         <tr>
1337           <td class="md" nowrap valign="top">void Server::DelSocket           </td>
1338           <td class="md" valign="top">(&nbsp;</td>
1339           <td class="md" nowrap valign="top"><a class="el" href="classInspSocket.html">InspSocket</a> *&nbsp;</td>
1340           <td class="mdname1" valign="top" nowrap> <em>sock</em>          </td>
1341           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1342           <td class="md" nowrap><code> [virtual]</code></td>
1343         </tr>
1344       </table>
1345     </td>
1346   </tr>
1347 </table>
1348 <table cellspacing="5" cellpadding="0" border="0">
1349   <tr>
1350     <td>
1351       &nbsp;
1352     </td>
1353     <td>
1354
1355 <p>
1356 Deletes a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> from the server's socket engine. 
1357 <p>
1358
1359 <p>
1360 Definition at line <a class="el" href="modules_8cpp-source.html#l00333">333</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1361 <p>
1362 References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00334"></a>00334 {
1363 <a name="l00335"></a>00335         <span class="keywordflow">for</span> (std::vector&lt;InspSocket*&gt;::iterator a = <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.begin(); a &lt; <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.end(); a++)
1364 <a name="l00336"></a>00336         {
1365 <a name="l00337"></a>00337                 <span class="keywordflow">if</span> (*a == sock)
1366 <a name="l00338"></a>00338                 {
1367 <a name="l00339"></a>00339                         <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.erase(a);
1368 <a name="l00340"></a>00340                         <span class="keywordflow">return</span>;
1369 <a name="l00341"></a>00341                 }
1370 <a name="l00342"></a>00342         }
1371 <a name="l00343"></a>00343 }
1372 </pre></div>
1373 <p>
1374     </td>
1375   </tr>
1376 </table>
1377 <a class="anchor" name="DelZLine_28std_3A_3Astring_20ipaddr_29"></a><!-- doxytag: member="Server::DelZLine" ref="DelZLine_28std_3A_3Astring_20ipaddr_29" args="(std::string ipaddr)" --><p>
1378 <table class="mdTable" cellpadding="2" cellspacing="0">
1379   <tr>
1380     <td class="mdRow">
1381       <table cellpadding="0" cellspacing="0" border="0">
1382         <tr>
1383           <td class="md" nowrap valign="top">bool Server::DelZLine           </td>
1384           <td class="md" valign="top">(&nbsp;</td>
1385           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1386           <td class="mdname1" valign="top" nowrap> <em>ipaddr</em>          </td>
1387           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1388           <td class="md" nowrap><code> [virtual]</code></td>
1389         </tr>
1390       </table>
1391     </td>
1392   </tr>
1393 </table>
1394 <table cellspacing="5" cellpadding="0" border="0">
1395   <tr>
1396     <td>
1397       &nbsp;
1398     </td>
1399     <td>
1400
1401 <p>
1402 Deletes a Z-Line from all servers on the mesh. 
1403 <p>
1404
1405 <p>
1406 Definition at line <a class="el" href="modules_8cpp-source.html#l00674">674</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1407 <p>
1408 References <a class="el" href="xline_8h.html#del_5Fzline_28const_20char_20_2Aipaddr_29">del_zline()</a>.<div class="fragment"><pre class="fragment"><a name="l00675"></a>00675 {
1409 <a name="l00676"></a>00676         <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fzline_28const_20char_20_2Aipaddr_29">del_zline</a>(ipaddr.c_str());
1410 <a name="l00677"></a>00677 }
1411 </pre></div>
1412 <p>
1413     </td>
1414   </tr>
1415 </table>
1416 <a class="anchor" name="FindChannel_28std_3A_3Astring_20channel_29"></a><!-- doxytag: member="Server::FindChannel" ref="FindChannel_28std_3A_3Astring_20channel_29" args="(std::string channel)" --><p>
1417 <table class="mdTable" cellpadding="2" cellspacing="0">
1418   <tr>
1419     <td class="mdRow">
1420       <table cellpadding="0" cellspacing="0" border="0">
1421         <tr>
1422           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel           </td>
1423           <td class="md" valign="top">(&nbsp;</td>
1424           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1425           <td class="mdname1" valign="top" nowrap> <em>channel</em>          </td>
1426           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1427           <td class="md" nowrap><code> [virtual]</code></td>
1428         </tr>
1429       </table>
1430     </td>
1431   </tr>
1432 </table>
1433 <table cellspacing="5" cellpadding="0" border="0">
1434   <tr>
1435     <td>
1436       &nbsp;
1437     </td>
1438     <td>
1439
1440 <p>
1441 Attempts to look up a channel and return a pointer to it. 
1442 <p>
1443 This function will return NULL if the channel does not exist.
1444 <p>
1445 Definition at line <a class="el" href="modules_8cpp-source.html#l00518">518</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1446 <p>
1447 References <a class="el" href="globals_8h.html#FindChan_28const_20char_20_2Achan_29">FindChan()</a>.<div class="fragment"><pre class="fragment"><a name="l00519"></a>00519 {
1448 <a name="l00520"></a>00520         <span class="keywordflow">return</span> <a class="code" href="globals_8h.html#FindChan_28const_20char_20_2Achan_29">FindChan</a>(channel.c_str());
1449 <a name="l00521"></a>00521 }
1450 </pre></div>
1451 <p>
1452     </td>
1453   </tr>
1454 </table>
1455 <a class="anchor" name="FindDescriptor_28int_20socket_29"></a><!-- doxytag: member="Server::FindDescriptor" ref="FindDescriptor_28int_20socket_29" args="(int socket)" --><p>
1456 <table class="mdTable" cellpadding="2" cellspacing="0">
1457   <tr>
1458     <td class="mdRow">
1459       <table cellpadding="0" cellspacing="0" border="0">
1460         <tr>
1461           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * Server::FindDescriptor           </td>
1462           <td class="md" valign="top">(&nbsp;</td>
1463           <td class="md" nowrap valign="top">int&nbsp;</td>
1464           <td class="mdname1" valign="top" nowrap> <em>socket</em>          </td>
1465           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1466           <td class="md" nowrap><code> [virtual]</code></td>
1467         </tr>
1468       </table>
1469     </td>
1470   </tr>
1471 </table>
1472 <table cellspacing="5" cellpadding="0" border="0">
1473   <tr>
1474     <td>
1475       &nbsp;
1476     </td>
1477     <td>
1478
1479 <p>
1480 Attempts to look up a nick using the file descriptor associated with that nick. 
1481 <p>
1482 This function will return NULL if the file descriptor is not associated with a valid user.
1483 <p>
1484 Definition at line <a class="el" href="modules_8cpp-source.html#l00513">513</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00514"></a>00514 {
1485 <a name="l00515"></a>00515         <span class="keywordflow">return</span> (socket &lt; 65536 ? fd_ref_table[socket] : NULL);
1486 <a name="l00516"></a>00516 }
1487 </pre></div>
1488 <p>
1489     </td>
1490   </tr>
1491 </table>
1492 <a class="anchor" name="FindModule_28std_3A_3Astring_20name_29"></a><!-- doxytag: member="Server::FindModule" ref="FindModule_28std_3A_3Astring_20name_29" args="(std::string name)" --><p>
1493 <table class="mdTable" cellpadding="2" cellspacing="0">
1494   <tr>
1495     <td class="mdRow">
1496       <table cellpadding="0" cellspacing="0" border="0">
1497         <tr>
1498           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> * Server::FindModule           </td>
1499           <td class="md" valign="top">(&nbsp;</td>
1500           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1501           <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
1502           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1503           <td class="md" nowrap><code> [virtual]</code></td>
1504         </tr>
1505       </table>
1506     </td>
1507   </tr>
1508 </table>
1509 <table cellspacing="5" cellpadding="0" border="0">
1510   <tr>
1511     <td>
1512       &nbsp;
1513     </td>
1514     <td>
1515
1516 <p>
1517 This function finds a module by name. 
1518 <p>
1519 You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.
1520 <p>
1521 Definition at line <a class="el" href="modules_8cpp-source.html#l00723">723</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1522 <p>
1523 References <a class="el" href="modules_8cpp-source.html#l00934">MODCOUNT</a>, <a class="el" href="inspircd__io_8h-source.html#l00248">ServerConfig::module_names</a>, and <a class="el" href="channels_8cpp.html#modules">modules</a>.<div class="fragment"><pre class="fragment"><a name="l00724"></a>00724 {
1524 <a name="l00725"></a>00725         <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt;= <a class="code" href="channels_8cpp.html#MODCOUNT">MODCOUNT</a>; i++)
1525 <a name="l00726"></a>00726         {
1526 <a name="l00727"></a>00727                 <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#module_5Fnames">module_names</a>[i] == name)
1527 <a name="l00728"></a>00728                 {
1528 <a name="l00729"></a>00729                         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#modules">modules</a>[i];
1529 <a name="l00730"></a>00730                 }
1530 <a name="l00731"></a>00731         }
1531 <a name="l00732"></a>00732         <span class="keywordflow">return</span> NULL;
1532 <a name="l00733"></a>00733 }
1533 </pre></div>
1534 <p>
1535     </td>
1536   </tr>
1537 </table>
1538 <a class="anchor" name="FindNick_28std_3A_3Astring_20nick_29"></a><!-- doxytag: member="Server::FindNick" ref="FindNick_28std_3A_3Astring_20nick_29" args="(std::string nick)" --><p>
1539 <table class="mdTable" cellpadding="2" cellspacing="0">
1540   <tr>
1541     <td class="mdRow">
1542       <table cellpadding="0" cellspacing="0" border="0">
1543         <tr>
1544           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * Server::FindNick           </td>
1545           <td class="md" valign="top">(&nbsp;</td>
1546           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1547           <td class="mdname1" valign="top" nowrap> <em>nick</em>          </td>
1548           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1549           <td class="md" nowrap><code> [virtual]</code></td>
1550         </tr>
1551       </table>
1552     </td>
1553   </tr>
1554 </table>
1555 <table cellspacing="5" cellpadding="0" border="0">
1556   <tr>
1557     <td>
1558       &nbsp;
1559     </td>
1560     <td>
1561
1562 <p>
1563 Attempts to look up a nick and return a pointer to it. 
1564 <p>
1565 This function will return NULL if the nick does not exist.
1566 <p>
1567 Definition at line <a class="el" href="modules_8cpp-source.html#l00508">508</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1568 <p>
1569 References <a class="el" href="globals_8h.html#Find_28std_3A_3Astring_20nick_29">Find()</a>.<div class="fragment"><pre class="fragment"><a name="l00509"></a>00509 {
1570 <a name="l00510"></a>00510         <span class="keywordflow">return</span> <a class="code" href="globals_8h.html#Find_28std_3A_3Astring_20nick_29">Find</a>(nick);
1571 <a name="l00511"></a>00511 }
1572 </pre></div>
1573 <p>
1574     </td>
1575   </tr>
1576 </table>
1577 <a class="anchor" name="GetAdmin_28_29"></a><!-- doxytag: member="Server::GetAdmin" ref="GetAdmin_28_29" args="()" --><p>
1578 <table class="mdTable" cellpadding="2" cellspacing="0">
1579   <tr>
1580     <td class="mdRow">
1581       <table cellpadding="0" cellspacing="0" border="0">
1582         <tr>
1583           <td class="md" nowrap valign="top"><a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin           </td>
1584           <td class="md" valign="top">(&nbsp;</td>
1585           <td class="mdname1" valign="top" nowrap>          </td>
1586           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1587           <td class="md" nowrap><code> [virtual]</code></td>
1588         </tr>
1589       </table>
1590     </td>
1591   </tr>
1592 </table>
1593 <table cellspacing="5" cellpadding="0" border="0">
1594   <tr>
1595     <td>
1596       &nbsp;
1597     </td>
1598     <td>
1599
1600 <p>
1601 Returns the information of the server as returned by the /ADMIN command. 
1602 <p>
1603 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#Nick">Admin::Nick</a>, <a class="el" href="classAdmin.html#Email">Admin::Email</a> and <a class="el" href="classAdmin.html#Name">Admin::Name</a> contain the information for the server where the module is loaded.
1604 <p>
1605 Definition at line <a class="el" href="modules_8cpp-source.html#l00548">548</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1606 <p>
1607 References <a class="el" href="inspircd__io_8h-source.html#l00090">ServerConfig::AdminEmail</a>, <a class="el" href="inspircd__io_8h-source.html#l00085">ServerConfig::AdminName</a>, and <a class="el" href="inspircd__io_8h-source.html#l00095">ServerConfig::AdminNick</a>.<div class="fragment"><pre class="fragment"><a name="l00549"></a>00549 {
1608 <a name="l00550"></a>00550         <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(<a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#AdminName_5BMAXBUF_5D">AdminName</a>,<a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#AdminEmail_5BMAXBUF_5D">AdminEmail</a>,<a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#AdminNick_5BMAXBUF_5D">AdminNick</a>);
1609 <a name="l00551"></a>00551 }
1610 </pre></div>
1611 <p>
1612     </td>
1613   </tr>
1614 </table>
1615 <a class="anchor" name="GetConfig_28_29"></a><!-- doxytag: member="Server::GetConfig" ref="GetConfig_28_29" args="()" --><p>
1616 <table class="mdTable" cellpadding="2" cellspacing="0">
1617   <tr>
1618     <td class="mdRow">
1619       <table cellpadding="0" cellspacing="0" border="0">
1620         <tr>
1621           <td class="md" nowrap valign="top"><a class="el" href="classServerConfig.html">ServerConfig</a> * Server::GetConfig           </td>
1622           <td class="md" valign="top">(&nbsp;</td>
1623           <td class="mdname1" valign="top" nowrap>          </td>
1624           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1625           <td class="md" nowrap></td>
1626         </tr>
1627       </table>
1628     </td>
1629   </tr>
1630 </table>
1631 <table cellspacing="5" cellpadding="0" border="0">
1632   <tr>
1633     <td>
1634       &nbsp;
1635     </td>
1636     <td>
1637
1638 <p>
1639 Obtains a pointer to the server's <a class="el" href="classServerConfig.html">ServerConfig</a> object. 
1640 <p>
1641 The <a class="el" href="classServerConfig.html">ServerConfig</a> object contains most of the configuration data of the IRC server, as read from the config file by the core.
1642 <p>
1643 Definition at line <a class="el" href="modules_8cpp-source.html#l00323">323</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00324"></a>00324 {
1644 <a name="l00325"></a>00325         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>;
1645 <a name="l00326"></a>00326 }
1646 </pre></div>
1647 <p>
1648     </td>
1649   </tr>
1650 </table>
1651 <a class="anchor" name="GetNetworkName_28_29"></a><!-- doxytag: member="Server::GetNetworkName" ref="GetNetworkName_28_29" args="()" --><p>
1652 <table class="mdTable" cellpadding="2" cellspacing="0">
1653   <tr>
1654     <td class="mdRow">
1655       <table cellpadding="0" cellspacing="0" border="0">
1656         <tr>
1657           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetNetworkName           </td>
1658           <td class="md" valign="top">(&nbsp;</td>
1659           <td class="mdname1" valign="top" nowrap>          </td>
1660           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1661           <td class="md" nowrap><code> [virtual]</code></td>
1662         </tr>
1663       </table>
1664     </td>
1665   </tr>
1666 </table>
1667 <table cellspacing="5" cellpadding="0" border="0">
1668   <tr>
1669     <td>
1670       &nbsp;
1671     </td>
1672     <td>
1673
1674 <p>
1675 Returns the network name, global to all linked servers. 
1676 <p>
1677
1678 <p>
1679 Definition at line <a class="el" href="modules_8cpp-source.html#l00538">538</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1680 <p>
1681 References <a class="el" href="inspircd__io_8h-source.html#l00075">ServerConfig::Network</a>.<div class="fragment"><pre class="fragment"><a name="l00539"></a>00539 {
1682 <a name="l00540"></a>00540         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#Network_5BMAXBUF_5D">Network</a>;
1683 <a name="l00541"></a>00541 }
1684 </pre></div>
1685 <p>
1686     </td>
1687   </tr>
1688 </table>
1689 <a class="anchor" name="GetServerDescription_28_29"></a><!-- doxytag: member="Server::GetServerDescription" ref="GetServerDescription_28_29" args="()" --><p>
1690 <table class="mdTable" cellpadding="2" cellspacing="0">
1691   <tr>
1692     <td class="mdRow">
1693       <table cellpadding="0" cellspacing="0" border="0">
1694         <tr>
1695           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetServerDescription           </td>
1696           <td class="md" valign="top">(&nbsp;</td>
1697           <td class="mdname1" valign="top" nowrap>          </td>
1698           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1699           <td class="md" nowrap><code> [virtual]</code></td>
1700         </tr>
1701       </table>
1702     </td>
1703   </tr>
1704 </table>
1705 <table cellspacing="5" cellpadding="0" border="0">
1706   <tr>
1707     <td>
1708       &nbsp;
1709     </td>
1710     <td>
1711
1712 <p>
1713 Returns the server description string of the local server. 
1714 <p>
1715
1716 <p>
1717 Definition at line <a class="el" href="modules_8cpp-source.html#l00543">543</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1718 <p>
1719 References <a class="el" href="inspircd__io_8h-source.html#l00080">ServerConfig::ServerDesc</a>.<div class="fragment"><pre class="fragment"><a name="l00544"></a>00544 {
1720 <a name="l00545"></a>00545         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ServerDesc_5BMAXBUF_5D">ServerDesc</a>;
1721 <a name="l00546"></a>00546 }
1722 </pre></div>
1723 <p>
1724     </td>
1725   </tr>
1726 </table>
1727 <a class="anchor" name="GetServerName_28_29"></a><!-- doxytag: member="Server::GetServerName" ref="GetServerName_28_29" args="()" --><p>
1728 <table class="mdTable" cellpadding="2" cellspacing="0">
1729   <tr>
1730     <td class="mdRow">
1731       <table cellpadding="0" cellspacing="0" border="0">
1732         <tr>
1733           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetServerName           </td>
1734           <td class="md" valign="top">(&nbsp;</td>
1735           <td class="mdname1" valign="top" nowrap>          </td>
1736           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1737           <td class="md" nowrap><code> [virtual]</code></td>
1738         </tr>
1739       </table>
1740     </td>
1741   </tr>
1742 </table>
1743 <table cellspacing="5" cellpadding="0" border="0">
1744   <tr>
1745     <td>
1746       &nbsp;
1747     </td>
1748     <td>
1749
1750 <p>
1751 Returns the server name of the server where the module is loaded. 
1752 <p>
1753
1754 <p>
1755 Definition at line <a class="el" href="modules_8cpp-source.html#l00533">533</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1756 <p>
1757 References <a class="el" href="inspircd__io_8h-source.html#l00069">ServerConfig::ServerName</a>.<div class="fragment"><pre class="fragment"><a name="l00534"></a>00534 {
1758 <a name="l00535"></a>00535         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#ServerName_5BMAXBUF_5D">ServerName</a>;
1759 <a name="l00536"></a>00536 }
1760 </pre></div>
1761 <p>
1762     </td>
1763   </tr>
1764 </table>
1765 <a class="anchor" name="GetUsers_28chanrec_20_2Achan_29"></a><!-- doxytag: member="Server::GetUsers" ref="GetUsers_28chanrec_20_2Achan_29" args="(chanrec *chan)" --><p>
1766 <table class="mdTable" cellpadding="2" cellspacing="0">
1767   <tr>
1768     <td class="mdRow">
1769       <table cellpadding="0" cellspacing="0" border="0">
1770         <tr>
1771           <td class="md" nowrap valign="top"><a class="el" href="modules_8h.html#chanuserlist">chanuserlist</a> Server::GetUsers           </td>
1772           <td class="md" valign="top">(&nbsp;</td>
1773           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1774           <td class="mdname1" valign="top" nowrap> <em>chan</em>          </td>
1775           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1776           <td class="md" nowrap><code> [virtual]</code></td>
1777         </tr>
1778       </table>
1779     </td>
1780   </tr>
1781 </table>
1782 <table cellspacing="5" cellpadding="0" border="0">
1783   <tr>
1784     <td>
1785       &nbsp;
1786     </td>
1787     <td>
1788
1789 <p>
1790 Fetches the userlist of a channel. 
1791 <p>
1792 This function must be here and not a member of userrec or chanrec due to include constraints.
1793 <p>
1794 Definition at line <a class="el" href="modules_8cpp-source.html#l00373">373</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1795 <p>
1796 References <a class="el" href="channels_8cpp-source.html#l00186">chanrec::GetUsers()</a>.<div class="fragment"><pre class="fragment"><a name="l00374"></a>00374 {
1797 <a name="l00375"></a>00375         <a class="code" href="modules_8h.html#chanuserlist">chanuserlist</a> userl;
1798 <a name="l00376"></a>00376         userl.clear();
1799 <a name="l00377"></a>00377         std::vector&lt;char*&gt; *list = chan-&gt;<a class="code" href="classchanrec.html#GetUsers_28_29">GetUsers</a>();
1800 <a name="l00378"></a>00378         <span class="keywordflow">for</span> (std::vector&lt;char*&gt;::iterator i = list-&gt;begin(); i != list-&gt;end(); i++)
1801 <a name="l00379"></a>00379         {
1802 <a name="l00380"></a>00380                 <span class="keywordtype">char</span>* o = *i;
1803 <a name="l00381"></a>00381                 userl.push_back((<a class="code" href="classuserrec.html">userrec</a>*)o);
1804 <a name="l00382"></a>00382         }
1805 <a name="l00383"></a>00383         <span class="keywordflow">return</span> userl;
1806 <a name="l00384"></a>00384 }
1807 </pre></div>
1808 <p>
1809     </td>
1810   </tr>
1811 </table>
1812 <a class="anchor" name="GetVersion_28_29"></a><!-- doxytag: member="Server::GetVersion" ref="GetVersion_28_29" args="()" --><p>
1813 <table class="mdTable" cellpadding="2" cellspacing="0">
1814   <tr>
1815     <td class="mdRow">
1816       <table cellpadding="0" cellspacing="0" border="0">
1817         <tr>
1818           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetVersion           </td>
1819           <td class="md" valign="top">(&nbsp;</td>
1820           <td class="mdname1" valign="top" nowrap>          </td>
1821           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1822           <td class="md" nowrap></td>
1823         </tr>
1824       </table>
1825     </td>
1826   </tr>
1827 </table>
1828 <table cellspacing="5" cellpadding="0" border="0">
1829   <tr>
1830     <td>
1831       &nbsp;
1832     </td>
1833     <td>
1834
1835 <p>
1836 Returns the version string of this server. 
1837 <p>
1838
1839 <p>
1840 Definition at line <a class="el" href="modules_8cpp-source.html#l00328">328</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1841 <p>
1842 References <a class="el" href="classInspIRCd.html#GetVersionString_28_29">InspIRCd::GetVersionString()</a>.<div class="fragment"><pre class="fragment"><a name="l00329"></a>00329 {
1843 <a name="l00330"></a>00330         <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#ServerInstance">ServerInstance</a>-&gt;<a class="code" href="classInspIRCd.html#GetVersionString_28_29">GetVersionString</a>();
1844 <a name="l00331"></a>00331 }
1845 </pre></div>
1846 <p>
1847     </td>
1848   </tr>
1849 </table>
1850 <a class="anchor" name="IsNick_28std_3A_3Astring_20nick_29"></a><!-- doxytag: member="Server::IsNick" ref="IsNick_28std_3A_3Astring_20nick_29" args="(std::string nick)" --><p>
1851 <table class="mdTable" cellpadding="2" cellspacing="0">
1852   <tr>
1853     <td class="mdRow">
1854       <table cellpadding="0" cellspacing="0" border="0">
1855         <tr>
1856           <td class="md" nowrap valign="top">bool Server::IsNick           </td>
1857           <td class="md" valign="top">(&nbsp;</td>
1858           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1859           <td class="mdname1" valign="top" nowrap> <em>nick</em>          </td>
1860           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1861           <td class="md" nowrap><code> [virtual]</code></td>
1862         </tr>
1863       </table>
1864     </td>
1865   </tr>
1866 </table>
1867 <table cellspacing="5" cellpadding="0" border="0">
1868   <tr>
1869     <td>
1870       &nbsp;
1871     </td>
1872     <td>
1873
1874 <p>
1875 Returns true if a nick is valid. 
1876 <p>
1877 Nicks for unregistered connections will return false.
1878 <p>
1879 Definition at line <a class="el" href="modules_8cpp-source.html#l00503">503</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1880 <p>
1881 References <a class="el" href="globals_8h.html#isnick_28const_20char_20_2An_29">isnick()</a>.<div class="fragment"><pre class="fragment"><a name="l00504"></a>00504 {
1882 <a name="l00505"></a>00505         <span class="keywordflow">return</span> (<a class="code" href="globals_8h.html#isnick_28const_20char_20_2An_29">isnick</a>(nick.c_str()) != 0);
1883 <a name="l00506"></a>00506 }
1884 </pre></div>
1885 <p>
1886     </td>
1887   </tr>
1888 </table>
1889 <a class="anchor" name="IsOnChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29"></a><!-- doxytag: member="Server::IsOnChannel" ref="IsOnChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChan_29" args="(userrec *User, chanrec *Chan)" --><p>
1890 <table class="mdTable" cellpadding="2" cellspacing="0">
1891   <tr>
1892     <td class="mdRow">
1893       <table cellpadding="0" cellspacing="0" border="0">
1894         <tr>
1895           <td class="md" nowrap valign="top">bool Server::IsOnChannel           </td>
1896           <td class="md" valign="top">(&nbsp;</td>
1897           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1898           <td class="mdname" nowrap> <em>User</em>, </td>
1899         </tr>
1900         <tr>
1901           <td class="md" nowrap align="right"></td>
1902           <td class="md"></td>
1903           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1904           <td class="mdname" nowrap> <em>Chan</em></td>
1905         </tr>
1906         <tr>
1907           <td class="md"></td>
1908           <td class="md">)&nbsp;</td>
1909           <td class="md" colspan="2"><code> [virtual]</code></td>
1910         </tr>
1911       </table>
1912     </td>
1913   </tr>
1914 </table>
1915 <table cellspacing="5" cellpadding="0" border="0">
1916   <tr>
1917     <td>
1918       &nbsp;
1919     </td>
1920     <td>
1921
1922 <p>
1923 Checks if a user is on a channel. 
1924 <p>
1925 This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1926 <p>
1927 Definition at line <a class="el" href="modules_8cpp-source.html#l00528">528</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1928 <p>
1929 References <a class="el" href="message_8h.html#has_5Fchannel_28userrec_20_2Au_2C_20chanrec_20_2Ac_29">has_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00529"></a>00529 {
1930 <a name="l00530"></a>00530         <span class="keywordflow">return</span> <a class="code" href="message_8h.html#has_5Fchannel_28userrec_20_2Au_2C_20chanrec_20_2Ac_29">has_channel</a>(User,Chan);
1931 <a name="l00531"></a>00531 }
1932 </pre></div>
1933 <p>
1934     </td>
1935   </tr>
1936 </table>
1937 <a class="anchor" name="IsUlined_28std_3A_3Astring_20server_29"></a><!-- doxytag: member="Server::IsUlined" ref="IsUlined_28std_3A_3Astring_20server_29" args="(std::string server)" --><p>
1938 <table class="mdTable" cellpadding="2" cellspacing="0">
1939   <tr>
1940     <td class="mdRow">
1941       <table cellpadding="0" cellspacing="0" border="0">
1942         <tr>
1943           <td class="md" nowrap valign="top">bool Server::IsUlined           </td>
1944           <td class="md" valign="top">(&nbsp;</td>
1945           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1946           <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
1947           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1948           <td class="md" nowrap><code> [virtual]</code></td>
1949         </tr>
1950       </table>
1951     </td>
1952   </tr>
1953 </table>
1954 <table cellspacing="5" cellpadding="0" border="0">
1955   <tr>
1956     <td>
1957       &nbsp;
1958     </td>
1959     <td>
1960
1961 <p>
1962 Returns true if the servername you give is ulined. 
1963 <p>
1964 ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.
1965 <p>
1966 Definition at line <a class="el" href="modules_8cpp-source.html#l00395">395</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1967 <p>
1968 References <a class="el" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline()</a>.<div class="fragment"><pre class="fragment"><a name="l00396"></a>00396 {
1969 <a name="l00397"></a>00397         <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline</a>(server.c_str());
1970 <a name="l00398"></a>00398 }
1971 </pre></div>
1972 <p>
1973     </td>
1974   </tr>
1975 </table>
1976 <a class="anchor" name="IsValidMask_28std_3A_3Astring_20mask_29"></a><!-- doxytag: member="Server::IsValidMask" ref="IsValidMask_28std_3A_3Astring_20mask_29" args="(std::string mask)" --><p>
1977 <table class="mdTable" cellpadding="2" cellspacing="0">
1978   <tr>
1979     <td class="mdRow">
1980       <table cellpadding="0" cellspacing="0" border="0">
1981         <tr>
1982           <td class="md" nowrap valign="top">bool Server::IsValidMask           </td>
1983           <td class="md" valign="top">(&nbsp;</td>
1984           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1985           <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
1986           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1987           <td class="md" nowrap><code> [virtual]</code></td>
1988         </tr>
1989       </table>
1990     </td>
1991   </tr>
1992 </table>
1993 <table cellspacing="5" cellpadding="0" border="0">
1994   <tr>
1995     <td>
1996       &nbsp;
1997     </td>
1998     <td>
1999
2000 <p>
2001 Returns true if a nick!ident string is correctly formatted, false if otherwise. 
2002 <p>
2003
2004 <p>
2005 Definition at line <a class="el" href="modules_8cpp-source.html#l00694">694</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00695"></a>00695 {
2006 <a name="l00696"></a>00696         <span class="keyword">const</span> <span class="keywordtype">char</span>* dest = mask.c_str();
2007 <a name="l00697"></a>00697         <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'!'</span>)==0)
2008 <a name="l00698"></a>00698                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2009 <a name="l00699"></a>00699         <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'@'</span>)==0)
2010 <a name="l00700"></a>00700                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2011 <a name="l00701"></a>00701         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2012 <a name="l00702"></a>00702                 <span class="keywordflow">if</span> (dest[i] &lt; 32)
2013 <a name="l00703"></a>00703                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
2014 <a name="l00704"></a>00704         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2015 <a name="l00705"></a>00705                 <span class="keywordflow">if</span> (dest[i] &gt; 126)
2016 <a name="l00706"></a>00706                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
2017 <a name="l00707"></a>00707         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c = 0;
2018 <a name="l00708"></a>00708         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2019 <a name="l00709"></a>00709                 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'!'</span>)
2020 <a name="l00710"></a>00710                         c++;
2021 <a name="l00711"></a>00711         <span class="keywordflow">if</span> (c&gt;1)
2022 <a name="l00712"></a>00712                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2023 <a name="l00713"></a>00713         c = 0;
2024 <a name="l00714"></a>00714         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2025 <a name="l00715"></a>00715                 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'@'</span>)
2026 <a name="l00716"></a>00716                         c++;
2027 <a name="l00717"></a>00717         <span class="keywordflow">if</span> (c&gt;1)
2028 <a name="l00718"></a>00718                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2029 <a name="l00719"></a>00719 
2030 <a name="l00720"></a>00720         <span class="keywordflow">return</span> <span class="keyword">true</span>;
2031 <a name="l00721"></a>00721 }
2032 </pre></div>
2033 <p>
2034     </td>
2035   </tr>
2036 </table>
2037 <a class="anchor" name="IsValidModuleCommand_28std_3A_3Astring_20commandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><!-- doxytag: member="Server::IsValidModuleCommand" ref="IsValidModuleCommand_28std_3A_3Astring_20commandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29" args="(std::string commandname, int pcnt, userrec *user)" --><p>
2038 <table class="mdTable" cellpadding="2" cellspacing="0">
2039   <tr>
2040     <td class="mdRow">
2041       <table cellpadding="0" cellspacing="0" border="0">
2042         <tr>
2043           <td class="md" nowrap valign="top">bool Server::IsValidModuleCommand           </td>
2044           <td class="md" valign="top">(&nbsp;</td>
2045           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2046           <td class="mdname" nowrap> <em>commandname</em>, </td>
2047         </tr>
2048         <tr>
2049           <td class="md" nowrap align="right"></td>
2050           <td class="md"></td>
2051           <td class="md" nowrap>int&nbsp;</td>
2052           <td class="mdname" nowrap> <em>pcnt</em>, </td>
2053         </tr>
2054         <tr>
2055           <td class="md" nowrap align="right"></td>
2056           <td class="md"></td>
2057           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2058           <td class="mdname" nowrap> <em>user</em></td>
2059         </tr>
2060         <tr>
2061           <td class="md"></td>
2062           <td class="md">)&nbsp;</td>
2063           <td class="md" colspan="2"><code> [virtual]</code></td>
2064         </tr>
2065       </table>
2066     </td>
2067   </tr>
2068 </table>
2069 <table cellspacing="5" cellpadding="0" border="0">
2070   <tr>
2071     <td>
2072       &nbsp;
2073     </td>
2074     <td>
2075
2076 <p>
2077
2078 <p>
2079 Definition at line <a class="el" href="modules_8cpp-source.html#l00405">405</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2080 <p>
2081 References <a class="el" href="inspircd_8h-source.html#l00110">InspIRCd::Parser</a>.<div class="fragment"><pre class="fragment"><a name="l00406"></a>00406 {
2082 <a name="l00407"></a>00407         <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#ServerInstance">ServerInstance</a>-&gt;<a class="code" href="classInspIRCd.html#Parser">Parser</a>-&gt;IsValidCommand(commandname, pcnt, user);
2083 <a name="l00408"></a>00408 }
2084 </pre></div>
2085 <p>
2086     </td>
2087   </tr>
2088 </table>
2089 <a class="anchor" name="JoinUserToChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20key_29"></a><!-- doxytag: member="Server::JoinUserToChannel" ref="JoinUserToChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20key_29" args="(userrec *user, std::string cname, std::string key)" --><p>
2090 <table class="mdTable" cellpadding="2" cellspacing="0">
2091   <tr>
2092     <td class="mdRow">
2093       <table cellpadding="0" cellspacing="0" border="0">
2094         <tr>
2095           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * Server::JoinUserToChannel           </td>
2096           <td class="md" valign="top">(&nbsp;</td>
2097           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2098           <td class="mdname" nowrap> <em>user</em>, </td>
2099         </tr>
2100         <tr>
2101           <td class="md" nowrap align="right"></td>
2102           <td class="md"></td>
2103           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2104           <td class="mdname" nowrap> <em>cname</em>, </td>
2105         </tr>
2106         <tr>
2107           <td class="md" nowrap align="right"></td>
2108           <td class="md"></td>
2109           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2110           <td class="mdname" nowrap> <em>key</em></td>
2111         </tr>
2112         <tr>
2113           <td class="md"></td>
2114           <td class="md">)&nbsp;</td>
2115           <td class="md" colspan="2"><code> [virtual]</code></td>
2116         </tr>
2117       </table>
2118     </td>
2119   </tr>
2120 </table>
2121 <table cellspacing="5" cellpadding="0" border="0">
2122   <tr>
2123     <td>
2124       &nbsp;
2125     </td>
2126     <td>
2127
2128 <p>
2129 Forces a user to join a channel. 
2130 <p>
2131 This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.
2132 <p>
2133 Definition at line <a class="el" href="modules_8cpp-source.html#l00363">363</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2134 <p>
2135 References <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00364"></a>00364 {
2136 <a name="l00365"></a>00365         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#add_5Fchannel_28userrec_20_2Auser_2C_20const_20char_20_2Acn_2C_20const_20char_20_2Akey_2C_20bool_20override_29">add_channel</a>(user,cname.c_str(),key.c_str(),<span class="keyword">false</span>);
2137 <a name="l00366"></a>00366 }
2138 </pre></div>
2139 <p>
2140     </td>
2141   </tr>
2142 </table>
2143 <a class="anchor" name="Log_28int_20level_2C_20std_3A_3Astring_20s_29"></a><!-- doxytag: member="Server::Log" ref="Log_28int_20level_2C_20std_3A_3Astring_20s_29" args="(int level, std::string s)" --><p>
2144 <table class="mdTable" cellpadding="2" cellspacing="0">
2145   <tr>
2146     <td class="mdRow">
2147       <table cellpadding="0" cellspacing="0" border="0">
2148         <tr>
2149           <td class="md" nowrap valign="top">void Server::Log           </td>
2150           <td class="md" valign="top">(&nbsp;</td>
2151           <td class="md" nowrap valign="top">int&nbsp;</td>
2152           <td class="mdname" nowrap> <em>level</em>, </td>
2153         </tr>
2154         <tr>
2155           <td class="md" nowrap align="right"></td>
2156           <td class="md"></td>
2157           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2158           <td class="mdname" nowrap> <em>s</em></td>
2159         </tr>
2160         <tr>
2161           <td class="md"></td>
2162           <td class="md">)&nbsp;</td>
2163           <td class="md" colspan="2"><code> [virtual]</code></td>
2164         </tr>
2165       </table>
2166     </td>
2167   </tr>
2168 </table>
2169 <table cellspacing="5" cellpadding="0" border="0">
2170   <tr>
2171     <td>
2172       &nbsp;
2173     </td>
2174     <td>
2175
2176 <p>
2177 Writes a log string. 
2178 <p>
2179 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.
2180 <p>
2181 Definition at line <a class="el" href="modules_8cpp-source.html#l00410">410</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2182 <p>
2183 References <a class="el" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log()</a>.<div class="fragment"><pre class="fragment"><a name="l00411"></a>00411 {
2184 <a name="l00412"></a>00412         <a class="code" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log</a>(level,<span class="stringliteral">"%s"</span>,s.c_str());
2185 <a name="l00413"></a>00413 }
2186 </pre></div>
2187 <p>
2188     </td>
2189   </tr>
2190 </table>
2191 <a class="anchor" name="MatchText_28std_3A_3Astring_20sliteral_2C_20std_3A_3Astring_20spattern_29"></a><!-- doxytag: member="Server::MatchText" ref="MatchText_28std_3A_3Astring_20sliteral_2C_20std_3A_3Astring_20spattern_29" args="(std::string sliteral, std::string spattern)" --><p>
2192 <table class="mdTable" cellpadding="2" cellspacing="0">
2193   <tr>
2194     <td class="mdRow">
2195       <table cellpadding="0" cellspacing="0" border="0">
2196         <tr>
2197           <td class="md" nowrap valign="top">bool Server::MatchText           </td>
2198           <td class="md" valign="top">(&nbsp;</td>
2199           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2200           <td class="mdname" nowrap> <em>sliteral</em>, </td>
2201         </tr>
2202         <tr>
2203           <td class="md" nowrap align="right"></td>
2204           <td class="md"></td>
2205           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2206           <td class="mdname" nowrap> <em>spattern</em></td>
2207         </tr>
2208         <tr>
2209           <td class="md"></td>
2210           <td class="md">)&nbsp;</td>
2211           <td class="md" colspan="2"><code> [virtual]</code></td>
2212         </tr>
2213       </table>
2214     </td>
2215   </tr>
2216 </table>
2217 <table cellspacing="5" cellpadding="0" border="0">
2218   <tr>
2219     <td>
2220       &nbsp;
2221     </td>
2222     <td>
2223
2224 <p>
2225 Matches text against a glob pattern. 
2226 <p>
2227 Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.
2228 <p>
2229 Definition at line <a class="el" href="modules_8cpp-source.html#l00350">350</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00351"></a>00351 {
2230 <a name="l00352"></a>00352         <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF];
2231 <a name="l00353"></a>00353         strlcpy(literal,sliteral.c_str(),MAXBUF);
2232 <a name="l00354"></a>00354         strlcpy(pattern,spattern.c_str(),MAXBUF);
2233 <a name="l00355"></a>00355         <span class="keywordflow">return</span> match(literal,pattern);
2234 <a name="l00356"></a>00356 }
2235 </pre></div>
2236 <p>
2237     </td>
2238   </tr>
2239 </table>
2240 <a class="anchor" name="PartUserFromChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20reason_29"></a><!-- doxytag: member="Server::PartUserFromChannel" ref="PartUserFromChannel_28userrec_20_2Auser_2C_20std_3A_3Astring_20cname_2C_20std_3A_3Astring_20reason_29" args="(userrec *user, std::string cname, std::string reason)" --><p>
2241 <table class="mdTable" cellpadding="2" cellspacing="0">
2242   <tr>
2243     <td class="mdRow">
2244       <table cellpadding="0" cellspacing="0" border="0">
2245         <tr>
2246           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * Server::PartUserFromChannel           </td>
2247           <td class="md" valign="top">(&nbsp;</td>
2248           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2249           <td class="mdname" nowrap> <em>user</em>, </td>
2250         </tr>
2251         <tr>
2252           <td class="md" nowrap align="right"></td>
2253           <td class="md"></td>
2254           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2255           <td class="mdname" nowrap> <em>cname</em>, </td>
2256         </tr>
2257         <tr>
2258           <td class="md" nowrap align="right"></td>
2259           <td class="md"></td>
2260           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2261           <td class="mdname" nowrap> <em>reason</em></td>
2262         </tr>
2263         <tr>
2264           <td class="md"></td>
2265           <td class="md">)&nbsp;</td>
2266           <td class="md" colspan="2"><code> [virtual]</code></td>
2267         </tr>
2268       </table>
2269     </td>
2270   </tr>
2271 </table>
2272 <table cellspacing="5" cellpadding="0" border="0">
2273   <tr>
2274     <td>
2275       &nbsp;
2276     </td>
2277     <td>
2278
2279 <p>
2280 Forces a user to part a channel. 
2281 <p>
2282 This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.
2283 <p>
2284 Definition at line <a class="el" href="modules_8cpp-source.html#l00368">368</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2285 <p>
2286 References <a class="el" href="channels_8cpp-source.html#l00401">del_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00369"></a>00369 {
2287 <a name="l00370"></a>00370         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#del_5Fchannel_28userrec_20_2Auser_2C_20const_20char_20_2Acname_2C_20const_20char_20_2Areason_2C_20bool_20local_29">del_channel</a>(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>);
2288 <a name="l00371"></a>00371 }
2289 </pre></div>
2290 <p>
2291     </td>
2292   </tr>
2293 </table>
2294 <a class="anchor" name="PseudoToUser_28userrec_20_2Aalive_2C_20userrec_20_2Azombie_2C_20std_3A_3Astring_20message_29"></a><!-- doxytag: member="Server::PseudoToUser" ref="PseudoToUser_28userrec_20_2Aalive_2C_20userrec_20_2Azombie_2C_20std_3A_3Astring_20message_29" args="(userrec *alive, userrec *zombie, std::string message)" --><p>
2295 <table class="mdTable" cellpadding="2" cellspacing="0">
2296   <tr>
2297     <td class="mdRow">
2298       <table cellpadding="0" cellspacing="0" border="0">
2299         <tr>
2300           <td class="md" nowrap valign="top">bool Server::PseudoToUser           </td>
2301           <td class="md" valign="top">(&nbsp;</td>
2302           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2303           <td class="mdname" nowrap> <em>alive</em>, </td>
2304         </tr>
2305         <tr>
2306           <td class="md" nowrap align="right"></td>
2307           <td class="md"></td>
2308           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2309           <td class="mdname" nowrap> <em>zombie</em>, </td>
2310         </tr>
2311         <tr>
2312           <td class="md" nowrap align="right"></td>
2313           <td class="md"></td>
2314           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2315           <td class="mdname" nowrap> <em>message</em></td>
2316         </tr>
2317         <tr>
2318           <td class="md"></td>
2319           <td class="md">)&nbsp;</td>
2320           <td class="md" colspan="2"><code> [virtual]</code></td>
2321         </tr>
2322       </table>
2323     </td>
2324   </tr>
2325 </table>
2326 <table cellspacing="5" cellpadding="0" border="0">
2327   <tr>
2328     <td>
2329       &nbsp;
2330     </td>
2331     <td>
2332
2333 <p>
2334 This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other. 
2335 <p>
2336 The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
2337 <p>
2338 Definition at line <a class="el" href="modules_8cpp-source.html#l00609">609</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2339 <p>
2340 References <a class="el" href="users_8h-source.html#l00153">userrec::chans</a>, <a class="el" href="users_8cpp-source.html#l00253">userrec::ClearBuffer()</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00102">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00133">userrec::ident</a>, <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>, <a class="el" href="channels_8h-source.html#l00108">chanrec::name</a>, <a class="el" href="users_8h-source.html#l00128">userrec::nick</a>, <a class="el" href="channels_8h-source.html#l00133">chanrec::setby</a>, <a class="el" href="channels_8h-source.html#l00122">chanrec::topic</a>, <a class="el" href="channels_8h-source.html#l00129">chanrec::topicset</a>, <a class="el" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write()</a>, <a class="el" href="globals_8h.html#WriteFrom_28int_20sock_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteFrom()</a>, and <a class="el" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ()</a>.<div class="fragment"><pre class="fragment"><a name="l00610"></a>00610 {
2341 <a name="l00611"></a>00611         zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a> = alive-&gt;<a class="code" href="classconnection.html#fd">fd</a>;
2342 <a name="l00612"></a>00612         alive-&gt;<a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="modules_8h.html#FD_5FMAGIC_5FNUMBER">FD_MAGIC_NUMBER</a>;
2343 <a name="l00613"></a>00613         alive-&gt;<a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>();
2344 <a name="l00614"></a>00614         <a class="code" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write</a>(zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">":%s!%s@%s NICK %s"</span>,alive-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,alive-&gt;<a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,alive-&gt;<a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,zombie-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>);
2345 <a name="l00615"></a>00615         <a class="code" href="users_8cpp.html#kill_5Flink_28userrec_20_2Auser_2C_20const_20char_20_2Ar_29">kill_link</a>(alive,message.c_str());
2346 <a name="l00616"></a>00616         <a class="code" href="modules_8cpp.html#fd_5Fref_5Ftable_5B_36_35_35_33_36_5D">fd_ref_table</a>[zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a>] = zombie;
2347 <a name="l00617"></a>00617         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; zombie-&gt;chans.size(); i++)
2348 <a name="l00618"></a>00618         {
2349 <a name="l00619"></a>00619                 <span class="keywordflow">if</span> (zombie-&gt;<a class="code" href="classuserrec.html#chans">chans</a>[i].channel != NULL)
2350 <a name="l00620"></a>00620                 {
2351 <a name="l00621"></a>00621                         <span class="keywordflow">if</span> (zombie-&gt;<a class="code" href="classuserrec.html#chans">chans</a>[i].channel-&gt;name)
2352 <a name="l00622"></a>00622                         {
2353 <a name="l00623"></a>00623                                 <a class="code" href="classchanrec.html">chanrec</a>* Ptr = zombie-&gt;<a class="code" href="classuserrec.html#chans">chans</a>[i].channel;
2354 <a name="l00624"></a>00624                                 <a class="code" href="globals_8h.html#WriteFrom_28int_20sock_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteFrom</a>(zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a>,zombie,<span class="stringliteral">"JOIN %s"</span>,Ptr-&gt;<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>);
2355 <a name="l00625"></a>00625                                 <span class="keywordflow">if</span> (Ptr-&gt;<a class="code" href="classchanrec.html#topicset">topicset</a>)
2356 <a name="l00626"></a>00626                                 {
2357 <a name="l00627"></a>00627                                         <a class="code" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ</a>(zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"332 %s %s :%s"</span>, zombie-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-&gt;<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>, Ptr-&gt;<a class="code" href="classchanrec.html#topic_5BMAXBUF_5D">topic</a>);
2358 <a name="l00628"></a>00628                                         <a class="code" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ</a>(zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"333 %s %s %s %d"</span>, zombie-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-&gt;<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>, Ptr-&gt;<a class="code" href="classchanrec.html#setby_5BNICKMAX_5D">setby</a>, Ptr-&gt;<a class="code" href="classchanrec.html#topicset">topicset</a>);
2359 <a name="l00629"></a>00629                                 }
2360 <a name="l00630"></a>00630                                 userlist(zombie,Ptr);
2361 <a name="l00631"></a>00631                                 <a class="code" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ</a>(zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"366 %s %s :End of /NAMES list."</span>, zombie-&gt;<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-&gt;<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>);
2362 <a name="l00632"></a>00632 
2363 <a name="l00633"></a>00633                         }
2364 <a name="l00634"></a>00634                 }
2365 <a name="l00635"></a>00635         }
2366 <a name="l00636"></a>00636         <span class="keywordflow">return</span> <span class="keyword">true</span>;
2367 <a name="l00637"></a>00637 }
2368 </pre></div>
2369 <p>
2370     </td>
2371   </tr>
2372 </table>
2373 <a class="anchor" name="QuitUser_28userrec_20_2Auser_2C_20std_3A_3Astring_20reason_29"></a><!-- doxytag: member="Server::QuitUser" ref="QuitUser_28userrec_20_2Auser_2C_20std_3A_3Astring_20reason_29" args="(userrec *user, std::string reason)" --><p>
2374 <table class="mdTable" cellpadding="2" cellspacing="0">
2375   <tr>
2376     <td class="mdRow">
2377       <table cellpadding="0" cellspacing="0" border="0">
2378         <tr>
2379           <td class="md" nowrap valign="top">void Server::QuitUser           </td>
2380           <td class="md" valign="top">(&nbsp;</td>
2381           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2382           <td class="mdname" nowrap> <em>user</em>, </td>
2383         </tr>
2384         <tr>
2385           <td class="md" nowrap align="right"></td>
2386           <td class="md"></td>
2387           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2388           <td class="mdname" nowrap> <em>reason</em></td>
2389         </tr>
2390         <tr>
2391           <td class="md"></td>
2392           <td class="md">)&nbsp;</td>
2393           <td class="md" colspan="2"><code> [virtual]</code></td>
2394         </tr>
2395       </table>
2396     </td>
2397   </tr>
2398 </table>
2399 <table cellspacing="5" cellpadding="0" border="0">
2400   <tr>
2401     <td>
2402       &nbsp;
2403     </td>
2404     <td>
2405
2406 <p>
2407 Forces a user to quit with the specified reason. 
2408 <p>
2409 To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.<p>
2410 WARNING!<p>
2411 Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.
2412 <p>
2413 Definition at line <a class="el" href="modules_8cpp-source.html#l00390">390</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2414 <p>
2415 References <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>.<div class="fragment"><pre class="fragment"><a name="l00391"></a>00391 {
2416 <a name="l00392"></a>00392         <a class="code" href="users_8cpp.html#kill_5Flink_28userrec_20_2Auser_2C_20const_20char_20_2Ar_29">kill_link</a>(user,reason.c_str());
2417 <a name="l00393"></a>00393 }
2418 </pre></div>
2419 <p>
2420     </td>
2421   </tr>
2422 </table>
2423 <a class="anchor" name="RehashServer_28_29"></a><!-- doxytag: member="Server::RehashServer" ref="RehashServer_28_29" args="()" --><p>
2424 <table class="mdTable" cellpadding="2" cellspacing="0">
2425   <tr>
2426     <td class="mdRow">
2427       <table cellpadding="0" cellspacing="0" border="0">
2428         <tr>
2429           <td class="md" nowrap valign="top">void Server::RehashServer           </td>
2430           <td class="md" valign="top">(&nbsp;</td>
2431           <td class="mdname1" valign="top" nowrap>          </td>
2432           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2433           <td class="md" nowrap><code> [virtual]</code></td>
2434         </tr>
2435       </table>
2436     </td>
2437   </tr>
2438 </table>
2439 <table cellspacing="5" cellpadding="0" border="0">
2440   <tr>
2441     <td>
2442       &nbsp;
2443     </td>
2444     <td>
2445
2446 <p>
2447
2448 <p>
2449 Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2450 <p>
2451 References <a class="el" href="classServerConfig.html#Read_28bool_20bail_2C_20userrec_20_2Auser_29">ServerConfig::Read()</a>, and <a class="el" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers()</a>.<div class="fragment"><pre class="fragment"><a name="l00318"></a>00318 {
2452 <a name="l00319"></a>00319         <a class="code" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers</a>(<span class="stringliteral">"*** Rehashing config file"</span>);
2453 <a name="l00320"></a>00320         <a class="code" href="channels_8cpp.html#Config">Config</a>-&gt;<a class="code" href="classServerConfig.html#Read_28bool_20bail_2C_20userrec_20_2Auser_29">Read</a>(<span class="keyword">false</span>,NULL);
2454 <a name="l00321"></a>00321 }
2455 </pre></div>
2456 <p>
2457     </td>
2458   </tr>
2459 </table>
2460 <a class="anchor" name="Send_28int_20Socket_2C_20std_3A_3Astring_20s_29"></a><!-- doxytag: member="Server::Send" ref="Send_28int_20Socket_2C_20std_3A_3Astring_20s_29" args="(int Socket, std::string s)" --><p>
2461 <table class="mdTable" cellpadding="2" cellspacing="0">
2462   <tr>
2463     <td class="mdRow">
2464       <table cellpadding="0" cellspacing="0" border="0">
2465         <tr>
2466           <td class="md" nowrap valign="top">void Server::Send           </td>
2467           <td class="md" valign="top">(&nbsp;</td>
2468           <td class="md" nowrap valign="top">int&nbsp;</td>
2469           <td class="mdname" nowrap> <em>Socket</em>, </td>
2470         </tr>
2471         <tr>
2472           <td class="md" nowrap align="right"></td>
2473           <td class="md"></td>
2474           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2475           <td class="mdname" nowrap> <em>s</em></td>
2476         </tr>
2477         <tr>
2478           <td class="md"></td>
2479           <td class="md">)&nbsp;</td>
2480           <td class="md" colspan="2"><code> [virtual]</code></td>
2481         </tr>
2482       </table>
2483     </td>
2484   </tr>
2485 </table>
2486 <table cellspacing="5" cellpadding="0" border="0">
2487   <tr>
2488     <td>
2489       &nbsp;
2490     </td>
2491     <td>
2492
2493 <p>
2494 Sends a line of text down a TCP/IP socket. 
2495 <p>
2496 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
2497 <p>
2498 Definition at line <a class="el" href="modules_8cpp-source.html#l00425">425</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2499 <p>
2500 References <a class="el" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write()</a>.<div class="fragment"><pre class="fragment"><a name="l00426"></a>00426 {
2501 <a name="l00427"></a>00427         <a class="code" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write</a>(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
2502 <a name="l00428"></a>00428 }
2503 </pre></div>
2504 <p>
2505     </td>
2506   </tr>
2507 </table>
2508 <a class="anchor" name="SendChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20s_2C_20bool_20IncludeSender_29"></a><!-- doxytag: member="Server::SendChannel" ref="SendChannel_28userrec_20_2AUser_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20s_2C_20bool_20IncludeSender_29" args="(userrec *User, chanrec *Channel, std::string s, bool IncludeSender)" --><p>
2509 <table class="mdTable" cellpadding="2" cellspacing="0">
2510   <tr>
2511     <td class="mdRow">
2512       <table cellpadding="0" cellspacing="0" border="0">
2513         <tr>
2514           <td class="md" nowrap valign="top">void Server::SendChannel           </td>
2515           <td class="md" valign="top">(&nbsp;</td>
2516           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2517           <td class="mdname" nowrap> <em>User</em>, </td>
2518         </tr>
2519         <tr>
2520           <td class="md" nowrap align="right"></td>
2521           <td class="md"></td>
2522           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2523           <td class="mdname" nowrap> <em>Channel</em>, </td>
2524         </tr>
2525         <tr>
2526           <td class="md" nowrap align="right"></td>
2527           <td class="md"></td>
2528           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2529           <td class="mdname" nowrap> <em>s</em>, </td>
2530         </tr>
2531         <tr>
2532           <td class="md" nowrap align="right"></td>
2533           <td class="md"></td>
2534           <td class="md" nowrap>bool&nbsp;</td>
2535           <td class="mdname" nowrap> <em>IncludeSender</em></td>
2536         </tr>
2537         <tr>
2538           <td class="md"></td>
2539           <td class="md">)&nbsp;</td>
2540           <td class="md" colspan="2"><code> [virtual]</code></td>
2541         </tr>
2542       </table>
2543     </td>
2544   </tr>
2545 </table>
2546 <table cellspacing="5" cellpadding="0" border="0">
2547   <tr>
2548     <td>
2549       &nbsp;
2550     </td>
2551     <td>
2552
2553 <p>
2554 Sends text from a user to a channel (mulicast). 
2555 <p>
2556 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).
2557 <p>
2558 Definition at line <a class="el" href="modules_8cpp-source.html#l00459">459</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2559 <p>
2560 References <a class="el" href="globals_8h.html#ChanExceptSender_28chanrec_20_2APtr_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">ChanExceptSender()</a>, and <a class="el" href="globals_8h.html#WriteChannel_28chanrec_20_2APtr_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteChannel()</a>.<div class="fragment"><pre class="fragment"><a name="l00460"></a>00460 {
2561 <a name="l00461"></a>00461         <span class="keywordflow">if</span> (IncludeSender)
2562 <a name="l00462"></a>00462         {
2563 <a name="l00463"></a>00463                 <a class="code" href="globals_8h.html#WriteChannel_28chanrec_20_2APtr_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteChannel</a>(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
2564 <a name="l00464"></a>00464         }
2565 <a name="l00465"></a>00465         <span class="keywordflow">else</span>
2566 <a name="l00466"></a>00466         {
2567 <a name="l00467"></a>00467                 <a class="code" href="globals_8h.html#ChanExceptSender_28chanrec_20_2APtr_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">ChanExceptSender</a>(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
2568 <a name="l00468"></a>00468         }
2569 <a name="l00469"></a>00469 }
2570 </pre></div>
2571 <p>
2572     </td>
2573   </tr>
2574 </table>
2575 <a class="anchor" name="SendChannelServerNotice_28std_3A_3Astring_20ServName_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Server::SendChannelServerNotice" ref="SendChannelServerNotice_28std_3A_3Astring_20ServName_2C_20chanrec_20_2AChannel_2C_20std_3A_3Astring_20text_29" args="(std::string ServName, chanrec *Channel, std::string text)" --><p>
2576 <table class="mdTable" cellpadding="2" cellspacing="0">
2577   <tr>
2578     <td class="mdRow">
2579       <table cellpadding="0" cellspacing="0" border="0">
2580         <tr>
2581           <td class="md" nowrap valign="top">void Server::SendChannelServerNotice           </td>
2582           <td class="md" valign="top">(&nbsp;</td>
2583           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2584           <td class="mdname" nowrap> <em>ServName</em>, </td>
2585         </tr>
2586         <tr>
2587           <td class="md" nowrap align="right"></td>
2588           <td class="md"></td>
2589           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2590           <td class="mdname" nowrap> <em>Channel</em>, </td>
2591         </tr>
2592         <tr>
2593           <td class="md" nowrap align="right"></td>
2594           <td class="md"></td>
2595           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2596           <td class="mdname" nowrap> <em>text</em></td>
2597         </tr>
2598         <tr>
2599           <td class="md"></td>
2600           <td class="md">)&nbsp;</td>
2601           <td class="md" colspan="2"><code> [virtual]</code></td>
2602         </tr>
2603       </table>
2604     </td>
2605   </tr>
2606 </table>
2607 <table cellspacing="5" cellpadding="0" border="0">
2608   <tr>
2609     <td>
2610       &nbsp;
2611     </td>
2612     <td>
2613
2614 <p>
2615 Writes text to a channel, but from a server, including all. 
2616 <p>
2617 This can be used to send server notices to a group of users.
2618 <p>
2619 Definition at line <a class="el" href="modules_8cpp-source.html#l00454">454</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00455"></a>00455 {
2620 <a name="l00456"></a>00456         WriteChannelWithServ((<span class="keywordtype">char</span>*)ServName.c_str(), Channel, <span class="stringliteral">"%s"</span>, text.c_str());
2621 <a name="l00457"></a>00457 }
2622 </pre></div>
2623 <p>
2624     </td>
2625   </tr>
2626 </table>
2627 <a class="anchor" name="SendCommon_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_2C_20bool_20IncludeSender_29"></a><!-- doxytag: member="Server::SendCommon" ref="SendCommon_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_2C_20bool_20IncludeSender_29" args="(userrec *User, std::string text, bool IncludeSender)" --><p>
2628 <table class="mdTable" cellpadding="2" cellspacing="0">
2629   <tr>
2630     <td class="mdRow">
2631       <table cellpadding="0" cellspacing="0" border="0">
2632         <tr>
2633           <td class="md" nowrap valign="top">void Server::SendCommon           </td>
2634           <td class="md" valign="top">(&nbsp;</td>
2635           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2636           <td class="mdname" nowrap> <em>User</em>, </td>
2637         </tr>
2638         <tr>
2639           <td class="md" nowrap align="right"></td>
2640           <td class="md"></td>
2641           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2642           <td class="mdname" nowrap> <em>text</em>, </td>
2643         </tr>
2644         <tr>
2645           <td class="md" nowrap align="right"></td>
2646           <td class="md"></td>
2647           <td class="md" nowrap>bool&nbsp;</td>
2648           <td class="mdname" nowrap> <em>IncludeSender</em></td>
2649         </tr>
2650         <tr>
2651           <td class="md"></td>
2652           <td class="md">)&nbsp;</td>
2653           <td class="md" colspan="2"><code> [virtual]</code></td>
2654         </tr>
2655       </table>
2656     </td>
2657   </tr>
2658 </table>
2659 <table cellspacing="5" cellpadding="0" border="0">
2660   <tr>
2661     <td>
2662       &nbsp;
2663     </td>
2664     <td>
2665
2666 <p>
2667 Sends text from a user to one or more channels (mulicast). 
2668 <p>
2669 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.
2670 <p>
2671 Definition at line <a class="el" href="modules_8cpp-source.html#l00476">476</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2672 <p>
2673 References <a class="el" href="globals_8h.html#WriteCommon_28userrec_20_2Au_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteCommon()</a>, and <a class="el" href="globals_8h.html#WriteCommonExcept_28userrec_20_2Au_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteCommonExcept()</a>.<div class="fragment"><pre class="fragment"><a name="l00477"></a>00477 {
2674 <a name="l00478"></a>00478         <span class="keywordflow">if</span> (IncludeSender)
2675 <a name="l00479"></a>00479         {
2676 <a name="l00480"></a>00480                 <a class="code" href="globals_8h.html#WriteCommon_28userrec_20_2Au_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteCommon</a>(User,<span class="stringliteral">"%s"</span>,text.c_str());
2677 <a name="l00481"></a>00481         }
2678 <a name="l00482"></a>00482         <span class="keywordflow">else</span>
2679 <a name="l00483"></a>00483         {
2680 <a name="l00484"></a>00484                 <a class="code" href="globals_8h.html#WriteCommonExcept_28userrec_20_2Au_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteCommonExcept</a>(User,<span class="stringliteral">"%s"</span>,text.c_str());
2681 <a name="l00485"></a>00485         }
2682 <a name="l00486"></a>00486 }
2683 </pre></div>
2684 <p>
2685     </td>
2686   </tr>
2687 </table>
2688 <a class="anchor" name="SendFrom_28int_20Socket_2C_20userrec_20_2AUser_2C_20std_3A_3Astring_20s_29"></a><!-- doxytag: member="Server::SendFrom" ref="SendFrom_28int_20Socket_2C_20userrec_20_2AUser_2C_20std_3A_3Astring_20s_29" args="(int Socket, userrec *User, std::string s)" --><p>
2689 <table class="mdTable" cellpadding="2" cellspacing="0">
2690   <tr>
2691     <td class="mdRow">
2692       <table cellpadding="0" cellspacing="0" border="0">
2693         <tr>
2694           <td class="md" nowrap valign="top">void Server::SendFrom           </td>
2695           <td class="md" valign="top">(&nbsp;</td>
2696           <td class="md" nowrap valign="top">int&nbsp;</td>
2697           <td class="mdname" nowrap> <em>Socket</em>, </td>
2698         </tr>
2699         <tr>
2700           <td class="md" nowrap align="right"></td>
2701           <td class="md"></td>
2702           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2703           <td class="mdname" nowrap> <em>User</em>, </td>
2704         </tr>
2705         <tr>
2706           <td class="md" nowrap align="right"></td>
2707           <td class="md"></td>
2708           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2709           <td class="mdname" nowrap> <em>s</em></td>
2710         </tr>
2711         <tr>
2712           <td class="md"></td>
2713           <td class="md">)&nbsp;</td>
2714           <td class="md" colspan="2"><code> [virtual]</code></td>
2715         </tr>
2716       </table>
2717     </td>
2718   </tr>
2719 </table>
2720 <table cellspacing="5" cellpadding="0" border="0">
2721   <tr>
2722     <td>
2723       &nbsp;
2724     </td>
2725     <td>
2726
2727 <p>
2728 Sends text from a user to a socket. 
2729 <p>
2730 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)
2731 <p>
2732 Definition at line <a class="el" href="modules_8cpp-source.html#l00435">435</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2733 <p>
2734 References <a class="el" href="globals_8h.html#WriteFrom_28int_20sock_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteFrom()</a>.<div class="fragment"><pre class="fragment"><a name="l00436"></a>00436 {
2735 <a name="l00437"></a>00437         <a class="code" href="globals_8h.html#WriteFrom_28int_20sock_2C_20userrec_20_2Auser_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteFrom</a>(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
2736 <a name="l00438"></a>00438 }
2737 </pre></div>
2738 <p>
2739     </td>
2740   </tr>
2741 </table>
2742 <a class="anchor" name="SendMode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><!-- doxytag: member="Server::SendMode" ref="SendMode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29" args="(char **parameters, int pcnt, userrec *user)" --><p>
2743 <table class="mdTable" cellpadding="2" cellspacing="0">
2744   <tr>
2745     <td class="mdRow">
2746       <table cellpadding="0" cellspacing="0" border="0">
2747         <tr>
2748           <td class="md" nowrap valign="top">void Server::SendMode           </td>
2749           <td class="md" valign="top">(&nbsp;</td>
2750           <td class="md" nowrap valign="top">char **&nbsp;</td>
2751           <td class="mdname" nowrap> <em>parameters</em>, </td>
2752         </tr>
2753         <tr>
2754           <td class="md" nowrap align="right"></td>
2755           <td class="md"></td>
2756           <td class="md" nowrap>int&nbsp;</td>
2757           <td class="mdname" nowrap> <em>pcnt</em>, </td>
2758         </tr>
2759         <tr>
2760           <td class="md" nowrap align="right"></td>
2761           <td class="md"></td>
2762           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2763           <td class="mdname" nowrap> <em>user</em></td>
2764         </tr>
2765         <tr>
2766           <td class="md"></td>
2767           <td class="md">)&nbsp;</td>
2768           <td class="md" colspan="2"><code> [virtual]</code></td>
2769         </tr>
2770       </table>
2771     </td>
2772   </tr>
2773 </table>
2774 <table cellspacing="5" cellpadding="0" border="0">
2775   <tr>
2776     <td>
2777       &nbsp;
2778     </td>
2779     <td>
2780
2781 <p>
2782 Sends a servermode. 
2783 <p>
2784 you must format the parameters array with the target, modes and parameters for those modes.<p>
2785 For example:<p>
2786 char *modes[3];<p>
2787 modes[0] = ChannelName;<p>
2788 modes[1] = "+o";<p>
2789 modes[2] = user-&gt;nick;<p>
2790 Srv-&gt;SendMode(modes,3,user);<p>
2791 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!
2792 <p>
2793 Definition at line <a class="el" href="modules_8cpp-source.html#l00420">420</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2794 <p>
2795 References <a class="el" href="inspircd_8h-source.html#l00109">InspIRCd::ModeGrok</a>, and <a class="el" href="classModeParser.html#ServerMode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">ModeParser::ServerMode()</a>.<div class="fragment"><pre class="fragment"><a name="l00421"></a>00421 {
2796 <a name="l00422"></a>00422         <a class="code" href="modules_8cpp.html#ServerInstance">ServerInstance</a>-&gt;<a class="code" href="classInspIRCd.html#ModeGrok">ModeGrok</a>-&gt;<a class="code" href="classModeParser.html#ServerMode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">ServerMode</a>(parameters,pcnt,user);
2797 <a name="l00423"></a>00423 }
2798 </pre></div>
2799 <p>
2800     </td>
2801   </tr>
2802 </table>
2803 <a class="anchor" name="SendOpers_28std_3A_3Astring_20s_29"></a><!-- doxytag: member="Server::SendOpers" ref="SendOpers_28std_3A_3Astring_20s_29" args="(std::string s)" --><p>
2804 <table class="mdTable" cellpadding="2" cellspacing="0">
2805   <tr>
2806     <td class="mdRow">
2807       <table cellpadding="0" cellspacing="0" border="0">
2808         <tr>
2809           <td class="md" nowrap valign="top">void Server::SendOpers           </td>
2810           <td class="md" valign="top">(&nbsp;</td>
2811           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2812           <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
2813           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2814           <td class="md" nowrap><code> [virtual]</code></td>
2815         </tr>
2816       </table>
2817     </td>
2818   </tr>
2819 </table>
2820 <table cellspacing="5" cellpadding="0" border="0">
2821   <tr>
2822     <td>
2823       &nbsp;
2824     </td>
2825     <td>
2826
2827 <p>
2828 Sends text to all opers. 
2829 <p>
2830 This method sends a server notice to all opers with the usermode +s.
2831 <p>
2832 Definition at line <a class="el" href="modules_8cpp-source.html#l00345">345</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2833 <p>
2834 References <a class="el" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers()</a>.<div class="fragment"><pre class="fragment"><a name="l00346"></a>00346 {
2835 <a name="l00347"></a>00347         <a class="code" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers</a>(<span class="stringliteral">"%s"</span>,s.c_str());
2836 <a name="l00348"></a>00348 }
2837 </pre></div>
2838 <p>
2839     </td>
2840   </tr>
2841 </table>
2842 <a class="anchor" name="SendServ_28int_20Socket_2C_20std_3A_3Astring_20s_29"></a><!-- doxytag: member="Server::SendServ" ref="SendServ_28int_20Socket_2C_20std_3A_3Astring_20s_29" args="(int Socket, std::string s)" --><p>
2843 <table class="mdTable" cellpadding="2" cellspacing="0">
2844   <tr>
2845     <td class="mdRow">
2846       <table cellpadding="0" cellspacing="0" border="0">
2847         <tr>
2848           <td class="md" nowrap valign="top">void Server::SendServ           </td>
2849           <td class="md" valign="top">(&nbsp;</td>
2850           <td class="md" nowrap valign="top">int&nbsp;</td>
2851           <td class="mdname" nowrap> <em>Socket</em>, </td>
2852         </tr>
2853         <tr>
2854           <td class="md" nowrap align="right"></td>
2855           <td class="md"></td>
2856           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2857           <td class="mdname" nowrap> <em>s</em></td>
2858         </tr>
2859         <tr>
2860           <td class="md"></td>
2861           <td class="md">)&nbsp;</td>
2862           <td class="md" colspan="2"><code> [virtual]</code></td>
2863         </tr>
2864       </table>
2865     </td>
2866   </tr>
2867 </table>
2868 <table cellspacing="5" cellpadding="0" border="0">
2869   <tr>
2870     <td>
2871       &nbsp;
2872     </td>
2873     <td>
2874
2875 <p>
2876 Sends text from the server to a socket. 
2877 <p>
2878 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
2879 <p>
2880 Definition at line <a class="el" href="modules_8cpp-source.html#l00430">430</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2881 <p>
2882 References <a class="el" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ()</a>.<div class="fragment"><pre class="fragment"><a name="l00431"></a>00431 {
2883 <a name="l00432"></a>00432         <a class="code" href="globals_8h.html#WriteServ_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteServ</a>(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
2884 <a name="l00433"></a>00433 }
2885 </pre></div>
2886 <p>
2887     </td>
2888   </tr>
2889 </table>
2890 <a class="anchor" name="SendTo_28userrec_20_2ASource_2C_20userrec_20_2ADest_2C_20std_3A_3Astring_20s_29"></a><!-- doxytag: member="Server::SendTo" ref="SendTo_28userrec_20_2ASource_2C_20userrec_20_2ADest_2C_20std_3A_3Astring_20s_29" args="(userrec *Source, userrec *Dest, std::string s)" --><p>
2891 <table class="mdTable" cellpadding="2" cellspacing="0">
2892   <tr>
2893     <td class="mdRow">
2894       <table cellpadding="0" cellspacing="0" border="0">
2895         <tr>
2896           <td class="md" nowrap valign="top">void Server::SendTo           </td>
2897           <td class="md" valign="top">(&nbsp;</td>
2898           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2899           <td class="mdname" nowrap> <em>Source</em>, </td>
2900         </tr>
2901         <tr>
2902           <td class="md" nowrap align="right"></td>
2903           <td class="md"></td>
2904           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2905           <td class="mdname" nowrap> <em>Dest</em>, </td>
2906         </tr>
2907         <tr>
2908           <td class="md" nowrap align="right"></td>
2909           <td class="md"></td>
2910           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2911           <td class="mdname" nowrap> <em>s</em></td>
2912         </tr>
2913         <tr>
2914           <td class="md"></td>
2915           <td class="md">)&nbsp;</td>
2916           <td class="md" colspan="2"><code> [virtual]</code></td>
2917         </tr>
2918       </table>
2919     </td>
2920   </tr>
2921 </table>
2922 <table cellspacing="5" cellpadding="0" border="0">
2923   <tr>
2924     <td>
2925       &nbsp;
2926     </td>
2927     <td>
2928
2929 <p>
2930 Sends text from a user to another user. 
2931 <p>
2932 This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:<p>
2933 :user!ident TEXT<p>
2934 The format will become:<p>
2935 :localserver TEXT<p>
2936 Which is useful for numerics and server notices to single users, etc.
2937 <p>
2938 Definition at line <a class="el" href="modules_8cpp-source.html#l00440">440</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2939 <p>
2940 References <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write()</a>, and <a class="el" href="globals_8h.html#WriteTo_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20char_20_2Adata_2C_2E_2E_2E_29">WriteTo()</a>.<div class="fragment"><pre class="fragment"><a name="l00441"></a>00441 {
2941 <a name="l00442"></a>00442         <span class="keywordflow">if</span> (!Source)
2942 <a name="l00443"></a>00443         {
2943 <a name="l00444"></a>00444                 <span class="comment">// if source is NULL, then the message originates from the local server</span>
2944 <a name="l00445"></a>00445                 <a class="code" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write</a>(Dest-&gt;<a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">":%s %s"</span>,this-&gt;GetServerName().c_str(),s.c_str());
2945 <a name="l00446"></a>00446         }
2946 <a name="l00447"></a>00447         <span class="keywordflow">else</span>
2947 <a name="l00448"></a>00448         {
2948 <a name="l00449"></a>00449                 <span class="comment">// otherwise it comes from the user specified</span>
2949 <a name="l00450"></a>00450                 <a class="code" href="globals_8h.html#WriteTo_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20char_20_2Adata_2C_2E_2E_2E_29">WriteTo</a>(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
2950 <a name="l00451"></a>00451         }
2951 <a name="l00452"></a>00452 }
2952 </pre></div>
2953 <p>
2954     </td>
2955   </tr>
2956 </table>
2957 <a class="anchor" name="SendToModeMask_28std_3A_3Astring_20modes_2C_20int_20flags_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Server::SendToModeMask" ref="SendToModeMask_28std_3A_3Astring_20modes_2C_20int_20flags_2C_20std_3A_3Astring_20text_29" args="(std::string modes, int flags, std::string text)" --><p>
2958 <table class="mdTable" cellpadding="2" cellspacing="0">
2959   <tr>
2960     <td class="mdRow">
2961       <table cellpadding="0" cellspacing="0" border="0">
2962         <tr>
2963           <td class="md" nowrap valign="top">void Server::SendToModeMask           </td>
2964           <td class="md" valign="top">(&nbsp;</td>
2965           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2966           <td class="mdname" nowrap> <em>modes</em>, </td>
2967         </tr>
2968         <tr>
2969           <td class="md" nowrap align="right"></td>
2970           <td class="md"></td>
2971           <td class="md" nowrap>int&nbsp;</td>
2972           <td class="mdname" nowrap> <em>flags</em>, </td>
2973         </tr>
2974         <tr>
2975           <td class="md" nowrap align="right"></td>
2976           <td class="md"></td>
2977           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2978           <td class="mdname" nowrap> <em>text</em></td>
2979         </tr>
2980         <tr>
2981           <td class="md"></td>
2982           <td class="md">)&nbsp;</td>
2983           <td class="md" colspan="2"><code> [virtual]</code></td>
2984         </tr>
2985       </table>
2986     </td>
2987   </tr>
2988 </table>
2989 <table cellspacing="5" cellpadding="0" border="0">
2990   <tr>
2991     <td>
2992       &nbsp;
2993     </td>
2994     <td>
2995
2996 <p>
2997 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. 
2998 <p>
2999 These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:<p>
3000 Serv-&gt;SendToModeMask("xi", WM_OR, "m00");<p>
3001 Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.
3002 <p>
3003 Definition at line <a class="el" href="modules_8cpp-source.html#l00358">358</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00359"></a>00359 {
3004 <a name="l00360"></a>00360         WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str());
3005 <a name="l00361"></a>00361 }
3006 </pre></div>
3007 <p>
3008     </td>
3009   </tr>
3010 </table>
3011 <a class="anchor" name="SendWallops_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Server::SendWallops" ref="SendWallops_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_29" args="(userrec *User, std::string text)" --><p>
3012 <table class="mdTable" cellpadding="2" cellspacing="0">
3013   <tr>
3014     <td class="mdRow">
3015       <table cellpadding="0" cellspacing="0" border="0">
3016         <tr>
3017           <td class="md" nowrap valign="top">void Server::SendWallops           </td>
3018           <td class="md" valign="top">(&nbsp;</td>
3019           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3020           <td class="mdname" nowrap> <em>User</em>, </td>
3021         </tr>
3022         <tr>
3023           <td class="md" nowrap align="right"></td>
3024           <td class="md"></td>
3025           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3026           <td class="mdname" nowrap> <em>text</em></td>
3027         </tr>
3028         <tr>
3029           <td class="md"></td>
3030           <td class="md">)&nbsp;</td>
3031           <td class="md" colspan="2"><code> [virtual]</code></td>
3032         </tr>
3033       </table>
3034     </td>
3035   </tr>
3036 </table>
3037 <table cellspacing="5" cellpadding="0" border="0">
3038   <tr>
3039     <td>
3040       &nbsp;
3041     </td>
3042     <td>
3043
3044 <p>
3045 Sends a WALLOPS message. 
3046 <p>
3047 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
3048 <p>
3049 Definition at line <a class="el" href="modules_8cpp-source.html#l00488">488</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
3050 <p>
3051 References <a class="el" href="globals_8h.html#WriteWallOps_28userrec_20_2Asource_2C_20bool_20local_5Fonly_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteWallOps()</a>.<div class="fragment"><pre class="fragment"><a name="l00489"></a>00489 {
3052 <a name="l00490"></a>00490         <a class="code" href="globals_8h.html#WriteWallOps_28userrec_20_2Asource_2C_20bool_20local_5Fonly_2C_20char_20_2Atext_2C_2E_2E_2E_29">WriteWallOps</a>(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str());
3053 <a name="l00491"></a>00491 }
3054 </pre></div>
3055 <p>
3056     </td>
3057   </tr>
3058 </table>
3059 <a class="anchor" name="UserToPseudo_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_29"></a><!-- doxytag: member="Server::UserToPseudo" ref="UserToPseudo_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_29" args="(userrec *user, std::string message)" --><p>
3060 <table class="mdTable" cellpadding="2" cellspacing="0">
3061   <tr>
3062     <td class="mdRow">
3063       <table cellpadding="0" cellspacing="0" border="0">
3064         <tr>
3065           <td class="md" nowrap valign="top">bool Server::UserToPseudo           </td>
3066           <td class="md" valign="top">(&nbsp;</td>
3067           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3068           <td class="mdname" nowrap> <em>user</em>, </td>
3069         </tr>
3070         <tr>
3071           <td class="md" nowrap align="right"></td>
3072           <td class="md"></td>
3073           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3074           <td class="mdname" nowrap> <em>message</em></td>
3075         </tr>
3076         <tr>
3077           <td class="md"></td>
3078           <td class="md">)&nbsp;</td>
3079           <td class="md" colspan="2"><code> [virtual]</code></td>
3080         </tr>
3081       </table>
3082     </td>
3083   </tr>
3084 </table>
3085 <table cellspacing="5" cellpadding="0" border="0">
3086   <tr>
3087     <td>
3088       &nbsp;
3089     </td>
3090     <td>
3091
3092 <p>
3093 Remove a user's connection to the irc server, but leave their client in existence in the user hash. 
3094 <p>
3095 When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.
3096 <p>
3097 Definition at line <a class="el" href="modules_8cpp-source.html#l00597">597</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
3098 <p>
3099 References <a class="el" href="users_8cpp-source.html#l00253">userrec::ClearBuffer()</a>, <a class="el" href="socketengine_8cpp-source.html#l00103">SocketEngine::DelFd()</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00102">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00133">userrec::ident</a>, <a class="el" href="inspircd_8h-source.html#l00111">InspIRCd::SE</a>, and <a class="el" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write()</a>.<div class="fragment"><pre class="fragment"><a name="l00598"></a>00598 {
3100 <a name="l00599"></a>00599         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> old_fd = user-&gt;<a class="code" href="classconnection.html#fd">fd</a>;
3101 <a name="l00600"></a>00600         user-&gt;<a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="modules_8h.html#FD_5FMAGIC_5FNUMBER">FD_MAGIC_NUMBER</a>;
3102 <a name="l00601"></a>00601         user-&gt;<a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>();
3103 <a name="l00602"></a>00602         <a class="code" href="globals_8h.html#Write_28int_20sock_2C_20char_20_2Atext_2C_2E_2E_2E_29">Write</a>(old_fd,<span class="stringliteral">"ERROR :Closing link (%s@%s) [%s]"</span>,user-&gt;<a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,user-&gt;<a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,message.c_str());
3104 <a name="l00603"></a>00603         <a class="code" href="modules_8cpp.html#ServerInstance">ServerInstance</a>-&gt;<a class="code" href="classInspIRCd.html#SE">SE</a>-&gt;<a class="code" href="classSocketEngine.html#DelFd_28int_20fd_29">DelFd</a>(old_fd);
3105 <a name="l00604"></a>00604         shutdown(old_fd,2);
3106 <a name="l00605"></a>00605         close(old_fd);
3107 <a name="l00606"></a>00606         <span class="keywordflow">return</span> <span class="keyword">true</span>;
3108 <a name="l00607"></a>00607 }
3109 </pre></div>
3110 <p>
3111     </td>
3112   </tr>
3113 </table>
3114 <hr>The documentation for this class was generated from the following files:<ul>
3115 <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>
3116 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:05:23 2005 for InspIRCd by&nbsp;
3117 <a href="http://www.doxygen.org/index.html">
3118 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
3119 </body>
3120 </html>