From afb51347b493a6ab54fcc8595b4a3f46972ce18f Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 17 Apr 2004 12:33:39 +0000 Subject: Added new documentation to cover ircd_connector git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@629 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 201 ++++++++++++++++++++------------------ 1 file changed, 108 insertions(+), 93 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 5270e6a4e..f85539459 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. @@ -54,8 +54,10 @@ Inheritance diagram for userrec:



- + + + @@ -67,7 +69,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 66 of file users.h.

Constructor & Destructor Documentation

+Definition at line 78 of file users.h.

Constructor & Destructor Documentation

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

char carryover [MAXBUF]
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 long 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.


Private Attributes

InvitedList invites
 A list of channels the user has a pending invite to.

@@ -97,12 +99,12 @@ Definition at line 66 of fi

Definition at line 11 of file users.cpp.

-References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, connection::signon, and timeout. +References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, flood, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, connection::signon, timeout, and ucrec::uc_modes. 

00012 {
 00013         // the PROPER way to do it, AVOID bzero at *ALL* costs
 00014         strcpy(nick,"");
-00015         ip = 0;
+00015         ip = 0;
 00016         timeout = 0;
 00017         strcpy(ident,"");
 00018         strcpy(host,"");
@@ -112,16 +114,17 @@ References connection::byt
 00022         strcpy(inbuf,"");
 00023         strcpy(server,"");
 00024         strcpy(awaymsg,"");
-00025         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00026         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00027         haspassed = false;
+00025         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
+00026         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
+00027         haspassed = false;
 00028         strcpy(result,"");
 00029         for (int i = 0; i < MAXCHANS; i++)
 00030         {
-00031                 chans[i].channel = NULL;
-00032         }
-00033         invites.clear();
-00034 }
+00031                 this->chans[i].channel = NULL;
+00032                 this->chans[i].uc_modes = 0;
+00033         }
+00034         invites.clear();
+00035 }
@@ -152,9 +155,9 @@ References connection::byt

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

-

00122 {  }
+
00142 {  }
 
    
   
 
@@ -188,14 +191,14 @@ Returns the full displayed host of the user This member function returns the hos
 

 
 

-Definition at line 38 of file users.cpp.
+Definition at line 39 of file users.cpp.
 

-References result.
+References result.
 

-
00039 {
-00040         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00041         return result;
-00042 }
+
00040 {
+00041         sprintf(result,"%s!%s@%s",nick,ident,dhost);
+00042         return result;
+00043 }
 
    
   
 
@@ -228,14 +231,14 @@ 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 45 of file users.cpp.
+Definition at line 46 of file users.cpp.
 

-References result.
+References result.
 

-
00046 {
-00047         sprintf(result,"%s!%s@%s",nick,ident,host);
-00048         return result;
-00049 }
+
00047 {
+00048         sprintf(result,"%s!%s@%s",nick,ident,host);
+00049         return result;
+00050 }
 
    
   
 
@@ -269,15 +272,15 @@ Adds a channel to a users invite list (invites them to a channel).
 

 
 

-Definition at line 65 of file users.cpp.
+Definition at line 66 of file users.cpp.
 

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

-
00066 {
-00067         Invited i;
-00068         strcpy(i.channel,channel);
-00069         invites.push_back(i);
-00070 }
+
00067 {
+00068         Invited i;
+00069         strcpy(i.channel,channel);
+00070         invites.push_back(i);
+00071 }
 
    
   
 
@@ -311,22 +314,22 @@ Returns true if a user is invited to a channel.
 

 
 

-Definition at line 51 of file users.cpp.
+Definition at line 52 of file users.cpp.
 

-References invites.
+References invites.
 

-
00052 {
-00053         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00054         {
-00055                 if (i->channel) {
-00056                         if (!strcasecmp(i->channel,channel))
-00057                         {
-00058                                 return true;
-00059                         }
-00060                 }
-00061         }
-00062         return false;
-00063 }
+
00053 {
+00054         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00055         {
+00056                 if (i->channel) {
+00057                         if (!strcasecmp(i->channel,channel))
+00058                         {
+00059                                 return true;
+00060                         }
+00061                 }
+00062         }
+00063         return false;
+00064 }
 
    
   
 
@@ -360,26 +363,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 72 of file users.cpp.
-

-References invites.
-

-
00073 {
-00074         log(DEBUG,"Removing invites");
-00075         if (invites.size())
-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                                         invites.erase(i);
-00083                                         return;
-00084                                 }
-00085                         }
-00086                 }
-00087         }
-00088 }
+Definition at line 73 of file users.cpp.
+

+References invites.
+

+
00074 {
+00075         log(DEBUG,"Removing invites");
+00076         if (channel)
+00077         {
+00078                 if (invites.size())
+00079                 {
+00080                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00081                         {
+00082                                 if (i->channel)
+00083                                 {
+00084                                         if (!strcasecmp(i->channel,channel))
+00085                                         {
+00086                                                 invites.erase(i);
+00087                                                 return;
+00088                                         }
+00089                                 }
+00090                         }
+00091                 }
+00092         }
+00093 }
 
    
   
 
@@ -407,16 +414,16 @@ The user's away message.
 

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

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

+

 
@@ -431,16 +438,18 @@ Definition at line 109 of f
 

 
 

-Definition at line 116 of file users.h.    
+Definition at line 112 of file users.h.
+

+Referenced by userrec().    
   
 

   

     
       
-          

         
 char userrec::carryover[MAXBUF]
+           ucrec userrec::chans[MAXCHANS]
       

     		
   

-

+

 
@@ -453,20 +462,20 @@ Definition at line 116 of f
     
+Definition at line 100 of file users.h.    

   

     
       
-          

         
 ucrec userrec::chans[MAXCHANS]
+           char userrec::dhost[256]
       

     		
   

 
 

-
+The host displayed to non-opers (used for cloaking etc).
 

-Definition at line 100 of file users.h.
+This usually matches the value of userrec::host.
 

-Referenced by userrec().    

   

 

-

+

 
@@ -479,11 +488,13 @@ Referenced by userrec().
     
+Referenced by userrec().    

   

     
       
-          

         
 char userrec::dhost[256]
+           int userrec::flood
       

     		
   

 
 

-The host displayed to non-opers (used for cloaking etc).
+Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
 

-This usually matches the value of userrec::host.
+
+

+Definition at line 132 of file users.h.
 

-Definition at line 88 of file users.h.    

   

 

 

@@ -509,7 +520,7 @@ The users full name.
 

 
 

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

@@ -535,7 +546,7 @@ The users ident reply.
 

 
 

-Definition at line 83 of file users.h.    
+Definition at line 95 of file users.h.    
   
 
 

@@ -561,9 +572,9 @@ A list of channels the user has a pending invite to.
 

 
 

-Definition at line 72 of file users.h.
+Definition at line 84 of file users.h.
 

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

@@ -589,7 +600,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 98 of file users.h.    
+Definition at line 110 of file users.h.    
   
 
 

@@ -615,7 +626,9 @@ The users nickname.
 

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

-Definition at line 79 of file users.h.    
+Definition at line 91 of file users.h.
+

+Referenced by Server::QuitUser().    
   
 
 

@@ -641,9 +654,9 @@ 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 114 of file users.h.
+Definition at line 126 of file users.h.
 

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

@@ -669,7 +682,7 @@ The server the user is connected to.
 

 
 

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

@@ -691,16 +704,18 @@ Definition at line 104 of f
     
 
 

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

 Referenced by userrec().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Thu Apr 8 19:13:23 2004 for InspIRCd by
+
Generated on Sat Apr 17 13:31:56 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3