From 3d7312f8af1becdbe458392e14ea64c904ee7b92 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 9 Apr 2005 14:39:07 +0000 Subject: Changed parameters of OnPacketTransmit and OnPacketReceive to be much more useful git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1024 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 77 +++++++++++++++++++++++++++------------ 1 file changed, 53 insertions(+), 24 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 849d914eb..87662d230 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -76,6 +76,9 @@ Inherits connection. bool dns_done  True when DNS lookups are completed.

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


Private Attributes

InvitedList invites @@ -88,7 +91,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 89 of file users.h.

Constructor & Destructor Documentation

+Definition at line 93 of file users.h.

Constructor & Destructor Documentation

@@ -118,7 +121,7 @@ Definition at line 89 of fi

Definition at line 28 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, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, 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, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. 

00029 {
 00030         // the PROPER way to do it, AVOID bzero at *ALL* costs
@@ -176,9 +179,9 @@ References awaymsg, 
 
 

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

-
00164 {  }
+
00172 {  }
@@ -214,7 +217,7 @@ Returns the full displayed host of the user This member function returns the hos

Definition at line 58 of file users.cpp.

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

00059 {
 00060         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
@@ -254,7 +257,7 @@ If any form of hostname cloaking is in operation, e.g. through a module, then th
 

 Definition at line 65 of file users.cpp.
 

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

 
00066 {
 00067         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
@@ -382,7 +385,7 @@ Adds a channel to a users invite list (invites them to a channel).
 

 Definition at line 85 of file users.cpp.
 

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

 
00086 {
 00087         Invited i;
@@ -424,7 +427,7 @@ Returns true if a user is invited to a channel.
 

 Definition at line 71 of file users.cpp.
 

-References invites.
+References invites.
 

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

 Definition at line 92 of file users.cpp.
 

-References DEBUG, and invites.
+References DEBUG, and invites.
 

 
00093 {
 00094         log(DEBUG,"Removing invites");
@@ -522,7 +525,7 @@ The user's away message.
 

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

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

 Referenced by userrec().    
   
@@ -548,7 +551,7 @@ Referenced by userrec().
 

 
 

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

 Referenced by userrec().    
   
@@ -576,7 +579,7 @@ The host displayed to non-opers (used for cloaking etc).
 

 This usually matches the value of userrec::host.
 

-Definition at line 111 of file users.h.
+Definition at line 115 of file users.h.
 

 Referenced by GetFullHost(), and userrec().    
   
@@ -604,7 +607,7 @@ True when DNS lookups are completed.
 

 
 

-Definition at line 160 of file users.h.
+Definition at line 164 of file users.h.
 

 Referenced by userrec().    
   
@@ -632,7 +635,7 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi
 

 
 

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

 Referenced by userrec().    
   
@@ -660,7 +663,7 @@ The users full name.
 

 
 

-Definition at line 115 of file users.h.
+Definition at line 119 of file users.h.
 

 Referenced by userrec().    
   
@@ -688,7 +691,7 @@ The users ident reply.
 

 
 

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

 Referenced by GetFullHost(), GetFullRealHost(), and userrec().    
   
@@ -716,7 +719,7 @@ A list of channels the user has a pending invite to.
 

 
 

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

 Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().    
   
@@ -744,7 +747,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 121 of file users.h.
+Definition at line 125 of file users.h.
 

 Referenced by userrec().    
   
@@ -772,7 +775,7 @@ The users nickname.
 

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

-Definition at line 102 of file users.h.
+Definition at line 106 of file users.h.
 

 Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::QuitUser(), and userrec().    
   
@@ -800,11 +803,37 @@ 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 156 of file users.h.
+Definition at line 160 of file users.h.
 

 Referenced by userrec().    
   
 
+

+
+  
+    
+  
+

+      
+        
+          
 unsigned long userrec::pingmax
+      

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

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

+
+

+Definition at line 168 of file users.h.    

 

 
@@ -828,7 +857,7 @@ 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 137 of file users.h.
+Definition at line 141 of file users.h.
 

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

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

 
 

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

 Referenced by userrec().    
   
@@ -884,14 +913,14 @@ Number of seconds this user is given to send USER/NICK If they do not send their
 

 
 

-Definition at line 149 of file users.h.
+Definition at line 153 of file users.h.
 

 Referenced by userrec().    
   
 

   

 
The documentation for this class was generated from the following files:
-
Generated on Thu Apr 7 20:14:27 2005 for InspIRCd by
+
Generated on Sat Apr 9 14:38:31 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91