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: userrec Class Reference</title>
4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.4.4-20050815 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
8 <h1>userrec Class Reference</h1><!-- doxytag: class="userrec" --><!-- doxytag: inherits="connection" -->Holds all information about a user This class stores all information about a user connected to the irc server.
9 <a href="#_details">More...</a>
11 <code>#include <<a class="el" href="users_8h-source.html">users.h</a>></code>
13 Inheritance diagram for userrec:<p><center><img src="classuserrec__inherit__graph.gif" border="0" usemap="#userrec__inherit__map" alt="Inheritance graph"></center>
14 <map name="userrec__inherit__map">
15 <area href="classconnection.html" shape="rect" coords="7,156,92,183" alt="">
16 <area href="classExtensible.html" shape="rect" coords="8,81,91,108" alt="">
17 <area href="classclassbase.html" shape="rect" coords="10,7,90,33" alt="">
19 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for userrec:<p><center><img src="classuserrec__coll__graph.gif" border="0" usemap="#userrec__coll__map" alt="Collaboration graph"></center>
20 <map name="userrec__coll__map">
21 <area href="classconnection.html" shape="rect" coords="209,355,295,382" alt="">
23 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classuserrec-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
25 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
26 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#userrec_28_29">userrec</a> ()</td></tr>
28 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#GetFullHost_28_29">GetFullHost</a> ()</td></tr>
30 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. <a href="#GetFullHost_28_29"></a><br></td></tr>
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#GetFullRealHost_28_29">GetFullRealHost</a> ()</td></tr>
33 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. <a href="#GetFullRealHost_28_29"></a><br></td></tr>
34 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#IsInvited_28irc_3A_3Astring_20_26channel_29">IsInvited</a> (<a class="el" href="namespaceirc.html#string">irc::string</a> &channel)</td></tr>
36 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a user is invited to a channel. <a href="#IsInvited_28irc_3A_3Astring_20_26channel_29"></a><br></td></tr>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#InviteTo_28irc_3A_3Astring_20_26channel_29">InviteTo</a> (<a class="el" href="namespaceirc.html#string">irc::string</a> &channel)</td></tr>
39 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a channel to a users invite list (invites them to a channel). <a href="#InviteTo_28irc_3A_3Astring_20_26channel_29"></a><br></td></tr>
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#RemoveInvite_28irc_3A_3Astring_20_26channel_29">RemoveInvite</a> (<a class="el" href="namespaceirc.html#string">irc::string</a> &channel)</td></tr>
42 <tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a channel from a users invite list. <a href="#RemoveInvite_28irc_3A_3Astring_20_26channel_29"></a><br></td></tr>
43 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#HasPermission_28std_3A_3Astring_20_26command_29">HasPermission</a> (<a class="el" href="namespaceirc.html#string">std::string</a> &command)</td></tr>
45 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true or false for if a user can execute a privilaged oper command. <a href="#HasPermission_28std_3A_3Astring_20_26command_29"></a><br></td></tr>
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#ReadData_28void_20_2Abuffer_2C_20size_5Ft_20size_29">ReadData</a> (void *buffer, size_t size)</td></tr>
48 <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls read() to read some data for this user using their fd. <a href="#ReadData_28void_20_2Abuffer_2C_20size_5Ft_20size_29"></a><br></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#AddBuffer_28std_3A_3Astring_20a_29">AddBuffer</a> (<a class="el" href="namespaceirc.html#string">std::string</a> a)</td></tr>
51 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method adds data to the buffer of the user. <a href="#AddBuffer_28std_3A_3Astring_20a_29"></a><br></td></tr>
52 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#BufferIsReady_28_29">BufferIsReady</a> ()</td></tr>
54 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns true if the buffer contains at least one carriage return character (e.g. <a href="#BufferIsReady_28_29"></a><br></td></tr>
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a> ()</td></tr>
57 <tr><td class="mdescLeft"> </td><td class="mdescRight">This function clears the entire buffer by setting it to an empty string. <a href="#ClearBuffer_28_29"></a><br></td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#GetBuffer_28_29">GetBuffer</a> ()</td></tr>
60 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. <a href="#GetBuffer_28_29"></a><br></td></tr>
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#SetWriteError_28std_3A_3Astring_20error_29">SetWriteError</a> (<a class="el" href="namespaceirc.html#string">std::string</a> error)</td></tr>
63 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the write error for a connection. <a href="#SetWriteError_28std_3A_3Astring_20error_29"></a><br></td></tr>
64 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#GetWriteError_28_29">GetWriteError</a> ()</td></tr>
66 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the write error which last occured on this connection or an empty string if none occured. <a href="#GetWriteError_28_29"></a><br></td></tr>
67 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#AddWriteBuf_28std_3A_3Astring_20data_29">AddWriteBuf</a> (<a class="el" href="namespaceirc.html#string">std::string</a> data)</td></tr>
69 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds to the user's write buffer. <a href="#AddWriteBuf_28std_3A_3Astring_20data_29"></a><br></td></tr>
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#FlushWriteBuf_28_29">FlushWriteBuf</a> ()</td></tr>
72 <tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes as much of the user's buffer to the file descriptor as possible. <a href="#FlushWriteBuf_28_29"></a><br></td></tr>
73 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="users_8h.html#InvitedList">InvitedList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#GetInviteList_28_29">GetInviteList</a> ()</td></tr>
75 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of channels this user has been invited to but has not yet joined. <a href="#GetInviteList_28_29"></a><br></td></tr>
76 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#CloseSocket_28_29">CloseSocket</a> ()</td></tr>
78 <tr><td class="mdescLeft"> </td><td class="mdescRight">Shuts down and closes the user's socket. <a href="#CloseSocket_28_29"></a><br></td></tr>
79 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#_7Euserrec_28_29">~userrec</a> ()</td></tr>
81 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
82 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a> [NICKMAX]</td></tr>
84 <tr><td class="mdescLeft"> </td><td class="mdescRight">The users nickname. <a href="#nick_5BNICKMAX_5D"></a><br></td></tr>
85 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a> [IDENTMAX+2]</td></tr>
87 <tr><td class="mdescLeft"> </td><td class="mdescRight">The users ident reply. <a href="#ident_5BIDENTMAX_2B_32_5D"></a><br></td></tr>
88 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#dhost_5B_31_36_30_5D">dhost</a> [160]</td></tr>
90 <tr><td class="mdescLeft"> </td><td class="mdescRight">The host displayed to non-opers (used for cloaking etc). <a href="#dhost_5B_31_36_30_5D"></a><br></td></tr>
91 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#fullname_5BMAXGECOS_2B_31_5D">fullname</a> [MAXGECOS+1]</td></tr>
93 <tr><td class="mdescLeft"> </td><td class="mdescRight">The users full name. <a href="#fullname_5BMAXGECOS_2B_31_5D"></a><br></td></tr>
94 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#modes_5B_35_34_5D">modes</a> [54]</td></tr>
96 <tr><td class="mdescLeft"> </td><td class="mdescRight">The user's mode string. <a href="#modes_5B_35_34_5D"></a><br></td></tr>
97 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< <a class="el" href="classucrec.html">ucrec</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#chans">chans</a></td></tr>
99 <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#server">server</a></td></tr>
101 <tr><td class="mdescLeft"> </td><td class="mdescRight">The server the user is connected to. <a href="#server"></a><br></td></tr>
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#awaymsg_5BMAXAWAY_2B_31_5D">awaymsg</a> [MAXAWAY+1]</td></tr>
104 <tr><td class="mdescLeft"> </td><td class="mdescRight">The user's away message. <a href="#awaymsg_5BMAXAWAY_2B_31_5D"></a><br></td></tr>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#flood">flood</a></td></tr>
107 <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. <a href="#flood"></a><br></td></tr>
108 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#timeout">timeout</a></td></tr>
110 <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. <a href="#timeout"></a><br></td></tr>
111 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#oper_5BNICKMAX_5D">oper</a> [NICKMAX]</td></tr>
113 <tr><td class="mdescLeft"> </td><td class="mdescRight">The oper type they logged in as, if they are an oper. <a href="#oper_5BNICKMAX_5D"></a><br></td></tr>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#dns_5Fdone">dns_done</a></td></tr>
116 <tr><td class="mdescLeft"> </td><td class="mdescRight">True when <a class="el" href="classDNS.html">DNS</a> lookups are completed. <a href="#dns_5Fdone"></a><br></td></tr>
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#pingmax">pingmax</a></td></tr>
119 <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of seconds between PINGs for this user (set from <connect:allow> tag. <a href="#pingmax"></a><br></td></tr>
120 <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#password_5BMAXBUF_5D">password</a> [MAXBUF]</td></tr>
122 <tr><td class="mdescLeft"> </td><td class="mdescRight">Password specified by the user when they registered. <a href="#password_5BMAXBUF_5D"></a><br></td></tr>
123 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#recvq">recvq</a></td></tr>
125 <tr><td class="mdescLeft"> </td><td class="mdescRight">User's receive queue. <a href="#recvq"></a><br></td></tr>
126 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#sendq">sendq</a></td></tr>
128 <tr><td class="mdescLeft"> </td><td class="mdescRight">User's send queue. <a href="#sendq"></a><br></td></tr>
129 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#lines_5Fin">lines_in</a></td></tr>
131 <tr><td class="mdescLeft"> </td><td class="mdescRight">Flood counters. <a href="#lines_5Fin"></a><br></td></tr>
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#reset_5Fdue">reset_due</a></td></tr>
134 <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#threshold">threshold</a></td></tr>
136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#WriteError">WriteError</a></td></tr>
138 <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#sendqmax">sendqmax</a></td></tr>
140 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size this user's sendq can become. <a href="#sendqmax"></a><br></td></tr>
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#recvqmax">recvqmax</a></td></tr>
143 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size this user's recvq can become. <a href="#recvqmax"></a><br></td></tr>
144 <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
145 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="users_8h.html#InvitedList">InvitedList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html#invites">invites</a></td></tr>
147 <tr><td class="mdescLeft"> </td><td class="mdescRight">A list of channels the user has a pending invite to. <a href="#invites"></a><br></td></tr>
149 <hr><a name="_details"></a><h2>Detailed Description</h2>
150 Holds all information about a user This class stores all information about a user connected to the irc server.
152 Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname.
156 Definition at line <a class="el" href="users_8h-source.html#l00115">115</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
157 <a class="anchor" name="userrec_28_29"></a><!-- doxytag: member="userrec::userrec" ref="userrec_28_29" args="()" --><p>
158 <table class="mdTable" cellpadding="2" cellspacing="0">
161 <table cellpadding="0" cellspacing="0" border="0">
163 <td class="md" nowrap valign="top">userrec::userrec </td>
164 <td class="md" valign="top">( </td>
165 <td class="mdname1" valign="top" nowrap> </td>
166 <td class="md" valign="top"> ) </td>
167 <td class="md" nowrap></td>
173 <table cellspacing="5" cellpadding="0" border="0">
183 Definition at line <a class="el" href="users_8cpp-source.html#l00063">63</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
185 References <a class="el" href="users_8h-source.html#l00162">awaymsg</a>, <a class="el" href="connection_8h-source.html#l00054">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00058">connection::bytes_out</a>, <a class="el" href="users_8h-source.html#l00153">chans</a>, <a class="el" href="connection_8h-source.html#l00062">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00066">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00138">dhost</a>, <a class="el" href="users_8h-source.html#l00185">dns_done</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="inspircd_8h.html#FindServerNamePtr_28std_3A_3Astring_20servername_29">FindServerNamePtr()</a>, <a class="el" href="users_8h-source.html#l00168">flood</a>, <a class="el" href="users_8h-source.html#l00142">fullname</a>, <a class="el" href="connection_8h-source.html#l00070">connection::haspassed</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00133">ident</a>, <a class="el" href="connection_8h-source.html#l00092">connection::idle_lastmsg</a>, <a class="el" href="users_8h-source.html#l00121">invites</a>, <a class="el" href="connection_8h-source.html#l00050">connection::ip</a>, <a class="el" href="connection_8h-source.html#l00084">connection::lastping</a>, <a class="el" href="users_8h-source.html#l00210">lines_in</a>, <a class="el" href="users_8h-source.html#l00151">modes</a>, <a class="el" href="users_8h-source.html#l00128">nick</a>, <a class="el" href="connection_8h-source.html#l00096">connection::nping</a>, <a class="el" href="users_8h-source.html#l00181">oper</a>, <a class="el" href="connection_8h-source.html#l00076">connection::port</a>, <a class="el" href="users_8h-source.html#l00201">recvq</a>, <a class="el" href="connection_8h-source.html#l00080">connection::registered</a>, <a class="el" href="users_8h-source.html#l00211">reset_due</a>, <a class="el" href="users_8h-source.html#l00206">sendq</a>, <a class="el" href="users_8h-source.html#l00157">server</a>, <a class="el" href="inspircd__io_8h-source.html#l00069">ServerConfig::ServerName</a>, <a class="el" href="connection_8h-source.html#l00088">connection::signon</a>, <a class="el" href="channels_8cpp.html#TIME">TIME</a>, and <a class="el" href="users_8h-source.html#l00174">timeout</a>.<div class="fragment"><pre class="fragment"><a name="l00064"></a>00064 {
186 <a name="l00065"></a>00065 <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span>
187 <a name="l00066"></a>00066 strcpy(<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,<span class="stringliteral">""</span>);
188 <a name="l00067"></a>00067 strcpy(<a class="code" href="classconnection.html#ip_5B_31_36_5D">ip</a>,<span class="stringliteral">"127.0.0.1"</span>);
189 <a name="l00068"></a>00068 <a class="code" href="classuserrec.html#timeout">timeout</a> = 0;
190 <a name="l00069"></a>00069 strcpy(<a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,<span class="stringliteral">""</span>);
191 <a name="l00070"></a>00070 strcpy(<a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,<span class="stringliteral">""</span>);
192 <a name="l00071"></a>00071 strcpy(<a class="code" href="classuserrec.html#dhost_5B_31_36_30_5D">dhost</a>,<span class="stringliteral">""</span>);
193 <a name="l00072"></a>00072 strcpy(<a class="code" href="classuserrec.html#fullname_5BMAXGECOS_2B_31_5D">fullname</a>,<span class="stringliteral">""</span>);
194 <a name="l00073"></a>00073 strcpy(<a class="code" href="classuserrec.html#modes_5B_35_34_5D">modes</a>,<span class="stringliteral">""</span>);
195 <a name="l00074"></a>00074 <a class="code" href="classuserrec.html#server">server</a> = (<span class="keywordtype">char</span>*)<a class="code" href="inspircd_8h.html#FindServerNamePtr_28std_3A_3Astring_20servername_29">FindServerNamePtr</a>(<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ServerName_5BMAXBUF_5D">ServerName</a>);
196 <a name="l00075"></a>00075 strcpy(<a class="code" href="classuserrec.html#awaymsg_5BMAXAWAY_2B_31_5D">awaymsg</a>,<span class="stringliteral">""</span>);
197 <a name="l00076"></a>00076 strcpy(<a class="code" href="classuserrec.html#oper_5BNICKMAX_5D">oper</a>,<span class="stringliteral">""</span>);
198 <a name="l00077"></a>00077 <a class="code" href="classuserrec.html#reset_5Fdue">reset_due</a> = <a class="code" href="channels_8cpp.html#TIME">TIME</a>;
199 <a name="l00078"></a>00078 <a class="code" href="classuserrec.html#lines_5Fin">lines_in</a> = 0;
200 <a name="l00079"></a>00079 <a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="classconnection.html#lastping">lastping</a> = <a class="code" href="classconnection.html#signon">signon</a> = <a class="code" href="classconnection.html#idle_5Flastmsg">idle_lastmsg</a> = <a class="code" href="classconnection.html#nping">nping</a> = <a class="code" href="classconnection.html#registered">registered</a> = 0;
201 <a name="l00080"></a>00080 <a class="code" href="classuserrec.html#flood">flood</a> = <a class="code" href="classconnection.html#port">port</a> = <a class="code" href="classconnection.html#bytes_5Fin">bytes_in</a> = <a class="code" href="classconnection.html#bytes_5Fout">bytes_out</a> = <a class="code" href="classconnection.html#cmds_5Fin">cmds_in</a> = <a class="code" href="classconnection.html#cmds_5Fout">cmds_out</a> = 0;
202 <a name="l00081"></a>00081 <a class="code" href="classconnection.html#haspassed">haspassed</a> = <span class="keyword">false</span>;
203 <a name="l00082"></a>00082 <a class="code" href="classuserrec.html#dns_5Fdone">dns_done</a> = <span class="keyword">false</span>;
204 <a name="l00083"></a>00083 <a class="code" href="classuserrec.html#recvq">recvq</a> = <span class="stringliteral">""</span>;
205 <a name="l00084"></a>00084 <a class="code" href="classuserrec.html#sendq">sendq</a> = <span class="stringliteral">""</span>;
206 <a name="l00085"></a>00085 <a class="code" href="classuserrec.html#chans">chans</a>.clear();
207 <a name="l00086"></a>00086 <a class="code" href="classuserrec.html#invites">invites</a>.clear();
208 <a name="l00087"></a>00087 }
214 <a class="anchor" name="_7Euserrec_28_29"></a><!-- doxytag: member="userrec::~userrec" ref="_7Euserrec_28_29" args="()" --><p>
215 <table class="mdTable" cellpadding="2" cellspacing="0">
218 <table cellpadding="0" cellspacing="0" border="0">
220 <td class="md" nowrap valign="top">userrec::~userrec </td>
221 <td class="md" valign="top">( </td>
222 <td class="mdname1" valign="top" nowrap> </td>
223 <td class="md" valign="top"> ) </td>
224 <td class="md" nowrap><code> [virtual]</code></td>
230 <table cellspacing="5" cellpadding="0" border="0">
240 Definition at line <a class="el" href="users_8cpp-source.html#l00089">89</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00090"></a>00090 {
241 <a name="l00091"></a>00091 }
247 <hr><h2>Member Function Documentation</h2>
248 <a class="anchor" name="AddBuffer_28std_3A_3Astring_20a_29"></a><!-- doxytag: member="userrec::AddBuffer" ref="AddBuffer_28std_3A_3Astring_20a_29" args="(std::string a)" --><p>
249 <table class="mdTable" cellpadding="2" cellspacing="0">
252 <table cellpadding="0" cellspacing="0" border="0">
254 <td class="md" nowrap valign="top">bool userrec::AddBuffer </td>
255 <td class="md" valign="top">( </td>
256 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td>
257 <td class="mdname1" valign="top" nowrap> <em>a</em> </td>
258 <td class="md" valign="top"> ) </td>
259 <td class="md" nowrap></td>
265 <table cellspacing="5" cellpadding="0" border="0">
273 This method adds data to the buffer of the user.
275 The buffer can grow to any size within limits of the available memory, managed by the size of a <a class="el" href="namespaceirc.html#string">std::string</a>, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.
277 Definition at line <a class="el" href="users_8cpp-source.html#l00219">219</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
279 References <a class="el" href="users_8h-source.html#l00201">recvq</a>, <a class="el" href="users_8h-source.html#l00224">recvqmax</a>, <a class="el" href="users_8cpp-source.html#l00317">SetWriteError()</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="l00220"></a>00220 {
280 <a name="l00221"></a>00221 <a class="code" href="namespaceirc.html#string">std::string</a> b = <span class="stringliteral">""</span>;
281 <a name="l00222"></a>00222 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < a.length(); i++)
282 <a name="l00223"></a>00223 <span class="keywordflow">if</span> ((a[i] != <span class="charliteral">'\r'</span>) && (a[i] != <span class="charliteral">'\0'</span>) && (a[i] != 7))
283 <a name="l00224"></a>00224 b = b + a[i];
284 <a name="l00225"></a>00225 std::stringstream stream(<a class="code" href="classuserrec.html#recvq">recvq</a>);
285 <a name="l00226"></a>00226 stream << b;
286 <a name="l00227"></a>00227 <a class="code" href="classuserrec.html#recvq">recvq</a> = stream.str();
287 <a name="l00228"></a>00228 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0;
288 <a name="l00229"></a>00229 <span class="comment">// count the size of the first line in the buffer.</span>
289 <a name="l00230"></a>00230 <span class="keywordflow">while</span> (i < <a class="code" href="classuserrec.html#recvq">recvq</a>.length())
290 <a name="l00231"></a>00231 {
291 <a name="l00232"></a>00232 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#recvq">recvq</a>[i++] == <span class="charliteral">'\n'</span>)
292 <a name="l00233"></a>00233 <span class="keywordflow">break</span>;
293 <a name="l00234"></a>00234 }
294 <a name="l00235"></a>00235 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#recvq">recvq</a>.length() > (unsigned)this-><a class="code" href="classuserrec.html#recvqmax">recvqmax</a>)
295 <a name="l00236"></a>00236 {
296 <a name="l00237"></a>00237 this-><a class="code" href="classuserrec.html#SetWriteError_28std_3A_3Astring_20error_29">SetWriteError</a>(<span class="stringliteral">"RecvQ exceeded"</span>);
297 <a name="l00238"></a>00238 <a class="code" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers</a>(<span class="stringliteral">"*** User %s RecvQ of %d exceeds connect class maximum of %d"</span>,this->nick,<a class="code" href="classuserrec.html#recvq">recvq</a>.length(),this-><a class="code" href="classuserrec.html#recvqmax">recvqmax</a>);
298 <a name="l00239"></a>00239 }
299 <a name="l00240"></a>00240 <span class="comment">// return false if we've had more than 600 characters WITHOUT</span>
300 <a name="l00241"></a>00241 <span class="comment">// a carriage return (this is BAD, drop the socket)</span>
301 <a name="l00242"></a>00242 <span class="keywordflow">return</span> (i < 600);
302 <a name="l00243"></a>00243 }
308 <a class="anchor" name="AddWriteBuf_28std_3A_3Astring_20data_29"></a><!-- doxytag: member="userrec::AddWriteBuf" ref="AddWriteBuf_28std_3A_3Astring_20data_29" args="(std::string data)" --><p>
309 <table class="mdTable" cellpadding="2" cellspacing="0">
312 <table cellpadding="0" cellspacing="0" border="0">
314 <td class="md" nowrap valign="top">void userrec::AddWriteBuf </td>
315 <td class="md" valign="top">( </td>
316 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td>
317 <td class="mdname1" valign="top" nowrap> <em>data</em> </td>
318 <td class="md" valign="top"> ) </td>
319 <td class="md" nowrap></td>
325 <table cellspacing="5" cellpadding="0" border="0">
333 Adds to the user's write buffer.
335 You may add any amount of text up to this users sendq value, if you exceed the sendq value, <a class="el" href="classuserrec.html#SetWriteError_28std_3A_3Astring_20error_29">SetWriteError()</a> will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped.
337 Definition at line <a class="el" href="users_8cpp-source.html#l00275">275</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
339 References <a class="el" href="users_8h-source.html#l00206">sendq</a>, <a class="el" href="users_8h-source.html#l00220">sendqmax</a>, <a class="el" href="users_8cpp-source.html#l00317">SetWriteError()</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="l00276"></a>00276 {
340 <a name="l00277"></a>00277 <span class="keywordflow">if</span> (this->GetWriteError() != <span class="stringliteral">""</span>)
341 <a name="l00278"></a>00278 <span class="keywordflow">return</span>;
342 <a name="l00279"></a>00279 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#sendq">sendq</a>.length() + data.length() > (unsigned)this-><a class="code" href="classuserrec.html#sendqmax">sendqmax</a>)
343 <a name="l00280"></a>00280 {
344 <a name="l00281"></a>00281 <span class="comment">/* Fix by brain - Set the error text BEFORE calling writeopers, because</span>
345 <a name="l00282"></a>00282 <span class="comment"> * if we dont it'll recursively call here over and over again trying</span>
346 <a name="l00283"></a>00283 <span class="comment"> * to repeatedly add the text to the sendq!</span>
347 <a name="l00284"></a>00284 <span class="comment"> */</span>
348 <a name="l00285"></a>00285 this-><a class="code" href="classuserrec.html#SetWriteError_28std_3A_3Astring_20error_29">SetWriteError</a>(<span class="stringliteral">"SendQ exceeded"</span>);
349 <a name="l00286"></a>00286 <a class="code" href="globals_8h.html#WriteOpers_28char_20_2Atext_2C_2E_2E_2E_29">WriteOpers</a>(<span class="stringliteral">"*** User %s SendQ of %d exceeds connect class maximum of %d"</span>,this->nick,<a class="code" href="classuserrec.html#sendq">sendq</a>.length() + data.length(),this-><a class="code" href="classuserrec.html#sendqmax">sendqmax</a>);
350 <a name="l00287"></a>00287 <span class="keywordflow">return</span>;
351 <a name="l00288"></a>00288 }
352 <a name="l00289"></a>00289 std::stringstream stream;
353 <a name="l00290"></a>00290 stream << <a class="code" href="classuserrec.html#sendq">sendq</a> << data;
354 <a name="l00291"></a>00291 <a class="code" href="classuserrec.html#sendq">sendq</a> = stream.str();
355 <a name="l00292"></a>00292 }
361 <a class="anchor" name="BufferIsReady_28_29"></a><!-- doxytag: member="userrec::BufferIsReady" ref="BufferIsReady_28_29" args="()" --><p>
362 <table class="mdTable" cellpadding="2" cellspacing="0">
365 <table cellpadding="0" cellspacing="0" border="0">
367 <td class="md" nowrap valign="top">bool userrec::BufferIsReady </td>
368 <td class="md" valign="top">( </td>
369 <td class="mdname1" valign="top" nowrap> </td>
370 <td class="md" valign="top"> ) </td>
371 <td class="md" nowrap></td>
377 <table cellspacing="5" cellpadding="0" border="0">
385 This method returns true if the buffer contains at least one carriage return character (e.g.
387 one complete line may be read)
389 Definition at line <a class="el" href="users_8cpp-source.html#l00245">245</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
391 References <a class="el" href="users_8h-source.html#l00201">recvq</a>.<div class="fragment"><pre class="fragment"><a name="l00246"></a>00246 {
392 <a name="l00247"></a>00247 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < <a class="code" href="classuserrec.html#recvq">recvq</a>.length(); i++)
393 <a name="l00248"></a>00248 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#recvq">recvq</a>[i] == <span class="charliteral">'\n'</span>)
394 <a name="l00249"></a>00249 <span class="keywordflow">return</span> <span class="keyword">true</span>;
395 <a name="l00250"></a>00250 <span class="keywordflow">return</span> <span class="keyword">false</span>;
396 <a name="l00251"></a>00251 }
402 <a class="anchor" name="ClearBuffer_28_29"></a><!-- doxytag: member="userrec::ClearBuffer" ref="ClearBuffer_28_29" args="()" --><p>
403 <table class="mdTable" cellpadding="2" cellspacing="0">
406 <table cellpadding="0" cellspacing="0" border="0">
408 <td class="md" nowrap valign="top">void userrec::ClearBuffer </td>
409 <td class="md" valign="top">( </td>
410 <td class="mdname1" valign="top" nowrap> </td>
411 <td class="md" valign="top"> ) </td>
412 <td class="md" nowrap></td>
418 <table cellspacing="5" cellpadding="0" border="0">
426 This function clears the entire buffer by setting it to an empty string.
430 Definition at line <a class="el" href="users_8cpp-source.html#l00253">253</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
432 References <a class="el" href="users_8h-source.html#l00201">recvq</a>.
434 Referenced by <a class="el" href="modules_8cpp-source.html#l00609">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00597">Server::UserToPseudo()</a>.<div class="fragment"><pre class="fragment"><a name="l00254"></a>00254 {
435 <a name="l00255"></a>00255 <a class="code" href="classuserrec.html#recvq">recvq</a> = <span class="stringliteral">""</span>;
436 <a name="l00256"></a>00256 }
442 <a class="anchor" name="CloseSocket_28_29"></a><!-- doxytag: member="userrec::CloseSocket" ref="CloseSocket_28_29" args="()" --><p>
443 <table class="mdTable" cellpadding="2" cellspacing="0">
446 <table cellpadding="0" cellspacing="0" border="0">
448 <td class="md" nowrap valign="top">void userrec::CloseSocket </td>
449 <td class="md" valign="top">( </td>
450 <td class="mdname1" valign="top" nowrap> </td>
451 <td class="md" valign="top"> ) </td>
452 <td class="md" nowrap></td>
458 <table cellspacing="5" cellpadding="0" border="0">
466 Shuts down and closes the user's socket.
470 Definition at line <a class="el" href="users_8cpp-source.html#l00093">93</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
472 Referenced by <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>, and <a class="el" href="users_8cpp-source.html#l00412">kill_link_silent()</a>.<div class="fragment"><pre class="fragment"><a name="l00094"></a>00094 {
473 <a name="l00095"></a>00095 shutdown(this->fd,2);
474 <a name="l00096"></a>00096 close(this->fd);
475 <a name="l00097"></a>00097 }
481 <a class="anchor" name="FlushWriteBuf_28_29"></a><!-- doxytag: member="userrec::FlushWriteBuf" ref="FlushWriteBuf_28_29" args="()" --><p>
482 <table class="mdTable" cellpadding="2" cellspacing="0">
485 <table cellpadding="0" cellspacing="0" border="0">
487 <td class="md" nowrap valign="top">void userrec::FlushWriteBuf </td>
488 <td class="md" valign="top">( </td>
489 <td class="mdname1" valign="top" nowrap> </td>
490 <td class="md" valign="top"> ) </td>
491 <td class="md" nowrap></td>
497 <table cellspacing="5" cellpadding="0" border="0">
505 Flushes as much of the user's buffer to the file descriptor as possible.
507 This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.
509 Definition at line <a class="el" href="users_8cpp-source.html#l00295">295</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
511 References <a class="el" href="connection_8h-source.html#l00058">connection::bytes_out</a>, <a class="el" href="connection_8h-source.html#l00066">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00206">sendq</a>, and <a class="el" href="users_8cpp-source.html#l00317">SetWriteError()</a>.
513 Referenced by <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>, and <a class="el" href="users_8cpp-source.html#l00412">kill_link_silent()</a>.<div class="fragment"><pre class="fragment"><a name="l00296"></a>00296 {
514 <a name="l00297"></a>00297 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#sendq">sendq</a>.length())
515 <a name="l00298"></a>00298 {
516 <a name="l00299"></a>00299 <span class="keywordtype">char</span>* tb = (<span class="keywordtype">char</span>*)this-><a class="code" href="classuserrec.html#sendq">sendq</a>.c_str();
517 <a name="l00300"></a>00300 <span class="keywordtype">int</span> n_sent = write(this->fd,tb,this->sendq.length());
518 <a name="l00301"></a>00301 <span class="keywordflow">if</span> (n_sent == -1)
519 <a name="l00302"></a>00302 {
520 <a name="l00303"></a>00303 this-><a class="code" href="classuserrec.html#SetWriteError_28std_3A_3Astring_20error_29">SetWriteError</a>(strerror(errno));
521 <a name="l00304"></a>00304 }
522 <a name="l00305"></a>00305 <span class="keywordflow">else</span>
523 <a name="l00306"></a>00306 {
524 <a name="l00307"></a>00307 <span class="comment">// advance the queue</span>
525 <a name="l00308"></a>00308 tb += n_sent;
526 <a name="l00309"></a>00309 this-><a class="code" href="classuserrec.html#sendq">sendq</a> = tb;
527 <a name="l00310"></a>00310 <span class="comment">// update the user's stats counters</span>
528 <a name="l00311"></a>00311 this-><a class="code" href="classconnection.html#bytes_5Fout">bytes_out</a> += n_sent;
529 <a name="l00312"></a>00312 this-><a class="code" href="classconnection.html#cmds_5Fout">cmds_out</a>++;
530 <a name="l00313"></a>00313 }
531 <a name="l00314"></a>00314 }
532 <a name="l00315"></a>00315 }
538 <a class="anchor" name="GetBuffer_28_29"></a><!-- doxytag: member="userrec::GetBuffer" ref="GetBuffer_28_29" args="()" --><p>
539 <table class="mdTable" cellpadding="2" cellspacing="0">
542 <table cellpadding="0" cellspacing="0" border="0">
544 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> userrec::GetBuffer </td>
545 <td class="md" valign="top">( </td>
546 <td class="mdname1" valign="top" nowrap> </td>
547 <td class="md" valign="top"> ) </td>
548 <td class="md" nowrap></td>
554 <table cellspacing="5" cellpadding="0" border="0">
562 This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string.
564 This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use <a class="el" href="classuserrec.html#BufferIsReady_28_29">BufferIsReady()</a> to check if it is ok to read the buffer before calling <a class="el" href="classuserrec.html#GetBuffer_28_29">GetBuffer()</a>.
566 Definition at line <a class="el" href="users_8cpp-source.html#l00258">258</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
568 References <a class="el" href="users_8h-source.html#l00201">recvq</a>.<div class="fragment"><pre class="fragment"><a name="l00259"></a>00259 {
569 <a name="l00260"></a>00260 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#recvq">recvq</a> == <span class="stringliteral">""</span>)
570 <a name="l00261"></a>00261 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
571 <a name="l00262"></a>00262 <span class="keywordtype">char</span>* line = (<span class="keywordtype">char</span>*)<a class="code" href="classuserrec.html#recvq">recvq</a>.c_str();
572 <a name="l00263"></a>00263 <a class="code" href="namespaceirc.html#string">std::string</a> ret = <span class="stringliteral">""</span>;
573 <a name="l00264"></a>00264 <span class="keywordflow">while</span> ((*line != <span class="charliteral">'\n'</span>) && (strlen(line)))
574 <a name="l00265"></a>00265 {
575 <a name="l00266"></a>00266 ret = ret + *line;
576 <a name="l00267"></a>00267 line++;
577 <a name="l00268"></a>00268 }
578 <a name="l00269"></a>00269 <span class="keywordflow">if</span> ((*line == <span class="charliteral">'\n'</span>) || (*line == <span class="charliteral">'\r'</span>))
579 <a name="l00270"></a>00270 line++;
580 <a name="l00271"></a>00271 <a class="code" href="classuserrec.html#recvq">recvq</a> = line;
581 <a name="l00272"></a>00272 <span class="keywordflow">return</span> ret;
582 <a name="l00273"></a>00273 }
588 <a class="anchor" name="GetFullHost_28_29"></a><!-- doxytag: member="userrec::GetFullHost" ref="GetFullHost_28_29" args="()" --><p>
589 <table class="mdTable" cellpadding="2" cellspacing="0">
592 <table cellpadding="0" cellspacing="0" border="0">
594 <td class="md" nowrap valign="top">char * userrec::GetFullHost </td>
595 <td class="md" valign="top">( </td>
596 <td class="mdname1" valign="top" nowrap> </td>
597 <td class="md" valign="top"> ) </td>
598 <td class="md" nowrap><code> [virtual]</code></td>
604 <table cellspacing="5" cellpadding="0" border="0">
612 Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.
616 Definition at line <a class="el" href="users_8cpp-source.html#l00099">99</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
618 References <a class="el" href="users_8h-source.html#l00138">dhost</a>, <a class="el" href="users_8h-source.html#l00133">ident</a>, and <a class="el" href="users_8h-source.html#l00128">nick</a>.
620 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00100"></a>00100 {
621 <a name="l00101"></a>00101 <span class="keyword">static</span> <span class="keywordtype">char</span> result[MAXBUF];
622 <a name="l00102"></a>00102 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,<a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,<a class="code" href="classuserrec.html#dhost_5B_31_36_30_5D">dhost</a>);
623 <a name="l00103"></a>00103 <span class="keywordflow">return</span> result;
624 <a name="l00104"></a>00104 }
630 <a class="anchor" name="GetFullRealHost_28_29"></a><!-- doxytag: member="userrec::GetFullRealHost" ref="GetFullRealHost_28_29" args="()" --><p>
631 <table class="mdTable" cellpadding="2" cellspacing="0">
634 <table cellpadding="0" cellspacing="0" border="0">
636 <td class="md" nowrap valign="top">char * userrec::GetFullRealHost </td>
637 <td class="md" valign="top">( </td>
638 <td class="mdname1" valign="top" nowrap> </td>
639 <td class="md" valign="top"> ) </td>
640 <td class="md" nowrap><code> [virtual]</code></td>
646 <table cellspacing="5" cellpadding="0" border="0">
654 Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.
656 If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.
658 Definition at line <a class="el" href="users_8cpp-source.html#l00116">116</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
660 References <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00133">ident</a>, and <a class="el" href="users_8h-source.html#l00128">nick</a>.<div class="fragment"><pre class="fragment"><a name="l00117"></a>00117 {
661 <a name="l00118"></a>00118 <span class="keyword">static</span> <span class="keywordtype">char</span> fresult[MAXBUF];
662 <a name="l00119"></a>00119 snprintf(fresult,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,<a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,<a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,<a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>);
663 <a name="l00120"></a>00120 <span class="keywordflow">return</span> fresult;
664 <a name="l00121"></a>00121 }
670 <a class="anchor" name="GetInviteList_28_29"></a><!-- doxytag: member="userrec::GetInviteList" ref="GetInviteList_28_29" args="()" --><p>
671 <table class="mdTable" cellpadding="2" cellspacing="0">
674 <table cellpadding="0" cellspacing="0" border="0">
676 <td class="md" nowrap valign="top"><a class="el" href="users_8h.html#InvitedList">InvitedList</a> * userrec::GetInviteList </td>
677 <td class="md" valign="top">( </td>
678 <td class="mdname1" valign="top" nowrap> </td>
679 <td class="md" valign="top"> ) </td>
680 <td class="md" nowrap></td>
686 <table cellspacing="5" cellpadding="0" border="0">
694 Returns the list of channels this user has been invited to but has not yet joined.
698 Definition at line <a class="el" href="users_8cpp-source.html#l00136">136</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
700 References <a class="el" href="users_8h-source.html#l00121">invites</a>.<div class="fragment"><pre class="fragment"><a name="l00137"></a>00137 {
701 <a name="l00138"></a>00138 <span class="keywordflow">return</span> &<a class="code" href="classuserrec.html#invites">invites</a>;
702 <a name="l00139"></a>00139 }
708 <a class="anchor" name="GetWriteError_28_29"></a><!-- doxytag: member="userrec::GetWriteError" ref="GetWriteError_28_29" args="()" --><p>
709 <table class="mdTable" cellpadding="2" cellspacing="0">
712 <table cellpadding="0" cellspacing="0" border="0">
714 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> userrec::GetWriteError </td>
715 <td class="md" valign="top">( </td>
716 <td class="mdname1" valign="top" nowrap> </td>
717 <td class="md" valign="top"> ) </td>
718 <td class="md" nowrap></td>
724 <table cellspacing="5" cellpadding="0" border="0">
732 Returns the write error which last occured on this connection or an empty string if none occured.
736 Definition at line <a class="el" href="users_8cpp-source.html#l00325">325</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
738 References <a class="el" href="users_8h-source.html#l00216">WriteError</a>.<div class="fragment"><pre class="fragment"><a name="l00326"></a>00326 {
739 <a name="l00327"></a>00327 <span class="keywordflow">return</span> this-><a class="code" href="classuserrec.html#WriteError">WriteError</a>;
740 <a name="l00328"></a>00328 }
746 <a class="anchor" name="HasPermission_28std_3A_3Astring_20_26command_29"></a><!-- doxytag: member="userrec::HasPermission" ref="HasPermission_28std_3A_3Astring_20_26command_29" args="(std::string &command)" --><p>
747 <table class="mdTable" cellpadding="2" cellspacing="0">
750 <table cellpadding="0" cellspacing="0" border="0">
752 <td class="md" nowrap valign="top">bool userrec::HasPermission </td>
753 <td class="md" valign="top">( </td>
754 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> & </td>
755 <td class="mdname1" valign="top" nowrap> <em>command</em> </td>
756 <td class="md" valign="top"> ) </td>
757 <td class="md" nowrap></td>
763 <table cellspacing="5" cellpadding="0" border="0">
771 Returns true or false for if a user can execute a privilaged oper command.
773 This is done by looking up their oper type from <a class="el" href="classuserrec.html#oper_5BNICKMAX_5D">userrec::oper</a>, then referencing this to their oper classes and checking the commands they can execute.
775 Definition at line <a class="el" href="users_8cpp-source.html#l00165">165</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
777 References <a class="el" href="inspircd__io_8h-source.html#l00239">ServerConfig::config_f</a>, <a class="el" href="classServerConfig.html#ConfValue_28char_20_2Atag_2C_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_2C_20std_3A_3Astringstream_20_2Aconfig_29">ServerConfig::ConfValue()</a>, and <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="l00166"></a>00166 {
778 <a name="l00167"></a>00167 <span class="keywordtype">char</span> TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
779 <a name="l00168"></a>00168 <span class="keywordtype">char</span>* mycmd;
780 <a name="l00169"></a>00169 <span class="keywordtype">char</span>* savept;
781 <a name="l00170"></a>00170 <span class="keywordtype">char</span>* savept2;
782 <a name="l00171"></a>00171
783 <a name="l00172"></a>00172 <span class="comment">// users on u-lined servers can completely bypass</span>
784 <a name="l00173"></a>00173 <span class="comment">// all permissions based checks.</span>
785 <a name="l00174"></a>00174 <span class="comment">//</span>
786 <a name="l00175"></a>00175 <span class="comment">// of course, if this is sent to a remote server and this</span>
787 <a name="l00176"></a>00176 <span class="comment">// server is not ulined there, then that other server</span>
788 <a name="l00177"></a>00177 <span class="comment">// silently drops the command.</span>
789 <a name="l00178"></a>00178 <span class="keywordflow">if</span> (<a class="code" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline</a>(this->server))
790 <a name="l00179"></a>00179 <span class="keywordflow">return</span> <span class="keyword">true</span>;
791 <a name="l00180"></a>00180
792 <a name="l00181"></a>00181 <span class="comment">// are they even an oper at all?</span>
793 <a name="l00182"></a>00182 <span class="keywordflow">if</span> (strchr(this->modes,<span class="charliteral">'o'</span>))
794 <a name="l00183"></a>00183 {
795 <a name="l00184"></a>00184 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j =0; j < Config->ConfValueEnum(<span class="stringliteral">"type"</span>,&<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#config_5Ff">config_f</a>); j++)
796 <a name="l00185"></a>00185 {
797 <a name="l00186"></a>00186 <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ConfValue_28char_20_2Atag_2C_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_2C_20std_3A_3Astringstream_20_2Aconfig_29">ConfValue</a>(<span class="stringliteral">"type"</span>,<span class="stringliteral">"name"</span>,j,TypeName,&<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#config_5Ff">config_f</a>);
798 <a name="l00187"></a>00187 <span class="keywordflow">if</span> (!strcmp(TypeName,this->oper))
799 <a name="l00188"></a>00188 {
800 <a name="l00189"></a>00189 <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ConfValue_28char_20_2Atag_2C_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_2C_20std_3A_3Astringstream_20_2Aconfig_29">ConfValue</a>(<span class="stringliteral">"type"</span>,<span class="stringliteral">"classes"</span>,j,Classes,&<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#config_5Ff">config_f</a>);
801 <a name="l00190"></a>00190 <span class="keywordtype">char</span>* myclass = strtok_r(Classes,<span class="stringliteral">" "</span>,&savept);
802 <a name="l00191"></a>00191 <span class="keywordflow">while</span> (myclass)
803 <a name="l00192"></a>00192 {
804 <a name="l00193"></a>00193 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> k =0; k < Config->ConfValueEnum(<span class="stringliteral">"class"</span>,&<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#config_5Ff">config_f</a>); k++)
805 <a name="l00194"></a>00194 {
806 <a name="l00195"></a>00195 <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ConfValue_28char_20_2Atag_2C_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_2C_20std_3A_3Astringstream_20_2Aconfig_29">ConfValue</a>(<span class="stringliteral">"class"</span>,<span class="stringliteral">"name"</span>,k,ClassName,&<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#config_5Ff">config_f</a>);
807 <a name="l00196"></a>00196 <span class="keywordflow">if</span> (!strcmp(ClassName,myclass))
808 <a name="l00197"></a>00197 {
809 <a name="l00198"></a>00198 <a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#ConfValue_28char_20_2Atag_2C_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_2C_20std_3A_3Astringstream_20_2Aconfig_29">ConfValue</a>(<span class="stringliteral">"class"</span>,<span class="stringliteral">"commands"</span>,k,CommandList,&<a class="code" href="channels_8cpp.html#Config">Config</a>-><a class="code" href="classServerConfig.html#config_5Ff">config_f</a>);
810 <a name="l00199"></a>00199 mycmd = strtok_r(CommandList,<span class="stringliteral">" "</span>,&savept2);
811 <a name="l00200"></a>00200 <span class="keywordflow">while</span> (mycmd)
812 <a name="l00201"></a>00201 {
813 <a name="l00202"></a>00202 <span class="keywordflow">if</span> ((!strcasecmp(mycmd,command.c_str())) || (*mycmd == <span class="charliteral">'*'</span>))
814 <a name="l00203"></a>00203 {
815 <a name="l00204"></a>00204 <span class="keywordflow">return</span> <span class="keyword">true</span>;
816 <a name="l00205"></a>00205 }
817 <a name="l00206"></a>00206 mycmd = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept2);
818 <a name="l00207"></a>00207 }
819 <a name="l00208"></a>00208 }
820 <a name="l00209"></a>00209 }
821 <a name="l00210"></a>00210 myclass = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept);
822 <a name="l00211"></a>00211 }
823 <a name="l00212"></a>00212 }
824 <a name="l00213"></a>00213 }
825 <a name="l00214"></a>00214 }
826 <a name="l00215"></a>00215 <span class="keywordflow">return</span> <span class="keyword">false</span>;
827 <a name="l00216"></a>00216 }
833 <a class="anchor" name="InviteTo_28irc_3A_3Astring_20_26channel_29"></a><!-- doxytag: member="userrec::InviteTo" ref="InviteTo_28irc_3A_3Astring_20_26channel_29" args="(irc::string &channel)" --><p>
834 <table class="mdTable" cellpadding="2" cellspacing="0">
837 <table cellpadding="0" cellspacing="0" border="0">
839 <td class="md" nowrap valign="top">void userrec::InviteTo </td>
840 <td class="md" valign="top">( </td>
841 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">irc::string</a> & </td>
842 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
843 <td class="md" valign="top"> ) </td>
844 <td class="md" nowrap><code> [virtual]</code></td>
850 <table cellspacing="5" cellpadding="0" border="0">
858 Adds a channel to a users invite list (invites them to a channel).
862 Definition at line <a class="el" href="users_8cpp-source.html#l00141">141</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
864 References <a class="el" href="users_8h-source.html#l00046">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00121">invites</a>.<div class="fragment"><pre class="fragment"><a name="l00142"></a>00142 {
865 <a name="l00143"></a>00143 <a class="code" href="classInvited.html">Invited</a> i;
866 <a name="l00144"></a>00144 i.<a class="code" href="classInvited.html#channel">channel</a> = channel;
867 <a name="l00145"></a>00145 <a class="code" href="classuserrec.html#invites">invites</a>.push_back(i);
868 <a name="l00146"></a>00146 }
874 <a class="anchor" name="IsInvited_28irc_3A_3Astring_20_26channel_29"></a><!-- doxytag: member="userrec::IsInvited" ref="IsInvited_28irc_3A_3Astring_20_26channel_29" args="(irc::string &channel)" --><p>
875 <table class="mdTable" cellpadding="2" cellspacing="0">
878 <table cellpadding="0" cellspacing="0" border="0">
880 <td class="md" nowrap valign="top">bool userrec::IsInvited </td>
881 <td class="md" valign="top">( </td>
882 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">irc::string</a> & </td>
883 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
884 <td class="md" valign="top"> ) </td>
885 <td class="md" nowrap><code> [virtual]</code></td>
891 <table cellspacing="5" cellpadding="0" border="0">
899 Returns true if a user is invited to a channel.
903 Definition at line <a class="el" href="users_8cpp-source.html#l00123">123</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
905 References <a class="el" href="users_8h-source.html#l00121">invites</a>.
907 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00124"></a>00124 {
908 <a name="l00125"></a>00125 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#invites">invites</a>.begin(); i != <a class="code" href="classuserrec.html#invites">invites</a>.end(); i++)
909 <a name="l00126"></a>00126 {
910 <a name="l00127"></a>00127 <a class="code" href="namespaceirc.html#string">irc::string</a> compare = i->channel;
911 <a name="l00128"></a>00128 <span class="keywordflow">if</span> (compare == channel)
912 <a name="l00129"></a>00129 {
913 <a name="l00130"></a>00130 <span class="keywordflow">return</span> <span class="keyword">true</span>;
914 <a name="l00131"></a>00131 }
915 <a name="l00132"></a>00132 }
916 <a name="l00133"></a>00133 <span class="keywordflow">return</span> <span class="keyword">false</span>;
917 <a name="l00134"></a>00134 }
923 <a class="anchor" name="ReadData_28void_20_2Abuffer_2C_20size_5Ft_20size_29"></a><!-- doxytag: member="userrec::ReadData" ref="ReadData_28void_20_2Abuffer_2C_20size_5Ft_20size_29" args="(void *buffer, size_t size)" --><p>
924 <table class="mdTable" cellpadding="2" cellspacing="0">
927 <table cellpadding="0" cellspacing="0" border="0">
929 <td class="md" nowrap valign="top">int userrec::ReadData </td>
930 <td class="md" valign="top">( </td>
931 <td class="md" nowrap valign="top">void * </td>
932 <td class="mdname" nowrap> <em>buffer</em>, </td>
935 <td class="md" nowrap align="right"></td>
937 <td class="md" nowrap>size_t </td>
938 <td class="mdname" nowrap> <em>size</em></td>
942 <td class="md">) </td>
943 <td class="md" colspan="2"></td>
949 <table cellspacing="5" cellpadding="0" border="0">
957 Calls read() to read some data for this user using their fd.
961 Definition at line <a class="el" href="users_8cpp-source.html#l00106">106</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00107"></a>00107 {
962 <a name="l00108"></a>00108 <span class="keywordflow">if</span> (this->fd > -1)
963 <a name="l00109"></a>00109 {
964 <a name="l00110"></a>00110 <span class="keywordflow">return</span> read(this->fd, buffer, size);
965 <a name="l00111"></a>00111 }
966 <a name="l00112"></a>00112 <span class="keywordflow">else</span> <span class="keywordflow">return</span> 0;
967 <a name="l00113"></a>00113 }
973 <a class="anchor" name="RemoveInvite_28irc_3A_3Astring_20_26channel_29"></a><!-- doxytag: member="userrec::RemoveInvite" ref="RemoveInvite_28irc_3A_3Astring_20_26channel_29" args="(irc::string &channel)" --><p>
974 <table class="mdTable" cellpadding="2" cellspacing="0">
977 <table cellpadding="0" cellspacing="0" border="0">
979 <td class="md" nowrap valign="top">void userrec::RemoveInvite </td>
980 <td class="md" valign="top">( </td>
981 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">irc::string</a> & </td>
982 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
983 <td class="md" valign="top"> ) </td>
984 <td class="md" nowrap><code> [virtual]</code></td>
990 <table cellspacing="5" cellpadding="0" border="0">
998 Removes a channel from a users invite list.
1000 This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
1002 Definition at line <a class="el" href="users_8cpp-source.html#l00148">148</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
1004 References <a class="el" href="inspircd__io_8h-source.html#l00029">DEBUG</a>, <a class="el" href="users_8h-source.html#l00121">invites</a>, and <a class="el" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log()</a>.
1006 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00149"></a>00149 {
1007 <a name="l00150"></a>00150 <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">"Removing invites"</span>);
1008 <a name="l00151"></a>00151 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#invites">invites</a>.size())
1009 <a name="l00152"></a>00152 {
1010 <a name="l00153"></a>00153 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#invites">invites</a>.begin(); i != <a class="code" href="classuserrec.html#invites">invites</a>.end(); i++)
1011 <a name="l00154"></a>00154 {
1012 <a name="l00155"></a>00155 <a class="code" href="namespaceirc.html#string">irc::string</a> compare = i->channel;
1013 <a name="l00156"></a>00156 <span class="keywordflow">if</span> (compare == channel)
1014 <a name="l00157"></a>00157 {
1015 <a name="l00158"></a>00158 <a class="code" href="classuserrec.html#invites">invites</a>.erase(i);
1016 <a name="l00159"></a>00159 <span class="keywordflow">return</span>;
1017 <a name="l00160"></a>00160 }
1018 <a name="l00161"></a>00161 }
1019 <a name="l00162"></a>00162 }
1020 <a name="l00163"></a>00163 }
1026 <a class="anchor" name="SetWriteError_28std_3A_3Astring_20error_29"></a><!-- doxytag: member="userrec::SetWriteError" ref="SetWriteError_28std_3A_3Astring_20error_29" args="(std::string error)" --><p>
1027 <table class="mdTable" cellpadding="2" cellspacing="0">
1030 <table cellpadding="0" cellspacing="0" border="0">
1032 <td class="md" nowrap valign="top">void userrec::SetWriteError </td>
1033 <td class="md" valign="top">( </td>
1034 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td>
1035 <td class="mdname1" valign="top" nowrap> <em>error</em> </td>
1036 <td class="md" valign="top"> ) </td>
1037 <td class="md" nowrap></td>
1043 <table cellspacing="5" cellpadding="0" border="0">
1051 Sets the write error for a connection.
1053 This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged.
1055 Definition at line <a class="el" href="users_8cpp-source.html#l00317">317</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
1057 References <a class="el" href="inspircd__io_8h-source.html#l00029">DEBUG</a>, <a class="el" href="globals_8h.html#log_28int_20level_2C_20char_20_2Atext_2C_2E_2E_2E_29">log()</a>, and <a class="el" href="users_8h-source.html#l00216">WriteError</a>.
1059 Referenced by <a class="el" href="users_8cpp-source.html#l00219">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00275">AddWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00295">FlushWriteBuf()</a>.<div class="fragment"><pre class="fragment"><a name="l00318"></a>00318 {
1060 <a name="l00319"></a>00319 <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">"Setting error string for %s to '%s'"</span>,this->nick,error.c_str());
1061 <a name="l00320"></a>00320 <span class="comment">// don't try to set the error twice, its already set take the first string.</span>
1062 <a name="l00321"></a>00321 <span class="keywordflow">if</span> (this->WriteError == <span class="stringliteral">""</span>)
1063 <a name="l00322"></a>00322 this-><a class="code" href="classuserrec.html#WriteError">WriteError</a> = error;
1064 <a name="l00323"></a>00323 }
1070 <hr><h2>Member Data Documentation</h2>
1071 <a class="anchor" name="awaymsg_5BMAXAWAY_2B_31_5D"></a><!-- doxytag: member="userrec::awaymsg" ref="awaymsg_5BMAXAWAY_2B_31_5D" args="[MAXAWAY+1]" --><p>
1072 <table class="mdTable" cellpadding="2" cellspacing="0">
1075 <table cellpadding="0" cellspacing="0" border="0">
1077 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#awaymsg_5BMAXAWAY_2B_31_5D">userrec::awaymsg</a>[MAXAWAY+1] </td>
1083 <table cellspacing="5" cellpadding="0" border="0">
1091 The user's away message.
1093 If this string is empty, the user is not marked as away.
1095 Definition at line <a class="el" href="users_8h-source.html#l00162">162</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1097 Referenced by <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1100 <a class="anchor" name="chans"></a><!-- doxytag: member="userrec::chans" ref="chans" args="" --><p>
1101 <table class="mdTable" cellpadding="2" cellspacing="0">
1104 <table cellpadding="0" cellspacing="0" border="0">
1106 <td class="md" nowrap valign="top">std::vector<<a class="el" href="classucrec.html">ucrec</a>> <a class="el" href="classuserrec.html#chans">userrec::chans</a> </td>
1112 <table cellspacing="5" cellpadding="0" border="0">
1122 Definition at line <a class="el" href="users_8h-source.html#l00153">153</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1124 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>, <a class="el" href="channels_8cpp-source.html#l00401">del_channel()</a>, <a class="el" href="channels_8cpp-source.html#l00459">kick_channel()</a>, <a class="el" href="modules_8cpp-source.html#l00609">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1127 <a class="anchor" name="dhost_5B_31_36_30_5D"></a><!-- doxytag: member="userrec::dhost" ref="dhost_5B_31_36_30_5D" args="[160]" --><p>
1128 <table class="mdTable" cellpadding="2" cellspacing="0">
1131 <table cellpadding="0" cellspacing="0" border="0">
1133 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#dhost_5B_31_36_30_5D">userrec::dhost</a>[160] </td>
1139 <table cellspacing="5" cellpadding="0" border="0">
1147 The host displayed to non-opers (used for cloaking etc).
1149 This usually matches the value of <a class="el" href="classconnection.html#host_5B_31_36_30_5D">userrec::host</a>.
1151 Definition at line <a class="el" href="users_8h-source.html#l00138">138</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1153 Referenced by <a class="el" href="users_8cpp-source.html#l00471">AddWhoWas()</a>, <a class="el" href="users_8cpp-source.html#l00099">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1156 <a class="anchor" name="dns_5Fdone"></a><!-- doxytag: member="userrec::dns_done" ref="dns_5Fdone" args="" --><p>
1157 <table class="mdTable" cellpadding="2" cellspacing="0">
1160 <table cellpadding="0" cellspacing="0" border="0">
1162 <td class="md" nowrap valign="top">bool <a class="el" href="classuserrec.html#dns_5Fdone">userrec::dns_done</a> </td>
1168 <table cellspacing="5" cellpadding="0" border="0">
1176 True when <a class="el" href="classDNS.html">DNS</a> lookups are completed.
1180 Definition at line <a class="el" href="users_8h-source.html#l00185">185</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1182 Referenced by <a class="el" href="users_8cpp-source.html#l00731">ConnectUser()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1185 <a class="anchor" name="flood"></a><!-- doxytag: member="userrec::flood" ref="flood" args="" --><p>
1186 <table class="mdTable" cellpadding="2" cellspacing="0">
1189 <table cellpadding="0" cellspacing="0" border="0">
1191 <td class="md" nowrap valign="top">int <a class="el" href="classuserrec.html#flood">userrec::flood</a> </td>
1197 <table cellspacing="5" cellpadding="0" border="0">
1205 Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
1209 Definition at line <a class="el" href="users_8h-source.html#l00168">168</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1211 Referenced by <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1214 <a class="anchor" name="fullname_5BMAXGECOS_2B_31_5D"></a><!-- doxytag: member="userrec::fullname" ref="fullname_5BMAXGECOS_2B_31_5D" args="[MAXGECOS+1]" --><p>
1215 <table class="mdTable" cellpadding="2" cellspacing="0">
1218 <table cellpadding="0" cellspacing="0" border="0">
1220 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#fullname_5BMAXGECOS_2B_31_5D">userrec::fullname</a>[MAXGECOS+1] </td>
1226 <table cellspacing="5" cellpadding="0" border="0">
1234 The users full name.
1238 Definition at line <a class="el" href="users_8h-source.html#l00142">142</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1240 Referenced by <a class="el" href="users_8cpp-source.html#l00471">AddWhoWas()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1243 <a class="anchor" name="ident_5BIDENTMAX_2B_32_5D"></a><!-- doxytag: member="userrec::ident" ref="ident_5BIDENTMAX_2B_32_5D" args="[IDENTMAX+2]" --><p>
1244 <table class="mdTable" cellpadding="2" cellspacing="0">
1247 <table cellpadding="0" cellspacing="0" border="0">
1249 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">userrec::ident</a>[IDENTMAX+2] </td>
1255 <table cellspacing="5" cellpadding="0" border="0">
1263 The users ident reply.
1265 Two characters are added to the user-defined limit to compensate for the tilde etc.
1267 Definition at line <a class="el" href="users_8h-source.html#l00133">133</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1269 Referenced by <a class="el" href="users_8cpp-source.html#l00471">AddWhoWas()</a>, <a class="el" href="users_8cpp-source.html#l00647">FullConnectUser()</a>, <a class="el" href="users_8cpp-source.html#l00099">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00116">GetFullRealHost()</a>, <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>, <a class="el" href="users_8cpp-source.html#l00412">kill_link_silent()</a>, <a class="el" href="modules_8cpp-source.html#l00609">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00597">Server::UserToPseudo()</a>. </td>
1272 <a class="anchor" name="invites"></a><!-- doxytag: member="userrec::invites" ref="invites" args="" --><p>
1273 <table class="mdTable" cellpadding="2" cellspacing="0">
1276 <table cellpadding="0" cellspacing="0" border="0">
1278 <td class="md" nowrap valign="top"><a class="el" href="users_8h.html#InvitedList">InvitedList</a> <a class="el" href="classuserrec.html#invites">userrec::invites</a><code> [private]</code> </td>
1284 <table cellspacing="5" cellpadding="0" border="0">
1292 A list of channels the user has a pending invite to.
1296 Definition at line <a class="el" href="users_8h-source.html#l00121">121</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1298 Referenced by <a class="el" href="users_8cpp-source.html#l00136">GetInviteList()</a>, <a class="el" href="users_8cpp-source.html#l00141">InviteTo()</a>, <a class="el" href="users_8cpp-source.html#l00123">IsInvited()</a>, <a class="el" href="users_8cpp-source.html#l00148">RemoveInvite()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1301 <a class="anchor" name="lines_5Fin"></a><!-- doxytag: member="userrec::lines_in" ref="lines_5Fin" args="" --><p>
1302 <table class="mdTable" cellpadding="2" cellspacing="0">
1305 <table cellpadding="0" cellspacing="0" border="0">
1307 <td class="md" nowrap valign="top">int <a class="el" href="classuserrec.html#lines_5Fin">userrec::lines_in</a> </td>
1313 <table cellspacing="5" cellpadding="0" border="0">
1325 Definition at line <a class="el" href="users_8h-source.html#l00210">210</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1327 Referenced by <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1330 <a class="anchor" name="modes_5B_35_34_5D"></a><!-- doxytag: member="userrec::modes" ref="modes_5B_35_34_5D" args="[54]" --><p>
1331 <table class="mdTable" cellpadding="2" cellspacing="0">
1334 <table cellpadding="0" cellspacing="0" border="0">
1336 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#modes_5B_35_34_5D">userrec::modes</a>[54] </td>
1342 <table cellspacing="5" cellpadding="0" border="0">
1350 The user's mode string.
1352 This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. it is limited to length 54, as there can only be a maximum of 52 user modes (26 upper, 26 lower case) a null terminating char, and an optional + character.
1354 Definition at line <a class="el" href="users_8h-source.html#l00151">151</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1356 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1359 <a class="anchor" name="nick_5BNICKMAX_5D"></a><!-- doxytag: member="userrec::nick" ref="nick_5BNICKMAX_5D" args="[NICKMAX]" --><p>
1360 <table class="mdTable" cellpadding="2" cellspacing="0">
1363 <table cellpadding="0" cellspacing="0" border="0">
1365 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#nick_5BNICKMAX_5D">userrec::nick</a>[NICKMAX] </td>
1371 <table cellspacing="5" cellpadding="0" border="0">
1381 An invalid nickname indicates an unregistered connection prior to the NICK command.
1383 Definition at line <a class="el" href="users_8h-source.html#l00128">128</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1385 Referenced by <a class="el" href="channels_8cpp-source.html#l00194">add_channel()</a>, <a class="el" href="users_8cpp-source.html#l00471">AddWhoWas()</a>, <a class="el" href="channels_8cpp-source.html#l00401">del_channel()</a>, <a class="el" href="modules_8cpp-source.html#l00834">ConfigReader::DumpErrors()</a>, <a class="el" href="users_8cpp-source.html#l00647">FullConnectUser()</a>, <a class="el" href="users_8cpp-source.html#l00099">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00116">GetFullRealHost()</a>, <a class="el" href="channels_8cpp-source.html#l00459">kick_channel()</a>, <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>, <a class="el" href="users_8cpp-source.html#l00412">kill_link_silent()</a>, <a class="el" href="modules_8cpp-source.html#l00609">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1388 <a class="anchor" name="oper_5BNICKMAX_5D"></a><!-- doxytag: member="userrec::oper" ref="oper_5BNICKMAX_5D" args="[NICKMAX]" --><p>
1389 <table class="mdTable" cellpadding="2" cellspacing="0">
1392 <table cellpadding="0" cellspacing="0" border="0">
1394 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#oper_5BNICKMAX_5D">userrec::oper</a>[NICKMAX] </td>
1400 <table cellspacing="5" cellpadding="0" border="0">
1408 The oper type they logged in as, if they are an oper.
1410 This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.
1412 Definition at line <a class="el" href="users_8h-source.html#l00181">181</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1414 Referenced by <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1417 <a class="anchor" name="password_5BMAXBUF_5D"></a><!-- doxytag: member="userrec::password" ref="password_5BMAXBUF_5D" args="[MAXBUF]" --><p>
1418 <table class="mdTable" cellpadding="2" cellspacing="0">
1421 <table cellpadding="0" cellspacing="0" border="0">
1423 <td class="md" nowrap valign="top">char <a class="el" href="classuserrec.html#password_5BMAXBUF_5D">userrec::password</a>[MAXBUF] </td>
1429 <table cellspacing="5" cellpadding="0" border="0">
1437 Password specified by the user when they registered.
1439 This is stored even if the <connect> block doesnt need a password, so that modules may check it.
1441 Definition at line <a class="el" href="users_8h-source.html#l00195">195</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
1444 <a class="anchor" name="pingmax"></a><!-- doxytag: member="userrec::pingmax" ref="pingmax" args="" --><p>
1445 <table class="mdTable" cellpadding="2" cellspacing="0">
1448 <table cellpadding="0" cellspacing="0" border="0">
1450 <td class="md" nowrap valign="top">unsigned int <a class="el" href="classuserrec.html#pingmax">userrec::pingmax</a> </td>
1456 <table cellspacing="5" cellpadding="0" border="0">
1464 Number of seconds between PINGs for this user (set from <connect:allow> tag.
1468 Definition at line <a class="el" href="users_8h-source.html#l00189">189</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
1471 <a class="anchor" name="recvq"></a><!-- doxytag: member="userrec::recvq" ref="recvq" args="" --><p>
1472 <table class="mdTable" cellpadding="2" cellspacing="0">
1475 <table cellpadding="0" cellspacing="0" border="0">
1477 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classuserrec.html#recvq">userrec::recvq</a> </td>
1483 <table cellspacing="5" cellpadding="0" border="0">
1491 User's receive queue.
1493 Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.
1495 Definition at line <a class="el" href="users_8h-source.html#l00201">201</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1497 Referenced by <a class="el" href="users_8cpp-source.html#l00219">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00245">BufferIsReady()</a>, <a class="el" href="users_8cpp-source.html#l00253">ClearBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00258">GetBuffer()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1500 <a class="anchor" name="recvqmax"></a><!-- doxytag: member="userrec::recvqmax" ref="recvqmax" args="" --><p>
1501 <table class="mdTable" cellpadding="2" cellspacing="0">
1504 <table cellpadding="0" cellspacing="0" border="0">
1506 <td class="md" nowrap valign="top">long <a class="el" href="classuserrec.html#recvqmax">userrec::recvqmax</a> </td>
1512 <table cellspacing="5" cellpadding="0" border="0">
1520 Maximum size this user's recvq can become.
1524 Definition at line <a class="el" href="users_8h-source.html#l00224">224</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1526 Referenced by <a class="el" href="users_8cpp-source.html#l00219">AddBuffer()</a>. </td>
1529 <a class="anchor" name="reset_5Fdue"></a><!-- doxytag: member="userrec::reset_due" ref="reset_5Fdue" args="" --><p>
1530 <table class="mdTable" cellpadding="2" cellspacing="0">
1533 <table cellpadding="0" cellspacing="0" border="0">
1535 <td class="md" nowrap valign="top">time_t <a class="el" href="classuserrec.html#reset_5Fdue">userrec::reset_due</a> </td>
1541 <table cellspacing="5" cellpadding="0" border="0">
1551 Definition at line <a class="el" href="users_8h-source.html#l00211">211</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1553 Referenced by <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1556 <a class="anchor" name="sendq"></a><!-- doxytag: member="userrec::sendq" ref="sendq" args="" --><p>
1557 <table class="mdTable" cellpadding="2" cellspacing="0">
1560 <table cellpadding="0" cellspacing="0" border="0">
1562 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classuserrec.html#sendq">userrec::sendq</a> </td>
1568 <table cellspacing="5" cellpadding="0" border="0">
1578 Lines waiting to be sent are stored here until their buffer is flushed.
1580 Definition at line <a class="el" href="users_8h-source.html#l00206">206</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1582 Referenced by <a class="el" href="users_8cpp-source.html#l00275">AddWriteBuf()</a>, <a class="el" href="users_8cpp-source.html#l00295">FlushWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1585 <a class="anchor" name="sendqmax"></a><!-- doxytag: member="userrec::sendqmax" ref="sendqmax" args="" --><p>
1586 <table class="mdTable" cellpadding="2" cellspacing="0">
1589 <table cellpadding="0" cellspacing="0" border="0">
1591 <td class="md" nowrap valign="top">long <a class="el" href="classuserrec.html#sendqmax">userrec::sendqmax</a> </td>
1597 <table cellspacing="5" cellpadding="0" border="0">
1605 Maximum size this user's sendq can become.
1609 Definition at line <a class="el" href="users_8h-source.html#l00220">220</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1611 Referenced by <a class="el" href="users_8cpp-source.html#l00275">AddWriteBuf()</a>. </td>
1614 <a class="anchor" name="server"></a><!-- doxytag: member="userrec::server" ref="server" args="" --><p>
1615 <table class="mdTable" cellpadding="2" cellspacing="0">
1618 <table cellpadding="0" cellspacing="0" border="0">
1620 <td class="md" nowrap valign="top">char* <a class="el" href="classuserrec.html#server">userrec::server</a> </td>
1626 <table cellspacing="5" cellpadding="0" border="0">
1634 The server the user is connected to.
1638 Definition at line <a class="el" href="users_8h-source.html#l00157">157</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1640 Referenced by <a class="el" href="users_8cpp-source.html#l00471">AddWhoWas()</a>, <a class="el" href="channels_8cpp-source.html#l00459">kick_channel()</a>, and <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1643 <a class="anchor" name="threshold"></a><!-- doxytag: member="userrec::threshold" ref="threshold" args="" --><p>
1644 <table class="mdTable" cellpadding="2" cellspacing="0">
1647 <table cellpadding="0" cellspacing="0" border="0">
1649 <td class="md" nowrap valign="top">long <a class="el" href="classuserrec.html#threshold">userrec::threshold</a> </td>
1655 <table cellspacing="5" cellpadding="0" border="0">
1665 Definition at line <a class="el" href="users_8h-source.html#l00212">212</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
1668 <a class="anchor" name="timeout"></a><!-- doxytag: member="userrec::timeout" ref="timeout" args="" --><p>
1669 <table class="mdTable" cellpadding="2" cellspacing="0">
1672 <table cellpadding="0" cellspacing="0" border="0">
1674 <td class="md" nowrap valign="top">unsigned int <a class="el" href="classuserrec.html#timeout">userrec::timeout</a> </td>
1680 <table cellspacing="5" cellpadding="0" border="0">
1688 Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.
1692 Definition at line <a class="el" href="users_8h-source.html#l00174">174</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1694 Referenced by <a class="el" href="users_8cpp-source.html#l00063">userrec()</a>. </td>
1697 <a class="anchor" name="WriteError"></a><!-- doxytag: member="userrec::WriteError" ref="WriteError" args="" --><p>
1698 <table class="mdTable" cellpadding="2" cellspacing="0">
1701 <table cellpadding="0" cellspacing="0" border="0">
1703 <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classuserrec.html#WriteError">userrec::WriteError</a> </td>
1709 <table cellspacing="5" cellpadding="0" border="0">
1719 Definition at line <a class="el" href="users_8h-source.html#l00216">216</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1721 Referenced by <a class="el" href="users_8cpp-source.html#l00325">GetWriteError()</a>, and <a class="el" href="users_8cpp-source.html#l00317">SetWriteError()</a>. </td>
1724 <hr>The documentation for this class was generated from the following files:<ul>
1725 <li><a class="el" href="users_8h-source.html">users.h</a><li><a class="el" href="users_8cpp-source.html">users.cpp</a></ul>
1726 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:16 2005 for InspIRCd by
1727 <a href="http://www.doxygen.org/index.html">
1728 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>