From cc61d20faae9a29422d34a367db9ac54d8de3d0e Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 20:38:00 +0000 Subject: Updated documentation scripts git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@143 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 226 +++++++++++++++++++------------------- 1 file changed, 113 insertions(+), 113 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index d4be7912e..c241c89f9 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -86,7 +86,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 80 of file users.h.

Constructor & Destructor Documentation

+Definition at line 83 of file users.h.

Constructor & Destructor Documentation

@@ -114,32 +114,32 @@ Definition at line 80 of fi

-Definition at line 23 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. -

-

00024 {
-00025         // the PROPER way to do it, AVOID bzero at *ALL* costs
-00026         strcpy(nick,"");
-00027         ip = 0;
-00028         strcpy(ident,"");
-00029         strcpy(host,"");
-00030         strcpy(dhost,"");
-00031         strcpy(fullname,"");
-00032         strcpy(modes,"");
-00033         strcpy(inbuf,"");
-00034         strcpy(server,"");
-00035         strcpy(awaymsg,"");
-00036         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00037         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00038         haspassed = false;
-00039         strcpy(result,"");
-00040         for (int i = 0; i < MAXCHANS; i++)
-00041         {
-00042                 chans[i].channel = NULL;
-00043         }
-00044         invites.clear();
-00045 }
+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.
+

+
00027 {
+00028         // the PROPER way to do it, AVOID bzero at *ALL* costs
+00029         strcpy(nick,"");
+00030         ip = 0;
+00031         strcpy(ident,"");
+00032         strcpy(host,"");
+00033         strcpy(dhost,"");
+00034         strcpy(fullname,"");
+00035         strcpy(modes,"");
+00036         strcpy(inbuf,"");
+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;
+00042         strcpy(result,"");
+00043         for (int i = 0; i < MAXCHANS; i++)
+00044         {
+00045                 chans[i].channel = NULL;
+00046         }
+00047         invites.clear();
+00048 }
@@ -170,9 +170,9 @@ References bytes_in,

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

-

00213 {  }
+
00216 {  }
 
    
   
 
@@ -206,14 +206,14 @@ Returns the full displayed host of the user This member function returns the hos
 

 
 

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

-References result.
+References result.
 

-
00049 {
-00050         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00051         return result;
-00052 }
+
00052 {
+00053         sprintf(result,"%s!%s@%s",nick,ident,dhost);
+00054         return result;
+00055 }
 
    
   
 
@@ -246,14 +246,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 55 of file users.cpp.
+Definition at line 58 of file users.cpp.
 

-References result.
+References result.
 

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

 
 

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

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

-
00073 {
-00074         Invited i;
-00075         strcpy(i.channel,channel);
-00076         invites.push_back(i);
-00077 }
+
00076 {
+00077         Invited i;
+00078         strcpy(i.channel,channel);
+00079         invites.push_back(i);
+00080 }
 
    
   
 
@@ -329,19 +329,19 @@ Returns true if a user is invited to a channel.
 

 
 

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

-References invites.
+References invites.
 

-
00062 {
-00063         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00064         {
-00065                 if (!strcasecmp(i->channel,channel))
-00066                 {
-00067                         return true;
-00068                 }
-00069         }
-00070 }
+
00065 {
+00066         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00067         {
+00068                 if (!strcasecmp(i->channel,channel))
+00069                 {
+00070                         return true;
+00071                 }
+00072         }
+00073 }
 
    
   
 
@@ -375,20 +375,20 @@ 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 79 of file users.cpp.
+Definition at line 82 of file users.cpp.
 

-References invites.
+References invites.
 

-
00080 {
-00081         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00082         {
-00083                 if (!strcasecmp(i->channel,channel))
-00084                 {
-00085                         invites.erase(i);
-00086                         return;
-00087                 }
-00088         }
-00089 }
+
00083 {
+00084         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00085         {
+00086                 if (!strcasecmp(i->channel,channel))
+00087                 {
+00088                         invites.erase(i);
+00089                         return;
+00090                 }
+00091         }
+00092 }
 
    
   
 
@@ -416,7 +416,7 @@ The user's away message.
 

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

-Definition at line 174 of file users.h.    
+Definition at line 177 of file users.h.    
   
 
 

@@ -442,9 +442,9 @@ Stores the number of incoming bytes from the connection.
 

 Used by /STATS
 

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

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

@@ -470,9 +470,9 @@ Stores the number of outgoing bytes to the connection.
 

 Used by /STATS
 

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

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

@@ -498,9 +498,9 @@ 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 165 of file users.h.
+Definition at line 168 of file users.h.
 

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

@@ -526,9 +526,9 @@ Stores the number of incoming commands from the connection.
 

 Used by /STATS
 

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

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

@@ -554,9 +554,9 @@ Stores the number of outgoing commands to the connection.
 

 Used by /STATS
 

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

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

@@ -582,7 +582,7 @@ The host displayed to non-opers (used for cloaking etc).
 

 This usually matches the value of userrec::host.
 

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

@@ -608,9 +608,9 @@ 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 120 of file users.h.
+Definition at line 123 of file users.h.
 

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

@@ -636,7 +636,7 @@ The users full name.
 

 
 

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

@@ -662,9 +662,9 @@ 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 209 of file users.h.
+Definition at line 212 of file users.h.
 

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

@@ -690,7 +690,7 @@ The users hostname, or ip address in string form.
 

 
 

-Definition at line 105 of file users.h.    
+Definition at line 108 of file users.h.    
   
 
 

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

 
 

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

@@ -742,9 +742,9 @@ The time the user last sent a message.
 

 See also userrec::lastping and userrec::signon
 

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

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

@@ -770,7 +770,7 @@ The users input buffer.
 

 Used by the C recv() function.
 

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

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

 
 

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

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

@@ -824,9 +824,9 @@ The users ip address in network order.
 

 
 

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

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

@@ -852,9 +852,9 @@ 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 138 of file users.h.
+Definition at line 141 of file users.h.
 

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

@@ -880,7 +880,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 126 of file users.h.    
+Definition at line 129 of file users.h.    
   
 
 

@@ -906,7 +906,7 @@ The users nickname.
 

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

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

@@ -932,9 +932,9 @@ 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 153 of file users.h.
+Definition at line 156 of file users.h.
 

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

@@ -960,9 +960,9 @@ The port that the user connected to.
 

 
 

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

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

@@ -988,9 +988,9 @@ Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a US
 

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

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

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

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

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

 
 

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

@@ -1070,14 +1070,14 @@ The users signon time.
 

 
 

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

-Referenced by userrec().    
+Referenced by userrec().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by
+
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by
 
 doxygen1.3-rc2 

-- 
cgit v1.2.3