From 767b12b0ab6a0d4ed5f7335b26d1c0f842d99543 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 26 Jan 2003 23:52:48 +0000 Subject: Modified documentation for base classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@150 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 557 ++++---------------------------------- 1 file changed, 57 insertions(+), 500 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index c241c89f9..07d5cf5ed 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -11,6 +11,12 @@

#include <users.h>

+

Inheritance diagram for userrec: +

+ +connection +classbase + List of all members. @@ -29,52 +35,21 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + @@ -86,7 +61,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 83 of file users.h.

Constructor & Destructor Documentation

+Definition at line 84 of file users.h.

Constructor & Destructor Documentation


Public Methods


Public Attributes

char nick [NICKMAX]
 The users nickname.

unsigned long ip
 The users ip address in network order.

char ident [64]
 The users ident reply.

char host [256]
 The users hostname, or ip address in string form.

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

char fullname [128]
 The users full name.

int fd
 The users file descriptor.

char modes [32]
 The user's mode string.

char inbuf [MAXBUF]
 The users input buffer.

time_t lastping
 The last time the user was pinged by the core.

time_t signon
 The users signon time.

time_t idle_lastmsg
 The time the user last sent a message.

time_t nping
 True if the user replied to their last ping.

int registered
 Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.

ucrec chans [MAXCHANS]
 A list of the channels the user is currently on.

char server [256]
 The server the user is connected to.

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

int port
 The port that the user connected to.

long bytes_in
 Stores the number of incoming bytes from the connection.

long bytes_out
 Stores the number of outgoing bytes to the connection.

long cmds_in
 Stores the number of incoming commands from the connection.

long cmds_out
 Stores the number of outgoing commands to the connection.

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

bool haspassed
 True if a correct password has been given using PASS command.

char ident [64]
 The users ident reply.

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

char fullname [128]
 The users full name.

char modes [32]
 The user's mode string.

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

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

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


Private Attributes

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

@@ -116,12 +91,12 @@ Definition at line 83 of fi

Definition at line 26 of file users.cpp.

-References bytes_in, bytes_out, ucrec::channel, chans, cmds_in, cmds_out, fd, haspassed, idle_lastmsg, invites, ip, lastping, nping, port, registered, and signon. +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, and connection::signon. 

00027 {
 00028         // the PROPER way to do it, AVOID bzero at *ALL* costs
 00029         strcpy(nick,"");
-00030         ip = 0;
+00030         ip = 0;
 00031         strcpy(ident,"");
 00032         strcpy(host,"");
 00033         strcpy(dhost,"");
@@ -130,13 +105,13 @@ References bytes_in, "");
 00037         strcpy(server,"");
 00038         strcpy(awaymsg,"");
-00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00041         haspassed = false;
+00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
+00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
+00041         haspassed = false;
 00042         strcpy(result,"");
 00043         for (int i = 0; i < MAXCHANS; i++)
 00044         {
-00045                 chans[i].channel = NULL;
+00045                 chans[i].channel = NULL;
 00046         }
 00047         invites.clear();
 00048 }
@@ -170,9 +145,9 @@ References bytes_in, 
 
 

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

-
00216 {  }
+
00136 {  }
@@ -208,11 +183,11 @@ Returns the full displayed host of the user This member function returns the hos

Definition at line 51 of file users.cpp.

-References result. +References result. 

00052 {
 00053         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00054         return result;
+00054         return result;
 00055 }
@@ -248,11 +223,11 @@ If any form of hostname cloaking is in operation, e.g. through a module, then th

Definition at line 58 of file users.cpp.

-References result. +References result. 

00059 {
 00060         sprintf(result,"%s!%s@%s",nick,ident,host);
-00061         return result;
+00061         return result;
 00062 }
@@ -289,7 +264,7 @@ Adds a channel to a users invite list (invites them to a channel).

Definition at line 75 of file users.cpp.

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

00076 {
 00077         Invited i;
@@ -331,7 +306,7 @@ Returns true if a user is invited to a channel.
 

 Definition at line 64 of file users.cpp.
 

-References invites.
+References invites.
 

 
00065 {
 00066         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
@@ -377,7 +352,7 @@ This member function is called on successfully joining an invite only channel to
 

 Definition at line 82 of file users.cpp.
 

-References invites.
+References invites.
 

 
00083 {
 00084         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
@@ -393,7 +368,7 @@ References invites.
   
 
 
Member Data Documentation

-

+

 
+Definition at line 127 of file users.h.    

   

     
@@ -416,66 +391,10 @@ The user's away message.
 

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

-Definition at line 177 of file users.h.    

   

 

-

-
-  
-    
-  
-

-      
-        
-          
 long userrec::bytes_in
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-Stores the number of incoming bytes from the connection.
-

-Used by /STATS
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 long userrec::bytes_out
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-Stores the number of outgoing bytes to the connection.
-

-Used by /STATS
-

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

-Referenced by userrec().    

-

+

 
-  
-

   

     
@@ -494,72 +413,14 @@ Referenced by userrec().
     
 
 

-A list of the channels the user is currently on.
-

-If any of these values are NULL, the record is not in use and may be associated with a channel by the JOIN command. see RFC 1459.
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 long userrec::cmds_in
-      

-    

-
-  
-    
-    

-       
-    
 
 

-Stores the number of incoming commands from the connection.
-

-Used by /STATS
-

-Definition at line 196 of file users.h.
+Definition at line 118 of file users.h.
 

 Referenced by userrec().    

   

 

-

-
-  
-    
-  
-

-      
-        
-          
 long userrec::cmds_out
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-Stores the number of outgoing commands to the connection.
-

-Used by /STATS
-

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

-Referenced by userrec().    

-

+

 
+Definition at line 106 of file users.h.    

   

     
@@ -580,40 +441,12 @@ Referenced by userrec().
 

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

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

-Definition at line 113 of file users.h.    

   

 

-

-
-  
-    
-  
-

-      
-        
-          
 int userrec::fd
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-The users file descriptor.
-

-If this is zero, the socket has been closed and the core has not yet realised and removed the record from memory.
-

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

-Referenced by userrec().    

-

+

 
-  
-

   

     
@@ -636,64 +469,10 @@ The users full name.
 

 
 

-Definition at line 117 of file users.h.    

-

-
-  
-    
-  
-

-      
-        
-          
 bool userrec::haspassed
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-True if a correct password has been given using PASS command.
-

-If the user is a member of a connection class that does not require a password, the value stored here is of no use.
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 char userrec::host[256]
-      

-    

-
-  
-    
-    
+Definition at line 110 of file users.h.    

-       
-    
-
-

-The users hostname, or ip address in string form.
-

-
-

-Definition at line 108 of file users.h.    

   

 

-

+

 
-  
-

   

     
@@ -716,61 +495,7 @@ The users ident reply.
 

 
 

-Definition at line 104 of file users.h.    

-

-
-  
-    
-  
-

-      
-        
-          
 time_t userrec::idle_lastmsg
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-The time the user last sent a message.
-

-See also userrec::lastping and userrec::signon
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 char userrec::inbuf[MAXBUF]
-      

-    

-
-  
-    
-    
+Definition at line 101 of file users.h.    

-       
-    
-
-

-The users input buffer.
-

-Used by the C recv() function.
-

-Definition at line 134 of file users.h.    

   

 

 

@@ -796,68 +521,12 @@ A list of channels the user has a pending invite to.
 

 
 

-Definition at line 89 of file users.h.
+Definition at line 90 of file users.h.
 

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

-
-  
-    
-  
-

-      
-        
-          
 unsigned long userrec::ip
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-The users ip address in network order.
-

-
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 time_t userrec::lastping
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-The last time the user was pinged by the core.
-

-When this value is more than 120 seconds difference from 'time(NULL)', a ping is sent to the client. If the user has an outstanding PING request the next time this event occurs after 4 total minutes, they are disconnected.
-

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

-Referenced by userrec().    

-

+

 
+Definition at line 116 of file users.h.    

   

     
@@ -880,7 +549,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 129 of file users.h.    

   

 

 

@@ -906,94 +575,10 @@ The users nickname.
 

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

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

-
-  
-    
-  
-

-      
-        
-          
 time_t userrec::nping
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-True if the user replied to their last ping.
-

-If this is true, the user can be sent another ping at the specified time, otherwise they will be discnnected. See also userrec::lastping
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 int userrec::port
-      

-    

-
-  
-    
-    
-  
-

-       
-    
-
-

-The port that the user connected to.
-

-
-

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

-Referenced by userrec().    

-

-
-  
-    
-  
-

-      
-        
-          
 int userrec::registered
-      

-    

-
-  
-    
-    
+Definition at line 97 of file users.h.    

-       
-    
-
-

-Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.
-

-If both bits are set then the connection is awaiting MOTD. Sending of MOTD sets bit 3, and makes the value of userrec::registered == 7, showing a fully established client session.
-

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

-Referenced by userrec().    

   

 

-

+

 

   

     
@@ -1016,12 +601,12 @@ 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 206 of file users.h.
+Definition at line 132 of file users.h.
 

 Referenced by GetFullHost(), and GetFullRealHost().    

   

 

-

+

 
-  
-

   

     
@@ -1044,40 +629,12 @@ The server the user is connected to.
 

 
 

-Definition at line 172 of file users.h.    

-

-
-  
-    
-  
-

-      
-        
-          
 time_t userrec::signon
-      

-    

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

-       
-    
-
-

-The users signon time.
-

-
-

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

-Referenced by userrec().    

   

 

 
The documentation for this class was generated from the following files:
-
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by
+
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by
 
 doxygen1.3-rc2 

-- 
cgit v1.2.3