From a266dadd1351d10b56ec187c7b6f7af75350ed68 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 12 May 2005 02:26:05 +0000 Subject: Documented new recvq and sendq stuff git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1367 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 759 +++++++++++++++++++++++++++----------- 1 file changed, 545 insertions(+), 214 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 16ad17d03..a1d605b1b 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -49,6 +49,18 @@ Inherits connection. std::string GetBuffer ()  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.

+void SetWriteError (std::string error) + + Sets the write error for a connection.

+std::string GetWriteError () + + Returns the write error which last occured on this connection or an empty string if none occured.

+void AddWriteBuf (std::string data) + + Adds to the user's write buffer.

+void FlushWriteBuf () + + Flushes as much of the user's buffer to the file descriptor as possible.


Public Attributes

char nick [NICKMAX] @@ -97,13 +109,24 @@ Inherits connection. std::string recvq  User's receive queue.

-long lines_in +std::string sendq + + User's send queue.

+long lines_in + + Flood counters.

+time_t reset_due + +long threshold + +std::string WriteError - Flood counters.

-time_t reset_due +long sendqmax -long threshold + Maximum size this user's sendq can become.

+long recvqmax + Maximum size this user's recvq can become.


Private Attributes

InvitedList invites @@ -116,7 +139,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 98 of file users.h.

Constructor & Destructor Documentation

+Definition at line 108 of file users.h.

Constructor & Destructor Documentation

@@ -146,7 +169,7 @@ Definition at line 98 of fi

Definition at line 28 of file users.cpp.

-References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, server, connection::signon, TIME, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, sendq, server, connection::signon, TIME, timeout, and ucrec::uc_modes. 

00029 {
 00030         // the PROPER way to do it, AVOID bzero at *ALL* costs
@@ -162,21 +185,22 @@ References awaymsg, "");
 00041         strcpy(awaymsg,"");
 00042         strcpy(oper,"");
-00043         reset_due = TIME;
-00044         lines_in = 0;
+00043         reset_due = TIME;
+00044         lines_in = 0;
 00045         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
 00046         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
 00047         haspassed = false;
 00048         dns_done = false;
 00049         recvq = "";
-00050         strcpy(result,"");
-00051         for (int i = 0; i < MAXCHANS; i++)
-00052         {
-00053                 this->chans[i].channel = NULL;
-00054                 this->chans[i].uc_modes = 0;
-00055         }
-00056         invites.clear();
-00057 }
+00050         sendq = "";
+00051         strcpy(result,"");
+00052         for (int i = 0; i < MAXCHANS; i++)
+00053         {
+00054                 this->chans[i].channel = NULL;
+00055                 this->chans[i].uc_modes = 0;
+00056         }
+00057         invites.clear();
+00058 }
@@ -207,9 +231,9 @@ References awaymsg,

-Definition at line 195 of file users.h. +Definition at line 222 of file users.h.

-

00195 {  }
+
00222 {  }
 
    
   
 
@@ -244,29 +268,84 @@ This method adds data to the buffer of the user.
 

 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.
 

-Definition at line 169 of file users.cpp.
-

-References recvq.
-

-
00170 {
-00171         std::string b = "";
-00172         for (int i = 0; i < a.length(); i++)
-00173                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
-00174                         b = b + a[i];
-00175         std::stringstream stream(recvq);
-00176         stream << b;
-00177         recvq = stream.str();
-00178         int i = 0;
-00179         // count the size of the first line in the buffer.
-00180         while (i < recvq.length())
-00181         {
-00182                 if (recvq[i++] == '\n')
-00183                         break;
-00184         }
-00185         // return false if we've had more than 600 characters WITHOUT
-00186         // a carriage return (this is BAD, drop the socket)
-00187         return (i < 600);
-00188 }
+Definition at line 170 of file users.cpp.
+

+References recvq, recvqmax, and SetWriteError().
+

+
00171 {
+00172         std::string b = "";
+00173         for (int i = 0; i < a.length(); i++)
+00174                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
+00175                         b = b + a[i];
+00176         std::stringstream stream(recvq);
+00177         stream << b;
+00178         recvq = stream.str();
+00179         int i = 0;
+00180         // count the size of the first line in the buffer.
+00181         while (i < recvq.length())
+00182         {
+00183                 if (recvq[i++] == '\n')
+00184                         break;
+00185         }
+00186         if (recvq.length() > this->recvqmax)
+00187         {
+00188                 this->SetWriteError("RecvQ exceeded");
+00189                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
+00190         }
+00191         // return false if we've had more than 600 characters WITHOUT
+00192         // a carriage return (this is BAD, drop the socket)
+00193         return (i < 600);
+00194 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+
+      
 void userrec::AddWriteBuf ( std::string  data           ) 

+    

+
+  
+    
+    

+       
+    
+
+

+Adds to the user's write buffer. 
+

+You may add any amount of text up to this users sendq value, if you exceed the sendq value, SetWriteError() will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped.
+

+Definition at line 226 of file users.cpp.
+

+References GetWriteError(), sendq, sendqmax, and SetWriteError().
+

+
00227 {
+00228         if (this->GetWriteError() != "")
+00229                 return;
+00230         if (sendq.length() + data.length() > this->sendqmax)
+00231         {
+00232                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
+00233                 this->SetWriteError("SendQ exceeded");
+00234                 return;
+00235         }
+00236         std::stringstream stream;
+00237         stream << sendq << data;
+00238         sendq = stream.str();
+00239 }
 
    		
   

 

@@ -299,16 +378,16 @@ This method returns true if the buffer contains at least one carriage return cha
 

 one complete line may be read)
 

-Definition at line 190 of file users.cpp.
+Definition at line 196 of file users.cpp.
 

-References recvq.
+References recvq.
 

-
00191 {
-00192         for (int i = 0; i < recvq.length(); i++)
-00193                 if (recvq[i] == '\n')
-00194                         return true;
-00195         return false;
-00196 }
+
00197 {
+00198         for (int i = 0; i < recvq.length(); i++)
+00199                 if (recvq[i] == '\n')
+00200                         return true;
+00201         return false;
+00202 }
 
    
   
 
@@ -341,15 +420,71 @@ This function clears the entire buffer by setting it to an empty string.
 

 
 

-Definition at line 198 of file users.cpp.
+Definition at line 204 of file users.cpp.
+

+References recvq.
+

+Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
+

+
00205 {
+00206         recvq = "";
+00207 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+        
+
+      
 void userrec::FlushWriteBuf (            ) 

+    

+
+  
+    
+    

+       
+    
+
+

+Flushes as much of the user's buffer to the file descriptor as possible. 
+

+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.
 

-References recvq.
+Definition at line 242 of file users.cpp.
 

-Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
+References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError().
 

-
00199 {
-00200         recvq = "";
-00201 }
+
00243 {
+00244         if (sendq.length())
+00245         {
+00246                 char* tb = (char*)this->sendq.c_str();
+00247                 int n_sent = write(this->fd,tb,this->sendq.length());
+00248                 if (n_sent == -1)
+00249                 {
+00250                         this->SetWriteError(strerror(errno));
+00251                 }
+00252                 else
+00253                 {
+00254                         // advance the queue
+00255                         tb += n_sent;
+00256                         this->sendq = tb;
+00257                         // update the user's stats counters
+00258                         this->bytes_out += n_sent;
+00259                         this->cmds_out++;
+00260                 }
+00261         }
+00262 }
 
    

   

 

@@ -382,25 +517,25 @@ This method returns the first available string at the tail end of the buffer and
 

 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 BufferIsReady() to check if it is ok to read the buffer before calling GetBuffer().
 

-Definition at line 203 of file users.cpp.
-

-References recvq.
-

-
00204 {
-00205         if (recvq == "")
-00206                 return "";
-00207         char* line = (char*)recvq.c_str();
-00208         std::string ret = "";
-00209         while ((*line != '\n') && (strlen(line)))
-00210         {
-00211                 ret = ret + *line;
-00212                 line++;
-00213         }
-00214         if ((*line == '\n') || (*line == '\r'))
-00215                 line++;
-00216         recvq = line;
-00217         return ret;
-00218 }
+Definition at line 209 of file users.cpp.
+

+References recvq.
+

+
00210 {
+00211         if (recvq == "")
+00212                 return "";
+00213         char* line = (char*)recvq.c_str();
+00214         std::string ret = "";
+00215         while ((*line != '\n') && (strlen(line)))
+00216         {
+00217                 ret = ret + *line;
+00218                 line++;
+00219         }
+00220         if ((*line == '\n') || (*line == '\r'))
+00221                 line++;
+00222         recvq = line;
+00223         return ret;
+00224 }
 
    
   
 
@@ -433,14 +568,14 @@ Returns the full displayed host of the user This member function returns the hos
 

 
 

-Definition at line 61 of file users.cpp.
+Definition at line 62 of file users.cpp.
 

-References dhost, ident, nick, and result.
+References dhost, ident, nick, and result.
 

-
00062 {
-00063         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00064         return result;
-00065 }
+
00063 {
+00064         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00065         return result;
+00066 }
 
    
   
 
@@ -473,14 +608,55 @@ Returns the full real host of the user This member function returns the hostname
 

 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.
 

-Definition at line 68 of file users.cpp.
+Definition at line 69 of file users.cpp.
 

-References connection::host, ident, nick, and result.
+References connection::host, ident, nick, and result.
 

-
00069 {
-00070         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
-00071         return result;
-00072 }
+
00070 {
+00071         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00072         return result;
+00073 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+        
+
+      
 std::string userrec::GetWriteError (            ) 

+    

+
+  
+    
+    

+       
+    
+
+

+Returns the write error which last occured on this connection or an empty string if none occured. 
+

+
+

+Definition at line 272 of file users.cpp.
+

+References WriteError.
+

+Referenced by AddWriteBuf().
+

+
00273 {
+00274         return this->WriteError;
+00275 }
 
    		
   

 

@@ -514,59 +690,59 @@ Returns true or false for if a user can execute a privilaged oper command.
 

 This is done by looking up their oper type from userrec::oper, then referencing this to their oper classes and checking the commands they can execute.
 

-Definition at line 117 of file users.cpp.
+Definition at line 118 of file users.cpp.
 

 References config_f, and DEBUG.
 

-
00118 {
-00119         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
-00120         char* mycmd;
-00121         char* savept;
-00122         char* savept2;
-00123         
-00124         // are they even an oper at all?
-00125         if (strchr(this->modes,'o'))
-00126         {
-00127                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
-00128                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
-00129                 {
-00130                         ConfValue("type","name",j,TypeName,&config_f);
-00131                         if (!strcmp(TypeName,this->oper))
-00132                         {
-00133                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
-00134                                 ConfValue("type","classes",j,Classes,&config_f);
-00135                                 char* myclass = strtok_r(Classes," ",&savept);
-00136                                 while (myclass)
-00137                                 {
-00138                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
-00139                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
-00140                                         {
-00141                                                 ConfValue("class","name",k,ClassName,&config_f);
-00142                                                 if (!strcmp(ClassName,myclass))
-00143                                                 {
-00144                                                         ConfValue("class","commands",k,CommandList,&config_f);
-00145                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
-00146                                                         
+
00119 {
+00120         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
+00121         char* mycmd;
+00122         char* savept;
+00123         char* savept2;
+00124         
+00125         // are they even an oper at all?
+00126         if (strchr(this->modes,'o'))
+00127         {
+00128                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
+00129                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
+00130                 {
+00131                         ConfValue("type","name",j,TypeName,&config_f);
+00132                         if (!strcmp(TypeName,this->oper))
+00133                         {
+00134                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
+00135                                 ConfValue("type","classes",j,Classes,&config_f);
+00136                                 char* myclass = strtok_r(Classes," ",&savept);
+00137                                 while (myclass)
+00138                                 {
+00139                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
+00140                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
+00141                                         {
+00142                                                 ConfValue("class","name",k,ClassName,&config_f);
+00143                                                 if (!strcmp(ClassName,myclass))
+00144                                                 {
+00145                                                         ConfValue("class","commands",k,CommandList,&config_f);
+00146                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
 00147                                                         
-00148                                                         mycmd = strtok_r(CommandList," ",&savept2);
-00149                                                         while (mycmd)
-00150                                                         {
-00151                                                                 if (!strcasecmp(mycmd,command))
-00152                                                                 {
-00153                                                                         log(DEBUG,"*** Command %s found, returning true",command);
-00154                                                                         return true;
-00155                                                                 }
-00156                                                                 mycmd = strtok_r(NULL," ",&savept2);
-00157                                                         }
-00158                                                 }
-00159                                         }
-00160                                         myclass = strtok_r(NULL," ",&savept);
-00161                                 }
-00162                         }
-00163                 }
-00164         }
-00165         return false;
-00166 }
+00148                                                         
+00149                                                         mycmd = strtok_r(CommandList," ",&savept2);
+00150                                                         while (mycmd)
+00151                                                         {
+00152                                                                 if (!strcasecmp(mycmd,command))
+00153                                                                 {
+00154                                                                         log(DEBUG,"*** Command %s found, returning true",command);
+00155                                                                         return true;
+00156                                                                 }
+00157                                                                 mycmd = strtok_r(NULL," ",&savept2);
+00158                                                         }
+00159                                                 }
+00160                                         }
+00161                                         myclass = strtok_r(NULL," ",&savept);
+00162                                 }
+00163                         }
+00164                 }
+00165         }
+00166         return false;
+00167 }
 
    
   
 
@@ -600,15 +776,15 @@ Adds a channel to a users invite list (invites them to a channel).
 

 
 

-Definition at line 88 of file users.cpp.
+Definition at line 89 of file users.cpp.
 

-References Invited::channel, and invites.
+References Invited::channel, and invites.
 

-
00089 {
-00090         Invited i;
-00091         strlcpy(i.channel,channel,CHANMAX);
-00092         invites.push_back(i);
-00093 }
+
00090 {
+00091         Invited i;
+00092         strlcpy(i.channel,channel,CHANMAX);
+00093         invites.push_back(i);
+00094 }
 
    
   
 
@@ -642,22 +818,22 @@ Returns true if a user is invited to a channel.
 

 
 

-Definition at line 74 of file users.cpp.
+Definition at line 75 of file users.cpp.
 

-References invites.
+References invites.
 

-
00075 {
-00076         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00077         {
-00078                 if (i->channel) {
-00079                         if (!strcasecmp(i->channel,channel))
-00080                         {
-00081                                 return true;
-00082                         }
-00083                 }
-00084         }
-00085         return false;
-00086 }
+
00076 {
+00077         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00078         {
+00079                 if (i->channel) {
+00080                         if (!strcasecmp(i->channel,channel))
+00081                         {
+00082                                 return true;
+00083                         }
+00084                 }
+00085         }
+00086         return false;
+00087 }
 
    
   
 
@@ -691,30 +867,75 @@ Removes a channel from a users invite list.
 

 This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
 

-Definition at line 95 of file users.cpp.
-

-References DEBUG, and invites.
-

-
00096 {
-00097         log(DEBUG,"Removing invites");
-00098         if (channel)
-00099         {
-00100                 if (invites.size())
-00101                 {
-00102                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00103                         {
-00104                                 if (i->channel)
-00105                                 {
-00106                                         if (!strcasecmp(i->channel,channel))
-00107                                         {
-00108                                                 invites.erase(i);
-00109                                                 return;
-00110                                         }
-00111                                 }
-00112                         }
-00113                 }
-00114         }
-00115 }
+Definition at line 96 of file users.cpp.
+

+References DEBUG, and invites.
+

+
00097 {
+00098         log(DEBUG,"Removing invites");
+00099         if (channel)
+00100         {
+00101                 if (invites.size())
+00102                 {
+00103                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00104                         {
+00105                                 if (i->channel)
+00106                                 {
+00107                                         if (!strcasecmp(i->channel,channel))
+00108                                         {
+00109                                                 invites.erase(i);
+00110                                                 return;
+00111                                         }
+00112                                 }
+00113                         }
+00114                 }
+00115         }
+00116 }
+
    
+  
+
+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+          
+        
+
+      
 void userrec::SetWriteError ( std::string  error           ) 

+    

+
+  
+    
+    

+       
+    
+
+

+Sets the write error for a connection. 
+

+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.
+

+Definition at line 264 of file users.cpp.
+

+References DEBUG, and WriteError.
+

+Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf().
+

+
00265 {
+00266         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
+00267         // don't try to set the error twice, its already set take the first string.
+00268         if (this->WriteError == "")
+00269                 this->WriteError = error;
+00270 }
 
    		
   

 

@@ -742,7 +963,7 @@ The user's away message.
 

 If this string is empty, the user is not marked as away.
 

-Definition at line 141 of file users.h.
+Definition at line 151 of file users.h.
 

 Referenced by userrec().    
   
@@ -768,9 +989,9 @@ Referenced by userrec().
 

 
 

-Definition at line 132 of file users.h.
+Definition at line 142 of file users.h.
 

-Referenced by Server::PseudoToUser(), and userrec().    
+Referenced by Server::PseudoToUser(), and userrec().    
   
 
 

@@ -796,9 +1017,9 @@ The host displayed to non-opers (used for cloaking etc).
 

 This usually matches the value of userrec::host.
 

-Definition at line 120 of file users.h.
+Definition at line 130 of file users.h.
 

-Referenced by GetFullHost(), and userrec().    
+Referenced by GetFullHost(), and userrec().    
   
 
 

@@ -824,7 +1045,7 @@ True when DNS lookups are completed.
 

 
 

-Definition at line 169 of file users.h.
+Definition at line 179 of file users.h.
 

 Referenced by userrec().    
   
@@ -852,7 +1073,7 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi
 

 
 

-Definition at line 152 of file users.h.
+Definition at line 162 of file users.h.
 

 Referenced by userrec().    
   
@@ -880,7 +1101,7 @@ The users full name.
 

 
 

-Definition at line 124 of file users.h.
+Definition at line 134 of file users.h.
 

 Referenced by userrec().    
   
@@ -908,9 +1129,9 @@ The users ident reply.
 

 
 

-Definition at line 115 of file users.h.
+Definition at line 125 of file users.h.
 

-Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().    
+Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().    
   
 
 

@@ -936,18 +1157,18 @@ A list of channels the user has a pending invite to.
 

 
 

-Definition at line 104 of file users.h.
+Definition at line 114 of file users.h.
 

-Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().    
+Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().    
   
 
-

+

 
@@ -964,7 +1185,7 @@ Flood counters.
 

 
 

-Definition at line 189 of file users.h.
+Definition at line 204 of file users.h.
 

 Referenced by userrec().    
   
@@ -992,7 +1213,7 @@ The user's mode string.
 

 This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.
 

-Definition at line 130 of file users.h.
+Definition at line 140 of file users.h.
 

 Referenced by userrec().    
   
@@ -1020,9 +1241,9 @@ The users nickname.
 

 An invalid nickname indicates an unregistered connection prior to the NICK command.
 

-Definition at line 111 of file users.h.
+Definition at line 121 of file users.h.
 

-Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec().    
+Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec().    
   
 

   

     
       
-          

         
 long userrec::lines_in
+           long userrec::lines_in
       

     		
   

 

@@ -1048,7 +1269,7 @@ The oper type they logged in as, if they are an oper.
 

 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.
 

-Definition at line 165 of file users.h.
+Definition at line 175 of file users.h.
 

 Referenced by userrec().    
   
@@ -1076,7 +1297,7 @@ Password specified by the user when they registered.
 

 This is stored even if the  block doesnt need a password, so that modules may check it.
 

-Definition at line 179 of file users.h.    
+Definition at line 189 of file users.h.    
   
 
 

@@ -1102,7 +1323,7 @@ Number of seconds between PINGs for this user (set from <connect:allow> ta
 

 
 

-Definition at line 173 of file users.h.    
+Definition at line 183 of file users.h.    
   
 
 

@@ -1128,18 +1349,18 @@ User's receive queue.
 

 Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.
 

-Definition at line 185 of file users.h.
+Definition at line 195 of file users.h.
 

-Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec().    
+Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec().    
   
 
-

+

 
@@ -1152,9 +1373,37 @@ Referenced by AddBuffer()
+  
+

   

     
       
-          

         
 time_t userrec::reset_due
+           long userrec::recvqmax
       

     		
   

     

 
 

+Maximum size this user's recvq can become. 
+

 
 

-Definition at line 190 of file users.h.
+Definition at line 218 of file users.h.
+

+Referenced by AddBuffer().    

+

+
+  
+    
+  
+

+      
+        
+          
 time_t userrec::reset_due
+      

+    

+
+  
+    
+    
@@ -1182,9 +1431,65 @@ Stores the result of the last GetFullHost or GetRealHost call.
 

 You may use this to increase the speed of use of this class.
 

-Definition at line 146 of file users.h.
+Definition at line 156 of file users.h.
 

-Referenced by GetFullHost(), GetFullRealHost(), and userrec().    
+Referenced by GetFullHost(), GetFullRealHost(), and userrec().    
+  
+

+       
+    
+
+

+
+

+Definition at line 205 of file users.h.
 

 Referenced by userrec().    

   

+

+
+  
+    
+  
+

+      
+        
+          
 std::string userrec::sendq
+      

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+User's send queue. 
+

+Lines waiting to be sent are stored here until their buffer is flushed.
+

+Definition at line 200 of file users.h.
+

+Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec().    

+

+
+  
+    
+  
+

+      
+        
+          
 long userrec::sendqmax
+      

+    

+
+  
+    
+    

+       
+    
+
+

+Maximum size this user's sendq can become. 
+

+
+

+Definition at line 214 of file users.h.
+

+Referenced by AddWriteBuf().    

   

 

 

@@ -1210,18 +1515,18 @@ The server the user is connected to.
 

 
 

-Definition at line 136 of file users.h.
+Definition at line 146 of file users.h.
 

 Referenced by userrec().    
   
 
-

+

 
@@ -1236,7 +1541,7 @@ Referenced by userrec().
 

 
 

-Definition at line 191 of file users.h.    
+Definition at line 206 of file users.h.    
   
 

   

     
       
-          

         
 long userrec::threshold
+           long userrec::threshold
       

     		
   

 

@@ -1262,14 +1567,40 @@ Number of seconds this user is given to send USER/NICK If they do not send their
 

 
 

-Definition at line 158 of file users.h.
+Definition at line 168 of file users.h.
 

 Referenced by userrec().    
   
 
+

+
+  
+    
+  
+

+      
+        
+          
 std::string userrec::WriteError
+      

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+
+

+Definition at line 210 of file users.h.
+

+Referenced by GetWriteError(), and SetWriteError().    

 
The documentation for this class was generated from the following files:
-
Generated on Sat May 7 15:34:29 2005 for InspIRCd by
+
Generated on Thu May 12 02:25:29 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3