From 956328e80741c88cdae6d98b07be4171c98f4e26 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 30 May 2005 05:23:22 +0000 Subject: Added docs for base: BoolSet git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1565 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 762 ++++++++++++++++++-------------------- 1 file changed, 366 insertions(+), 396 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index e67ee6fd5..c96dc5009 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -18,8 +18,8 @@ Inheritance diagram for userrec:

[legend]
Collaboration diagram for userrec:

Collaboration graph
- - + +
[legend]
List of all members. @@ -83,68 +83,65 @@ Inheritance diagram for userrec:

char 
- + - + - + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + - + - + - + + - - - - + @@ -185,32 +182,31 @@ Definition at line 108 of f

-Definition at line 31 of file users.cpp. +Definition at line 32 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, 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. +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, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, sendq, server, ServerName, connection::signon, TIME, timeout, and ucrec::uc_modes.

-

00032 {
-00033         // the PROPER way to do it, AVOID bzero at *ALL* costs
-00034         strcpy(nick,"");
-00035         strcpy(ip,"127.0.0.1");
-00036         timeout = 0;
-00037         strcpy(ident,"");
-00038         strcpy(host,"");
-00039         strcpy(dhost,"");
-00040         strcpy(fullname,"");
-00041         strcpy(modes,"");
-00042         strcpy(server,"");
-00043         strcpy(awaymsg,"");
-00044         strcpy(oper,"");
-00045         reset_due = TIME;
-00046         lines_in = 0;
-00047         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00048         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00049         haspassed = false;
-00050         dns_done = false;
-00051         recvq = "";
-00052         sendq = "";
-00053         strcpy(result,"");
+
00033 {
+00034         // the PROPER way to do it, AVOID bzero at *ALL* costs
+00035         strcpy(nick,"");
+00036         strcpy(ip,"127.0.0.1");
+00037         timeout = 0;
+00038         strcpy(ident,"");
+00039         strcpy(host,"");
+00040         strcpy(dhost,"");
+00041         strcpy(fullname,"");
+00042         strcpy(modes,"");
+00043         server = (char*)FindServerNamePtr(ServerName);
+00044         strcpy(awaymsg,"");
+00045         strcpy(oper,"");
+00046         reset_due = TIME;
+00047         lines_in = 0;
+00048         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
+00049         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
+00050         haspassed = false;
+00051         dns_done = false;
+00052         recvq = "";
+00053         sendq = "";
 00054         for (int i = 0; i < MAXCHANS; i++)
 00055         {
 00056                 this->chans[i].channel = NULL;
@@ -248,9 +244,9 @@ References awaymsg, 
 
 

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

-

00222 {  }
+
00221 {  }
 
nick [NICKMAX]
 The users nickname.

char ident [16]
char ident [IDENTMAX+2]
 The users ident reply.

char dhost [160]
 The host displayed to non-opers (used for cloaking etc).

char fullname [128]
char fullname [MAXGECOS+1]
 The users full name.

char modes [MAXBUF]
char modes [54]
 The user's mode string.

ucrec chans [MAXCHANS]
char server [256]
char * server
 The server the user is connected to.

char awaymsg [512]
char awaymsg [MAXAWAY+1]
 The user's away message.

char result [256]
int flood
 Stores the result of the last GetFullHost or GetRealHost call.

int flood
 Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.

unsigned int timeout
 Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.

unsigned int timeout
 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.

char oper [NICKMAX]
 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.

char oper [NICKMAX]
 The oper type they logged in as, if they are an oper.

bool dns_done
 The oper type they logged in as, if they are an oper.

bool dns_done
 True when DNS lookups are completed.

unsigned int pingmax
 True when DNS lookups are completed.

unsigned int pingmax
 Number of seconds between PINGs for this user (set from <connect:allow> tag.

char password [MAXBUF]
 Number of seconds between PINGs for this user (set from <connect:allow> tag.

char password [MAXBUF]
 Password specified by the user when they registered.

std::string recvq
 Password specified by the user when they registered.

std::string recvq
 User's receive queue.

std::string sendq
 User's receive queue.

std::string sendq
 User's send queue.

int lines_in
 User's send queue.

int lines_in
 Flood counters.

time_t reset_due
 Flood counters.

time_t reset_due
long threshold
long threshold
std::string WriteError
std::string WriteError
long sendqmax
long sendqmax
 Maximum size this user's sendq can become.

long recvqmax
 Maximum size this user's sendq can become.

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

 Maximum size this user's recvq can become.


Private Attributes

InvitedList invites
@@ -285,34 +281,34 @@ 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 190 of file users.cpp. -

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

-

00191 {
-00192         std::string b = "";
-00193         for (int i = 0; i < a.length(); i++)
-00194                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
-00195                         b = b + a[i];
-00196         std::stringstream stream(recvq);
-00197         stream << b;
-00198         recvq = stream.str();
-00199         int i = 0;
-00200         // count the size of the first line in the buffer.
-00201         while (i < recvq.length())
-00202         {
-00203                 if (recvq[i++] == '\n')
-00204                         break;
-00205         }
-00206         if (recvq.length() > this->recvqmax)
-00207         {
-00208                 this->SetWriteError("RecvQ exceeded");
-00209                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
-00210         }
-00211         // return false if we've had more than 600 characters WITHOUT
-00212         // a carriage return (this is BAD, drop the socket)
-00213         return (i < 600);
-00214 }
+Definition at line 192 of file users.cpp.
+

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

+

00193 {
+00194         std::string b = "";
+00195         for (int i = 0; i < a.length(); i++)
+00196                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
+00197                         b = b + a[i];
+00198         std::stringstream stream(recvq);
+00199         stream << b;
+00200         recvq = stream.str();
+00201         int i = 0;
+00202         // count the size of the first line in the buffer.
+00203         while (i < recvq.length())
+00204         {
+00205                 if (recvq[i++] == '\n')
+00206                         break;
+00207         }
+00208         if (recvq.length() > this->recvqmax)
+00209         {
+00210                 this->SetWriteError("RecvQ exceeded");
+00211                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
+00212         }
+00213         // return false if we've had more than 600 characters WITHOUT
+00214         // a carriage return (this is BAD, drop the socket)
+00215         return (i < 600);
+00216 }
 
@@ -346,23 +342,23 @@ 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 246 of file users.cpp. -

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

-

00247 {
-00248         if (this->GetWriteError() != "")
-00249                 return;
-00250         if (sendq.length() + data.length() > this->sendqmax)
-00251         {
-00252                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
-00253                 this->SetWriteError("SendQ exceeded");
-00254                 return;
-00255         }
-00256         std::stringstream stream;
-00257         stream << sendq << data;
-00258         sendq = stream.str();
-00259 }
+Definition at line 248 of file users.cpp.
+

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

+

00249 {
+00250         if (this->GetWriteError() != "")
+00251                 return;
+00252         if (sendq.length() + data.length() > this->sendqmax)
+00253         {
+00254                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
+00255                 this->SetWriteError("SendQ exceeded");
+00256                 return;
+00257         }
+00258         std::stringstream stream;
+00259         stream << sendq << data;
+00260         sendq = stream.str();
+00261 }
 
@@ -395,16 +391,16 @@ This method returns true if the buffer contains at least one carriage return cha

one complete line may be read)

-Definition at line 216 of file users.cpp. +Definition at line 218 of file users.cpp.

-References recvq. +References recvq.

-

00217 {
-00218         for (int i = 0; i < recvq.length(); i++)
-00219                 if (recvq[i] == '\n')
-00220                         return true;
-00221         return false;
-00222 }
+
00219 {
+00220         for (int i = 0; i < recvq.length(); i++)
+00221                 if (recvq[i] == '\n')
+00222                         return true;
+00223         return false;
+00224 }
 
@@ -437,15 +433,15 @@ This function clears the entire buffer by setting it to an empty string.

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

-References recvq. +References recvq.

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

-

00225 {
-00226         recvq = "";
-00227 }
+
00227 {
+00228         recvq = "";
+00229 }
 
@@ -516,30 +512,30 @@ 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.

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

-References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). -

-

00263 {
-00264         if (sendq.length())
-00265         {
-00266                 char* tb = (char*)this->sendq.c_str();
-00267                 int n_sent = write(this->fd,tb,this->sendq.length());
-00268                 if (n_sent == -1)
-00269                 {
-00270                         this->SetWriteError(strerror(errno));
-00271                 }
-00272                 else
-00273                 {
-00274                         // advance the queue
-00275                         tb += n_sent;
-00276                         this->sendq = tb;
-00277                         // update the user's stats counters
-00278                         this->bytes_out += n_sent;
-00279                         this->cmds_out++;
-00280                 }
-00281         }
-00282 }
+Definition at line 264 of file users.cpp.
+

+References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). +

+

00265 {
+00266         if (sendq.length())
+00267         {
+00268                 char* tb = (char*)this->sendq.c_str();
+00269                 int n_sent = write(this->fd,tb,this->sendq.length());
+00270                 if (n_sent == -1)
+00271                 {
+00272                         this->SetWriteError(strerror(errno));
+00273                 }
+00274                 else
+00275                 {
+00276                         // advance the queue
+00277                         tb += n_sent;
+00278                         this->sendq = tb;
+00279                         // update the user's stats counters
+00280                         this->bytes_out += n_sent;
+00281                         this->cmds_out++;
+00282                 }
+00283         }
+00284 }
 
@@ -572,25 +568,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 229 of file users.cpp. -

-References recvq. -

-

00230 {
-00231         if (recvq == "")
-00232                 return "";
-00233         char* line = (char*)recvq.c_str();
-00234         std::string ret = "";
-00235         while ((*line != '\n') && (strlen(line)))
-00236         {
-00237                 ret = ret + *line;
-00238                 line++;
-00239         }
-00240         if ((*line == '\n') || (*line == '\r'))
-00241                 line++;
-00242         recvq = line;
-00243         return ret;
-00244 }
+Definition at line 231 of file users.cpp.
+

+References recvq. +

+

00232 {
+00233         if (recvq == "")
+00234                 return "";
+00235         char* line = (char*)recvq.c_str();
+00236         std::string ret = "";
+00237         while ((*line != '\n') && (strlen(line)))
+00238         {
+00239                 ret = ret + *line;
+00240                 line++;
+00241         }
+00242         if ((*line == '\n') || (*line == '\r'))
+00243                 line++;
+00244         recvq = line;
+00245         return ret;
+00246 }
 
@@ -625,12 +621,13 @@ Returns the full displayed host of the user This member function returns the hos

Definition at line 68 of file users.cpp.

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

00069 {
-00070         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00071         return result;
-00072 }
+00070         static char result[MAXBUF];
+00071         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00072         return result;
+00073 }
 
@@ -663,14 +660,15 @@ 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 84 of file users.cpp. +Definition at line 85 of file users.cpp.

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

-

00085 {
-00086         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
-00087         return result;
-00088 }
+
00086 {
+00087         static char fresult[MAXBUF];
+00088         snprintf(fresult,MAXBUF,"%s!%s@%s",nick,ident,host);
+00089         return fresult;
+00090 }
 
@@ -703,13 +701,13 @@ Returns the list of channels this user has been invited to but has not yet joine

-Definition at line 104 of file users.cpp. +Definition at line 106 of file users.cpp.

References InvitedList, and invites.

-

00105 {
-00106         return &invites;
-00107 }
+
00107 {
+00108         return &invites;
+00109 }
 
@@ -742,15 +740,15 @@ Returns the write error which last occured on this connection or an empty string

-Definition at line 292 of file users.cpp. +Definition at line 294 of file users.cpp.

-References WriteError. +References WriteError.

-Referenced by AddWriteBuf(). +Referenced by AddWriteBuf().

-

00293 {
-00294         return this->WriteError;
-00295 }
+
00295 {
+00296         return this->WriteError;
+00297 }
 
@@ -782,61 +780,61 @@ Referenced by AddWriteBuf() 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. +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 138 of file users.cpp. +Definition at line 140 of file users.cpp.

References config_f, and DEBUG.

-

00139 {
-00140         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
-00141         char* mycmd;
-00142         char* savept;
-00143         char* savept2;
-00144         
-00145         // are they even an oper at all?
-00146         if (strchr(this->modes,'o'))
-00147         {
-00148                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
-00149                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
-00150                 {
-00151                         ConfValue("type","name",j,TypeName,&config_f);
-00152                         if (!strcmp(TypeName,this->oper))
-00153                         {
-00154                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
-00155                                 ConfValue("type","classes",j,Classes,&config_f);
-00156                                 char* myclass = strtok_r(Classes," ",&savept);
-00157                                 while (myclass)
-00158                                 {
-00159                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
-00160                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
-00161                                         {
-00162                                                 ConfValue("class","name",k,ClassName,&config_f);
-00163                                                 if (!strcmp(ClassName,myclass))
-00164                                                 {
-00165                                                         ConfValue("class","commands",k,CommandList,&config_f);
-00166                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
-00167                                                         
-00168                                                         
-00169                                                         mycmd = strtok_r(CommandList," ",&savept2);
-00170                                                         while (mycmd)
-00171                                                         {
-00172                                                                 if (!strcasecmp(mycmd,command))
-00173                                                                 {
-00174                                                                         log(DEBUG,"*** Command %s found, returning true",command);
-00175                                                                         return true;
-00176                                                                 }
-00177                                                                 mycmd = strtok_r(NULL," ",&savept2);
-00178                                                         }
-00179                                                 }
-00180                                         }
-00181                                         myclass = strtok_r(NULL," ",&savept);
-00182                                 }
-00183                         }
-00184                 }
-00185         }
-00186         return false;
-00187 }
+
00141 {
+00142         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
+00143         char* mycmd;
+00144         char* savept;
+00145         char* savept2;
+00146         
+00147         // are they even an oper at all?
+00148         if (strchr(this->modes,'o'))
+00149         {
+00150                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
+00151                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
+00152                 {
+00153                         ConfValue("type","name",j,TypeName,&config_f);
+00154                         if (!strcmp(TypeName,this->oper))
+00155                         {
+00156                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
+00157                                 ConfValue("type","classes",j,Classes,&config_f);
+00158                                 char* myclass = strtok_r(Classes," ",&savept);
+00159                                 while (myclass)
+00160                                 {
+00161                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
+00162                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
+00163                                         {
+00164                                                 ConfValue("class","name",k,ClassName,&config_f);
+00165                                                 if (!strcmp(ClassName,myclass))
+00166                                                 {
+00167                                                         ConfValue("class","commands",k,CommandList,&config_f);
+00168                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
+00169                                                         
+00170                                                         
+00171                                                         mycmd = strtok_r(CommandList," ",&savept2);
+00172                                                         while (mycmd)
+00173                                                         {
+00174                                                                 if (!strcasecmp(mycmd,command))
+00175                                                                 {
+00176                                                                         log(DEBUG,"*** Command %s found, returning true",command);
+00177                                                                         return true;
+00178                                                                 }
+00179                                                                 mycmd = strtok_r(NULL," ",&savept2);
+00180                                                         }
+00181                                                 }
+00182                                         }
+00183                                         myclass = strtok_r(NULL," ",&savept);
+00184                                 }
+00185                         }
+00186                 }
+00187         }
+00188         return false;
+00189 }
 
@@ -870,15 +868,15 @@ Adds a channel to a users invite list (invites them to a channel).

-Definition at line 109 of file users.cpp. +Definition at line 111 of file users.cpp.

References Invited::channel, and invites.

-

00110 {
-00111         Invited i;
-00112         strlcpy(i.channel,channel,CHANMAX);
-00113         invites.push_back(i);
-00114 }
+
00112 {
+00113         Invited i;
+00114         strlcpy(i.channel,channel,CHANMAX);
+00115         invites.push_back(i);
+00116 }
 
@@ -912,22 +910,22 @@ Returns true if a user is invited to a channel.

-Definition at line 90 of file users.cpp. +Definition at line 92 of file users.cpp.

References invites.

-

00091 {
-00092         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00093         {
-00094                 if (i->channel) {
-00095                         if (!strcasecmp(i->channel,channel))
-00096                         {
-00097                                 return true;
-00098                         }
-00099                 }
-00100         }
-00101         return false;
-00102 }
+
00093 {
+00094         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00095         {
+00096                 if (i->channel) {
+00097                         if (!strcasecmp(i->channel,channel))
+00098                         {
+00099                                 return true;
+00100                         }
+00101                 }
+00102         }
+00103         return false;
+00104 }
 
@@ -970,17 +968,17 @@ Calls read() to read some data for this user using their fd.

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

References connection::fd.

-

00075 {
-00076         if (this->fd > -1)
-00077         {
-00078                 return read(this->fd, buffer, size);
-00079         }
-00080         else return 0;
-00081 }
+
00076 {
+00077         if (this->fd > -1)
+00078         {
+00079                 return read(this->fd, buffer, size);
+00080         }
+00081         else return 0;
+00082 }
 
@@ -1014,30 +1012,30 @@ 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 116 of file users.cpp. +Definition at line 118 of file users.cpp.

References DEBUG, and invites.

-

00117 {
-00118         log(DEBUG,"Removing invites");
-00119         if (channel)
-00120         {
-00121                 if (invites.size())
-00122                 {
-00123                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00124                         {
-00125                                 if (i->channel)
-00126                                 {
-00127                                         if (!strcasecmp(i->channel,channel))
-00128                                         {
-00129                                                 invites.erase(i);
-00130                                                 return;
-00131                                         }
-00132                                 }
-00133                         }
-00134                 }
-00135         }
-00136 }
+
00119 {
+00120         log(DEBUG,"Removing invites");
+00121         if (channel)
+00122         {
+00123                 if (invites.size())
+00124                 {
+00125                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00126                         {
+00127                                 if (i->channel)
+00128                                 {
+00129                                         if (!strcasecmp(i->channel,channel))
+00130                                         {
+00131                                                 invites.erase(i);
+00132                                                 return;
+00133                                         }
+00134                                 }
+00135                         }
+00136                 }
+00137         }
+00138 }
 
@@ -1071,18 +1069,18 @@ 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 284 of file users.cpp. +Definition at line 286 of file users.cpp.

-References DEBUG, and WriteError. +References DEBUG, and WriteError.

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

-

00285 {
-00286         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
-00287         // don't try to set the error twice, its already set take the first string.
-00288         if (this->WriteError == "")
-00289                 this->WriteError = error;
-00290 }
+
00287 {
+00288         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
+00289         // don't try to set the error twice, its already set take the first string.
+00290         if (this->WriteError == "")
+00291                 this->WriteError = error;
+00292 }
 
@@ -1093,7 +1091,7 @@ Referenced by AddBuffer() -
char userrec::awaymsg[512] + char userrec::awaymsg[MAXAWAY+1]
@@ -1110,9 +1108,9 @@ The user's away message.

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

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

-Referenced by userrec(). +Referenced by userrec().

@@ -1136,9 +1134,9 @@ Referenced by userrec().

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

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

@@ -1164,18 +1162,18 @@ The host displayed to non-opers (used for cloaking etc).

This usually matches the value of userrec::host.

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

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

+

@@ -1192,18 +1190,18 @@ True when DNS lookups are completed.

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

-Referenced by userrec(). +Referenced by userrec().

-
bool userrec::dns_done + bool userrec::dns_done
-

+

@@ -1220,9 +1218,9 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi

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

-Referenced by userrec(). +Referenced by userrec().

-
int userrec::flood + int userrec::flood

@@ -1231,7 +1229,7 @@ Referenced by userrec(). -
char userrec::fullname[128] + char userrec::fullname[MAXGECOS+1]
@@ -1248,9 +1246,9 @@ The users full name.

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

-Referenced by userrec(). +Referenced by userrec().

@@ -1259,7 +1257,7 @@ Referenced by userrec(). -
char userrec::ident[16] + char userrec::ident[IDENTMAX+2]
@@ -1274,11 +1272,11 @@ Referenced by userrec().

The users ident reply.

- +Two characters are added to the user-defined limit to compensate for the tilde etc.

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

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

@@ -1306,16 +1304,16 @@ A list of channels the user has a pending invite to.

Definition at line 114 of file users.h.

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

+

@@ -1332,9 +1330,9 @@ Flood counters.

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

-Referenced by userrec(). +Referenced by userrec().

-
int userrec::lines_in + int userrec::lines_in

@@ -1343,7 +1341,7 @@ Referenced by userrec(). -
char userrec::modes[MAXBUF] + char userrec::modes[54]
@@ -1358,11 +1356,11 @@ Referenced by userrec().

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. +This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. it is limited to length 54, as there can only be a maximum of 52 user modes (26 upper, 26 lower case) a null terminating char, and an optional + character.

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

-Referenced by userrec(). +Referenced by userrec().

@@ -1390,16 +1388,16 @@ An invalid nickname indicates an unregistered connection prior to the NICK comma

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(). -

+

@@ -1416,18 +1414,18 @@ 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 175 of file users.h. +Definition at line 174 of file users.h.

-Referenced by userrec(). +Referenced by userrec().

-
char userrec::oper[NICKMAX] + char userrec::oper[NICKMAX]
-

+

@@ -1444,16 +1442,16 @@ 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 189 of file users.h. +Definition at line 188 of file users.h.

-
char userrec::password[MAXBUF] + char userrec::password[MAXBUF]
-

+

@@ -1470,16 +1468,16 @@ Number of seconds between PINGs for this user (set from <connect:allow> ta

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

-
unsigned int userrec::pingmax + unsigned int userrec::pingmax
-

+

@@ -1496,18 +1494,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 195 of file users.h. +Definition at line 194 of file users.h.

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

-
std::string userrec::recvq + std::string userrec::recvq
-

+

@@ -1524,18 +1522,18 @@ Maximum size this user's recvq can become.

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

-Referenced by AddBuffer(). +Referenced by AddBuffer().

-
long userrec::recvqmax + long userrec::recvqmax
-

+

@@ -1550,46 +1548,18 @@ Referenced by AddBuffer()

-Definition at line 205 of file users.h. -

-Referenced by userrec(). - -

-
time_t userrec::reset_due + time_t userrec::reset_due
-

- - - - -
- - -
char userrec::result[256] -
-
- - - - +Referenced by userrec().
-   - - -

-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 156 of file users.h. +Definition at line 204 of file users.h.

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

-

+

@@ -1606,18 +1576,18 @@ 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. +Definition at line 199 of file users.h.

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

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

+

@@ -1634,9 +1604,9 @@ Maximum size this user's sendq can become.

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

-Referenced by AddWriteBuf(). +Referenced by AddWriteBuf().

-
long userrec::sendqmax + long userrec::sendqmax

@@ -1645,7 +1615,7 @@ Referenced by AddWriteBuf() -
char userrec::server[256] + char* userrec::server
@@ -1662,18 +1632,18 @@ The server the user is connected to.

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

-Referenced by userrec(). +Referenced by userrec(). -

+

@@ -1688,16 +1658,16 @@ Referenced by userrec().

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

-
long userrec::threshold + long userrec::threshold
-

+

@@ -1714,18 +1684,18 @@ Number of seconds this user is given to send USER/NICK If they do not send their

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

-Referenced by userrec(). +Referenced by userrec().

-
unsigned int userrec::timeout + unsigned int userrec::timeout
-

+

@@ -1740,14 +1710,14 @@ Referenced by userrec().

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

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

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


The documentation for this class was generated from the following files: -
Generated on Wed May 25 22:03:30 2005 for InspIRCd by +
Generated on Mon May 30 05:17:43 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91