mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-11 19:49:02 -04:00
4d5a17380b
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 e03df62e-2008-0410-955e-edbf42e46eb7
1659 lines
78 KiB
HTML
1659 lines
78 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>InspIRCd: userrec class Reference</title>
|
|
<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3.3 -->
|
|
<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">Compound List</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">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
|
<h1>userrec Class Reference</h1>Holds all information about a user This class stores all information about a user connected to the irc server.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="users_8h-source.html">users.h</a>></code>
|
|
<p>
|
|
Inheritance diagram for userrec:<p><center><img src="classuserrec__inherit__graph.gif" border="0" usemap="#userrec__inherit__map" alt="Inheritance graph"></center>
|
|
<map name="userrec__inherit__map">
|
|
<area href="classconnection.html" shape="rect" coords="7,157,93,184" alt="">
|
|
<area href="classExtensible.html" shape="rect" coords="9,82,91,109" alt="">
|
|
<area href="classclassbase.html" shape="rect" coords="10,8,90,34" alt="">
|
|
</map>
|
|
<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>
|
|
<map name="userrec__coll__map">
|
|
<area href="classconnection.html" shape="rect" coords="199,469,285,496" alt="">
|
|
<area href="classucrec.html" shape="rect" coords="215,237,269,264" alt="">
|
|
</map>
|
|
<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>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a0">userrec</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a1">~userrec</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual char * </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a2">GetFullHost</a> ()</td></tr>
|
|
|
|
<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. </em> <a href="#a2"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual char * </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a3">GetFullRealHost</a> ()</td></tr>
|
|
|
|
<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. </em> <a href="#a3"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a4">IsInvited</a> (char *channel)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a user is invited to a channel. </em> <a href="#a4"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a5">InviteTo</a> (char *channel)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a channel to a users invite list (invites them to a channel). </em> <a href="#a5"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a6">RemoveInvite</a> (char *channel)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a channel from a users invite list. </em> <a href="#a6"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a7">HasPermission</a> (char *command)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true or false for if a user can execute a privilaged oper command. </em> <a href="#a7"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a8">AddBuffer</a> (std::string a)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method adds data to the buffer of the user. </em> <a href="#a8"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a9">BufferIsReady</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns true if the buffer contains at least one carriage return character (e.g. </em> <a href="#a9"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a10">ClearBuffer</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function clears the entire buffer by setting it to an empty string. </em> <a href="#a10"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a11">GetBuffer</a> ()</td></tr>
|
|
|
|
<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. </em> <a href="#a11"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a12">SetWriteError</a> (std::string error)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the write error for a connection. </em> <a href="#a12"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a13">GetWriteError</a> ()</td></tr>
|
|
|
|
<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. </em> <a href="#a13"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a14">AddWriteBuf</a> (std::string data)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds to the user's write buffer. </em> <a href="#a14"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a15">FlushWriteBuf</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes as much of the user's buffer to the file descriptor as possible. </em> <a href="#a15"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="users_8h.html#a6">InvitedList</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a16">GetInviteList</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of channels this user has been invited to but has not yet joined. </em> <a href="#a16"></a><em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o0">nick</a> [NICKMAX]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The users nickname. </em> <a href="#o0"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o1">ident</a> [16]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The users ident reply. </em> <a href="#o1"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o2">dhost</a> [160]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The host displayed to non-opers (used for cloaking etc). </em> <a href="#o2"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o3">fullname</a> [128]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The users full name. </em> <a href="#o3"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o4">modes</a> [MAXBUF]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The user's mode string. </em> <a href="#o4"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classucrec.html">ucrec</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o5">chans</a> [MAXCHANS]</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o6">server</a> [256]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The server the user is connected to. </em> <a href="#o6"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o7">awaymsg</a> [512]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The user's away message. </em> <a href="#o7"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o8">result</a> [256]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stores the result of the last GetFullHost or GetRealHost call. </em> <a href="#o8"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o9">flood</a></td></tr>
|
|
|
|
<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. </em> <a href="#o9"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o10">timeout</a></td></tr>
|
|
|
|
<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. </em> <a href="#o10"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o11">oper</a> [NICKMAX]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The oper type they logged in as, if they are an oper. </em> <a href="#o11"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o12">dns_done</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">True when <a class="el" href="classDNS.html">DNS</a> lookups are completed. </em> <a href="#o12"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o13">pingmax</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of seconds between PINGs for this user (set from <connect:allow> tag. </em> <a href="#o13"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o14">password</a> [MAXBUF]</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Password specified by the user when they registered. </em> <a href="#o14"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o15">recvq</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">User's receive queue. </em> <a href="#o15"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o16">sendq</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">User's send queue. </em> <a href="#o16"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o17">lines_in</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flood counters. </em> <a href="#o17"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>time_t </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o18">reset_due</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o19">threshold</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o20">WriteError</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o21">sendqmax</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size this user's sendq can become. </em> <a href="#o21"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o22">recvqmax</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size this user's recvq can become. </em> <a href="#o22"></a><em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="users_8h.html#a6">InvitedList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#r0">invites</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">A list of channels the user has a pending invite to. </em> <a href="#r0"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Holds all information about a user This class stores all information about a user connected to the irc server.
|
|
<p>
|
|
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.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00108">108</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="a0" doxytag="userrec::userrec"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> userrec::userrec </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00029">29</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00151">awaymsg</a>, <a class="el" href="connection_8h-source.html#l00229">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00233">connection::bytes_out</a>, <a class="el" href="channels_8h-source.html#l00233">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00142">chans</a>, <a class="el" href="connection_8h-source.html#l00237">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00241">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00130">dhost</a>, <a class="el" href="users_8h-source.html#l00179">dns_done</a>, <a class="el" href="connection_8h-source.html#l00217">connection::fd</a>, <a class="el" href="users_8h-source.html#l00162">flood</a>, <a class="el" href="users_8h-source.html#l00134">fullname</a>, <a class="el" href="connection_8h-source.html#l00245">connection::haspassed</a>, <a class="el" href="connection_8h-source.html#l00221">connection::host</a>, <a class="el" href="users_8h-source.html#l00125">ident</a>, <a class="el" href="connection_8h-source.html#l00267">connection::idle_lastmsg</a>, <a class="el" href="users_8h-source.html#l00114">invites</a>, <a class="el" href="connection_8h-source.html#l00225">connection::ip</a>, <a class="el" href="connection_8h-source.html#l00259">connection::lastping</a>, <a class="el" href="users_8h-source.html#l00204">lines_in</a>, <a class="el" href="users_8h-source.html#l00140">modes</a>, <a class="el" href="users_8h-source.html#l00121">nick</a>, <a class="el" href="connection_8h-source.html#l00271">connection::nping</a>, <a class="el" href="users_8h-source.html#l00175">oper</a>, <a class="el" href="connection_8h-source.html#l00251">connection::port</a>, <a class="el" href="users_8h-source.html#l00195">recvq</a>, <a class="el" href="connection_8h-source.html#l00255">connection::registered</a>, <a class="el" href="users_8h-source.html#l00205">reset_due</a>, <a class="el" href="users_8h-source.html#l00156">result</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, <a class="el" href="users_8h-source.html#l00146">server</a>, <a class="el" href="connection_8h-source.html#l00263">connection::signon</a>, <a class="el" href="channels_8cpp-source.html#l00102">TIME</a>, <a class="el" href="users_8h-source.html#l00168">timeout</a>, and <a class="el" href="channels_8h-source.html#l00228">ucrec::uc_modes</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00030 {
|
|
00031 <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span>
|
|
00032 strcpy(nick,<span class="stringliteral">""</span>);
|
|
00033 strcpy(ip,<span class="stringliteral">"127.0.0.1"</span>);
|
|
00034 <a class="code" href="classuserrec.html#o10">timeout</a> = 0;
|
|
00035 strcpy(ident,<span class="stringliteral">""</span>);
|
|
00036 strcpy(host,<span class="stringliteral">""</span>);
|
|
00037 strcpy(dhost,<span class="stringliteral">""</span>);
|
|
00038 strcpy(fullname,<span class="stringliteral">""</span>);
|
|
00039 strcpy(modes,<span class="stringliteral">""</span>);
|
|
00040 strcpy(server,<span class="stringliteral">""</span>);
|
|
00041 strcpy(awaymsg,<span class="stringliteral">""</span>);
|
|
00042 strcpy(oper,<span class="stringliteral">""</span>);
|
|
00043 <a class="code" href="classuserrec.html#o18">reset_due</a> = <a class="code" href="channels_8cpp.html#a37">TIME</a>;
|
|
00044 <a class="code" href="classuserrec.html#o17">lines_in</a> = 0;
|
|
00045 <a class="code" href="classconnection.html#o0">fd</a> = <a class="code" href="classconnection.html#o10">lastping</a> = <a class="code" href="classconnection.html#o11">signon</a> = <a class="code" href="classconnection.html#o12">idle_lastmsg</a> = <a class="code" href="classconnection.html#o13">nping</a> = <a class="code" href="classconnection.html#o9">registered</a> = 0;
|
|
00046 <a class="code" href="classuserrec.html#o9">flood</a> = <a class="code" href="classconnection.html#o8">port</a> = <a class="code" href="classconnection.html#o3">bytes_in</a> = <a class="code" href="classconnection.html#o4">bytes_out</a> = <a class="code" href="classconnection.html#o5">cmds_in</a> = <a class="code" href="classconnection.html#o6">cmds_out</a> = 0;
|
|
00047 <a class="code" href="classconnection.html#o7">haspassed</a> = <span class="keyword">false</span>;
|
|
00048 <a class="code" href="classuserrec.html#o12">dns_done</a> = <span class="keyword">false</span>;
|
|
00049 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>;
|
|
00050 <a class="code" href="classuserrec.html#o16">sendq</a> = <span class="stringliteral">""</span>;
|
|
00051 strcpy(result,<span class="stringliteral">""</span>);
|
|
00052 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < MAXCHANS; i++)
|
|
00053 {
|
|
00054 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o1">channel</a> = NULL;
|
|
00055 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o0">uc_modes</a> = 0;
|
|
00056 }
|
|
00057 <a class="code" href="classuserrec.html#r0">invites</a>.clear();
|
|
00058 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a1" doxytag="userrec::~userrec"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual userrec::~<a class="el" href="classuserrec.html">userrec</a> </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00222">222</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00222 { }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a8" doxytag="userrec::AddBuffer"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> bool userrec::AddBuffer </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::string </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>a</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This method adds data to the buffer of the user.
|
|
<p>
|
|
The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, 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.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00175">175</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00195">recvq</a>, <a class="el" href="users_8h-source.html#l00218">recvqmax</a>, and <a class="el" href="users_8cpp-source.html#l00269">SetWriteError()</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00176 {
|
|
00177 std::string b = <span class="stringliteral">""</span>;
|
|
00178 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < a.length(); i++)
|
|
00179 <span class="keywordflow">if</span> ((a[i] != <span class="charliteral">'\r'</span>) && (a[i] != <span class="charliteral">'\0'</span>) && (a[i] != 7))
|
|
00180 b = b + a[i];
|
|
00181 std::stringstream stream(recvq);
|
|
00182 stream << b;
|
|
00183 <a class="code" href="classuserrec.html#o15">recvq</a> = stream.str();
|
|
00184 <span class="keywordtype">int</span> i = 0;
|
|
00185 <span class="comment">// count the size of the first line in the buffer.</span>
|
|
00186 <span class="keywordflow">while</span> (i < <a class="code" href="classuserrec.html#o15">recvq</a>.length())
|
|
00187 {
|
|
00188 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i++] == <span class="charliteral">'\n'</span>)
|
|
00189 <span class="keywordflow">break</span>;
|
|
00190 }
|
|
00191 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>.length() > this-><a class="code" href="classuserrec.html#o22">recvqmax</a>)
|
|
00192 {
|
|
00193 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(<span class="stringliteral">"RecvQ exceeded"</span>);
|
|
00194 WriteOpers(<span class="stringliteral">"*** User %s RecvQ of %d exceeds connect class maximum of %d"</span>,this->nick,<a class="code" href="classuserrec.html#o15">recvq</a>.length(),this-><a class="code" href="classuserrec.html#o22">recvqmax</a>);
|
|
00195 }
|
|
00196 <span class="comment">// return false if we've had more than 600 characters WITHOUT</span>
|
|
00197 <span class="comment">// a carriage return (this is BAD, drop the socket)</span>
|
|
00198 <span class="keywordflow">return</span> (i < 600);
|
|
00199 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a14" doxytag="userrec::AddWriteBuf"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void userrec::AddWriteBuf </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::string </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Adds to the user's write buffer.
|
|
<p>
|
|
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#a12">SetWriteError()</a> will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00231">231</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8cpp-source.html#l00277">GetWriteError()</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, <a class="el" href="users_8h-source.html#l00214">sendqmax</a>, and <a class="el" href="users_8cpp-source.html#l00269">SetWriteError()</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00232 {
|
|
00233 <span class="keywordflow">if</span> (this-><a class="code" href="classuserrec.html#a13">GetWriteError</a>() != <span class="stringliteral">""</span>)
|
|
00234 <span class="keywordflow">return</span>;
|
|
00235 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o16">sendq</a>.length() + data.length() > this-><a class="code" href="classuserrec.html#o21">sendqmax</a>)
|
|
00236 {
|
|
00237 WriteOpers(<span class="stringliteral">"*** User %s SendQ of %d exceeds connect class maximum of %d"</span>,this->nick,<a class="code" href="classuserrec.html#o16">sendq</a>.length() + data.length(),this-><a class="code" href="classuserrec.html#o21">sendqmax</a>);
|
|
00238 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(<span class="stringliteral">"SendQ exceeded"</span>);
|
|
00239 <span class="keywordflow">return</span>;
|
|
00240 }
|
|
00241 std::stringstream stream;
|
|
00242 stream << <a class="code" href="classuserrec.html#o16">sendq</a> << data;
|
|
00243 <a class="code" href="classuserrec.html#o16">sendq</a> = stream.str();
|
|
00244 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a9" doxytag="userrec::BufferIsReady"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> bool userrec::BufferIsReady </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This method returns true if the buffer contains at least one carriage return character (e.g.
|
|
<p>
|
|
one complete line may be read)
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00201">201</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00195">recvq</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00202 {
|
|
00203 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="classuserrec.html#o15">recvq</a>.length(); i++)
|
|
00204 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i] == <span class="charliteral">'\n'</span>)
|
|
00205 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
00206 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
00207 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a10" doxytag="userrec::ClearBuffer"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void userrec::ClearBuffer </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
This function clears the entire buffer by setting it to an empty string.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00209">209</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00195">recvq</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="modules_8cpp-source.html#l00629">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00610">Server::UserToPseudo()</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00210 {
|
|
00211 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>;
|
|
00212 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a15" doxytag="userrec::FlushWriteBuf"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void userrec::FlushWriteBuf </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Flushes as much of the user's buffer to the file descriptor as possible.
|
|
<p>
|
|
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.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00247">247</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="connection_8h-source.html#l00233">connection::bytes_out</a>, <a class="el" href="connection_8h-source.html#l00241">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, and <a class="el" href="users_8cpp-source.html#l00269">SetWriteError()</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00248 {
|
|
00249 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o16">sendq</a>.length())
|
|
00250 {
|
|
00251 <span class="keywordtype">char</span>* tb = (<span class="keywordtype">char</span>*)this-><a class="code" href="classuserrec.html#o16">sendq</a>.c_str();
|
|
00252 <span class="keywordtype">int</span> n_sent = write(this->fd,tb,this->sendq.length());
|
|
00253 <span class="keywordflow">if</span> (n_sent == -1)
|
|
00254 {
|
|
00255 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(strerror(errno));
|
|
00256 }
|
|
00257 <span class="keywordflow">else</span>
|
|
00258 {
|
|
00259 <span class="comment">// advance the queue</span>
|
|
00260 tb += n_sent;
|
|
00261 this-><a class="code" href="classuserrec.html#o16">sendq</a> = tb;
|
|
00262 <span class="comment">// update the user's stats counters</span>
|
|
00263 this-><a class="code" href="classconnection.html#o4">bytes_out</a> += n_sent;
|
|
00264 this-><a class="code" href="classconnection.html#o6">cmds_out</a>++;
|
|
00265 }
|
|
00266 }
|
|
00267 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a11" doxytag="userrec::GetBuffer"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> std::string userrec::GetBuffer </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
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.
|
|
<p>
|
|
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#a9">BufferIsReady()</a> to check if it is ok to read the buffer before calling <a class="el" href="classuserrec.html#a11">GetBuffer()</a>.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00214">214</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00195">recvq</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00215 {
|
|
00216 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a> == <span class="stringliteral">""</span>)
|
|
00217 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
|
|
00218 <span class="keywordtype">char</span>* line = (<span class="keywordtype">char</span>*)<a class="code" href="classuserrec.html#o15">recvq</a>.c_str();
|
|
00219 std::string ret = <span class="stringliteral">""</span>;
|
|
00220 <span class="keywordflow">while</span> ((*line != <span class="charliteral">'\n'</span>) && (strlen(line)))
|
|
00221 {
|
|
00222 ret = ret + *line;
|
|
00223 line++;
|
|
00224 }
|
|
00225 <span class="keywordflow">if</span> ((*line == <span class="charliteral">'\n'</span>) || (*line == <span class="charliteral">'\r'</span>))
|
|
00226 line++;
|
|
00227 <a class="code" href="classuserrec.html#o15">recvq</a> = line;
|
|
00228 <span class="keywordflow">return</span> ret;
|
|
00229 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="userrec::GetFullHost"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char * userrec::GetFullHost </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
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.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00062">62</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00130">dhost</a>, <a class="el" href="users_8h-source.html#l00125">ident</a>, <a class="el" href="users_8h-source.html#l00121">nick</a>, and <a class="el" href="users_8h-source.html#l00156">result</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00063 {
|
|
00064 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost);
|
|
00065 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>;
|
|
00066 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="userrec::GetFullRealHost"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char * userrec::GetFullRealHost </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
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.
|
|
<p>
|
|
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.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00069">69</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="connection_8h-source.html#l00221">connection::host</a>, <a class="el" href="users_8h-source.html#l00125">ident</a>, <a class="el" href="users_8h-source.html#l00121">nick</a>, and <a class="el" href="users_8h-source.html#l00156">result</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00070 {
|
|
00071 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host);
|
|
00072 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>;
|
|
00073 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a16" doxytag="userrec::GetInviteList"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> <a class="el" href="users_8h.html#a6">InvitedList</a> * userrec::GetInviteList </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns the list of channels this user has been invited to but has not yet joined.
|
|
<p>
|
|
|
|
<p>
|
|
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>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00094">InvitedList</a>, and <a class="el" href="users_8h-source.html#l00114">invites</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00090 {
|
|
00091 <span class="keywordflow">return</span> &<a class="code" href="classuserrec.html#r0">invites</a>;
|
|
00092 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a13" doxytag="userrec::GetWriteError"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> std::string userrec::GetWriteError </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns the write error which last occured on this connection or an empty string if none occured.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00277">277</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00210">WriteError</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00231">AddWriteBuf()</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00278 {
|
|
00279 <span class="keywordflow">return</span> this-><a class="code" href="classuserrec.html#o20">WriteError</a>;
|
|
00280 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a7" doxytag="userrec::HasPermission"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> bool userrec::HasPermission </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">char * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>command</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns true or false for if a user can execute a privilaged oper command.
|
|
<p>
|
|
This is done by looking up their oper type from <a class="el" href="classuserrec.html#o11">userrec::oper</a>, then referencing this to their oper classes and checking the commands they can execute.
|
|
<p>
|
|
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>.
|
|
<p>
|
|
References <a class="el" href="channels_8cpp-source.html#l00096">config_f</a>, and <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00124 {
|
|
00125 <span class="keywordtype">char</span> TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
|
|
00126 <span class="keywordtype">char</span>* mycmd;
|
|
00127 <span class="keywordtype">char</span>* savept;
|
|
00128 <span class="keywordtype">char</span>* savept2;
|
|
00129
|
|
00130 <span class="comment">// are they even an oper at all?</span>
|
|
00131 <span class="keywordflow">if</span> (strchr(this->modes,<span class="charliteral">'o'</span>))
|
|
00132 {
|
|
00133 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper"</span>,this->nick);
|
|
00134 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j =0; j < ConfValueEnum(<span class="stringliteral">"type"</span>,&config_f); j++)
|
|
00135 {
|
|
00136 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"name"</span>,j,TypeName,&config_f);
|
|
00137 <span class="keywordflow">if</span> (!strcmp(TypeName,this->oper))
|
|
00138 {
|
|
00139 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper of type '%s'"</span>,this->nick,this->oper);
|
|
00140 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"classes"</span>,j,Classes,&config_f);
|
|
00141 <span class="keywordtype">char</span>* myclass = strtok_r(Classes,<span class="stringliteral">" "</span>,&savept);
|
|
00142 <span class="keywordflow">while</span> (myclass)
|
|
00143 {
|
|
00144 log(DEBUG,<span class="stringliteral">"*** HasPermission: checking classtype '%s'"</span>,myclass);
|
|
00145 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> k =0; k < ConfValueEnum(<span class="stringliteral">"class"</span>,&config_f); k++)
|
|
00146 {
|
|
00147 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"name"</span>,k,ClassName,&config_f);
|
|
00148 <span class="keywordflow">if</span> (!strcmp(ClassName,myclass))
|
|
00149 {
|
|
00150 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"commands"</span>,k,CommandList,&config_f);
|
|
00151 log(DEBUG,<span class="stringliteral">"*** HasPermission: found class named %s with commands: '%s'"</span>,ClassName,CommandList);
|
|
00152
|
|
00153
|
|
00154 mycmd = strtok_r(CommandList,<span class="stringliteral">" "</span>,&savept2);
|
|
00155 <span class="keywordflow">while</span> (mycmd)
|
|
00156 {
|
|
00157 <span class="keywordflow">if</span> (!strcasecmp(mycmd,command))
|
|
00158 {
|
|
00159 log(DEBUG,<span class="stringliteral">"*** Command %s found, returning true"</span>,command);
|
|
00160 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
00161 }
|
|
00162 mycmd = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept2);
|
|
00163 }
|
|
00164 }
|
|
00165 }
|
|
00166 myclass = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept);
|
|
00167 }
|
|
00168 }
|
|
00169 }
|
|
00170 }
|
|
00171 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
00172 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a5" doxytag="userrec::InviteTo"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void userrec::InviteTo </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">char * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Adds a channel to a users invite list (invites them to a channel).
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00094">94</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00039">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00114">invites</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00095 {
|
|
00096 <a class="code" href="classInvited.html">Invited</a> i;
|
|
00097 strlcpy(i.<a class="code" href="classInvited.html#o0">channel</a>,channel,CHANMAX);
|
|
00098 <a class="code" href="classuserrec.html#r0">invites</a>.push_back(i);
|
|
00099 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a4" doxytag="userrec::IsInvited"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> bool userrec::IsInvited </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">char * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns true if a user is invited to a channel.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00075">75</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="users_8h-source.html#l00114">invites</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00076 {
|
|
00077 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#r0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#r0">invites</a>.end(); i++)
|
|
00078 {
|
|
00079 <span class="keywordflow">if</span> (i->channel) {
|
|
00080 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel))
|
|
00081 {
|
|
00082 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
00083 }
|
|
00084 }
|
|
00085 }
|
|
00086 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
00087 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a6" doxytag="userrec::RemoveInvite"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void userrec::RemoveInvite </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">char * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Removes a channel from a users invite list.
|
|
<p>
|
|
This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00101">101</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00114">invites</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00102 {
|
|
00103 log(DEBUG,<span class="stringliteral">"Removing invites"</span>);
|
|
00104 <span class="keywordflow">if</span> (channel)
|
|
00105 {
|
|
00106 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#r0">invites</a>.size())
|
|
00107 {
|
|
00108 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#r0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#r0">invites</a>.end(); i++)
|
|
00109 {
|
|
00110 <span class="keywordflow">if</span> (i->channel)
|
|
00111 {
|
|
00112 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel))
|
|
00113 {
|
|
00114 <a class="code" href="classuserrec.html#r0">invites</a>.erase(i);
|
|
00115 <span class="keywordflow">return</span>;
|
|
00116 }
|
|
00117 }
|
|
00118 }
|
|
00119 }
|
|
00120 }
|
|
00121 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a12" doxytag="userrec::SetWriteError"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void userrec::SetWriteError </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">std::string </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>error</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Sets the write error for a connection.
|
|
<p>
|
|
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.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8cpp-source.html#l00269">269</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
|
|
<p>
|
|
References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00210">WriteError</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00175">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00231">AddWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00247">FlushWriteBuf()</a>.
|
|
<p>
|
|
<div class="fragment"><pre>00270 {
|
|
00271 log(DEBUG,<span class="stringliteral">"Setting error string for %s to '%s'"</span>,this->nick,error.c_str());
|
|
00272 <span class="comment">// don't try to set the error twice, its already set take the first string.</span>
|
|
00273 <span class="keywordflow">if</span> (this-><a class="code" href="classuserrec.html#o20">WriteError</a> == <span class="stringliteral">""</span>)
|
|
00274 this-><a class="code" href="classuserrec.html#o20">WriteError</a> = error;
|
|
00275 }
|
|
</pre></div> </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Data Documentation</h2>
|
|
<a name="o7" doxytag="userrec::awaymsg"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o7">userrec::awaymsg</a>[512]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The user's away message.
|
|
<p>
|
|
If this string is empty, the user is not marked as away.
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o5" doxytag="userrec::chans"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> <a class="el" href="classucrec.html">ucrec</a> <a class="el" href="classuserrec.html#o5">userrec::chans</a>[MAXCHANS]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="modules_8cpp-source.html#l00629">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o2" doxytag="userrec::dhost"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o2">userrec::dhost</a>[160]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The host displayed to non-opers (used for cloaking etc).
|
|
<p>
|
|
This usually matches the value of <a class="el" href="classconnection.html#o1">userrec::host</a>.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00130">130</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o12" doxytag="userrec::dns_done"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> bool <a class="el" href="classuserrec.html#o12">userrec::dns_done</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
True when <a class="el" href="classDNS.html">DNS</a> lookups are completed.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00179">179</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o9" doxytag="userrec::flood"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> int <a class="el" href="classuserrec.html#o9">userrec::flood</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
|
|
<p>
|
|
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o3" doxytag="userrec::fullname"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o3">userrec::fullname</a>[128]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The users full name.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00134">134</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o1" doxytag="userrec::ident"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o1">userrec::ident</a>[16]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The users ident reply.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00125">125</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00069">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00629">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00610">Server::UserToPseudo()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="r0" doxytag="userrec::invites"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> <a class="el" href="users_8h.html#a6">InvitedList</a> <a class="el" href="classuserrec.html#r0">userrec::invites</a><code> [private]</code>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
A list of channels the user has a pending invite to.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00114">114</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00089">GetInviteList()</a>, <a class="el" href="users_8cpp-source.html#l00094">InviteTo()</a>, <a class="el" href="users_8cpp-source.html#l00075">IsInvited()</a>, <a class="el" href="users_8cpp-source.html#l00101">RemoveInvite()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o17" doxytag="userrec::lines_in"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> int <a class="el" href="classuserrec.html#o17">userrec::lines_in</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Flood counters.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00204">204</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o4" doxytag="userrec::modes"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o4">userrec::modes</a>[MAXBUF]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The user's mode string.
|
|
<p>
|
|
This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00140">140</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o0" doxytag="userrec::nick"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o0">userrec::nick</a>[NICKMAX]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The users nickname.
|
|
<p>
|
|
An invalid nickname indicates an unregistered connection prior to the NICK command.
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="modules_8cpp-source.html#l00896">ConfigReader::DumpErrors()</a>, <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00069">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00629">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o11" doxytag="userrec::oper"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o11">userrec::oper</a>[NICKMAX]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The oper type they logged in as, if they are an oper.
|
|
<p>
|
|
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.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00175">175</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o14" doxytag="userrec::password"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o14">userrec::password</a>[MAXBUF]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Password specified by the user when they registered.
|
|
<p>
|
|
This is stored even if the block doesnt need a password, so that modules may check it.
|
|
<p>
|
|
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>
|
|
</tr>
|
|
</table>
|
|
<a name="o13" doxytag="userrec::pingmax"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> unsigned int <a class="el" href="classuserrec.html#o13">userrec::pingmax</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Number of seconds between PINGs for this user (set from <connect:allow> tag.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00183">183</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o15" doxytag="userrec::recvq"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o15">userrec::recvq</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
User's receive queue.
|
|
<p>
|
|
Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00175">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00201">BufferIsReady()</a>, <a class="el" href="users_8cpp-source.html#l00209">ClearBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00214">GetBuffer()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o22" doxytag="userrec::recvqmax"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o22">userrec::recvqmax</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Maximum size this user's recvq can become.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00218">218</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00175">AddBuffer()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o18" doxytag="userrec::reset_due"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> time_t <a class="el" href="classuserrec.html#o18">userrec::reset_due</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00205">205</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o8" doxytag="userrec::result"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o8">userrec::result</a>[256]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Stores the result of the last GetFullHost or GetRealHost call.
|
|
<p>
|
|
You may use this to increase the speed of use of this class.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00156">156</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00069">GetFullRealHost()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o16" doxytag="userrec::sendq"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o16">userrec::sendq</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
User's send queue.
|
|
<p>
|
|
Lines waiting to be sent are stored here until their buffer is flushed.
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00200">200</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00231">AddWriteBuf()</a>, <a class="el" href="users_8cpp-source.html#l00247">FlushWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o21" doxytag="userrec::sendqmax"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o21">userrec::sendqmax</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Maximum size this user's sendq can become.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00214">214</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00231">AddWriteBuf()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o6" doxytag="userrec::server"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o6">userrec::server</a>[256]
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The server the user is connected to.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="users_8h-source.html#l00146">146</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o19" doxytag="userrec::threshold"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o19">userrec::threshold</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
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>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o10" doxytag="userrec::timeout"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> unsigned int <a class="el" href="classuserrec.html#o10">userrec::timeout</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
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.
|
|
<p>
|
|
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00029">userrec()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="o20" doxytag="userrec::WriteError"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o20">userrec::WriteError</a>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
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>.
|
|
<p>
|
|
Referenced by <a class="el" href="users_8cpp-source.html#l00277">GetWriteError()</a>, and <a class="el" href="users_8cpp-source.html#l00269">SetWriteError()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following files:<ul>
|
|
<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>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Sun May 15 17:03:51 2005 for InspIRCd by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
|
|
</a>1.3.3 </small></address>
|
|
</body>
|
|
</html>
|