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_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">AddCommand</a> (char *cmd, <a class="el" href="inspircd_8h.html#handlerfunc_29_28char_20_2A_2A_2C_20int_2C_20userrec_20_2A_29">handlerfunc</a> f, char flags, int minparams, char *source)</td></tr>
 109
 110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a command to the command table.  <a href="#AddCommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_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#l01096">1096</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#l00305">305</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00306"></a>00306 {
 240 <a name="l00307"></a>00307 }
 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#l00309">309</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00310"></a>00310 {
 275 <a name="l00311"></a>00311 }
 276 </pre></div>
 277 <p>
 278     </td>
 279   </tr>
 280 </table>
 281 <hr><h2>Member Function Documentation</h2>
 282 <a class="anchor" name="AddCommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29"></a><!-- doxytag: member="Server::AddCommand" ref="AddCommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29" args="(char *cmd, handlerfunc f, char flags, int minparams, char *source)" --><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">char *&nbsp;</td>
 291           <td class="mdname" nowrap> <em>cmd</em>, </td>
 292         </tr>
 293         <tr>
 294           <td class="md" nowrap align="right"></td>
 295           <td class="md"></td>
 296           <td class="md" nowrap><a class="el" href="inspircd_8h.html#handlerfunc_29_28char_20_2A_2A_2C_20int_2C_20userrec_20_2A_29">handlerfunc</a>&nbsp;</td>
 297           <td class="mdname" nowrap> <em>f</em>, </td>
 298         </tr>
 299         <tr>
 300           <td class="md" nowrap align="right"></td>
 301           <td class="md"></td>
 302           <td class="md" nowrap>char&nbsp;</td>
 303           <td class="mdname" nowrap> <em>flags</em>, </td>
 304         </tr>
 305         <tr>
 306           <td class="md" nowrap align="right"></td>
 307           <td class="md"></td>
 308           <td class="md" nowrap>int&nbsp;</td>
 309           <td class="mdname" nowrap> <em>minparams</em>, </td>
 310         </tr>
 311         <tr>
 312           <td class="md" nowrap align="right"></td>
 313           <td class="md"></td>
 314           <td class="md" nowrap>char *&nbsp;</td>
 315           <td class="mdname" nowrap> <em>source</em></td>
 316         </tr>
 317         <tr>
 318           <td class="md"></td>
 319           <td class="md">)&nbsp;</td>
 320           <td class="md" colspan="2"><code> [virtual]</code></td>
 321         </tr>
 322       </table>
 323     </td>
 324   </tr>
 325 </table>
 326 <table cellspacing="5" cellpadding="0" border="0">
 327   <tr>
 328     <td>
 329       &nbsp;
 330     </td>
 331     <td>
 332
 333 <p>
 334 Adds a command to the command table.
 335 <p>
 336 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>
 337 typedef void (handlerfunc) (char**, int, userrec*); ... void <a class="el" href="commands_8h.html#handle_5Fkill_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">handle_kill(char **parameters, int pcnt, userrec *user)</a><p>
 338 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.
 339 <p>
 340 Definition at line <a class="el" href="modules_8cpp-source.html#l00416">416</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 341 <p>
 342 References <a class="el" href="modules_8h.html#createcommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">createcommand()</a>.<div class="fragment"><pre class="fragment"><a name="l00417"></a>00417 {
 343 <a name="l00418"></a>00418         <a class="code" href="modules_8h.html#createcommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">createcommand</a>(cmd,f,flags,minparams,source);
 344 <a name="l00419"></a>00419 }
 345 </pre></div>
 346 <p>
 347     </td>
 348   </tr>
 349 </table>
 350 <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>
 351 <table class="mdTable" cellpadding="2" cellspacing="0">
 352   <tr>
 353     <td class="mdRow">
 354       <table cellpadding="0" cellspacing="0" border="0">
 355         <tr>
 356           <td class="md" nowrap valign="top">void Server::AddELine           </td>
 357           <td class="md" valign="top">(&nbsp;</td>
 358           <td class="md" nowrap valign="top">long&nbsp;</td>
 359           <td class="mdname" nowrap> <em>duration</em>, </td>
 360         </tr>
 361         <tr>
 362           <td class="md" nowrap align="right"></td>
 363           <td class="md"></td>
 364           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 365           <td class="mdname" nowrap> <em>source</em>, </td>
 366         </tr>
 367         <tr>
 368           <td class="md" nowrap align="right"></td>
 369           <td class="md"></td>
 370           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 371           <td class="mdname" nowrap> <em>reason</em>, </td>
 372         </tr>
 373         <tr>
 374           <td class="md" nowrap align="right"></td>
 375           <td class="md"></td>
 376           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 377           <td class="mdname" nowrap> <em>hostmask</em></td>
 378         </tr>
 379         <tr>
 380           <td class="md"></td>
 381           <td class="md">)&nbsp;</td>
 382           <td class="md" colspan="2"><code> [virtual]</code></td>
 383         </tr>
 384       </table>
 385     </td>
 386   </tr>
 387 </table>
 388 <table cellspacing="5" cellpadding="0" border="0">
 389   <tr>
 390     <td>
 391       &nbsp;
 392     </td>
 393     <td>
 394
 395 <p>
 396 Adds a E-line The E-line is enforced as soon as it is added.
 397 <p>
 398 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.
 399 <p>
 400 Definition at line <a class="el" href="modules_8cpp-source.html#l00660">660</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 401 <p>
 402 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="l00661"></a>00661 {
 403 <a name="l00662"></a>00662         <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());
 404 <a name="l00663"></a>00663 }
 405 </pre></div>
 406 <p>
 407     </td>
 408   </tr>
 409 </table>
 410 <a class="anchor" name="AddExtendedListMode_28char_20modechar_29"></a><!-- doxytag: member="Server::AddExtendedListMode" ref="AddExtendedListMode_28char_20modechar_29" args="(char modechar)" --><p>
 411 <table class="mdTable" cellpadding="2" cellspacing="0">
 412   <tr>
 413     <td class="mdRow">
 414       <table cellpadding="0" cellspacing="0" border="0">
 415         <tr>
 416           <td class="md" nowrap valign="top">bool Server::AddExtendedListMode           </td>
 417           <td class="md" valign="top">(&nbsp;</td>
 418           <td class="md" nowrap valign="top">char&nbsp;</td>
 419           <td class="mdname1" valign="top" nowrap> <em>modechar</em>          </td>
 420           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 421           <td class="md" nowrap><code> [virtual]</code></td>
 422         </tr>
 423       </table>
 424     </td>
 425   </tr>
 426 </table>
 427 <table cellspacing="5" cellpadding="0" border="0">
 428   <tr>
 429     <td>
 430       &nbsp;
 431     </td>
 432     <td>
 433
 434 <p>
 435 Adds an extended mode letter which is parsed by a module and handled in a list fashion.
 436 <p>
 437 This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:<p>
 438 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL<p>
 439 (2) They always take exactly one parameter when being added or removed<p>
 440 (3) They can be set multiple times, usually on users in channels<p>
 441 (4) The mode and its parameter are NOT stored in the channels modes structure<p>
 442 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.
 443 <p>
 444 Definition at line <a class="el" href="modules_8cpp-source.html#l00584">584</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 445 <p>
 446 References <a class="el" href="modules_8cpp-source.html#l00134">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00144">ModeMakeList()</a>, and <a class="el" href="modules_8h-source.html#l00031">MT_CHANNEL</a>.<div class="fragment"><pre class="fragment"><a name="l00585"></a>00585 {
 447 <a name="l00586"></a>00586         <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);
 448 <a name="l00587"></a>00587         <span class="keywordflow">if</span> (res)
 449 <a name="l00588"></a>00588                 <a class="code" href="modules_8cpp.html#ModeMakeList_28char_20modechar_29">ModeMakeList</a>(modechar);
 450 <a name="l00589"></a>00589         <span class="keywordflow">return</span> res;
 451 <a name="l00590"></a>00590 }
 452 </pre></div>
 453 <p>
 454     </td>
 455   </tr>
 456 </table>
 457 <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>
 458 <table class="mdTable" cellpadding="2" cellspacing="0">
 459   <tr>
 460     <td class="mdRow">
 461       <table cellpadding="0" cellspacing="0" border="0">
 462         <tr>
 463           <td class="md" nowrap valign="top">bool Server::AddExtendedMode           </td>
 464           <td class="md" valign="top">(&nbsp;</td>
 465           <td class="md" nowrap valign="top">char&nbsp;</td>
 466           <td class="mdname" nowrap> <em>modechar</em>, </td>
 467         </tr>
 468         <tr>
 469           <td class="md" nowrap align="right"></td>
 470           <td class="md"></td>
 471           <td class="md" nowrap>int&nbsp;</td>
 472           <td class="mdname" nowrap> <em>type</em>, </td>
 473         </tr>
 474         <tr>
 475           <td class="md" nowrap align="right"></td>
 476           <td class="md"></td>
 477           <td class="md" nowrap>bool&nbsp;</td>
 478           <td class="mdname" nowrap> <em>requires_oper</em>, </td>
 479         </tr>
 480         <tr>
 481           <td class="md" nowrap align="right"></td>
 482           <td class="md"></td>
 483           <td class="md" nowrap>int&nbsp;</td>
 484           <td class="mdname" nowrap> <em>params_when_on</em>, </td>
 485         </tr>
 486         <tr>
 487           <td class="md" nowrap align="right"></td>
 488           <td class="md"></td>
 489           <td class="md" nowrap>int&nbsp;</td>
 490           <td class="mdname" nowrap> <em>params_when_off</em></td>
 491         </tr>
 492         <tr>
 493           <td class="md"></td>
 494           <td class="md">)&nbsp;</td>
 495           <td class="md" colspan="2"><code> [virtual]</code></td>
 496         </tr>
 497       </table>
 498     </td>
 499   </tr>
 500 </table>
 501 <table cellspacing="5" cellpadding="0" border="0">
 502   <tr>
 503     <td>
 504       &nbsp;
 505     </td>
 506     <td>
 507
 508 <p>
 509 Adds an extended mode letter which is parsed by a module.
 510 <p>
 511 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.
 512 <p>
 513 Definition at line <a class="el" href="modules_8cpp-source.html#l00556">556</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 514 <p>
 515 References <a class="el" href="inspircd__io_8h-source.html#l00028">DEBUG</a>, <a class="el" href="modules_8cpp-source.html#l00134">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="l00557"></a>00557 {
 516 <a name="l00558"></a>00558         <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>)))
 517 <a name="l00559"></a>00559         {
 518 <a name="l00560"></a>00560                 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#MT_5FSERVER">MT_SERVER</a>)
 519 <a name="l00561"></a>00561                 {
 520 <a name="l00562"></a>00562                         <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>);
 521 <a name="l00563"></a>00563                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
 522 <a name="l00564"></a>00564                 }
 523 <a name="l00565"></a>00565                 <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>))
 524 <a name="l00566"></a>00566                 {
 525 <a name="l00567"></a>00567                         <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>);
 526 <a name="l00568"></a>00568                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
 527 <a name="l00569"></a>00569                 }
 528 <a name="l00570"></a>00570                 <span class="keywordflow">if</span> ((params_when_on&gt;1) || (params_when_off&gt;1))
 529 <a name="l00571"></a>00571                 {
 530 <a name="l00572"></a>00572                         <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>);
 531 <a name="l00573"></a>00573                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
 532 <a name="l00574"></a>00574                 }
 533 <a name="l00575"></a>00575                 <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);
 534 <a name="l00576"></a>00576         }
 535 <a name="l00577"></a>00577         <span class="keywordflow">else</span>
 536 <a name="l00578"></a>00578         {
 537 <a name="l00579"></a>00579                 <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>);
 538 <a name="l00580"></a>00580         }
 539 <a name="l00581"></a>00581         <span class="keywordflow">return</span> <span class="keyword">false</span>;
 540 <a name="l00582"></a>00582 }
 541 </pre></div>
 542 <p>
 543     </td>
 544   </tr>
 545 </table>
 546 <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>
 547 <table class="mdTable" cellpadding="2" cellspacing="0">
 548   <tr>
 549     <td class="mdRow">
 550       <table cellpadding="0" cellspacing="0" border="0">
 551         <tr>
 552           <td class="md" nowrap valign="top">void Server::AddGLine           </td>
 553           <td class="md" valign="top">(&nbsp;</td>
 554           <td class="md" nowrap valign="top">long&nbsp;</td>
 555           <td class="mdname" nowrap> <em>duration</em>, </td>
 556         </tr>
 557         <tr>
 558           <td class="md" nowrap align="right"></td>
 559           <td class="md"></td>
 560           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 561           <td class="mdname" nowrap> <em>source</em>, </td>
 562         </tr>
 563         <tr>
 564           <td class="md" nowrap align="right"></td>
 565           <td class="md"></td>
 566           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 567           <td class="mdname" nowrap> <em>reason</em>, </td>
 568         </tr>
 569         <tr>
 570           <td class="md" nowrap align="right"></td>
 571           <td class="md"></td>
 572           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 573           <td class="mdname" nowrap> <em>hostmask</em></td>
 574         </tr>
 575         <tr>
 576           <td class="md"></td>
 577           <td class="md">)&nbsp;</td>
 578           <td class="md" colspan="2"><code> [virtual]</code></td>
 579         </tr>
 580       </table>
 581     </td>
 582   </tr>
 583 </table>
 584 <table cellspacing="5" cellpadding="0" border="0">
 585   <tr>
 586     <td>
 587       &nbsp;
 588     </td>
 589     <td>
 590
 591 <p>
 592 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.
 593 <p>
 594 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.
 595 <p>
 596 Definition at line <a class="el" href="modules_8cpp-source.html#l00640">640</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 597 <p>
 598 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="l00641"></a>00641 {
 599 <a name="l00642"></a>00642         <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());
 600 <a name="l00643"></a>00643 }
 601 </pre></div>
 602 <p>
 603     </td>
 604   </tr>
 605 </table>
 606 <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>
 607 <table class="mdTable" cellpadding="2" cellspacing="0">
 608   <tr>
 609     <td class="mdRow">
 610       <table cellpadding="0" cellspacing="0" border="0">
 611         <tr>
 612           <td class="md" nowrap valign="top">void Server::AddKLine           </td>
 613           <td class="md" valign="top">(&nbsp;</td>
 614           <td class="md" nowrap valign="top">long&nbsp;</td>
 615           <td class="mdname" nowrap> <em>duration</em>, </td>
 616         </tr>
 617         <tr>
 618           <td class="md" nowrap align="right"></td>
 619           <td class="md"></td>
 620           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 621           <td class="mdname" nowrap> <em>source</em>, </td>
 622         </tr>
 623         <tr>
 624           <td class="md" nowrap align="right"></td>
 625           <td class="md"></td>
 626           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 627           <td class="mdname" nowrap> <em>reason</em>, </td>
 628         </tr>
 629         <tr>
 630           <td class="md" nowrap align="right"></td>
 631           <td class="md"></td>
 632           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 633           <td class="mdname" nowrap> <em>hostmask</em></td>
 634         </tr>
 635         <tr>
 636           <td class="md"></td>
 637           <td class="md">)&nbsp;</td>
 638           <td class="md" colspan="2"><code> [virtual]</code></td>
 639         </tr>
 640       </table>
 641     </td>
 642   </tr>
 643 </table>
 644 <table cellspacing="5" cellpadding="0" border="0">
 645   <tr>
 646     <td>
 647       &nbsp;
 648     </td>
 649     <td>
 650
 651 <p>
 652 Adds a K-line The K-line is enforced as soon as it is added.
 653 <p>
 654 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.
 655 <p>
 656 Definition at line <a class="el" href="modules_8cpp-source.html#l00655">655</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 657 <p>
 658 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="l00656"></a>00656 {
 659 <a name="l00657"></a>00657         <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());
 660 <a name="l00658"></a>00658 }
 661 </pre></div>
 662 <p>
 663     </td>
 664   </tr>
 665 </table>
 666 <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>
 667 <table class="mdTable" cellpadding="2" cellspacing="0">
 668   <tr>
 669     <td class="mdRow">
 670       <table cellpadding="0" cellspacing="0" border="0">
 671         <tr>
 672           <td class="md" nowrap valign="top">void Server::AddQLine           </td>
 673           <td class="md" valign="top">(&nbsp;</td>
 674           <td class="md" nowrap valign="top">long&nbsp;</td>
 675           <td class="mdname" nowrap> <em>duration</em>, </td>
 676         </tr>
 677         <tr>
 678           <td class="md" nowrap align="right"></td>
 679           <td class="md"></td>
 680           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 681           <td class="mdname" nowrap> <em>source</em>, </td>
 682         </tr>
 683         <tr>
 684           <td class="md" nowrap align="right"></td>
 685           <td class="md"></td>
 686           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 687           <td class="mdname" nowrap> <em>reason</em>, </td>
 688         </tr>
 689         <tr>
 690           <td class="md" nowrap align="right"></td>
 691           <td class="md"></td>
 692           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 693           <td class="mdname" nowrap> <em>nickname</em></td>
 694         </tr>
 695         <tr>
 696           <td class="md"></td>
 697           <td class="md">)&nbsp;</td>
 698           <td class="md" colspan="2"><code> [virtual]</code></td>
 699         </tr>
 700       </table>
 701     </td>
 702   </tr>
 703 </table>
 704 <table cellspacing="5" cellpadding="0" border="0">
 705   <tr>
 706     <td>
 707       &nbsp;
 708     </td>
 709     <td>
 710
 711 <p>
 712 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.
 713 <p>
 714 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.
 715 <p>
 716 Definition at line <a class="el" href="modules_8cpp-source.html#l00645">645</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 717 <p>
 718 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="l00646"></a>00646 {
 719 <a name="l00647"></a>00647         <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());
 720 <a name="l00648"></a>00648 }
 721 </pre></div>
 722 <p>
 723     </td>
 724   </tr>
 725 </table>
 726 <a class="anchor" name="AddSocket_28InspSocket_20_2Asock_29"></a><!-- doxytag: member="Server::AddSocket" ref="AddSocket_28InspSocket_20_2Asock_29" args="(InspSocket *sock)" --><p>
 727 <table class="mdTable" cellpadding="2" cellspacing="0">
 728   <tr>
 729     <td class="mdRow">
 730       <table cellpadding="0" cellspacing="0" border="0">
 731         <tr>
 732           <td class="md" nowrap valign="top">void Server::AddSocket           </td>
 733           <td class="md" valign="top">(&nbsp;</td>
 734           <td class="md" nowrap valign="top"><a class="el" href="classInspSocket.html">InspSocket</a> *&nbsp;</td>
 735           <td class="mdname1" valign="top" nowrap> <em>sock</em>          </td>
 736           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 737           <td class="md" nowrap><code> [virtual]</code></td>
 738         </tr>
 739       </table>
 740     </td>
 741   </tr>
 742 </table>
 743 <table cellspacing="5" cellpadding="0" border="0">
 744   <tr>
 745     <td>
 746       &nbsp;
 747     </td>
 748     <td>
 749
 750 <p>
 751 Adds a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> to the server's socket engine.
 752 <p>
 753
 754 <p>
 755 Definition at line <a class="el" href="modules_8cpp-source.html#l00313">313</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 756 <p>
 757 References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00314"></a>00314 {
 758 <a name="l00315"></a>00315         <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.push_back(sock);
 759 <a name="l00316"></a>00316 }
 760 </pre></div>
 761 <p>
 762     </td>
 763   </tr>
 764 </table>
 765 <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>
 766 <table class="mdTable" cellpadding="2" cellspacing="0">
 767   <tr>
 768     <td class="mdRow">
 769       <table cellpadding="0" cellspacing="0" border="0">
 770         <tr>
 771           <td class="md" nowrap valign="top">void Server::AddZLine           </td>
 772           <td class="md" valign="top">(&nbsp;</td>
 773           <td class="md" nowrap valign="top">long&nbsp;</td>
 774           <td class="mdname" nowrap> <em>duration</em>, </td>
 775         </tr>
 776         <tr>
 777           <td class="md" nowrap align="right"></td>
 778           <td class="md"></td>
 779           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 780           <td class="mdname" nowrap> <em>source</em>, </td>
 781         </tr>
 782         <tr>
 783           <td class="md" nowrap align="right"></td>
 784           <td class="md"></td>
 785           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 786           <td class="mdname" nowrap> <em>reason</em>, </td>
 787         </tr>
 788         <tr>
 789           <td class="md" nowrap align="right"></td>
 790           <td class="md"></td>
 791           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 792           <td class="mdname" nowrap> <em>ipaddr</em></td>
 793         </tr>
 794         <tr>
 795           <td class="md"></td>
 796           <td class="md">)&nbsp;</td>
 797           <td class="md" colspan="2"><code> [virtual]</code></td>
 798         </tr>
 799       </table>
 800     </td>
 801   </tr>
 802 </table>
 803 <table cellspacing="5" cellpadding="0" border="0">
 804   <tr>
 805     <td>
 806       &nbsp;
 807     </td>
 808     <td>
 809
 810 <p>
 811 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.
 812 <p>
 813 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.
 814 <p>
 815 Definition at line <a class="el" href="modules_8cpp-source.html#l00650">650</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 816 <p>
 817 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="l00651"></a>00651 {
 818 <a name="l00652"></a>00652         <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());
 819 <a name="l00653"></a>00653 }
 820 </pre></div>
 821 <p>
 822     </td>
 823   </tr>
 824 </table>
 825 <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>
 826 <table class="mdTable" cellpadding="2" cellspacing="0">
 827   <tr>
 828     <td class="mdRow">
 829       <table cellpadding="0" cellspacing="0" border="0">
 830         <tr>
 831           <td class="md" nowrap valign="top">long Server::CalcDuration           </td>
 832           <td class="md" valign="top">(&nbsp;</td>
 833           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 834           <td class="mdname1" valign="top" nowrap> <em>duration</em>          </td>
 835           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 836           <td class="md" nowrap><code> [virtual]</code></td>
 837         </tr>
 838       </table>
 839     </td>
 840   </tr>
 841 </table>
 842 <table cellspacing="5" cellpadding="0" border="0">
 843   <tr>
 844     <td>
 845       &nbsp;
 846     </td>
 847     <td>
 848
 849 <p>
 850 Calculates a duration This method will take a string containing a formatted duration (e.g.
 851 <p>
 852 "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.
 853 <p>
 854 Definition at line <a class="el" href="modules_8cpp-source.html#l00690">690</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 855 <p>
 856 References <a class="el" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration()</a>.<div class="fragment"><pre class="fragment"><a name="l00691"></a>00691 {
 857 <a name="l00692"></a>00692         <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>(delta.c_str());
 858 <a name="l00693"></a>00693 }
 859 </pre></div>
 860 <p>
 861     </td>
 862   </tr>
 863 </table>
 864 <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>
 865 <table class="mdTable" cellpadding="2" cellspacing="0">
 866   <tr>
 867     <td class="mdRow">
 868       <table cellpadding="0" cellspacing="0" border="0">
 869         <tr>
 870           <td class="md" nowrap valign="top">void Server::CallCommandHandler           </td>
 871           <td class="md" valign="top">(&nbsp;</td>
 872           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 873           <td class="mdname" nowrap> <em>commandname</em>, </td>
 874         </tr>
 875         <tr>
 876           <td class="md" nowrap align="right"></td>
 877           <td class="md"></td>
 878           <td class="md" nowrap>char **&nbsp;</td>
 879           <td class="mdname" nowrap> <em>parameters</em>, </td>
 880         </tr>
 881         <tr>
 882           <td class="md" nowrap align="right"></td>
 883           <td class="md"></td>
 884           <td class="md" nowrap>int&nbsp;</td>
 885           <td class="mdname" nowrap> <em>pcnt</em>, </td>
 886         </tr>
 887         <tr>
 888           <td class="md" nowrap align="right"></td>
 889           <td class="md"></td>
 890           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 891           <td class="mdname" nowrap> <em>user</em></td>
 892         </tr>
 893         <tr>
 894           <td class="md"></td>
 895           <td class="md">)&nbsp;</td>
 896           <td class="md" colspan="2"><code> [virtual]</code></td>
 897         </tr>
 898       </table>
 899     </td>
 900   </tr>
 901 </table>
 902 <table cellspacing="5" cellpadding="0" border="0">
 903   <tr>
 904     <td>
 905       &nbsp;
 906     </td>
 907     <td>
 908
 909 <p>
 910 Calls the handler for a command, either implemented by the core or by another module.
 911 <p>
 912 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>
 913 ) 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_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_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.
 914 <p>
 915 Definition at line <a class="el" href="modules_8cpp-source.html#l00401">401</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 916 <p>
 917 References <a class="el" href="inspircd_8h.html#call_5Fhandler_28const_20char_20_2Acommandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">call_handler()</a>.<div class="fragment"><pre class="fragment"><a name="l00402"></a>00402 {
 918 <a name="l00403"></a>00403         <a class="code" href="inspircd_8h.html#call_5Fhandler_28const_20char_20_2Acommandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">call_handler</a>(commandname.c_str(),parameters,pcnt,user);
 919 <a name="l00404"></a>00404 }
 920 </pre></div>
 921 <p>
 922     </td>
 923   </tr>
 924 </table>
 925 <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>
 926 <table class="mdTable" cellpadding="2" cellspacing="0">
 927   <tr>
 928     <td class="mdRow">
 929       <table cellpadding="0" cellspacing="0" border="0">
 930         <tr>
 931           <td class="md" nowrap valign="top">void Server::ChangeGECOS           </td>
 932           <td class="md" valign="top">(&nbsp;</td>
 933           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 934           <td class="mdname" nowrap> <em>user</em>, </td>
 935         </tr>
 936         <tr>
 937           <td class="md" nowrap align="right"></td>
 938           <td class="md"></td>
 939           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 940           <td class="mdname" nowrap> <em>gecos</em></td>
 941         </tr>
 942         <tr>
 943           <td class="md"></td>
 944           <td class="md">)&nbsp;</td>
 945           <td class="md" colspan="2"><code> [virtual]</code></td>
 946         </tr>
 947       </table>
 948     </td>
 949   </tr>
 950 </table>
 951 <table cellspacing="5" cellpadding="0" border="0">
 952   <tr>
 953     <td>
 954       &nbsp;
 955     </td>
 956     <td>
 957
 958 <p>
 959 Change GECOS (fullname) of a user.
 960 <p>
 961 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.
 962 <p>
 963 Definition at line <a class="el" href="modules_8cpp-source.html#l00499">499</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 964 <p>
 965 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="l00500"></a>00500 {
 966 <a name="l00501"></a>00501         <a class="code" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName</a>(user,gecos.c_str());
 967 <a name="l00502"></a>00502 }
 968 </pre></div>
 969 <p>
 970     </td>
 971   </tr>
 972 </table>
 973 <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>
 974 <table class="mdTable" cellpadding="2" cellspacing="0">
 975   <tr>
 976     <td class="mdRow">
 977       <table cellpadding="0" cellspacing="0" border="0">
 978         <tr>
 979           <td class="md" nowrap valign="top">void Server::ChangeHost           </td>
 980           <td class="md" valign="top">(&nbsp;</td>
 981           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 982           <td class="mdname" nowrap> <em>user</em>, </td>
 983         </tr>
 984         <tr>
 985           <td class="md" nowrap align="right"></td>
 986           <td class="md"></td>
 987           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 988           <td class="mdname" nowrap> <em>host</em></td>
 989         </tr>
 990         <tr>
 991           <td class="md"></td>
 992           <td class="md">)&nbsp;</td>
 993           <td class="md" colspan="2"><code> [virtual]</code></td>
 994         </tr>
 995       </table>
 996     </td>
 997   </tr>
 998 </table>
 999 <table cellspacing="5" cellpadding="0" border="0">
1000   <tr>
1001     <td>
1002       &nbsp;
1003     </td>
1004     <td>
1005
1006 <p>
1007 Change displayed hostname of a user.
1008 <p>
1009 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.
1010 <p>
1011 Definition at line <a class="el" href="modules_8cpp-source.html#l00494">494</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1012 <p>
1013 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="l00495"></a>00495 {
1014 <a name="l00496"></a>00496         <a class="code" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost</a>(user,host.c_str());
1015 <a name="l00497"></a>00497 }
1016 </pre></div>
1017 <p>
1018     </td>
1019   </tr>
1020 </table>
1021 <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>
1022 <table class="mdTable" cellpadding="2" cellspacing="0">
1023   <tr>
1024     <td class="mdRow">
1025       <table cellpadding="0" cellspacing="0" border="0">
1026         <tr>
1027           <td class="md" nowrap valign="top">void Server::ChangeUserNick           </td>
1028           <td class="md" valign="top">(&nbsp;</td>
1029           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1030           <td class="mdname" nowrap> <em>user</em>, </td>
1031         </tr>
1032         <tr>
1033           <td class="md" nowrap align="right"></td>
1034           <td class="md"></td>
1035           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1036           <td class="mdname" nowrap> <em>nickname</em></td>
1037         </tr>
1038         <tr>
1039           <td class="md"></td>
1040           <td class="md">)&nbsp;</td>
1041           <td class="md" colspan="2"><code> [virtual]</code></td>
1042         </tr>
1043       </table>
1044     </td>
1045   </tr>
1046 </table>
1047 <table cellspacing="5" cellpadding="0" border="0">
1048   <tr>
1049     <td>
1050       &nbsp;
1051     </td>
1052     <td>
1053
1054 <p>
1055 Forces a user nickchange.
1056 <p>
1057 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.
1058 <p>
1059 Definition at line <a class="el" href="modules_8cpp-source.html#l00386">386</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1060 <p>
1061 References <a class="el" href="inspircd_8h.html#force_5Fnickchange_28userrec_20_2Auser_2C_20const_20char_20_2Anewnick_29">force_nickchange()</a>.<div class="fragment"><pre class="fragment"><a name="l00387"></a>00387 {
1062 <a name="l00388"></a>00388         <a class="code" href="inspircd_8h.html#force_5Fnickchange_28userrec_20_2Auser_2C_20const_20char_20_2Anewnick_29">force_nickchange</a>(user,nickname.c_str());
1063 <a name="l00389"></a>00389 }
1064 </pre></div>
1065 <p>
1066     </td>
1067   </tr>
1068 </table>
1069 <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>
1070 <table class="mdTable" cellpadding="2" cellspacing="0">
1071   <tr>
1072     <td class="mdRow">
1073       <table cellpadding="0" cellspacing="0" border="0">
1074         <tr>
1075           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::ChanMode           </td>
1076           <td class="md" valign="top">(&nbsp;</td>
1077           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1078           <td class="mdname" nowrap> <em>User</em>, </td>
1079         </tr>
1080         <tr>
1081           <td class="md" nowrap align="right"></td>
1082           <td class="md"></td>
1083           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1084           <td class="mdname" nowrap> <em>Chan</em></td>
1085         </tr>
1086         <tr>
1087           <td class="md"></td>
1088           <td class="md">)&nbsp;</td>
1089           <td class="md" colspan="2"><code> [virtual]</code></td>
1090         </tr>
1091       </table>
1092     </td>
1093   </tr>
1094 </table>
1095 <table cellspacing="5" cellpadding="0" border="0">
1096   <tr>
1097     <td>
1098       &nbsp;
1099     </td>
1100     <td>
1101
1102 <p>
1103 Attempts to look up a user's privilages on a channel.
1104 <p>
1105 This function will return a string containing either @, %, +, or an empty string, representing the user's privilages upon the channel you specify.
1106 <p>
1107 Definition at line <a class="el" href="modules_8cpp-source.html#l00524">524</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1108 <p>
1109 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="l00525"></a>00525 {
1110 <a name="l00526"></a>00526         <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);
1111 <a name="l00527"></a>00527 }
1112 </pre></div>
1113 <p>
1114     </td>
1115   </tr>
1116 </table>
1117 <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>
1118 <table class="mdTable" cellpadding="2" cellspacing="0">
1119   <tr>
1120     <td class="mdRow">
1121       <table cellpadding="0" cellspacing="0" border="0">
1122         <tr>
1123           <td class="md" nowrap valign="top">bool Server::CommonChannels           </td>
1124           <td class="md" valign="top">(&nbsp;</td>
1125           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1126           <td class="mdname" nowrap> <em>u1</em>, </td>
1127         </tr>
1128         <tr>
1129           <td class="md" nowrap align="right"></td>
1130           <td class="md"></td>
1131           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1132           <td class="mdname" nowrap> <em>u2</em></td>
1133         </tr>
1134         <tr>
1135           <td class="md"></td>
1136           <td class="md">)&nbsp;</td>
1137           <td class="md" colspan="2"><code> [virtual]</code></td>
1138         </tr>
1139       </table>
1140     </td>
1141   </tr>
1142 </table>
1143 <table cellspacing="5" cellpadding="0" border="0">
1144   <tr>
1145     <td>
1146       &nbsp;
1147     </td>
1148     <td>
1149
1150 <p>
1151 Returns true if two users share a common channel.
1152 <p>
1153 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.
1154 <p>
1155 Definition at line <a class="el" href="modules_8cpp-source.html#l00472">472</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1156 <p>
1157 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="l00473"></a>00473 {
1158 <a name="l00474"></a>00474         <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);
1159 <a name="l00475"></a>00475 }
1160 </pre></div>
1161 <p>
1162     </td>
1163   </tr>
1164 </table>
1165 <a class="anchor" name="CountUsers_28chanrec_20_2Ac_29"></a><!-- doxytag: member="Server::CountUsers" ref="CountUsers_28chanrec_20_2Ac_29" args="(chanrec *c)" --><p>
1166 <table class="mdTable" cellpadding="2" cellspacing="0">
1167   <tr>
1168     <td class="mdRow">
1169       <table cellpadding="0" cellspacing="0" border="0">
1170         <tr>
1171           <td class="md" nowrap valign="top">int Server::CountUsers           </td>
1172           <td class="md" valign="top">(&nbsp;</td>
1173           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1174           <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>
1175           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1176           <td class="md" nowrap><code> [virtual]</code></td>
1177         </tr>
1178       </table>
1179     </td>
1180   </tr>
1181 </table>
1182 <table cellspacing="5" cellpadding="0" border="0">
1183   <tr>
1184     <td>
1185       &nbsp;
1186     </td>
1187     <td>
1188
1189 <p>
1190 Returns a count of the number of users on a channel.
1191 <p>
1192 This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1193 <p>
1194 Definition at line <a class="el" href="modules_8cpp-source.html#l00592">592</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00593"></a>00593 {
1195 <a name="l00594"></a>00594         <span class="keywordflow">return</span> usercount(c);
1196 <a name="l00595"></a>00595 }
1197 </pre></div>
1198 <p>
1199     </td>
1200   </tr>
1201 </table>
1202 <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>
1203 <table class="mdTable" cellpadding="2" cellspacing="0">
1204   <tr>
1205     <td class="mdRow">
1206       <table cellpadding="0" cellspacing="0" border="0">
1207         <tr>
1208           <td class="md" nowrap valign="top">bool Server::DelELine           </td>
1209           <td class="md" valign="top">(&nbsp;</td>
1210           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1211           <td class="mdname1" valign="top" nowrap> <em>hostmask</em>          </td>
1212           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1213           <td class="md" nowrap><code> [virtual]</code></td>
1214         </tr>
1215       </table>
1216     </td>
1217   </tr>
1218 </table>
1219 <table cellspacing="5" cellpadding="0" border="0">
1220   <tr>
1221     <td>
1222       &nbsp;
1223     </td>
1224     <td>
1225
1226 <p>
1227 Deletes a local E-Line.
1228 <p>
1229
1230 <p>
1231 Definition at line <a class="el" href="modules_8cpp-source.html#l00685">685</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1232 <p>
1233 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="l00686"></a>00686 {
1234 <a name="l00687"></a>00687         <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());
1235 <a name="l00688"></a>00688 }
1236 </pre></div>
1237 <p>
1238     </td>
1239   </tr>
1240 </table>
1241 <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>
1242 <table class="mdTable" cellpadding="2" cellspacing="0">
1243   <tr>
1244     <td class="mdRow">
1245       <table cellpadding="0" cellspacing="0" border="0">
1246         <tr>
1247           <td class="md" nowrap valign="top">bool Server::DelGLine           </td>
1248           <td class="md" valign="top">(&nbsp;</td>
1249           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1250           <td class="mdname1" valign="top" nowrap> <em>hostmask</em>          </td>
1251           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1252           <td class="md" nowrap><code> [virtual]</code></td>
1253         </tr>
1254       </table>
1255     </td>
1256   </tr>
1257 </table>
1258 <table cellspacing="5" cellpadding="0" border="0">
1259   <tr>
1260     <td>
1261       &nbsp;
1262     </td>
1263     <td>
1264
1265 <p>
1266 Deletes a G-Line from all servers on the mesh.
1267 <p>
1268
1269 <p>
1270 Definition at line <a class="el" href="modules_8cpp-source.html#l00665">665</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1271 <p>
1272 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="l00666"></a>00666 {
1273 <a name="l00667"></a>00667         <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());
1274 <a name="l00668"></a>00668 }
1275 </pre></div>
1276 <p>
1277     </td>
1278   </tr>
1279 </table>
1280 <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>
1281 <table class="mdTable" cellpadding="2" cellspacing="0">
1282   <tr>
1283     <td class="mdRow">
1284       <table cellpadding="0" cellspacing="0" border="0">
1285         <tr>
1286           <td class="md" nowrap valign="top">bool Server::DelKLine           </td>
1287           <td class="md" valign="top">(&nbsp;</td>
1288           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1289           <td class="mdname1" valign="top" nowrap> <em>hostmask</em>          </td>
1290           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1291           <td class="md" nowrap><code> [virtual]</code></td>
1292         </tr>
1293       </table>
1294     </td>
1295   </tr>
1296 </table>
1297 <table cellspacing="5" cellpadding="0" border="0">
1298   <tr>
1299     <td>
1300       &nbsp;
1301     </td>
1302     <td>
1303
1304 <p>
1305 Deletes a local K-Line.
1306 <p>
1307
1308 <p>
1309 Definition at line <a class="el" href="modules_8cpp-source.html#l00680">680</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1310 <p>
1311 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="l00681"></a>00681 {
1312 <a name="l00682"></a>00682         <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());
1313 <a name="l00683"></a>00683 }
1314 </pre></div>
1315 <p>
1316     </td>
1317   </tr>
1318 </table>
1319 <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>
1320 <table class="mdTable" cellpadding="2" cellspacing="0">
1321   <tr>
1322     <td class="mdRow">
1323       <table cellpadding="0" cellspacing="0" border="0">
1324         <tr>
1325           <td class="md" nowrap valign="top">bool Server::DelQLine           </td>
1326           <td class="md" valign="top">(&nbsp;</td>
1327           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1328           <td class="mdname1" valign="top" nowrap> <em>nickname</em>          </td>
1329           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1330           <td class="md" nowrap><code> [virtual]</code></td>
1331         </tr>
1332       </table>
1333     </td>
1334   </tr>
1335 </table>
1336 <table cellspacing="5" cellpadding="0" border="0">
1337   <tr>
1338     <td>
1339       &nbsp;
1340     </td>
1341     <td>
1342
1343 <p>
1344 Deletes a Q-Line from all servers on the mesh.
1345 <p>
1346
1347 <p>
1348 Definition at line <a class="el" href="modules_8cpp-source.html#l00670">670</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1349 <p>
1350 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="l00671"></a>00671 {
1351 <a name="l00672"></a>00672         <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());
1352 <a name="l00673"></a>00673 }
1353 </pre></div>
1354 <p>
1355     </td>
1356   </tr>
1357 </table>
1358 <a class="anchor" name="DelSocket_28InspSocket_20_2Asock_29"></a><!-- doxytag: member="Server::DelSocket" ref="DelSocket_28InspSocket_20_2Asock_29" args="(InspSocket *sock)" --><p>
1359 <table class="mdTable" cellpadding="2" cellspacing="0">
1360   <tr>
1361     <td class="mdRow">
1362       <table cellpadding="0" cellspacing="0" border="0">
1363         <tr>
1364           <td class="md" nowrap valign="top">void Server::DelSocket           </td>
1365           <td class="md" valign="top">(&nbsp;</td>
1366           <td class="md" nowrap valign="top"><a class="el" href="classInspSocket.html">InspSocket</a> *&nbsp;</td>
1367           <td class="mdname1" valign="top" nowrap> <em>sock</em>          </td>
1368           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1369           <td class="md" nowrap><code> [virtual]</code></td>
1370         </tr>
1371       </table>
1372     </td>
1373   </tr>
1374 </table>
1375 <table cellspacing="5" cellpadding="0" border="0">
1376   <tr>
1377     <td>
1378       &nbsp;
1379     </td>
1380     <td>
1381
1382 <p>
1383 Deletes a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> from the server's socket engine.
1384 <p>
1385
1386 <p>
1387 Definition at line <a class="el" href="modules_8cpp-source.html#l00334">334</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1388 <p>
1389 References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00335"></a>00335 {
1390 <a name="l00336"></a>00336         <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++)
1391 <a name="l00337"></a>00337         {
1392 <a name="l00338"></a>00338                 <span class="keywordflow">if</span> (*a == sock)
1393 <a name="l00339"></a>00339                 {
1394 <a name="l00340"></a>00340                         <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.erase(a);
1395 <a name="l00341"></a>00341                         <span class="keywordflow">return</span>;
1396 <a name="l00342"></a>00342                 }
1397 <a name="l00343"></a>00343         }
1398 <a name="l00344"></a>00344 }
1399 </pre></div>
1400 <p>
1401     </td>
1402   </tr>
1403 </table>
1404 <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>
1405 <table class="mdTable" cellpadding="2" cellspacing="0">
1406   <tr>
1407     <td class="mdRow">
1408       <table cellpadding="0" cellspacing="0" border="0">
1409         <tr>
1410           <td class="md" nowrap valign="top">bool Server::DelZLine           </td>
1411           <td class="md" valign="top">(&nbsp;</td>
1412           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1413           <td class="mdname1" valign="top" nowrap> <em>ipaddr</em>          </td>
1414           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1415           <td class="md" nowrap><code> [virtual]</code></td>
1416         </tr>
1417       </table>
1418     </td>
1419   </tr>
1420 </table>
1421 <table cellspacing="5" cellpadding="0" border="0">
1422   <tr>
1423     <td>
1424       &nbsp;
1425     </td>
1426     <td>
1427
1428 <p>
1429 Deletes a Z-Line from all servers on the mesh.
1430 <p>
1431
1432 <p>
1433 Definition at line <a class="el" href="modules_8cpp-source.html#l00675">675</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1434 <p>
1435 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="l00676"></a>00676 {
1436 <a name="l00677"></a>00677         <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());
1437 <a name="l00678"></a>00678 }
1438 </pre></div>
1439 <p>
1440     </td>
1441   </tr>
1442 </table>
1443 <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>
1444 <table class="mdTable" cellpadding="2" cellspacing="0">
1445   <tr>
1446     <td class="mdRow">
1447       <table cellpadding="0" cellspacing="0" border="0">
1448         <tr>
1449           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel           </td>
1450           <td class="md" valign="top">(&nbsp;</td>
1451           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1452           <td class="mdname1" valign="top" nowrap> <em>channel</em>          </td>
1453           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1454           <td class="md" nowrap><code> [virtual]</code></td>
1455         </tr>
1456       </table>
1457     </td>
1458   </tr>
1459 </table>
1460 <table cellspacing="5" cellpadding="0" border="0">
1461   <tr>
1462     <td>
1463       &nbsp;
1464     </td>
1465     <td>
1466
1467 <p>
1468 Attempts to look up a channel and return a pointer to it.
1469 <p>
1470 This function will return NULL if the channel does not exist.
1471 <p>
1472 Definition at line <a class="el" href="modules_8cpp-source.html#l00519">519</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1473 <p>
1474 References <a class="el" href="globals_8h.html#FindChan_28const_20char_20_2Achan_29">FindChan()</a>.<div class="fragment"><pre class="fragment"><a name="l00520"></a>00520 {
1475 <a name="l00521"></a>00521         <span class="keywordflow">return</span> <a class="code" href="globals_8h.html#FindChan_28const_20char_20_2Achan_29">FindChan</a>(channel.c_str());
1476 <a name="l00522"></a>00522 }
1477 </pre></div>
1478 <p>
1479     </td>
1480   </tr>
1481 </table>
1482 <a class="anchor" name="FindDescriptor_28int_20socket_29"></a><!-- doxytag: member="Server::FindDescriptor" ref="FindDescriptor_28int_20socket_29" args="(int socket)" --><p>
1483 <table class="mdTable" cellpadding="2" cellspacing="0">
1484   <tr>
1485     <td class="mdRow">
1486       <table cellpadding="0" cellspacing="0" border="0">
1487         <tr>
1488           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * Server::FindDescriptor           </td>
1489           <td class="md" valign="top">(&nbsp;</td>
1490           <td class="md" nowrap valign="top">int&nbsp;</td>
1491           <td class="mdname1" valign="top" nowrap> <em>socket</em>          </td>
1492           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1493           <td class="md" nowrap><code> [virtual]</code></td>
1494         </tr>
1495       </table>
1496     </td>
1497   </tr>
1498 </table>
1499 <table cellspacing="5" cellpadding="0" border="0">
1500   <tr>
1501     <td>
1502       &nbsp;
1503     </td>
1504     <td>
1505
1506 <p>
1507 Attempts to look up a nick using the file descriptor associated with that nick.
1508 <p>
1509 This function will return NULL if the file descriptor is not associated with a valid user.
1510 <p>
1511 Definition at line <a class="el" href="modules_8cpp-source.html#l00514">514</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00515"></a>00515 {
1512 <a name="l00516"></a>00516         <span class="keywordflow">return</span> (socket &lt; 65536 ? fd_ref_table[socket] : NULL);
1513 <a name="l00517"></a>00517 }
1514 </pre></div>
1515 <p>
1516     </td>
1517   </tr>
1518 </table>
1519 <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>
1520 <table class="mdTable" cellpadding="2" cellspacing="0">
1521   <tr>
1522     <td class="mdRow">
1523       <table cellpadding="0" cellspacing="0" border="0">
1524         <tr>
1525           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> * Server::FindModule           </td>
1526           <td class="md" valign="top">(&nbsp;</td>
1527           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1528           <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
1529           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1530           <td class="md" nowrap><code> [virtual]</code></td>
1531         </tr>
1532       </table>
1533     </td>
1534   </tr>
1535 </table>
1536 <table cellspacing="5" cellpadding="0" border="0">
1537   <tr>
1538     <td>
1539       &nbsp;
1540     </td>
1541     <td>
1542
1543 <p>
1544 This function finds a module by name.
1545 <p>
1546 You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.
1547 <p>
1548 Definition at line <a class="el" href="modules_8cpp-source.html#l00724">724</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1549 <p>
1550 References <a class="el" href="modules_8cpp-source.html#l00935">MODCOUNT</a>, <a class="el" href="inspircd__io_8h-source.html#l00247">ServerConfig::module_names</a>, and <a class="el" href="channels_8cpp.html#modules">modules</a>.<div class="fragment"><pre class="fragment"><a name="l00725"></a>00725 {
1551 <a name="l00726"></a>00726         <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++)
1552 <a name="l00727"></a>00727         {
1553 <a name="l00728"></a>00728                 <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)
1554 <a name="l00729"></a>00729                 {
1555 <a name="l00730"></a>00730                         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#modules">modules</a>[i];
1556 <a name="l00731"></a>00731                 }
1557 <a name="l00732"></a>00732         }
1558 <a name="l00733"></a>00733         <span class="keywordflow">return</span> NULL;
1559 <a name="l00734"></a>00734 }
1560 </pre></div>
1561 <p>
1562     </td>
1563   </tr>
1564 </table>
1565 <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>
1566 <table class="mdTable" cellpadding="2" cellspacing="0">
1567   <tr>
1568     <td class="mdRow">
1569       <table cellpadding="0" cellspacing="0" border="0">
1570         <tr>
1571           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * Server::FindNick           </td>
1572           <td class="md" valign="top">(&nbsp;</td>
1573           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1574           <td class="mdname1" valign="top" nowrap> <em>nick</em>          </td>
1575           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1576           <td class="md" nowrap><code> [virtual]</code></td>
1577         </tr>
1578       </table>
1579     </td>
1580   </tr>
1581 </table>
1582 <table cellspacing="5" cellpadding="0" border="0">
1583   <tr>
1584     <td>
1585       &nbsp;
1586     </td>
1587     <td>
1588
1589 <p>
1590 Attempts to look up a nick and return a pointer to it.
1591 <p>
1592 This function will return NULL if the nick does not exist.
1593 <p>
1594 Definition at line <a class="el" href="modules_8cpp-source.html#l00509">509</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1595 <p>
1596 References <a class="el" href="globals_8h.html#Find_28std_3A_3Astring_20nick_29">Find()</a>.<div class="fragment"><pre class="fragment"><a name="l00510"></a>00510 {
1597 <a name="l00511"></a>00511         <span class="keywordflow">return</span> <a class="code" href="globals_8h.html#Find_28std_3A_3Astring_20nick_29">Find</a>(nick);
1598 <a name="l00512"></a>00512 }
1599 </pre></div>
1600 <p>
1601     </td>
1602   </tr>
1603 </table>
1604 <a class="anchor" name="GetAdmin_28_29"></a><!-- doxytag: member="Server::GetAdmin" ref="GetAdmin_28_29" args="()" --><p>
1605 <table class="mdTable" cellpadding="2" cellspacing="0">
1606   <tr>
1607     <td class="mdRow">
1608       <table cellpadding="0" cellspacing="0" border="0">
1609         <tr>
1610           <td class="md" nowrap valign="top"><a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin           </td>
1611           <td class="md" valign="top">(&nbsp;</td>
1612           <td class="mdname1" valign="top" nowrap>          </td>
1613           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1614           <td class="md" nowrap><code> [virtual]</code></td>
1615         </tr>
1616       </table>
1617     </td>
1618   </tr>
1619 </table>
1620 <table cellspacing="5" cellpadding="0" border="0">
1621   <tr>
1622     <td>
1623       &nbsp;
1624     </td>
1625     <td>
1626
1627 <p>
1628 Returns the information of the server as returned by the /ADMIN command.
1629 <p>
1630 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.
1631 <p>
1632 Definition at line <a class="el" href="modules_8cpp-source.html#l00549">549</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1633 <p>
1634 References <a class="el" href="inspircd__io_8h-source.html#l00089">ServerConfig::AdminEmail</a>, <a class="el" href="inspircd__io_8h-source.html#l00084">ServerConfig::AdminName</a>, and <a class="el" href="inspircd__io_8h-source.html#l00094">ServerConfig::AdminNick</a>.<div class="fragment"><pre class="fragment"><a name="l00550"></a>00550 {
1635 <a name="l00551"></a>00551         <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>);
1636 <a name="l00552"></a>00552 }
1637 </pre></div>
1638 <p>
1639     </td>
1640   </tr>
1641 </table>
1642 <a class="anchor" name="GetConfig_28_29"></a><!-- doxytag: member="Server::GetConfig" ref="GetConfig_28_29" args="()" --><p>
1643 <table class="mdTable" cellpadding="2" cellspacing="0">
1644   <tr>
1645     <td class="mdRow">
1646       <table cellpadding="0" cellspacing="0" border="0">
1647         <tr>
1648           <td class="md" nowrap valign="top"><a class="el" href="classServerConfig.html">ServerConfig</a> * Server::GetConfig           </td>
1649           <td class="md" valign="top">(&nbsp;</td>
1650           <td class="mdname1" valign="top" nowrap>          </td>
1651           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1652           <td class="md" nowrap></td>
1653         </tr>
1654       </table>
1655     </td>
1656   </tr>
1657 </table>
1658 <table cellspacing="5" cellpadding="0" border="0">
1659   <tr>
1660     <td>
1661       &nbsp;
1662     </td>
1663     <td>
1664
1665 <p>
1666 Obtains a pointer to the server's <a class="el" href="classServerConfig.html">ServerConfig</a> object.
1667 <p>
1668 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.
1669 <p>
1670 Definition at line <a class="el" href="modules_8cpp-source.html#l00324">324</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00325"></a>00325 {
1671 <a name="l00326"></a>00326         <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#Config">Config</a>;
1672 <a name="l00327"></a>00327 }
1673 </pre></div>
1674 <p>
1675     </td>
1676   </tr>
1677 </table>
1678 <a class="anchor" name="GetNetworkName_28_29"></a><!-- doxytag: member="Server::GetNetworkName" ref="GetNetworkName_28_29" args="()" --><p>
1679 <table class="mdTable" cellpadding="2" cellspacing="0">
1680   <tr>
1681     <td class="mdRow">
1682       <table cellpadding="0" cellspacing="0" border="0">
1683         <tr>
1684           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetNetworkName           </td>
1685           <td class="md" valign="top">(&nbsp;</td>
1686           <td class="mdname1" valign="top" nowrap>          </td>
1687           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1688           <td class="md" nowrap><code> [virtual]</code></td>
1689         </tr>
1690       </table>
1691     </td>
1692   </tr>
1693 </table>
1694 <table cellspacing="5" cellpadding="0" border="0">
1695   <tr>
1696     <td>
1697       &nbsp;
1698     </td>
1699     <td>
1700
1701 <p>
1702 Returns the network name, global to all linked servers.
1703 <p>
1704
1705 <p>
1706 Definition at line <a class="el" href="modules_8cpp-source.html#l00539">539</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1707 <p>
1708 References <a class="el" href="inspircd__io_8h-source.html#l00074">ServerConfig::Network</a>.<div class="fragment"><pre class="fragment"><a name="l00540"></a>00540 {
1709 <a name="l00541"></a>00541         <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>;
1710 <a name="l00542"></a>00542 }
1711 </pre></div>
1712 <p>
1713     </td>
1714   </tr>
1715 </table>
1716 <a class="anchor" name="GetServerDescription_28_29"></a><!-- doxytag: member="Server::GetServerDescription" ref="GetServerDescription_28_29" args="()" --><p>
1717 <table class="mdTable" cellpadding="2" cellspacing="0">
1718   <tr>
1719     <td class="mdRow">
1720       <table cellpadding="0" cellspacing="0" border="0">
1721         <tr>
1722           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetServerDescription           </td>
1723           <td class="md" valign="top">(&nbsp;</td>
1724           <td class="mdname1" valign="top" nowrap>          </td>
1725           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1726           <td class="md" nowrap><code> [virtual]</code></td>
1727         </tr>
1728       </table>
1729     </td>
1730   </tr>
1731 </table>
1732 <table cellspacing="5" cellpadding="0" border="0">
1733   <tr>
1734     <td>
1735       &nbsp;
1736     </td>
1737     <td>
1738
1739 <p>
1740 Returns the server description string of the local server.
1741 <p>
1742
1743 <p>
1744 Definition at line <a class="el" href="modules_8cpp-source.html#l00544">544</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1745 <p>
1746 References <a class="el" href="inspircd__io_8h-source.html#l00079">ServerConfig::ServerDesc</a>.<div class="fragment"><pre class="fragment"><a name="l00545"></a>00545 {
1747 <a name="l00546"></a>00546         <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>;
1748 <a name="l00547"></a>00547 }
1749 </pre></div>
1750 <p>
1751     </td>
1752   </tr>
1753 </table>
1754 <a class="anchor" name="GetServerName_28_29"></a><!-- doxytag: member="Server::GetServerName" ref="GetServerName_28_29" args="()" --><p>
1755 <table class="mdTable" cellpadding="2" cellspacing="0">
1756   <tr>
1757     <td class="mdRow">
1758       <table cellpadding="0" cellspacing="0" border="0">
1759         <tr>
1760           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetServerName           </td>
1761           <td class="md" valign="top">(&nbsp;</td>
1762           <td class="mdname1" valign="top" nowrap>          </td>
1763           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1764           <td class="md" nowrap><code> [virtual]</code></td>
1765         </tr>
1766       </table>
1767     </td>
1768   </tr>
1769 </table>
1770 <table cellspacing="5" cellpadding="0" border="0">
1771   <tr>
1772     <td>
1773       &nbsp;
1774     </td>
1775     <td>
1776
1777 <p>
1778 Returns the server name of the server where the module is loaded.
1779 <p>
1780
1781 <p>
1782 Definition at line <a class="el" href="modules_8cpp-source.html#l00534">534</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1783 <p>
1784 References <a class="el" href="inspircd__io_8h-source.html#l00068">ServerConfig::ServerName</a>.<div class="fragment"><pre class="fragment"><a name="l00535"></a>00535 {
1785 <a name="l00536"></a>00536         <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>;
1786 <a name="l00537"></a>00537 }
1787 </pre></div>
1788 <p>
1789     </td>
1790   </tr>
1791 </table>
1792 <a class="anchor" name="GetUsers_28chanrec_20_2Achan_29"></a><!-- doxytag: member="Server::GetUsers" ref="GetUsers_28chanrec_20_2Achan_29" args="(chanrec *chan)" --><p>
1793 <table class="mdTable" cellpadding="2" cellspacing="0">
1794   <tr>
1795     <td class="mdRow">
1796       <table cellpadding="0" cellspacing="0" border="0">
1797         <tr>
1798           <td class="md" nowrap valign="top"><a class="el" href="modules_8h.html#chanuserlist">chanuserlist</a> Server::GetUsers           </td>
1799           <td class="md" valign="top">(&nbsp;</td>
1800           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1801           <td class="mdname1" valign="top" nowrap> <em>chan</em>          </td>
1802           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1803           <td class="md" nowrap><code> [virtual]</code></td>
1804         </tr>
1805       </table>
1806     </td>
1807   </tr>
1808 </table>
1809 <table cellspacing="5" cellpadding="0" border="0">
1810   <tr>
1811     <td>
1812       &nbsp;
1813     </td>
1814     <td>
1815
1816 <p>
1817 Fetches the userlist of a channel.
1818 <p>
1819 This function must be here and not a member of userrec or chanrec due to include constraints.
1820 <p>
1821 Definition at line <a class="el" href="modules_8cpp-source.html#l00374">374</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1822 <p>
1823 References <a class="el" href="channels_8cpp-source.html#l00187">chanrec::GetUsers()</a>.<div class="fragment"><pre class="fragment"><a name="l00375"></a>00375 {
1824 <a name="l00376"></a>00376         <a class="code" href="modules_8h.html#chanuserlist">chanuserlist</a> userl;
1825 <a name="l00377"></a>00377         userl.clear();
1826 <a name="l00378"></a>00378         std::vector&lt;char*&gt; *list = chan-&gt;<a class="code" href="classchanrec.html#GetUsers_28_29">GetUsers</a>();
1827 <a name="l00379"></a>00379         <span class="keywordflow">for</span> (std::vector&lt;char*&gt;::iterator i = list-&gt;begin(); i != list-&gt;end(); i++)
1828 <a name="l00380"></a>00380         {
1829 <a name="l00381"></a>00381                 <span class="keywordtype">char</span>* o = *i;
1830 <a name="l00382"></a>00382                 userl.push_back((<a class="code" href="classuserrec.html">userrec</a>*)o);
1831 <a name="l00383"></a>00383         }
1832 <a name="l00384"></a>00384         <span class="keywordflow">return</span> userl;
1833 <a name="l00385"></a>00385 }
1834 </pre></div>
1835 <p>
1836     </td>
1837   </tr>
1838 </table>
1839 <a class="anchor" name="GetVersion_28_29"></a><!-- doxytag: member="Server::GetVersion" ref="GetVersion_28_29" args="()" --><p>
1840 <table class="mdTable" cellpadding="2" cellspacing="0">
1841   <tr>
1842     <td class="mdRow">
1843       <table cellpadding="0" cellspacing="0" border="0">
1844         <tr>
1845           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> Server::GetVersion           </td>
1846           <td class="md" valign="top">(&nbsp;</td>
1847           <td class="mdname1" valign="top" nowrap>          </td>
1848           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1849           <td class="md" nowrap></td>
1850         </tr>
1851       </table>
1852     </td>
1853   </tr>
1854 </table>
1855 <table cellspacing="5" cellpadding="0" border="0">
1856   <tr>
1857     <td>
1858       &nbsp;
1859     </td>
1860     <td>
1861
1862 <p>
1863 Returns the version string of this server.
1864 <p>
1865
1866 <p>
1867 Definition at line <a class="el" href="modules_8cpp-source.html#l00329">329</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1868 <p>
1869 References <a class="el" href="classInspIRCd.html#GetVersionString_28_29">InspIRCd::GetVersionString()</a>.<div class="fragment"><pre class="fragment"><a name="l00330"></a>00330 {
1870 <a name="l00331"></a>00331         <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>();
1871 <a name="l00332"></a>00332 }
1872 </pre></div>
1873 <p>
1874     </td>
1875   </tr>
1876 </table>
1877 <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>
1878 <table class="mdTable" cellpadding="2" cellspacing="0">
1879   <tr>
1880     <td class="mdRow">
1881       <table cellpadding="0" cellspacing="0" border="0">
1882         <tr>
1883           <td class="md" nowrap valign="top">bool Server::IsNick           </td>
1884           <td class="md" valign="top">(&nbsp;</td>
1885           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1886           <td class="mdname1" valign="top" nowrap> <em>nick</em>          </td>
1887           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1888           <td class="md" nowrap><code> [virtual]</code></td>
1889         </tr>
1890       </table>
1891     </td>
1892   </tr>
1893 </table>
1894 <table cellspacing="5" cellpadding="0" border="0">
1895   <tr>
1896     <td>
1897       &nbsp;
1898     </td>
1899     <td>
1900
1901 <p>
1902 Returns true if a nick is valid.
1903 <p>
1904 Nicks for unregistered connections will return false.
1905 <p>
1906 Definition at line <a class="el" href="modules_8cpp-source.html#l00504">504</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1907 <p>
1908 References <a class="el" href="globals_8h.html#isnick_28const_20char_20_2An_29">isnick()</a>.<div class="fragment"><pre class="fragment"><a name="l00505"></a>00505 {
1909 <a name="l00506"></a>00506         <span class="keywordflow">return</span> (<a class="code" href="globals_8h.html#isnick_28const_20char_20_2An_29">isnick</a>(nick.c_str()) != 0);
1910 <a name="l00507"></a>00507 }
1911 </pre></div>
1912 <p>
1913     </td>
1914   </tr>
1915 </table>
1916 <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>
1917 <table class="mdTable" cellpadding="2" cellspacing="0">
1918   <tr>
1919     <td class="mdRow">
1920       <table cellpadding="0" cellspacing="0" border="0">
1921         <tr>
1922           <td class="md" nowrap valign="top">bool Server::IsOnChannel           </td>
1923           <td class="md" valign="top">(&nbsp;</td>
1924           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1925           <td class="mdname" nowrap> <em>User</em>, </td>
1926         </tr>
1927         <tr>
1928           <td class="md" nowrap align="right"></td>
1929           <td class="md"></td>
1930           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1931           <td class="mdname" nowrap> <em>Chan</em></td>
1932         </tr>
1933         <tr>
1934           <td class="md"></td>
1935           <td class="md">)&nbsp;</td>
1936           <td class="md" colspan="2"><code> [virtual]</code></td>
1937         </tr>
1938       </table>
1939     </td>
1940   </tr>
1941 </table>
1942 <table cellspacing="5" cellpadding="0" border="0">
1943   <tr>
1944     <td>
1945       &nbsp;
1946     </td>
1947     <td>
1948
1949 <p>
1950 Checks if a user is on a channel.
1951 <p>
1952 This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1953 <p>
1954 Definition at line <a class="el" href="modules_8cpp-source.html#l00529">529</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1955 <p>
1956 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="l00530"></a>00530 {
1957 <a name="l00531"></a>00531         <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);
1958 <a name="l00532"></a>00532 }
1959 </pre></div>
1960 <p>
1961     </td>
1962   </tr>
1963 </table>
1964 <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>
1965 <table class="mdTable" cellpadding="2" cellspacing="0">
1966   <tr>
1967     <td class="mdRow">
1968       <table cellpadding="0" cellspacing="0" border="0">
1969         <tr>
1970           <td class="md" nowrap valign="top">bool Server::IsUlined           </td>
1971           <td class="md" valign="top">(&nbsp;</td>
1972           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1973           <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
1974           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1975           <td class="md" nowrap><code> [virtual]</code></td>
1976         </tr>
1977       </table>
1978     </td>
1979   </tr>
1980 </table>
1981 <table cellspacing="5" cellpadding="0" border="0">
1982   <tr>
1983     <td>
1984       &nbsp;
1985     </td>
1986     <td>
1987
1988 <p>
1989 Returns true if the servername you give is ulined.
1990 <p>
1991 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.
1992 <p>
1993 Definition at line <a class="el" href="modules_8cpp-source.html#l00396">396</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1994 <p>
1995 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="l00397"></a>00397 {
1996 <a name="l00398"></a>00398         <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());
1997 <a name="l00399"></a>00399 }
1998 </pre></div>
1999 <p>
2000     </td>
2001   </tr>
2002 </table>
2003 <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>
2004 <table class="mdTable" cellpadding="2" cellspacing="0">
2005   <tr>
2006     <td class="mdRow">
2007       <table cellpadding="0" cellspacing="0" border="0">
2008         <tr>
2009           <td class="md" nowrap valign="top">bool Server::IsValidMask           </td>
2010           <td class="md" valign="top">(&nbsp;</td>
2011           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2012           <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
2013           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2014           <td class="md" nowrap><code> [virtual]</code></td>
2015         </tr>
2016       </table>
2017     </td>
2018   </tr>
2019 </table>
2020 <table cellspacing="5" cellpadding="0" border="0">
2021   <tr>
2022     <td>
2023       &nbsp;
2024     </td>
2025     <td>
2026
2027 <p>
2028 Returns true if a nick!ident string is correctly formatted, false if otherwise.
2029 <p>
2030
2031 <p>
2032 Definition at line <a class="el" href="modules_8cpp-source.html#l00695">695</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00696"></a>00696 {
2033 <a name="l00697"></a>00697         <span class="keyword">const</span> <span class="keywordtype">char</span>* dest = mask.c_str();
2034 <a name="l00698"></a>00698         <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'!'</span>)==0)
2035 <a name="l00699"></a>00699                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2036 <a name="l00700"></a>00700         <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'@'</span>)==0)
2037 <a name="l00701"></a>00701                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2038 <a name="l00702"></a>00702         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2039 <a name="l00703"></a>00703                 <span class="keywordflow">if</span> (dest[i] &lt; 32)
2040 <a name="l00704"></a>00704                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
2041 <a name="l00705"></a>00705         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2042 <a name="l00706"></a>00706                 <span class="keywordflow">if</span> (dest[i] &gt; 126)
2043 <a name="l00707"></a>00707                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
2044 <a name="l00708"></a>00708         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c = 0;
2045 <a name="l00709"></a>00709         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2046 <a name="l00710"></a>00710                 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'!'</span>)
2047 <a name="l00711"></a>00711                         c++;
2048 <a name="l00712"></a>00712         <span class="keywordflow">if</span> (c&gt;1)
2049 <a name="l00713"></a>00713                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2050 <a name="l00714"></a>00714         c = 0;
2051 <a name="l00715"></a>00715         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; strlen(dest); i++)
2052 <a name="l00716"></a>00716                 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'@'</span>)
2053 <a name="l00717"></a>00717                         c++;
2054 <a name="l00718"></a>00718         <span class="keywordflow">if</span> (c&gt;1)
2055 <a name="l00719"></a>00719                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
2056 <a name="l00720"></a>00720
2057 <a name="l00721"></a>00721         <span class="keywordflow">return</span> <span class="keyword">true</span>;
2058 <a name="l00722"></a>00722 }
2059 </pre></div>
2060 <p>
2061     </td>
2062   </tr>
2063 </table>
2064 <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>
2065 <table class="mdTable" cellpadding="2" cellspacing="0">
2066   <tr>
2067     <td class="mdRow">
2068       <table cellpadding="0" cellspacing="0" border="0">
2069         <tr>
2070           <td class="md" nowrap valign="top">bool Server::IsValidModuleCommand           </td>
2071           <td class="md" valign="top">(&nbsp;</td>
2072           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2073           <td class="mdname" nowrap> <em>commandname</em>, </td>
2074         </tr>
2075         <tr>
2076           <td class="md" nowrap align="right"></td>
2077           <td class="md"></td>
2078           <td class="md" nowrap>int&nbsp;</td>
2079           <td class="mdname" nowrap> <em>pcnt</em>, </td>
2080         </tr>
2081         <tr>
2082           <td class="md" nowrap align="right"></td>
2083           <td class="md"></td>
2084           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2085           <td class="mdname" nowrap> <em>user</em></td>
2086         </tr>
2087         <tr>
2088           <td class="md"></td>
2089           <td class="md">)&nbsp;</td>
2090           <td class="md" colspan="2"><code> [virtual]</code></td>
2091         </tr>
2092       </table>
2093     </td>
2094   </tr>
2095 </table>
2096 <table cellspacing="5" cellpadding="0" border="0">
2097   <tr>
2098     <td>
2099       &nbsp;
2100     </td>
2101     <td>
2102
2103 <p>
2104
2105 <p>
2106 Definition at line <a class="el" href="modules_8cpp-source.html#l00406">406</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2107 <p>
2108 References <a class="el" href="inspircd_8h.html#is_5Fvalid_5Fcmd_28const_20char_20_2Acommandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">is_valid_cmd()</a>.<div class="fragment"><pre class="fragment"><a name="l00407"></a>00407 {
2109 <a name="l00408"></a>00408         <span class="keywordflow">return</span> <a class="code" href="inspircd_8h.html#is_5Fvalid_5Fcmd_28const_20char_20_2Acommandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">is_valid_cmd</a>(commandname.c_str(), pcnt, user);
2110 <a name="l00409"></a>00409 }
2111 </pre></div>
2112 <p>
2113     </td>
2114   </tr>
2115 </table>
2116 <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>
2117 <table class="mdTable" cellpadding="2" cellspacing="0">
2118   <tr>
2119     <td class="mdRow">
2120       <table cellpadding="0" cellspacing="0" border="0">
2121         <tr>
2122           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * Server::JoinUserToChannel           </td>
2123           <td class="md" valign="top">(&nbsp;</td>
2124           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2125           <td class="mdname" nowrap> <em>user</em>, </td>
2126         </tr>
2127         <tr>
2128           <td class="md" nowrap align="right"></td>
2129           <td class="md"></td>
2130           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2131           <td class="mdname" nowrap> <em>cname</em>, </td>
2132         </tr>
2133         <tr>
2134           <td class="md" nowrap align="right"></td>
2135           <td class="md"></td>
2136           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2137           <td class="mdname" nowrap> <em>key</em></td>
2138         </tr>
2139         <tr>
2140           <td class="md"></td>
2141           <td class="md">)&nbsp;</td>
2142           <td class="md" colspan="2"><code> [virtual]</code></td>
2143         </tr>
2144       </table>
2145     </td>
2146   </tr>
2147 </table>
2148 <table cellspacing="5" cellpadding="0" border="0">
2149   <tr>
2150     <td>
2151       &nbsp;
2152     </td>
2153     <td>
2154
2155 <p>
2156 Forces a user to join a channel.
2157 <p>
2158 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.
2159 <p>
2160 Definition at line <a class="el" href="modules_8cpp-source.html#l00364">364</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2161 <p>
2162 References <a class="el" href="channels_8cpp-source.html#l00195">add_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00365"></a>00365 {
2163 <a name="l00366"></a>00366         <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>);
2164 <a name="l00367"></a>00367 }
2165 </pre></div>
2166 <p>
2167     </td>
2168   </tr>
2169 </table>
2170 <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>
2171 <table class="mdTable" cellpadding="2" cellspacing="0">
2172   <tr>
2173     <td class="mdRow">
2174       <table cellpadding="0" cellspacing="0" border="0">
2175         <tr>
2176           <td class="md" nowrap valign="top">void Server::Log           </td>
2177           <td class="md" valign="top">(&nbsp;</td>
2178           <td class="md" nowrap valign="top">int&nbsp;</td>
2179           <td class="mdname" nowrap> <em>level</em>, </td>
2180         </tr>
2181         <tr>
2182           <td class="md" nowrap align="right"></td>
2183           <td class="md"></td>
2184           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2185           <td class="mdname" nowrap> <em>s</em></td>
2186         </tr>
2187         <tr>
2188           <td class="md"></td>
2189           <td class="md">)&nbsp;</td>
2190           <td class="md" colspan="2"><code> [virtual]</code></td>
2191         </tr>
2192       </table>
2193     </td>
2194   </tr>
2195 </table>
2196 <table cellspacing="5" cellpadding="0" border="0">
2197   <tr>
2198     <td>
2199       &nbsp;
2200     </td>
2201     <td>
2202
2203 <p>
2204 Writes a log string.
2205 <p>
2206 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.
2207 <p>
2208 Definition at line <a class="el" href="modules_8cpp-source.html#l00411">411</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2209 <p>
2210 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="l00412"></a>00412 {
2211 <a name="l00413"></a>00413         <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());
2212 <a name="l00414"></a>00414 }
2213 </pre></div>
2214 <p>
2215     </td>
2216   </tr>
2217 </table>
2218 <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>
2219 <table class="mdTable" cellpadding="2" cellspacing="0">
2220   <tr>
2221     <td class="mdRow">
2222       <table cellpadding="0" cellspacing="0" border="0">
2223         <tr>
2224           <td class="md" nowrap valign="top">bool Server::MatchText           </td>
2225           <td class="md" valign="top">(&nbsp;</td>
2226           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2227           <td class="mdname" nowrap> <em>sliteral</em>, </td>
2228         </tr>
2229         <tr>
2230           <td class="md" nowrap align="right"></td>
2231           <td class="md"></td>
2232           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2233           <td class="mdname" nowrap> <em>spattern</em></td>
2234         </tr>
2235         <tr>
2236           <td class="md"></td>
2237           <td class="md">)&nbsp;</td>
2238           <td class="md" colspan="2"><code> [virtual]</code></td>
2239         </tr>
2240       </table>
2241     </td>
2242   </tr>
2243 </table>
2244 <table cellspacing="5" cellpadding="0" border="0">
2245   <tr>
2246     <td>
2247       &nbsp;
2248     </td>
2249     <td>
2250
2251 <p>
2252 Matches text against a glob pattern.
2253 <p>
2254 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.
2255 <p>
2256 Definition at line <a class="el" href="modules_8cpp-source.html#l00351">351</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00352"></a>00352 {
2257 <a name="l00353"></a>00353         <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF];
2258 <a name="l00354"></a>00354         strlcpy(literal,sliteral.c_str(),MAXBUF);
2259 <a name="l00355"></a>00355         strlcpy(pattern,spattern.c_str(),MAXBUF);
2260 <a name="l00356"></a>00356         <span class="keywordflow">return</span> match(literal,pattern);
2261 <a name="l00357"></a>00357 }
2262 </pre></div>
2263 <p>
2264     </td>
2265   </tr>
2266 </table>
2267 <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>
2268 <table class="mdTable" cellpadding="2" cellspacing="0">
2269   <tr>
2270     <td class="mdRow">
2271       <table cellpadding="0" cellspacing="0" border="0">
2272         <tr>
2273           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * Server::PartUserFromChannel           </td>
2274           <td class="md" valign="top">(&nbsp;</td>
2275           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2276           <td class="mdname" nowrap> <em>user</em>, </td>
2277         </tr>
2278         <tr>
2279           <td class="md" nowrap align="right"></td>
2280           <td class="md"></td>
2281           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2282           <td class="mdname" nowrap> <em>cname</em>, </td>
2283         </tr>
2284         <tr>
2285           <td class="md" nowrap align="right"></td>
2286           <td class="md"></td>
2287           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2288           <td class="mdname" nowrap> <em>reason</em></td>
2289         </tr>
2290         <tr>
2291           <td class="md"></td>
2292           <td class="md">)&nbsp;</td>
2293           <td class="md" colspan="2"><code> [virtual]</code></td>
2294         </tr>
2295       </table>
2296     </td>
2297   </tr>
2298 </table>
2299 <table cellspacing="5" cellpadding="0" border="0">
2300   <tr>
2301     <td>
2302       &nbsp;
2303     </td>
2304     <td>
2305
2306 <p>
2307 Forces a user to part a channel.
2308 <p>
2309 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.
2310 <p>
2311 Definition at line <a class="el" href="modules_8cpp-source.html#l00369">369</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2312 <p>
2313 References <a class="el" href="channels_8cpp-source.html#l00401">del_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00370"></a>00370 {
2314 <a name="l00371"></a>00371         <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>);
2315 <a name="l00372"></a>00372 }
2316 </pre></div>
2317 <p>
2318     </td>
2319   </tr>
2320 </table>
2321 <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>
2322 <table class="mdTable" cellpadding="2" cellspacing="0">
2323   <tr>
2324     <td class="mdRow">
2325       <table cellpadding="0" cellspacing="0" border="0">
2326         <tr>
2327           <td class="md" nowrap valign="top">bool Server::PseudoToUser           </td>
2328           <td class="md" valign="top">(&nbsp;</td>
2329           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2330           <td class="mdname" nowrap> <em>alive</em>, </td>
2331         </tr>
2332         <tr>
2333           <td class="md" nowrap align="right"></td>
2334           <td class="md"></td>
2335           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2336           <td class="mdname" nowrap> <em>zombie</em>, </td>
2337         </tr>
2338         <tr>
2339           <td class="md" nowrap align="right"></td>
2340           <td class="md"></td>
2341           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2342           <td class="mdname" nowrap> <em>message</em></td>
2343         </tr>
2344         <tr>
2345           <td class="md"></td>
2346           <td class="md">)&nbsp;</td>
2347           <td class="md" colspan="2"><code> [virtual]</code></td>
2348         </tr>
2349       </table>
2350     </td>
2351   </tr>
2352 </table>
2353 <table cellspacing="5" cellpadding="0" border="0">
2354   <tr>
2355     <td>
2356       &nbsp;
2357     </td>
2358     <td>
2359
2360 <p>
2361 This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other.
2362 <p>
2363 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.
2364 <p>
2365 Definition at line <a class="el" href="modules_8cpp-source.html#l00610">610</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2366 <p>
2367 References <a class="el" href="users_8h-source.html#l00149">userrec::chans</a>, <a class="el" href="users_8cpp-source.html#l00232">userrec::ClearBuffer()</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00101">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00129">userrec::ident</a>, <a class="el" href="inspircd_8h.html#kill_5Flink_28userrec_20_2Auser_2C_20const_20char_20_2Ar_29">kill_link()</a>, <a class="el" href="channels_8h-source.html#l00108">chanrec::name</a>, <a class="el" href="users_8h-source.html#l00124">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="l00611"></a>00611 {
2368 <a name="l00612"></a>00612         zombie-&gt;<a class="code" href="classconnection.html#fd">fd</a> = alive-&gt;<a class="code" href="classconnection.html#fd">fd</a>;
2369 <a name="l00613"></a>00613         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>;
2370 <a name="l00614"></a>00614         alive-&gt;<a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>();
2371 <a name="l00615"></a>00615         <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>);
2372 <a name="l00616"></a>00616         <a class="code" href="inspircd_8h.html#kill_5Flink_28userrec_20_2Auser_2C_20const_20char_20_2Ar_29">kill_link</a>(alive,message.c_str());
2373 <a name="l00617"></a>00617         <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;
2374 <a name="l00618"></a>00618         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; zombie-&gt;chans.size(); i++)
2375 <a name="l00619"></a>00619         {
2376 <a name="l00620"></a>00620                 <span class="keywordflow">if</span> (zombie-&gt;<a class="code" href="classuserrec.html#chans">chans</a>[i].channel != NULL)
2377 <a name="l00621"></a>00621                 {
2378 <a name="l00622"></a>00622                         <span class="keywordflow">if</span> (zombie-&gt;<a class="code" href="classuserrec.html#chans">chans</a>[i].channel-&gt;name)
2379 <a name="l00623"></a>00623                         {
2380 <a name="l00624"></a>00624                                 <a class="code" href="classchanrec.html">chanrec</a>* Ptr = zombie-&gt;<a class="code" href="classuserrec.html#chans">chans</a>[i].channel;
2381 <a name="l00625"></a>00625                                 <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>);
2382 <a name="l00626"></a>00626                                 <span class="keywordflow">if</span> (Ptr-&gt;<a class="code" href="classchanrec.html#topicset">topicset</a>)
2383 <a name="l00627"></a>00627                                 {
2384 <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">"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>);
2385 <a name="l00629"></a>00629                                         <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>);
2386 <a name="l00630"></a>00630                                 }
2387 <a name="l00631"></a>00631                                 userlist(zombie,Ptr);
2388 <a name="l00632"></a>00632                                 <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>);
2389 <a name="l00633"></a>00633
2390 <a name="l00634"></a>00634                         }
2391 <a name="l00635"></a>00635                 }
2392 <a name="l00636"></a>00636         }
2393 <a name="l00637"></a>00637         <span class="keywordflow">return</span> <span class="keyword">true</span>;
2394 <a name="l00638"></a>00638 }
2395 </pre></div>
2396 <p>
2397     </td>
2398   </tr>
2399 </table>
2400 <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>
2401 <table class="mdTable" cellpadding="2" cellspacing="0">
2402   <tr>
2403     <td class="mdRow">
2404       <table cellpadding="0" cellspacing="0" border="0">
2405         <tr>
2406           <td class="md" nowrap valign="top">void Server::QuitUser           </td>
2407           <td class="md" valign="top">(&nbsp;</td>
2408           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2409           <td class="mdname" nowrap> <em>user</em>, </td>
2410         </tr>
2411         <tr>
2412           <td class="md" nowrap align="right"></td>
2413           <td class="md"></td>
2414           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2415           <td class="mdname" nowrap> <em>reason</em></td>
2416         </tr>
2417         <tr>
2418           <td class="md"></td>
2419           <td class="md">)&nbsp;</td>
2420           <td class="md" colspan="2"><code> [virtual]</code></td>
2421         </tr>
2422       </table>
2423     </td>
2424   </tr>
2425 </table>
2426 <table cellspacing="5" cellpadding="0" border="0">
2427   <tr>
2428     <td>
2429       &nbsp;
2430     </td>
2431     <td>
2432
2433 <p>
2434 Forces a user to quit with the specified reason.
2435 <p>
2436 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>
2437 WARNING!<p>
2438 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.
2439 <p>
2440 Definition at line <a class="el" href="modules_8cpp-source.html#l00391">391</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2441 <p>
2442 References <a class="el" href="inspircd_8h.html#kill_5Flink_28userrec_20_2Auser_2C_20const_20char_20_2Ar_29">kill_link()</a>.<div class="fragment"><pre class="fragment"><a name="l00392"></a>00392 {
2443 <a name="l00393"></a>00393         <a class="code" href="inspircd_8h.html#kill_5Flink_28userrec_20_2Auser_2C_20const_20char_20_2Ar_29">kill_link</a>(user,reason.c_str());
2444 <a name="l00394"></a>00394 }
2445 </pre></div>
2446 <p>
2447     </td>
2448   </tr>
2449 </table>
2450 <a class="anchor" name="RehashServer_28_29"></a><!-- doxytag: member="Server::RehashServer" ref="RehashServer_28_29" args="()" --><p>
2451 <table class="mdTable" cellpadding="2" cellspacing="0">
2452   <tr>
2453     <td class="mdRow">
2454       <table cellpadding="0" cellspacing="0" border="0">
2455         <tr>
2456           <td class="md" nowrap valign="top">void Server::RehashServer           </td>
2457           <td class="md" valign="top">(&nbsp;</td>
2458           <td class="mdname1" valign="top" nowrap>          </td>
2459           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2460           <td class="md" nowrap><code> [virtual]</code></td>
2461         </tr>
2462       </table>
2463     </td>
2464   </tr>
2465 </table>
2466 <table cellspacing="5" cellpadding="0" border="0">
2467   <tr>
2468     <td>
2469       &nbsp;
2470     </td>
2471     <td>
2472
2473 <p>
2474
2475 <p>
2476 Definition at line <a class="el" href="modules_8cpp-source.html#l00318">318</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2477 <p>
2478 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="l00319"></a>00319 {
2479 <a name="l00320"></a>00320         <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>);
2480 <a name="l00321"></a>00321         <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);
2481 <a name="l00322"></a>00322 }
2482 </pre></div>
2483 <p>
2484     </td>
2485   </tr>
2486 </table>
2487 <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>
2488 <table class="mdTable" cellpadding="2" cellspacing="0">
2489   <tr>
2490     <td class="mdRow">
2491       <table cellpadding="0" cellspacing="0" border="0">
2492         <tr>
2493           <td class="md" nowrap valign="top">void Server::Send           </td>
2494           <td class="md" valign="top">(&nbsp;</td>
2495           <td class="md" nowrap valign="top">int&nbsp;</td>
2496           <td class="mdname" nowrap> <em>Socket</em>, </td>
2497         </tr>
2498         <tr>
2499           <td class="md" nowrap align="right"></td>
2500           <td class="md"></td>
2501           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2502           <td class="mdname" nowrap> <em>s</em></td>
2503         </tr>
2504         <tr>
2505           <td class="md"></td>
2506           <td class="md">)&nbsp;</td>
2507           <td class="md" colspan="2"><code> [virtual]</code></td>
2508         </tr>
2509       </table>
2510     </td>
2511   </tr>
2512 </table>
2513 <table cellspacing="5" cellpadding="0" border="0">
2514   <tr>
2515     <td>
2516       &nbsp;
2517     </td>
2518     <td>
2519
2520 <p>
2521 Sends a line of text down a TCP/IP socket.
2522 <p>
2523 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
2524 <p>
2525 Definition at line <a class="el" href="modules_8cpp-source.html#l00426">426</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2526 <p>
2527 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="l00427"></a>00427 {
2528 <a name="l00428"></a>00428         <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());
2529 <a name="l00429"></a>00429 }
2530 </pre></div>
2531 <p>
2532     </td>
2533   </tr>
2534 </table>
2535 <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>
2536 <table class="mdTable" cellpadding="2" cellspacing="0">
2537   <tr>
2538     <td class="mdRow">
2539       <table cellpadding="0" cellspacing="0" border="0">
2540         <tr>
2541           <td class="md" nowrap valign="top">void Server::SendChannel           </td>
2542           <td class="md" valign="top">(&nbsp;</td>
2543           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2544           <td class="mdname" nowrap> <em>User</em>, </td>
2545         </tr>
2546         <tr>
2547           <td class="md" nowrap align="right"></td>
2548           <td class="md"></td>
2549           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2550           <td class="mdname" nowrap> <em>Channel</em>, </td>
2551         </tr>
2552         <tr>
2553           <td class="md" nowrap align="right"></td>
2554           <td class="md"></td>
2555           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2556           <td class="mdname" nowrap> <em>s</em>, </td>
2557         </tr>
2558         <tr>
2559           <td class="md" nowrap align="right"></td>
2560           <td class="md"></td>
2561           <td class="md" nowrap>bool&nbsp;</td>
2562           <td class="mdname" nowrap> <em>IncludeSender</em></td>
2563         </tr>
2564         <tr>
2565           <td class="md"></td>
2566           <td class="md">)&nbsp;</td>
2567           <td class="md" colspan="2"><code> [virtual]</code></td>
2568         </tr>
2569       </table>
2570     </td>
2571   </tr>
2572 </table>
2573 <table cellspacing="5" cellpadding="0" border="0">
2574   <tr>
2575     <td>
2576       &nbsp;
2577     </td>
2578     <td>
2579
2580 <p>
2581 Sends text from a user to a channel (mulicast).
2582 <p>
2583 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).
2584 <p>
2585 Definition at line <a class="el" href="modules_8cpp-source.html#l00460">460</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2586 <p>
2587 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="l00461"></a>00461 {
2588 <a name="l00462"></a>00462         <span class="keywordflow">if</span> (IncludeSender)
2589 <a name="l00463"></a>00463         {
2590 <a name="l00464"></a>00464                 <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());
2591 <a name="l00465"></a>00465         }
2592 <a name="l00466"></a>00466         <span class="keywordflow">else</span>
2593 <a name="l00467"></a>00467         {
2594 <a name="l00468"></a>00468                 <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());
2595 <a name="l00469"></a>00469         }
2596 <a name="l00470"></a>00470 }
2597 </pre></div>
2598 <p>
2599     </td>
2600   </tr>
2601 </table>
2602 <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>
2603 <table class="mdTable" cellpadding="2" cellspacing="0">
2604   <tr>
2605     <td class="mdRow">
2606       <table cellpadding="0" cellspacing="0" border="0">
2607         <tr>
2608           <td class="md" nowrap valign="top">void Server::SendChannelServerNotice           </td>
2609           <td class="md" valign="top">(&nbsp;</td>
2610           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2611           <td class="mdname" nowrap> <em>ServName</em>, </td>
2612         </tr>
2613         <tr>
2614           <td class="md" nowrap align="right"></td>
2615           <td class="md"></td>
2616           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2617           <td class="mdname" nowrap> <em>Channel</em>, </td>
2618         </tr>
2619         <tr>
2620           <td class="md" nowrap align="right"></td>
2621           <td class="md"></td>
2622           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2623           <td class="mdname" nowrap> <em>text</em></td>
2624         </tr>
2625         <tr>
2626           <td class="md"></td>
2627           <td class="md">)&nbsp;</td>
2628           <td class="md" colspan="2"><code> [virtual]</code></td>
2629         </tr>
2630       </table>
2631     </td>
2632   </tr>
2633 </table>
2634 <table cellspacing="5" cellpadding="0" border="0">
2635   <tr>
2636     <td>
2637       &nbsp;
2638     </td>
2639     <td>
2640
2641 <p>
2642 Writes text to a channel, but from a server, including all.
2643 <p>
2644 This can be used to send server notices to a group of users.
2645 <p>
2646 Definition at line <a class="el" href="modules_8cpp-source.html#l00455">455</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00456"></a>00456 {
2647 <a name="l00457"></a>00457         WriteChannelWithServ((<span class="keywordtype">char</span>*)ServName.c_str(), Channel, <span class="stringliteral">"%s"</span>, text.c_str());
2648 <a name="l00458"></a>00458 }
2649 </pre></div>
2650 <p>
2651     </td>
2652   </tr>
2653 </table>
2654 <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>
2655 <table class="mdTable" cellpadding="2" cellspacing="0">
2656   <tr>
2657     <td class="mdRow">
2658       <table cellpadding="0" cellspacing="0" border="0">
2659         <tr>
2660           <td class="md" nowrap valign="top">void Server::SendCommon           </td>
2661           <td class="md" valign="top">(&nbsp;</td>
2662           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2663           <td class="mdname" nowrap> <em>User</em>, </td>
2664         </tr>
2665         <tr>
2666           <td class="md" nowrap align="right"></td>
2667           <td class="md"></td>
2668           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2669           <td class="mdname" nowrap> <em>text</em>, </td>
2670         </tr>
2671         <tr>
2672           <td class="md" nowrap align="right"></td>
2673           <td class="md"></td>
2674           <td class="md" nowrap>bool&nbsp;</td>
2675           <td class="mdname" nowrap> <em>IncludeSender</em></td>
2676         </tr>
2677         <tr>
2678           <td class="md"></td>
2679           <td class="md">)&nbsp;</td>
2680           <td class="md" colspan="2"><code> [virtual]</code></td>
2681         </tr>
2682       </table>
2683     </td>
2684   </tr>
2685 </table>
2686 <table cellspacing="5" cellpadding="0" border="0">
2687   <tr>
2688     <td>
2689       &nbsp;
2690     </td>
2691     <td>
2692
2693 <p>
2694 Sends text from a user to one or more channels (mulicast).
2695 <p>
2696 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.
2697 <p>
2698 Definition at line <a class="el" href="modules_8cpp-source.html#l00477">477</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2699 <p>
2700 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="l00478"></a>00478 {
2701 <a name="l00479"></a>00479         <span class="keywordflow">if</span> (IncludeSender)
2702 <a name="l00480"></a>00480         {
2703 <a name="l00481"></a>00481                 <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());
2704 <a name="l00482"></a>00482         }
2705 <a name="l00483"></a>00483         <span class="keywordflow">else</span>
2706 <a name="l00484"></a>00484         {
2707 <a name="l00485"></a>00485                 <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());
2708 <a name="l00486"></a>00486         }
2709 <a name="l00487"></a>00487 }
2710 </pre></div>
2711 <p>
2712     </td>
2713   </tr>
2714 </table>
2715 <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>
2716 <table class="mdTable" cellpadding="2" cellspacing="0">
2717   <tr>
2718     <td class="mdRow">
2719       <table cellpadding="0" cellspacing="0" border="0">
2720         <tr>
2721           <td class="md" nowrap valign="top">void Server::SendFrom           </td>
2722           <td class="md" valign="top">(&nbsp;</td>
2723           <td class="md" nowrap valign="top">int&nbsp;</td>
2724           <td class="mdname" nowrap> <em>Socket</em>, </td>
2725         </tr>
2726         <tr>
2727           <td class="md" nowrap align="right"></td>
2728           <td class="md"></td>
2729           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2730           <td class="mdname" nowrap> <em>User</em>, </td>
2731         </tr>
2732         <tr>
2733           <td class="md" nowrap align="right"></td>
2734           <td class="md"></td>
2735           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2736           <td class="mdname" nowrap> <em>s</em></td>
2737         </tr>
2738         <tr>
2739           <td class="md"></td>
2740           <td class="md">)&nbsp;</td>
2741           <td class="md" colspan="2"><code> [virtual]</code></td>
2742         </tr>
2743       </table>
2744     </td>
2745   </tr>
2746 </table>
2747 <table cellspacing="5" cellpadding="0" border="0">
2748   <tr>
2749     <td>
2750       &nbsp;
2751     </td>
2752     <td>
2753
2754 <p>
2755 Sends text from a user to a socket.
2756 <p>
2757 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)
2758 <p>
2759 Definition at line <a class="el" href="modules_8cpp-source.html#l00436">436</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2760 <p>
2761 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="l00437"></a>00437 {
2762 <a name="l00438"></a>00438         <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());
2763 <a name="l00439"></a>00439 }
2764 </pre></div>
2765 <p>
2766     </td>
2767   </tr>
2768 </table>
2769 <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>
2770 <table class="mdTable" cellpadding="2" cellspacing="0">
2771   <tr>
2772     <td class="mdRow">
2773       <table cellpadding="0" cellspacing="0" border="0">
2774         <tr>
2775           <td class="md" nowrap valign="top">void Server::SendMode           </td>
2776           <td class="md" valign="top">(&nbsp;</td>
2777           <td class="md" nowrap valign="top">char **&nbsp;</td>
2778           <td class="mdname" nowrap> <em>parameters</em>, </td>
2779         </tr>
2780         <tr>
2781           <td class="md" nowrap align="right"></td>
2782           <td class="md"></td>
2783           <td class="md" nowrap>int&nbsp;</td>
2784           <td class="mdname" nowrap> <em>pcnt</em>, </td>
2785         </tr>
2786         <tr>
2787           <td class="md" nowrap align="right"></td>
2788           <td class="md"></td>
2789           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2790           <td class="mdname" nowrap> <em>user</em></td>
2791         </tr>
2792         <tr>
2793           <td class="md"></td>
2794           <td class="md">)&nbsp;</td>
2795           <td class="md" colspan="2"><code> [virtual]</code></td>
2796         </tr>
2797       </table>
2798     </td>
2799   </tr>
2800 </table>
2801 <table cellspacing="5" cellpadding="0" border="0">
2802   <tr>
2803     <td>
2804       &nbsp;
2805     </td>
2806     <td>
2807
2808 <p>
2809 Sends a servermode.
2810 <p>
2811 you must format the parameters array with the target, modes and parameters for those modes.<p>
2812 For example:<p>
2813 char *modes[3];<p>
2814 modes[0] = ChannelName;<p>
2815 modes[1] = "+o";<p>
2816 modes[2] = user-&gt;nick;<p>
2817 Srv-&gt;SendMode(modes,3,user);<p>
2818 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!
2819 <p>
2820 Definition at line <a class="el" href="modules_8cpp-source.html#l00421">421</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2821 <p>
2822 References <a class="el" href="mode_8h.html#server_5Fmode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">server_mode()</a>.<div class="fragment"><pre class="fragment"><a name="l00422"></a>00422 {
2823 <a name="l00423"></a>00423         <a class="code" href="mode_8h.html#server_5Fmode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">server_mode</a>(parameters,pcnt,user);
2824 <a name="l00424"></a>00424 }
2825 </pre></div>
2826 <p>
2827     </td>
2828   </tr>
2829 </table>
2830 <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>
2831 <table class="mdTable" cellpadding="2" cellspacing="0">
2832   <tr>
2833     <td class="mdRow">
2834       <table cellpadding="0" cellspacing="0" border="0">
2835         <tr>
2836           <td class="md" nowrap valign="top">void Server::SendOpers           </td>
2837           <td class="md" valign="top">(&nbsp;</td>
2838           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2839           <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>
2840           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2841           <td class="md" nowrap><code> [virtual]</code></td>
2842         </tr>
2843       </table>
2844     </td>
2845   </tr>
2846 </table>
2847 <table cellspacing="5" cellpadding="0" border="0">
2848   <tr>
2849     <td>
2850       &nbsp;
2851     </td>
2852     <td>
2853
2854 <p>
2855 Sends text to all opers.
2856 <p>
2857 This method sends a server notice to all opers with the usermode +s.
2858 <p>
2859 Definition at line <a class="el" href="modules_8cpp-source.html#l00346">346</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2860 <p>
2861 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="l00347"></a>00347 {
2862 <a name="l00348"></a>00348         <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());
2863 <a name="l00349"></a>00349 }
2864 </pre></div>
2865 <p>
2866     </td>
2867   </tr>
2868 </table>
2869 <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>
2870 <table class="mdTable" cellpadding="2" cellspacing="0">
2871   <tr>
2872     <td class="mdRow">
2873       <table cellpadding="0" cellspacing="0" border="0">
2874         <tr>
2875           <td class="md" nowrap valign="top">void Server::SendServ           </td>
2876           <td class="md" valign="top">(&nbsp;</td>
2877           <td class="md" nowrap valign="top">int&nbsp;</td>
2878           <td class="mdname" nowrap> <em>Socket</em>, </td>
2879         </tr>
2880         <tr>
2881           <td class="md" nowrap align="right"></td>
2882           <td class="md"></td>
2883           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2884           <td class="mdname" nowrap> <em>s</em></td>
2885         </tr>
2886         <tr>
2887           <td class="md"></td>
2888           <td class="md">)&nbsp;</td>
2889           <td class="md" colspan="2"><code> [virtual]</code></td>
2890         </tr>
2891       </table>
2892     </td>
2893   </tr>
2894 </table>
2895 <table cellspacing="5" cellpadding="0" border="0">
2896   <tr>
2897     <td>
2898       &nbsp;
2899     </td>
2900     <td>
2901
2902 <p>
2903 Sends text from the server to a socket.
2904 <p>
2905 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
2906 <p>
2907 Definition at line <a class="el" href="modules_8cpp-source.html#l00431">431</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2908 <p>
2909 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="l00432"></a>00432 {
2910 <a name="l00433"></a>00433         <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());
2911 <a name="l00434"></a>00434 }
2912 </pre></div>
2913 <p>
2914     </td>
2915   </tr>
2916 </table>
2917 <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>
2918 <table class="mdTable" cellpadding="2" cellspacing="0">
2919   <tr>
2920     <td class="mdRow">
2921       <table cellpadding="0" cellspacing="0" border="0">
2922         <tr>
2923           <td class="md" nowrap valign="top">void Server::SendTo           </td>
2924           <td class="md" valign="top">(&nbsp;</td>
2925           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2926           <td class="mdname" nowrap> <em>Source</em>, </td>
2927         </tr>
2928         <tr>
2929           <td class="md" nowrap align="right"></td>
2930           <td class="md"></td>
2931           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2932           <td class="mdname" nowrap> <em>Dest</em>, </td>
2933         </tr>
2934         <tr>
2935           <td class="md" nowrap align="right"></td>
2936           <td class="md"></td>
2937           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2938           <td class="mdname" nowrap> <em>s</em></td>
2939         </tr>
2940         <tr>
2941           <td class="md"></td>
2942           <td class="md">)&nbsp;</td>
2943           <td class="md" colspan="2"><code> [virtual]</code></td>
2944         </tr>
2945       </table>
2946     </td>
2947   </tr>
2948 </table>
2949 <table cellspacing="5" cellpadding="0" border="0">
2950   <tr>
2951     <td>
2952       &nbsp;
2953     </td>
2954     <td>
2955
2956 <p>
2957 Sends text from a user to another user.
2958 <p>
2959 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>
2960 :user!ident TEXT<p>
2961 The format will become:<p>
2962 :localserver TEXT<p>
2963 Which is useful for numerics and server notices to single users, etc.
2964 <p>
2965 Definition at line <a class="el" href="modules_8cpp-source.html#l00441">441</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2966 <p>
2967 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="l00442"></a>00442 {
2968 <a name="l00443"></a>00443         <span class="keywordflow">if</span> (!Source)
2969 <a name="l00444"></a>00444         {
2970 <a name="l00445"></a>00445                 <span class="comment">// if source is NULL, then the message originates from the local server</span>
2971 <a name="l00446"></a>00446                 <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());
2972 <a name="l00447"></a>00447         }
2973 <a name="l00448"></a>00448         <span class="keywordflow">else</span>
2974 <a name="l00449"></a>00449         {
2975 <a name="l00450"></a>00450                 <span class="comment">// otherwise it comes from the user specified</span>
2976 <a name="l00451"></a>00451                 <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());
2977 <a name="l00452"></a>00452         }
2978 <a name="l00453"></a>00453 }
2979 </pre></div>
2980 <p>
2981     </td>
2982   </tr>
2983 </table>
2984 <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>
2985 <table class="mdTable" cellpadding="2" cellspacing="0">
2986   <tr>
2987     <td class="mdRow">
2988       <table cellpadding="0" cellspacing="0" border="0">
2989         <tr>
2990           <td class="md" nowrap valign="top">void Server::SendToModeMask           </td>
2991           <td class="md" valign="top">(&nbsp;</td>
2992           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2993           <td class="mdname" nowrap> <em>modes</em>, </td>
2994         </tr>
2995         <tr>
2996           <td class="md" nowrap align="right"></td>
2997           <td class="md"></td>
2998           <td class="md" nowrap>int&nbsp;</td>
2999           <td class="mdname" nowrap> <em>flags</em>, </td>
3000         </tr>
3001         <tr>
3002           <td class="md" nowrap align="right"></td>
3003           <td class="md"></td>
3004           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3005           <td class="mdname" nowrap> <em>text</em></td>
3006         </tr>
3007         <tr>
3008           <td class="md"></td>
3009           <td class="md">)&nbsp;</td>
3010           <td class="md" colspan="2"><code> [virtual]</code></td>
3011         </tr>
3012       </table>
3013     </td>
3014   </tr>
3015 </table>
3016 <table cellspacing="5" cellpadding="0" border="0">
3017   <tr>
3018     <td>
3019       &nbsp;
3020     </td>
3021     <td>
3022
3023 <p>
3024 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.
3025 <p>
3026 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>
3027 Serv-&gt;SendToModeMask("xi", WM_OR, "m00");<p>
3028 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.
3029 <p>
3030 Definition at line <a class="el" href="modules_8cpp-source.html#l00359">359</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00360"></a>00360 {
3031 <a name="l00361"></a>00361         WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str());
3032 <a name="l00362"></a>00362 }
3033 </pre></div>
3034 <p>
3035     </td>
3036   </tr>
3037 </table>
3038 <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>
3039 <table class="mdTable" cellpadding="2" cellspacing="0">
3040   <tr>
3041     <td class="mdRow">
3042       <table cellpadding="0" cellspacing="0" border="0">
3043         <tr>
3044           <td class="md" nowrap valign="top">void Server::SendWallops           </td>
3045           <td class="md" valign="top">(&nbsp;</td>
3046           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3047           <td class="mdname" nowrap> <em>User</em>, </td>
3048         </tr>
3049         <tr>
3050           <td class="md" nowrap align="right"></td>
3051           <td class="md"></td>
3052           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3053           <td class="mdname" nowrap> <em>text</em></td>
3054         </tr>
3055         <tr>
3056           <td class="md"></td>
3057           <td class="md">)&nbsp;</td>
3058           <td class="md" colspan="2"><code> [virtual]</code></td>
3059         </tr>
3060       </table>
3061     </td>
3062   </tr>
3063 </table>
3064 <table cellspacing="5" cellpadding="0" border="0">
3065   <tr>
3066     <td>
3067       &nbsp;
3068     </td>
3069     <td>
3070
3071 <p>
3072 Sends a WALLOPS message.
3073 <p>
3074 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
3075 <p>
3076 Definition at line <a class="el" href="modules_8cpp-source.html#l00489">489</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
3077 <p>
3078 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="l00490"></a>00490 {
3079 <a name="l00491"></a>00491         <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());
3080 <a name="l00492"></a>00492 }
3081 </pre></div>
3082 <p>
3083     </td>
3084   </tr>
3085 </table>
3086 <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>
3087 <table class="mdTable" cellpadding="2" cellspacing="0">
3088   <tr>
3089     <td class="mdRow">
3090       <table cellpadding="0" cellspacing="0" border="0">
3091         <tr>
3092           <td class="md" nowrap valign="top">bool Server::UserToPseudo           </td>
3093           <td class="md" valign="top">(&nbsp;</td>
3094           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3095           <td class="mdname" nowrap> <em>user</em>, </td>
3096         </tr>
3097         <tr>
3098           <td class="md" nowrap align="right"></td>
3099           <td class="md"></td>
3100           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3101           <td class="mdname" nowrap> <em>message</em></td>
3102         </tr>
3103         <tr>
3104           <td class="md"></td>
3105           <td class="md">)&nbsp;</td>
3106           <td class="md" colspan="2"><code> [virtual]</code></td>
3107         </tr>
3108       </table>
3109     </td>
3110   </tr>
3111 </table>
3112 <table cellspacing="5" cellpadding="0" border="0">
3113   <tr>
3114     <td>
3115       &nbsp;
3116     </td>
3117     <td>
3118
3119 <p>
3120 Remove a user's connection to the irc server, but leave their client in existence in the user hash.
3121 <p>
3122 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.
3123 <p>
3124 Definition at line <a class="el" href="modules_8cpp-source.html#l00598">598</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
3125 <p>
3126 References <a class="el" href="users_8cpp-source.html#l00232">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#l00101">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00129">userrec::ident</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="l00599"></a>00599 {
3127 <a name="l00600"></a>00600         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> old_fd = user-&gt;<a class="code" href="classconnection.html#fd">fd</a>;
3128 <a name="l00601"></a>00601         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>;
3129 <a name="l00602"></a>00602         user-&gt;<a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>();
3130 <a name="l00603"></a>00603         <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());
3131 <a name="l00604"></a>00604         <a class="code" href="modules_8cpp.html#SE">SE</a>-&gt;<a class="code" href="classSocketEngine.html#DelFd_28int_20fd_29">DelFd</a>(old_fd);
3132 <a name="l00605"></a>00605         shutdown(old_fd,2);
3133 <a name="l00606"></a>00606         close(old_fd);
3134 <a name="l00607"></a>00607         <span class="keywordflow">return</span> <span class="keyword">true</span>;
3135 <a name="l00608"></a>00608 }
3136 </pre></div>
3137 <p>
3138     </td>
3139   </tr>
3140 </table>
3141 <hr>The documentation for this class was generated from the following files:<ul>
3142 <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>
3143 <hr size="1"><address style="align: right;"><small>Generated on Thu Dec 15 11:14:19 2005 for InspIRCd by&nbsp;
3144 <a href="http://www.doxygen.org/index.html">
3145 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
3146 </body>
3147 </html>