docs/man/man3/userrec.3

   1 .TH "userrec" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 userrec \- Holds all information about a user This class stores all information about a user connected to the irc server.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <users.h>\fP
  12 .PP
  13 Inherits \fBconnection\fP.
  14 .PP
  15 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBuserrec\fP ()"
  20 .br
  21 .ti -1c
  22 .RI "virtual \fB~userrec\fP ()"
  23 .br
  24 .ti -1c
  25 .RI "virtual char * \fBGetFullHost\fP ()"
  26 .br
  27 .RI "\fIReturns 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. \fP"
  28 .ti -1c
  29 .RI "virtual char * \fBGetFullRealHost\fP ()"
  30 .br
  31 .RI "\fIReturns 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. \fP"
  32 .ti -1c
  33 .RI "virtual bool \fBIsInvited\fP (char *channel)"
  34 .br
  35 .RI "\fIReturns true if a user is invited to a channel. \fP"
  36 .ti -1c
  37 .RI "virtual void \fBInviteTo\fP (char *channel)"
  38 .br
  39 .RI "\fIAdds a channel to a users invite list (invites them to a channel). \fP"
  40 .ti -1c
  41 .RI "virtual void \fBRemoveInvite\fP (char *channel)"
  42 .br
  43 .RI "\fIRemoves a channel from a users invite list. \fP"
  44 .ti -1c
  45 .RI "bool \fBHasPermission\fP (char *command)"
  46 .br
  47 .RI "\fIReturns true or false for if a user can execute a privilaged oper command. \fP"
  48 .ti -1c
  49 .RI "bool \fBAddBuffer\fP (std::string a)"
  50 .br
  51 .RI "\fIThis method adds data to the buffer of the user. \fP"
  52 .ti -1c
  53 .RI "bool \fBBufferIsReady\fP ()"
  54 .br
  55 .RI "\fIThis method returns true if the buffer contains at least one carriage return character (e.g. \fP"
  56 .ti -1c
  57 .RI "void \fBClearBuffer\fP ()"
  58 .br
  59 .RI "\fIThis function clears the entire buffer by setting it to an empty string. \fP"
  60 .ti -1c
  61 .RI "std::string \fBGetBuffer\fP ()"
  62 .br
  63 .RI "\fIThis method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. \fP"
  64 .ti -1c
  65 .RI "void \fBSetWriteError\fP (std::string error)"
  66 .br
  67 .RI "\fISets the write error for a connection. \fP"
  68 .ti -1c
  69 .RI "std::string \fBGetWriteError\fP ()"
  70 .br
  71 .RI "\fIReturns the write error which last occured on this connection or an empty string if none occured. \fP"
  72 .ti -1c
  73 .RI "void \fBAddWriteBuf\fP (std::string data)"
  74 .br
  75 .RI "\fIAdds to the user's write buffer. \fP"
  76 .ti -1c
  77 .RI "void \fBFlushWriteBuf\fP ()"
  78 .br
  79 .RI "\fIFlushes as much of the user's buffer to the file descriptor as possible. \fP"
  80 .in -1c
  81 .SS "Public Attributes"
  82
  83 .in +1c
  84 .ti -1c
  85 .RI "char \fBnick\fP [NICKMAX]"
  86 .br
  87 .RI "\fIThe users nickname. \fP"
  88 .ti -1c
  89 .RI "char \fBident\fP [16]"
  90 .br
  91 .RI "\fIThe users ident reply. \fP"
  92 .ti -1c
  93 .RI "char \fBdhost\fP [160]"
  94 .br
  95 .RI "\fIThe host displayed to non-opers (used for cloaking etc). \fP"
  96 .ti -1c
  97 .RI "char \fBfullname\fP [128]"
  98 .br
  99 .RI "\fIThe users full name. \fP"
 100 .ti -1c
 101 .RI "char \fBmodes\fP [MAXBUF]"
 102 .br
 103 .RI "\fIThe user's mode string. \fP"
 104 .ti -1c
 105 .RI "\fBucrec\fP \fBchans\fP [MAXCHANS]"
 106 .br
 107 .ti -1c
 108 .RI "char \fBserver\fP [256]"
 109 .br
 110 .RI "\fIThe server the user is connected to. \fP"
 111 .ti -1c
 112 .RI "char \fBawaymsg\fP [512]"
 113 .br
 114 .RI "\fIThe user's away message. \fP"
 115 .ti -1c
 116 .RI "char \fBresult\fP [256]"
 117 .br
 118 .RI "\fIStores the result of the last GetFullHost or GetRealHost call. \fP"
 119 .ti -1c
 120 .RI "int \fBflood\fP"
 121 .br
 122 .RI "\fINumber of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. \fP"
 123 .ti -1c
 124 .RI "unsigned int \fBtimeout\fP"
 125 .br
 126 .RI "\fINumber 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. \fP"
 127 .ti -1c
 128 .RI "char \fBoper\fP [NICKMAX]"
 129 .br
 130 .RI "\fIThe oper type they logged in as, if they are an oper. \fP"
 131 .ti -1c
 132 .RI "bool \fBdns_done\fP"
 133 .br
 134 .RI "\fITrue when \fBDNS\fP lookups are completed. \fP"
 135 .ti -1c
 136 .RI "unsigned int \fBpingmax\fP"
 137 .br
 138 .RI "\fINumber of seconds between PINGs for this user (set from <connect:allow> tag. \fP"
 139 .ti -1c
 140 .RI "char \fBpassword\fP [MAXBUF]"
 141 .br
 142 .RI "\fIPassword specified by the user when they registered. \fP"
 143 .ti -1c
 144 .RI "std::string \fBrecvq\fP"
 145 .br
 146 .RI "\fIUser's receive queue. \fP"
 147 .ti -1c
 148 .RI "std::string \fBsendq\fP"
 149 .br
 150 .RI "\fIUser's send queue. \fP"
 151 .ti -1c
 152 .RI "int \fBlines_in\fP"
 153 .br
 154 .RI "\fIFlood counters. \fP"
 155 .ti -1c
 156 .RI "time_t \fBreset_due\fP"
 157 .br
 158 .ti -1c
 159 .RI "long \fBthreshold\fP"
 160 .br
 161 .ti -1c
 162 .RI "std::string \fBWriteError\fP"
 163 .br
 164 .ti -1c
 165 .RI "long \fBsendqmax\fP"
 166 .br
 167 .RI "\fIMaximum size this user's sendq can become. \fP"
 168 .ti -1c
 169 .RI "long \fBrecvqmax\fP"
 170 .br
 171 .RI "\fIMaximum size this user's recvq can become. \fP"
 172 .in -1c
 173 .SS "Private Attributes"
 174
 175 .in +1c
 176 .ti -1c
 177 .RI "\fBInvitedList\fP \fBinvites\fP"
 178 .br
 179 .RI "\fIA list of channels the user has a pending invite to. \fP"
 180 .in -1c
 181 .SH "Detailed Description"
 182 .PP
 183 Holds all information about a user This class stores all information about a user connected to the irc server.
 184
 185 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.
 186 .PP
 187 Definition at line 108 of file users.h.
 188 .SH "Constructor & Destructor Documentation"
 189 .PP
 190 .SS "userrec::userrec ()"
 191 .PP
 192 Definition at line 28 of file users.cpp.
 193 .PP
 194 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.
 195 .PP
 196 .nf
 197 29 {
 198 30         // the PROPER way to do it, AVOID bzero at *ALL* costs
 199 31         strcpy(nick,'');
 200 32         strcpy(ip,'127.0.0.1');
 201 33         timeout = 0;
 202 34         strcpy(ident,'');
 203 35         strcpy(host,'');
 204 36         strcpy(dhost,'');
 205 37         strcpy(fullname,'');
 206 38         strcpy(modes,'');
 207 39         strcpy(server,'');
 208 40         strcpy(awaymsg,'');
 209 41         strcpy(oper,'');
 210 42         reset_due = TIME;
 211 43         lines_in = 0;
 212 44         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
 213 45         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
 214 46         haspassed = false;
 215 47         dns_done = false;
 216 48         recvq = '';
 217 49         sendq = '';
 218 50         strcpy(result,'');
 219 51         for (int i = 0; i < MAXCHANS; i++)
 220 52         {
 221 53                 this->chans[i].channel = NULL;
 222 54                 this->chans[i].uc_modes = 0;
 223 55         }
 224 56         invites.clear();
 225 57 }
 226 .fi
 227 .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP"
 228 .PP
 229 Definition at line 222 of file users.h.
 230 .PP
 231 .nf
 232 222 {  }
 233 .fi
 234 .SH "Member Function Documentation"
 235 .PP
 236 .SS "bool userrec::AddBuffer (std::string a)"
 237 .PP
 238 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.
 239 .PP
 240 References recvq, recvqmax, and SetWriteError().
 241 .PP
 242 .nf
 243 170 {
 244 171         std::string b = '';
 245 172         for (int i = 0; i < a.length(); i++)
 246 173                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
 247 174                         b = b + a[i];
 248 175         std::stringstream stream(recvq);
 249 176         stream << b;
 250 177         recvq = stream.str();
 251 178         int i = 0;
 252 179         // count the size of the first line in the buffer.
 253 180         while (i < recvq.length())
 254 181         {
 255 182                 if (recvq[i++] == '\n')
 256 183                         break;
 257 184         }
 258 185         if (recvq.length() > this->recvqmax)
 259 186         {
 260 187                 this->SetWriteError('RecvQ exceeded');
 261 188                 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax);
 262 189         }
 263 190         // return false if we've had more than 600 characters WITHOUT
 264 191         // a carriage return (this is BAD, drop the socket)
 265 192         return (i < 600);
 266 193 }
 267 .fi
 268 .SS "void userrec::AddWriteBuf (std::string data)"
 269 .PP
 270 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, \fBSetWriteError()\fP will be called to set the users error string to 'SendQ exceeded', and further buffer adds will be dropped.Definition at line 225 of file users.cpp.
 271 .PP
 272 References GetWriteError(), sendq, sendqmax, and SetWriteError().
 273 .PP
 274 .nf
 275 226 {
 276 227         if (this->GetWriteError() != '')
 277 228                 return;
 278 229         if (sendq.length() + data.length() > this->sendqmax)
 279 230         {
 280 231                 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax);
 281 232                 this->SetWriteError('SendQ exceeded');
 282 233                 return;
 283 234         }
 284 235         std::stringstream stream;
 285 236         stream << sendq << data;
 286 237         sendq = stream.str();
 287 238 }
 288 .fi
 289 .SS "bool userrec::BufferIsReady ()"
 290 .PP
 291 This method returns true if the buffer contains at least one carriage return character (e.g. one complete line may be read)Definition at line 195 of file users.cpp.
 292 .PP
 293 References recvq.
 294 .PP
 295 .nf
 296 196 {
 297 197         for (int i = 0; i < recvq.length(); i++)
 298 198                 if (recvq[i] == '\n')
 299 199                         return true;
 300 200         return false;
 301 201 }
 302 .fi
 303 .SS "void userrec::ClearBuffer ()"
 304 .PP
 305 This function clears the entire buffer by setting it to an empty string. Definition at line 203 of file users.cpp.
 306 .PP
 307 References recvq.
 308 .PP
 309 Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
 310 .PP
 311 .nf
 312 204 {
 313 205         recvq = '';
 314 206 }
 315 .fi
 316 .SS "void userrec::FlushWriteBuf ()"
 317 .PP
 318 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 241 of file users.cpp.
 319 .PP
 320 References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError().
 321 .PP
 322 .nf
 323 242 {
 324 243         if (sendq.length())
 325 244         {
 326 245                 char* tb = (char*)this->sendq.c_str();
 327 246                 int n_sent = write(this->fd,tb,this->sendq.length());
 328 247                 if (n_sent == -1)
 329 248                 {
 330 249                         this->SetWriteError(strerror(errno));
 331 250                 }
 332 251                 else
 333 252                 {
 334 253                         // advance the queue
 335 254                         tb += n_sent;
 336 255                         this->sendq = tb;
 337 256                         // update the user's stats counters
 338 257                         this->bytes_out += n_sent;
 339 258                         this->cmds_out++;
 340 259                 }
 341 260         }
 342 261 }
 343 .fi
 344 .SS "std::string userrec::GetBuffer ()"
 345 .PP
 346 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. 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 \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.Definition at line 208 of file users.cpp.
 347 .PP
 348 References recvq.
 349 .PP
 350 .nf
 351 209 {
 352 210         if (recvq == '')
 353 211                 return '';
 354 212         char* line = (char*)recvq.c_str();
 355 213         std::string ret = '';
 356 214         while ((*line != '\n') && (strlen(line)))
 357 215         {
 358 216                 ret = ret + *line;
 359 217                 line++;
 360 218         }
 361 219         if ((*line == '\n') || (*line == '\r'))
 362 220                 line++;
 363 221         recvq = line;
 364 222         return ret;
 365 223 }
 366 .fi
 367 .SS "char * userrec::GetFullHost ()\fC [virtual]\fP"
 368 .PP
 369 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. Definition at line 61 of file users.cpp.
 370 .PP
 371 References dhost, ident, nick, and result.
 372 .PP
 373 .nf
 374 62 {
 375 63         snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost);
 376 64         return result;
 377 65 }
 378 .fi
 379 .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP"
 380 .PP
 381 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. 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.
 382 .PP
 383 References connection::host, ident, nick, and result.
 384 .PP
 385 .nf
 386 69 {
 387 70         snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host);
 388 71         return result;
 389 72 }
 390 .fi
 391 .SS "std::string userrec::GetWriteError ()"
 392 .PP
 393 Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 271 of file users.cpp.
 394 .PP
 395 References WriteError.
 396 .PP
 397 Referenced by AddWriteBuf().
 398 .PP
 399 .nf
 400 272 {
 401 273         return this->WriteError;
 402 274 }
 403 .fi
 404 .SS "bool userrec::HasPermission (char * command)"
 405 .PP
 406 Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 117 of file users.cpp.
 407 .PP
 408 References config_f, and DEBUG.
 409 .PP
 410 .nf
 411 118 {
 412 119         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
 413 120         char* mycmd;
 414 121         char* savept;
 415 122         char* savept2;
 416 123
 417 124         // are they even an oper at all?
 418 125         if (strchr(this->modes,'o'))
 419 126         {
 420 127                 log(DEBUG,'*** HasPermission: %s is an oper',this->nick);
 421 128                 for (int j =0; j < ConfValueEnum('type',&config_f); j++)
 422 129                 {
 423 130                         ConfValue('type','name',j,TypeName,&config_f);
 424 131                         if (!strcmp(TypeName,this->oper))
 425 132                         {
 426 133                                 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper);
 427 134                                 ConfValue('type','classes',j,Classes,&config_f);
 428 135                                 char* myclass = strtok_r(Classes,' ',&savept);
 429 136                                 while (myclass)
 430 137                                 {
 431 138                                         log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass);
 432 139                                         for (int k =0; k < ConfValueEnum('class',&config_f); k++)
 433 140                                         {
 434 141                                                 ConfValue('class','name',k,ClassName,&config_f);
 435 142                                                 if (!strcmp(ClassName,myclass))
 436 143                                                 {
 437 144                                                         ConfValue('class','commands',k,CommandList,&config_f);
 438 145                                                         log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList);
 439 146
 440 147
 441 148                                                         mycmd = strtok_r(CommandList,' ',&savept2);
 442 149                                                         while (mycmd)
 443 150                                                         {
 444 151                                                                 if (!strcasecmp(mycmd,command))
 445 152                                                                 {
 446 153                                                                         log(DEBUG,'*** Command %s found, returning true',command);
 447 154                                                                         return true;
 448 155                                                                 }
 449 156                                                                 mycmd = strtok_r(NULL,' ',&savept2);
 450 157                                                         }
 451 158                                                 }
 452 159                                         }
 453 160                                         myclass = strtok_r(NULL,' ',&savept);
 454 161                                 }
 455 162                         }
 456 163                 }
 457 164         }
 458 165         return false;
 459 166 }
 460 .fi
 461 .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP"
 462 .PP
 463 Adds a channel to a users invite list (invites them to a channel). Definition at line 88 of file users.cpp.
 464 .PP
 465 References Invited::channel, and invites.
 466 .PP
 467 .nf
 468 89 {
 469 90         Invited i;
 470 91         strlcpy(i.channel,channel,CHANMAX);
 471 92         invites.push_back(i);
 472 93 }
 473 .fi
 474 .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP"
 475 .PP
 476 Returns true if a user is invited to a channel. Definition at line 74 of file users.cpp.
 477 .PP
 478 References invites.
 479 .PP
 480 .nf
 481 75 {
 482 76         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
 483 77         {
 484 78                 if (i->channel) {
 485 79                         if (!strcasecmp(i->channel,channel))
 486 80                         {
 487 81                                 return true;
 488 82                         }
 489 83                 }
 490 84         }
 491 85         return false;
 492 86 }
 493 .fi
 494 .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP"
 495 .PP
 496 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.
 497 .PP
 498 References DEBUG, and invites.
 499 .PP
 500 .nf
 501 96 {
 502 97         log(DEBUG,'Removing invites');
 503 98         if (channel)
 504 99         {
 505 100                 if (invites.size())
 506 101                 {
 507 102                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
 508 103                         {
 509 104                                 if (i->channel)
 510 105                                 {
 511 106                                         if (!strcasecmp(i->channel,channel))
 512 107                                         {
 513 108                                                 invites.erase(i);
 514 109                                                 return;
 515 110                                         }
 516 111                                 }
 517 112                         }
 518 113                 }
 519 114         }
 520 115 }
 521 .fi
 522 .SS "void userrec::SetWriteError (std::string error)"
 523 .PP
 524 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 263 of file users.cpp.
 525 .PP
 526 References DEBUG, and WriteError.
 527 .PP
 528 Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf().
 529 .PP
 530 .nf
 531 264 {
 532 265         log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str());
 533 266         // don't try to set the error twice, its already set take the first string.
 534 267         if (this->WriteError == '')
 535 268                 this->WriteError = error;
 536 269 }
 537 .fi
 538 .SH "Member Data Documentation"
 539 .PP
 540 .SS "char \fBuserrec::awaymsg\fP[512]"
 541 .PP
 542 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.
 543 .PP
 544 Referenced by userrec().
 545 .SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]"
 546 .PP
 547 Definition at line 142 of file users.h.
 548 .PP
 549 Referenced by Server::PseudoToUser(), and userrec().
 550 .SS "char \fBuserrec::dhost\fP[160]"
 551 .PP
 552 The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 130 of file users.h.
 553 .PP
 554 Referenced by GetFullHost(), and userrec().
 555 .SS "bool \fBuserrec::dns_done\fP"
 556 .PP
 557 True when \fBDNS\fP lookups are completed. Definition at line 179 of file users.h.
 558 .PP
 559 Referenced by userrec().
 560 .SS "int \fBuserrec::flood\fP"
 561 .PP
 562 Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 162 of file users.h.
 563 .PP
 564 Referenced by userrec().
 565 .SS "char \fBuserrec::fullname\fP[128]"
 566 .PP
 567 The users full name. Definition at line 134 of file users.h.
 568 .PP
 569 Referenced by userrec().
 570 .SS "char \fBuserrec::ident\fP[16]"
 571 .PP
 572 The users ident reply. Definition at line 125 of file users.h.
 573 .PP
 574 Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().
 575 .SS "\fBInvitedList\fP \fBuserrec::invites\fP\fC [private]\fP"
 576 .PP
 577 A list of channels the user has a pending invite to. Definition at line 114 of file users.h.
 578 .PP
 579 Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().
 580 .SS "int \fBuserrec::lines_in\fP"
 581 .PP
 582 Flood counters. Definition at line 204 of file users.h.
 583 .PP
 584 Referenced by userrec().
 585 .SS "char \fBuserrec::modes\fP[MAXBUF]"
 586 .PP
 587 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 140 of file users.h.
 588 .PP
 589 Referenced by userrec().
 590 .SS "char \fBuserrec::nick\fP[NICKMAX]"
 591 .PP
 592 The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 121 of file users.h.
 593 .PP
 594 Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec().
 595 .SS "char \fBuserrec::oper\fP[NICKMAX]"
 596 .PP
 597 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.
 598 .PP
 599 Referenced by userrec().
 600 .SS "char \fBuserrec::password\fP[MAXBUF]"
 601 .PP
 602 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.
 603 .SS "unsigned int \fBuserrec::pingmax\fP"
 604 .PP
 605 Number of seconds between PINGs for this user (set from <connect:allow> tag. Definition at line 183 of file users.h.
 606 .SS "std::string \fBuserrec::recvq\fP"
 607 .PP
 608 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.
 609 .PP
 610 Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec().
 611 .SS "long \fBuserrec::recvqmax\fP"
 612 .PP
 613 Maximum size this user's recvq can become. Definition at line 218 of file users.h.
 614 .PP
 615 Referenced by AddBuffer().
 616 .SS "time_t \fBuserrec::reset_due\fP"
 617 .PP
 618 Definition at line 205 of file users.h.
 619 .PP
 620 Referenced by userrec().
 621 .SS "char \fBuserrec::result\fP[256]"
 622 .PP
 623 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.
 624 .PP
 625 Referenced by GetFullHost(), GetFullRealHost(), and userrec().
 626 .SS "std::string \fBuserrec::sendq\fP"
 627 .PP
 628 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.
 629 .PP
 630 Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec().
 631 .SS "long \fBuserrec::sendqmax\fP"
 632 .PP
 633 Maximum size this user's sendq can become. Definition at line 214 of file users.h.
 634 .PP
 635 Referenced by AddWriteBuf().
 636 .SS "char \fBuserrec::server\fP[256]"
 637 .PP
 638 The server the user is connected to. Definition at line 146 of file users.h.
 639 .PP
 640 Referenced by userrec().
 641 .SS "long \fBuserrec::threshold\fP"
 642 .PP
 643 Definition at line 206 of file users.h.
 644 .SS "unsigned int \fBuserrec::timeout\fP"
 645 .PP
 646 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. Definition at line 168 of file users.h.
 647 .PP
 648 Referenced by userrec().
 649 .SS "std::string \fBuserrec::WriteError\fP"
 650 .PP
 651 Definition at line 210 of file users.h.
 652 .PP
 653 Referenced by GetWriteError(), and SetWriteError().
 654
 655 .SH "Author"
 656 .PP
 657 Generated automatically by Doxygen for InspIRCd from the source code.