From 1d994c544474da53159257d9097997c0744a48a5 Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 6 Apr 2004 10:43:34 +0000 Subject: Added support for SVS-style Server class methods for modules git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@400 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 208 +++++++++++++++++++++----------------- 1 file changed, 118 insertions(+), 90 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 82aeba2ba..6bd92e868 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,6 +54,7 @@ Inheritance diagram for userrec:



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

-Definition at line 58 of file users.h.

Constructor & Destructor Documentation

+Definition at line 66 of file users.h.

Constructor & Destructor Documentation

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

unsigned long timeout

Private Attributes

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

@@ -95,30 +96,31 @@ Definition at line 58 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, and connection::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, connection::signon, and timeout. 

00012 {
 00013         // the PROPER way to do it, AVOID bzero at *ALL* costs
 00014         strcpy(nick,"");
 00015         ip = 0;
-00016         strcpy(ident,"");
-00017         strcpy(host,"");
-00018         strcpy(dhost,"");
-00019         strcpy(fullname,"");
-00020         strcpy(modes,"");
-00021         strcpy(inbuf,"");
-00022         strcpy(server,"");
-00023         strcpy(awaymsg,"");
-00024         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00025         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00026         haspassed = false;
-00027         strcpy(result,"");
-00028         for (int i = 0; i < MAXCHANS; i++)
-00029         {
-00030                 chans[i].channel = NULL;
-00031         }
-00032         invites.clear();
-00033 }
+00016         timeout = 0;
+00017         strcpy(ident,"");
+00018         strcpy(host,"");
+00019         strcpy(dhost,"");
+00020         strcpy(fullname,"");
+00021         strcpy(modes,"");
+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;
+00028         strcpy(result,"");
+00029         for (int i = 0; i < MAXCHANS; i++)
+00030         {
+00031                 chans[i].channel = NULL;
+00032         }
+00033         invites.clear();
+00034 }
@@ -149,9 +151,9 @@ References connection::byt

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

-

00110 {  }
+
00120 {  }
 
    
   
 
@@ -185,14 +187,14 @@ Returns the full displayed host of the user This member function returns the hos
 

 
 

-Definition at line 36 of file users.cpp.
+Definition at line 37 of file users.cpp.
 

-References result.
+References result.
 

-
00037 {
-00038         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00039         return result;
-00040 }
+
00038 {
+00039         sprintf(result,"%s!%s@%s",nick,ident,dhost);
+00040         return result;
+00041 }
 
    
   
 
@@ -225,14 +227,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 43 of file users.cpp.
+Definition at line 44 of file users.cpp.
 

-References result.
+References result.
 

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

 
 

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

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

-
00064 {
-00065         Invited i;
-00066         strcpy(i.channel,channel);
-00067         invites.push_back(i);
-00068 }
+
00065 {
+00066         Invited i;
+00067         strcpy(i.channel,channel);
+00068         invites.push_back(i);
+00069 }
 
    
   
 
@@ -308,22 +310,22 @@ Returns true if a user is invited to a channel.
 

 
 

-Definition at line 49 of file users.cpp.
+Definition at line 50 of file users.cpp.
 

-References invites.
+References invites.
 

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

-References invites.
-

-
00071 {
-00072         log(DEBUG,"Removing invites");
-00073         if (invites.size())
-00074         {
-00075                 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00076                 {
-00077                         if (i->channel) {
-00078                                 if (!strcasecmp(i->channel,channel))
-00079                                 {
-00080                                         invites.erase(i);
-00081                                         return;
-00082                                 }
-00083                         }
-00084                 }
-00085         }
-00086 }
+Definition at line 71 of file users.cpp.
+

+References invites.
+

+
00072 {
+00073         log(DEBUG,"Removing invites");
+00074         if (invites.size())
+00075         {
+00076                 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00077                 {
+00078                         if (i->channel) {
+00079                                 if (!strcasecmp(i->channel,channel))
+00080                                 {
+00081                                         invites.erase(i);
+00082                                         return;
+00083                                 }
+00084                         }
+00085                 }
+00086         }
+00087 }
 
    
   
 
@@ -404,7 +406,7 @@ The user's away message.
 

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

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

@@ -428,7 +430,7 @@ Definition at line 101 of f
 

 
 

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

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

 This usually matches the value of userrec::host.
 

-Definition at line 80 of file users.h.    
+Definition at line 88 of file users.h.    
   
 
 

@@ -482,7 +484,7 @@ The users full name.
 

 
 

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

@@ -508,7 +510,7 @@ The users ident reply.
 

 
 

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

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

 
 

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

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

@@ -562,7 +564,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 90 of file users.h.    
+Definition at line 98 of file users.h.    
   
 
 

@@ -588,7 +590,7 @@ The users nickname.
 

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

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

@@ -614,9 +616,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 106 of file users.h.
+Definition at line 114 of file users.h.
 

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

@@ -642,12 +644,38 @@ The server the user is connected to.
 

 
 

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

+
+  
+    
+  
+

+      
+        
+          
 unsigned long userrec::timeout
+      

+    

+
+  
+    
+    

+       
+    
+
+

+
+

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

+Referenced by userrec().    

   

 

 
The documentation for this class was generated from the following files:
-
Generated on Mon Apr 5 02:04:11 2004 for InspIRCd by
+
Generated on Tue Apr 6 11:42:49 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3